Class
PdfImportSettings

Settings for importing PDF documents, controlling reading mode, stream copying, and event hooks used during the import process.

Definition

Namespace:Telerik.Windows.Documents.Fixed.FormatProviders.Pdf.Import

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
[TypeConverter(typeof(PdfImportSettingsTypeConverter))]
public class PdfImportSettings

Inheritance: objectPdfImportSettings

Constructors

PdfImportSettings()

Creates import settings with ReadingMode set to AllAtOnce and CopyStream set to false.

Declaration

cs-api-definition
public PdfImportSettings()

Properties

CopyStream

Controls whether the document stream is copied during import. When false and ReadingMode is OnDemand, the original stream must be kept open while the document is in use. When true, the original stream can be disposed after import, regardless of the reading mode.

Declaration

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

Property Value

bool

IgnoreMarkedContent

Instructs the importer to ignore marked content containers (if any) and import only their contained content.

Declaration

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

Property Value

bool

True if the document should ignore marked content on import; otherwise, false.

ReadAllAtOnce

        Default settings for loading all page content on import: 
csharp
{ ReadingMode = AllAtOnce, CopyStream = false }

Declaration

cs-api-definition
public static PdfImportSettings ReadAllAtOnce { get; }

Property Value

PdfImportSettings

ReadOnDemand

        Default settings for deferred, on-demand page loading: 
csharp
{ ReadingMode = OnDemand, CopyStream = true }

Declaration

cs-api-definition
public static PdfImportSettings ReadOnDemand { get; }

Property Value

PdfImportSettings

ReadingMode

Controls how page content is loaded during import. If AllAtOnce applied, the document pages content will be loaded on import. If OnDemand applied, the document pages content will be loaded on demand.

Currently, the OnDemand setting should be applied for use with viewers only.

Declaration

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

Property Value

ReadingMode

Events

DocumentUnhandledException

Raised when an unhandled exception occurs during document import; provides error details for logging or recovery.

Declaration

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

Event Value

EventHandler<DocumentUnhandledExceptionEventArgs>

DuplicatedEmbeddedFileNameResolving

Raised when embedded files share the same name; provides a way to resolve to a unique file name.

Declaration

cs-api-definition
public event EventHandler<DuplicatedEmbeddedFileNameResolvingEventArgs> DuplicatedEmbeddedFileNameResolving

Event Value

EventHandler<DuplicatedEmbeddedFileNameResolvingEventArgs>

OwnerPasswordNeeded

Raised when an owner password is required to access restricted operations; provides the password to continue import.

Declaration

cs-api-definition
public event EventHandler<PasswordNeededEventArgs> OwnerPasswordNeeded

Event Value

EventHandler<PasswordNeededEventArgs>

UserPasswordNeeded

Raised when a user password is required to open the document; provides the password to continue import.

Declaration

cs-api-definition
public event EventHandler<PasswordNeededEventArgs> UserPasswordNeeded

Event Value

EventHandler<PasswordNeededEventArgs>