Class RadFixedDocument

Represents a fixed document that contains a collection of pages and provides document-level functionality such as merging, annotations, and metadata management.

Inheritance

System.Object

FixedDocumentElementBase

RadFixedDocument

Inherited Members

FixedDocumentElementBase.Parent

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Fixed.Model

Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public class RadFixedDocument : FixedDocumentElementBase, IFixedDocument, IDestinationContainer, IFixedDocumentElement, IOnExceptionEventRaiser

Constructors

RadFixedDocument(Boolean)

Initializes a new instance of the RadFixedDocument class.

Declaration

public RadFixedDocument(bool autoTag = false)

Parameters

System.Boolean autoTag

Properties

AcroForm

Gets the interactive form (AcroForm) that manages form fields elements within the document.

Declaration

public AcroForm AcroForm { get; }

Property Value

AcroForm

Actions

Gets the collection of document-level actions that are triggered by events such as opening or closing the document.

Declaration

public DocumentActionCollection Actions { get; }

Property Value

DocumentActionCollection

Annotations

Gets all annotations from all pages in the document as a flat enumerable collection.

Declaration

public IEnumerable<Annotation> Annotations { get; }

Property Value

System.Collections.Generic.IEnumerable<Annotation> An enumerable collection of all annotations across all document pages.

AutoTag

Gets a value indicating whether the document is set to automatically tag elements.

Declaration

public bool AutoTag { get; }

Property Value

System.Boolean

Bookmarks

Gets the hierarchical collection of bookmarks (outline items) that provide structured navigation through the document.

Declaration

public BookmarksCollection Bookmarks { get; }

Property Value

BookmarksCollection

CaretPosition

Gets the caret position in the document. This property only works with RadPdfViewer.

Declaration

public TextPosition CaretPosition { get; }

Property Value

TextPosition The caret position.

DocumentInfo

Gets the document metadata and properties such as title, author, creation date, and other document information.

Declaration

public RadFixedDocumentInfo DocumentInfo { get; }

Property Value

RadFixedDocumentInfo The document information object containing metadata properties.

EmbeddedFiles

Gets the collection of files embedded within this document as attachments.

Declaration

public EmbeddedFilesCollection EmbeddedFiles { get; }

Property Value

EmbeddedFilesCollection The collection of embedded file attachments.

HasLayers

Gets whether the document has layers.

Declaration

public bool HasLayers { get; }

Property Value

System.Boolean

Language

Gets or sets the language of the document.

Declaration

public string Language { get; set; }

Property Value

System.String

NamedDestinations

Gets the collection of named destinations that provide bookmark-like navigation points within the document.

Declaration

public NamedDestinationsCollection NamedDestinations { get; }

Property Value

NamedDestinationsCollection The collection of named destinations for document navigation.

PageMode

Gets or sets the page display mode that determines how the document appears when first opened in a PDF viewer.

Declaration

public PageMode PageMode { get; set; }

Property Value

PageMode

Pages

Gets the collection of pages that comprise this document.

Declaration

public PageCollection Pages { get; }

Property Value

PageCollection The collection containing all pages in the document.

Selection

Gets the selection of the document.

Declaration

public TextSelection Selection { get; }

Property Value

TextSelection The selection.

StructureTree

Gets or sets the structure tree of the document.

Declaration

public StructureTree StructureTree { get; set; }

Property Value

StructureTree

ViewerPreferences

Gets the viewer preferences controlling the way the document is to be presented on the screen or in print. If no such dictionary is specified, viewing and printing applications should behave in accordance with their own current user preference settings.

Declaration

public ViewerPreferences ViewerPreferences { get; }

Property Value

ViewerPreferences The viewer preferences.

Methods

Clone()

Clones the document content.

Declaration

public RadFixedDocument Clone()

Returns

RadFixedDocument The cloned RadFixedDocument instance.

Merge(RadFixedDocument)

Merges this document with the specified source document.

Declaration

public void Merge(RadFixedDocument source)

Parameters

RadFixedDocument source The source document.

ToSimpleTextDocument()

Converts the current document to a plain text document.

Declaration

public ISimpleTextDocument ToSimpleTextDocument()

Returns

ISimpleTextDocument An instance of ISimpleTextDocument representing the plain text version of the document.

ToSimpleTextDocument(Int32, Int32)

Converts the current document to a plain text document.

Declaration

public ISimpleTextDocument ToSimpleTextDocument(int startPage, int endPage)

Parameters

System.Int32 startPage

System.Int32 endPage

Returns

ISimpleTextDocument An instance of ISimpleTextDocument representing the plain text version of the document.

Events

DocumentUnhandledException

Occurs when an unhandled exception is thrown while loading the document properties, e.g. page content and annotations. This event applies when the document is imported with the PdfFormatProvider class using the ReadingMode.OnDemand import setting.

Declaration

public event EventHandler<DocumentUnhandledExceptionEventArgs> DocumentUnhandledException

Event Type

System.EventHandler<DocumentUnhandledExceptionEventArgs>

MergedEmbeddedFileNameResolving

Occurs when trying to resolve conflicts between the embedded file names while merging RadFixedDocument instances.

Declaration

public event EventHandler<DuplicatedEmbeddedFileNameResolvingEventArgs> MergedEmbeddedFileNameResolving

Event Type

System.EventHandler<DuplicatedEmbeddedFileNameResolvingEventArgs>

MergedFieldNameResolving

Occurs when trying to resolve conflicts between the fields names while merging RadFixedDocument instances.

Declaration

public event EventHandler<MergedFormFieldNameResolvingEventArgs> MergedFieldNameResolving

Event Type

System.EventHandler<MergedFormFieldNameResolvingEventArgs>

MergedJavaScriptNameResolving

Occurs when trying to resolve conflicts between the embedded file names while merging RadFixedDocument instances.

Declaration

public event EventHandler<DuplicatedJavaScriptNameResolvingEventArgs> MergedJavaScriptNameResolving

Event Type

System.EventHandler<DuplicatedJavaScriptNameResolvingEventArgs>