ClassRadFixedDocument
Root fixed document aggregating pages, annotations, form fields, actions, bookmarks, structure tree, and metadata, with merge and clone operations.
Definition
Namespace:Telerik.Windows.Documents.Fixed.Model
Assembly:Telerik.Windows.Documents.Fixed.dll
Syntax:
public class RadFixedDocument : FixedDocumentElementBase, IFixedDocument, IDestinationContainer, IFixedDocumentElementInheritance: objectFixedDocumentElementBaseRadFixedDocument
Implements:
Inherited Members
Constructors
RadFixedDocument(bool)
Create an empty document with initialized collections and optional automatic tagging.
Properties
AcroForm
Interactive form (AcroForm) container managing form fields and widgets.
Actions
Document-level actions executed on open, close, save, or print events.
Declaration
public DocumentActionCollection Actions { get; }Property Value
Annotations
Enumerates all annotations across every page (lazy per page load).
Declaration
public IEnumerable<Annotation> Annotations { get; }Property Value
IEnumerable<Annotation>
An enumerable collection of all annotations across all document pages.
AutoTag
Indicates whether new content is auto-tagged for accessibility.
Bookmarks
Hierarchical outline (bookmarks) tree for structured navigation.
Declaration
public BookmarksCollection Bookmarks { get; }Property Value
DocumentInfo
Document metadata (info dictionary) including title, author, creation date, etc.
Declaration
public RadFixedDocumentInfo DocumentInfo { get; }Property Value
The document information object containing metadata properties.
EmbeddedFiles
Embedded file attachments collection.
Declaration
public EmbeddedFilesCollection EmbeddedFiles { get; }Property Value
The collection of embedded file attachments.
HasLayers
Indicates presence of optional content groups (layers).
Language
BCP 47 language tag applied to document content.
NamedDestinations
Named destination targets enabling internal navigation by name.
Declaration
public NamedDestinationsCollection NamedDestinations { get; }Property Value
The collection of named destinations for document navigation.
PageMode
Initial viewer page display mode (e.g., outline, thumbnails) when opened.
Pages
Ordered page collection forming the document body.
Declaration
public PageCollection Pages { get; }Property Value
The collection containing all pages in the document.
StructureTree
Logical structure tree root describing tagged PDF semantics.
Declaration
public StructureTree StructureTree { get; set; }Property Value
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
The viewer preferences.
Methods
Clone()
Deep clone the document (pages, form fields, annotations, destinations, files, scripts, bookmarks) into a new instance.
Declaration
public RadFixedDocument Clone()Returns
The cloned RadFixedDocument instance.
Merge(RadFixedDocument)
Merge pages, form fields, destinations, actions, scripts, files, and bookmarks from another document.
Declaration
public void Merge(RadFixedDocument source)Parameters
source
The source document.
ToSimpleTextDocument()
Export a plain text representation of the entire document.
Declaration
[Obsolete("This method is obsolete. Please use ToSimpleTextDocument(TimeSpan? timeout) instead.")]
public SimpleTextDocument ToSimpleTextDocument()Returns
An instance of SimpleTextDocument representing the plain text version of the document.
ToSimpleTextDocument(TimeSpan?)
Converts the current document to a plain text document.
Declaration
public SimpleTextDocument ToSimpleTextDocument(TimeSpan? timeout)Parameters
timeout
The timeout after which the operation will be cancelled.
Returns
An instance of SimpleTextDocument representing the plain text version of the document.
ToSimpleTextDocument(int, int)
Export a plain text representation limited to the specified page range.
Declaration
[Obsolete("This method is obsolete. Please use ToSimpleTextDocument(int startPage, int endPage, TimeSpan? timeout) instead.")]
public SimpleTextDocument ToSimpleTextDocument(int startPage, int endPage)Parameters
startPage
endPage
Returns
An instance of SimpleTextDocument representing the plain text version of the document.
ToSimpleTextDocument(int, int, TimeSpan?)
Converts the current document to a plain text document.
Declaration
public SimpleTextDocument ToSimpleTextDocument(int startPage, int endPage, TimeSpan? timeout)Parameters
startPage
The starting page index (inclusive) from which to extract text.
endPage
The ending page index (inclusive) up to which to extract text.
timeout
The timeout after which the operation will be cancelled.
Returns
An instance of SimpleTextDocument 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> DocumentUnhandledExceptionEvent Value
MergedEmbeddedFileNameResolving
Raised to resolve duplicate embedded file names during merge.
Declaration
public event EventHandler<DuplicatedEmbeddedFileNameResolvingEventArgs> MergedEmbeddedFileNameResolvingEvent Value
MergedFieldNameResolving
Raised to resolve duplicate form field names during merge; handler can supply a unique name.
Declaration
public event EventHandler<MergedFormFieldNameResolvingEventArgs> MergedFieldNameResolvingEvent Value
MergedJavaScriptNameResolving
Raised to resolve duplicate JavaScript action names during merge.
Declaration
public event EventHandler<DuplicatedJavaScriptNameResolvingEventArgs> MergedJavaScriptNameResolvingEvent Value