Class
PdfExportSettings

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:

cs-api-definition
public class PdfExportSettings

Inheritance: objectPdfExportSettings

Derived Classes: PdfExportSettings

Constructors

PdfExportSettings()

Initializes a new instance of the PdfExportSettings class.

Declaration

cs-api-definition
public PdfExportSettings()

Properties

ComplianceLevel

Target PDF/A or PDF/UA level; may restrict features to satisfy conformance.

Declaration

cs-api-definition
public PdfComplianceLevel ComplianceLevel { get; set; }

Property Value

PdfComplianceLevel

The compliance level.

EncryptionType

Encryption algorithm applied when IsEncrypted is true.

Declaration

cs-api-definition
public EncryptionType EncryptionType { get; set; }

Property Value

EncryptionType

FontEmbeddingType

Font embedding strategy used for export, affecting portability and file size.

Declaration

cs-api-definition
public FontEmbeddingType FontEmbeddingType { get; set; }

Property Value

FontEmbeddingType

ImageCompression

Image encoding filter(s) to use; only a single value is supported by the current implementation.

Declaration

cs-api-definition
public ImageFilterTypes[] ImageCompression { get; set; }

Property Value

ImageFilterTypes[]

ImageQuality

Default image quality used when re-encoding images; higher values increase fidelity and file size. Overridden by per-image settings.

Declaration

cs-api-definition
public ImageQuality ImageQuality { get; set; }

Property Value

ImageQuality

The image quality.

IsEncrypted

Enable encryption for the exported PDF using the selected EncryptionType.

Declaration

cs-api-definition
public bool IsEncrypted { get; set; }

Property Value

bool

True if the document should be encrypted; otherwise, false.

OwnerPassword

Gets or sets the owner password.

Declaration

cs-api-definition
public string OwnerPassword { get; set; }

Property Value

string

The owner password.

ShouldExportXfa

Include XFA content in the exported PDF when present.

Declaration

cs-api-definition
public bool ShouldExportXfa { get; set; }

Property Value

bool

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

cs-api-definition
public StreamFilterTypes[] StreamCompression { get; set; }

Property Value

StreamFilterTypes[]

StripJavaScriptActions

Remove JavaScript actions during export to improve security or meet compliance requirements.

Declaration

cs-api-definition
public bool StripJavaScriptActions { get; set; }

Property Value

bool

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

cs-api-definition
public bool StripStructureTree { get; set; }

Property Value

bool

True if the document should strip the structure tree; otherwise, false.

TaggingStrategy

Tagging strategy used to produce an accessible StructureTree.

Declaration

cs-api-definition
public TaggingStrategyType TaggingStrategy { get; set; }

Property Value

TaggingStrategyType

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

cs-api-definition
public UserAccessPermissions UserAccessPermissions { get; set; }

Property Value

UserAccessPermissions

The user access permissions.

UserPassword

Gets or sets the user password.

Declaration

cs-api-definition
public string UserPassword { get; set; }

Property Value

string

The user password.

Methods

CanRaiseEvent()

Determines whether the object can raise an exception event.

Declaration

cs-api-definition
public bool CanRaiseEvent()

Returns

bool

True if the object can raise an exception event; otherwise, false.

RaiseEvent(DocumentUnhandledExceptionEventArgs)

Declaration

cs-api-definition
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

cs-api-definition
public event EventHandler<DocumentUnhandledExceptionEventArgs> DocumentUnhandledException

Event Value

EventHandler<DocumentUnhandledExceptionEventArgs>