ClassPdfExportSettings
Configuration for PDF export, controlling encryption, compliance, compression, fonts, tagging, and exception handling.
Definition
Namespace:Telerik.Windows.Documents.Fixed.FormatProviders.Pdf.Export
Assembly:Telerik.Windows.Documents.Fixed.dll
Syntax:
public class PdfExportSettings
Inheritance: objectPdfExportSettings
Derived Classes:
Constructors
PdfExportSettings()
Initializes a new instance of the PdfExportSettings class.
Declaration
public PdfExportSettings()
Properties
ComplianceLevel
Target PDF/A or PDF/UA level; may restrict features to satisfy conformance.
Declaration
public PdfComplianceLevel ComplianceLevel { get; set; }
Property Value
The compliance level.
EncryptionType
Encryption algorithm applied when IsEncrypted is true.
Declaration
public EncryptionType EncryptionType { get; set; }
Property Value
FontEmbeddingType
Font embedding strategy used for export, affecting portability and file size.
Declaration
public FontEmbeddingType FontEmbeddingType { get; set; }
Property Value
ImageCompression
Image encoding filter(s) to use; only a single value is supported by the current implementation.
Declaration
public ImageFilterTypes[] ImageCompression { get; set; }
Property Value
ImageQuality
Default image quality used when re-encoding images; higher values increase fidelity and file size. Overridden by per-image settings.
Declaration
public ImageQuality ImageQuality { get; set; }
Property Value
The image quality.
IsEncrypted
Enable encryption for the exported PDF using the selected EncryptionType.
Declaration
public bool IsEncrypted { get; set; }
Property Value
True if the document should be encrypted; otherwise, false.
OwnerPassword
Gets or sets the owner password.
Declaration
public string OwnerPassword { get; set; }
Property Value
The owner password.
ShouldExportXfa
Include XFA content in the exported PDF when present.
Declaration
public bool ShouldExportXfa { get; set; }
Property Value
True if the document should export XFA; otherwise, false.
StreamCompression
Content stream encoding filter(s) to use; only a single value is supported by the current implementation.
Declaration
public StreamFilterTypes[] StreamCompression { get; set; }
Property Value
StripJavaScriptActions
Remove JavaScript actions during export to improve security or meet compliance requirements.
Declaration
public bool StripJavaScriptActions { get; set; }
Property Value
True if the document should strip the JavaScript actions; otherwise, false.
StripStructureTree
Omit the StructureTree from the exported PDF to reduce size or when not required.
Declaration
public bool StripStructureTree { get; set; }
Property Value
True if the document should strip the structure tree; otherwise, false.
TaggingStrategy
Tagging strategy used to produce an accessible StructureTree.
Declaration
public TaggingStrategyType TaggingStrategy { get; set; }
Property Value
UserAccessPermissions
Gets or sets the user access permissions. These permissions specify which access permissions should be granted when the document is opened with user access. In order to be applied the IsEncrypted property should be set to true.
Declaration
public UserAccessPermissions UserAccessPermissions { get; set; }
Property Value
The user access permissions.
UserPassword
Gets or sets the user password.
Declaration
public string UserPassword { get; set; }
Property Value
The user password.
Methods
CanRaiseEvent()
Determines whether the object can raise an exception event.
Declaration
public bool CanRaiseEvent()
Returns
True if the object can raise an exception event; otherwise, false.
RaiseEvent(DocumentUnhandledExceptionEventArgs)
Raises the DocumentUnhandledExceptionEventArgs event.
Declaration
public void RaiseEvent(DocumentUnhandledExceptionEventArgs args)
Parameters
args
DocumentUnhandledExceptionEventArgs
The DocumentUnhandledExceptionEventArgs containing the event data.
Events
DocumentUnhandledException
Raised when an unhandled exception occurs during export.
Declaration
public event EventHandler<DocumentUnhandledExceptionEventArgs> DocumentUnhandledException
Event Value