Class RadFixedDocument

Root fixed document aggregating pages, annotations, form fields, actions, bookmarks, structure tree, and metadata, with merge and clone operations.

Inheritance
System.Object
FixedDocumentElementBase
RadFixedDocument
Inherited Members
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)

Create an empty document with initialized collections and optional automatic tagging.

Declaration
public RadFixedDocument(bool autoTag = false)
Parameters
System.Boolean autoTag

Properties

AcroForm

Interactive form (AcroForm) container managing form fields and widgets.

Declaration
public AcroForm AcroForm { get; }
Property Value
AcroForm

Actions

Document-level actions executed on open, close, save, or print events.

Declaration
public DocumentActionCollection Actions { get; }
Property Value
DocumentActionCollection

Annotations

Enumerates all annotations across every page (lazy per page load).

Declaration
public IEnumerable<Annotation> Annotations { get; }
Property Value
System.Collections.Generic.IEnumerable<Annotation>

An enumerable collection of all annotations across all document pages.

AutoTag

Indicates whether new content is auto-tagged for accessibility.

Declaration
public bool AutoTag { get; }
Property Value
System.Boolean

Bookmarks

Hierarchical outline (bookmarks) tree for structured navigation.

Declaration
public BookmarksCollection Bookmarks { get; }
Property Value
BookmarksCollection

CaretPosition

Legacy caret position (RadPdfViewer only).

Declaration
public TextPosition CaretPosition { get; }
Property Value
TextPosition

The caret position.

DocumentInfo

Document metadata (info dictionary) including title, author, creation date, etc.

Declaration
public RadFixedDocumentInfo DocumentInfo { get; }
Property Value
RadFixedDocumentInfo

The document information object containing metadata properties.

EmbeddedFiles

Embedded file attachments collection.

Declaration
public EmbeddedFilesCollection EmbeddedFiles { get; }
Property Value
EmbeddedFilesCollection

The collection of embedded file attachments.

HasLayers

Indicates presence of optional content groups (layers).

Declaration
public bool HasLayers { get; }
Property Value
System.Boolean

Language

BCP 47 language tag applied to document content.

Declaration
public string Language { get; set; }
Property Value
System.String

NamedDestinations

Named destination targets enabling internal navigation by name.

Declaration
public NamedDestinationsCollection NamedDestinations { get; }
Property Value
NamedDestinationsCollection

The collection of named destinations for document navigation.

PageMode

Initial viewer page display mode (e.g., outline, thumbnails) when opened.

Declaration
public PageMode PageMode { get; set; }
Property Value
PageMode

Pages

Ordered page collection forming the document body.

Declaration
public PageCollection Pages { get; }
Property Value
PageCollection

The collection containing all pages in the document.

Selection

Legacy text selection accessor (RadPdfViewer only).

Declaration
public TextSelection Selection { get; }
Property Value
TextSelection

The selection.

StructureTree

Logical structure tree root describing tagged PDF semantics.

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()

Deep clone the document (pages, form fields, annotations, destinations, files, scripts, bookmarks) into a new instance.

Declaration
public RadFixedDocument Clone()
Returns
RadFixedDocument

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
RadFixedDocument 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
SimpleTextDocument

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

ToSimpleTextDocument(Int32, Int32)

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
System.Int32 startPage

System.Int32 endPage

Returns
SimpleTextDocument

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

ToSimpleTextDocument(Int32, Int32, Nullable<TimeSpan>)

Converts the current document to a plain text document.

Declaration
public SimpleTextDocument ToSimpleTextDocument(int startPage, int endPage, TimeSpan? timeout)
Parameters
System.Int32 startPage

The starting page index (inclusive) from which to extract text.
System.Int32 endPage

The ending page index (inclusive) up to which to extract text.
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.
Returns
SimpleTextDocument

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

ToSimpleTextDocument(Nullable<TimeSpan>)

Converts the current document to a plain text document.

Declaration
public SimpleTextDocument ToSimpleTextDocument(TimeSpan? timeout)
Parameters
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.
Returns
SimpleTextDocument

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> DocumentUnhandledException
Event Type
System.EventHandler<DocumentUnhandledExceptionEventArgs>

MergedEmbeddedFileNameResolving

Raised to resolve duplicate embedded file names during merge.

Declaration
public event EventHandler<DuplicatedEmbeddedFileNameResolvingEventArgs> MergedEmbeddedFileNameResolving
Event Type
System.EventHandler<DuplicatedEmbeddedFileNameResolvingEventArgs>

MergedFieldNameResolving

Raised to resolve duplicate form field names during merge; handler can supply a unique name.

Declaration
public event EventHandler<MergedFormFieldNameResolvingEventArgs> MergedFieldNameResolving
Event Type
System.EventHandler<MergedFormFieldNameResolvingEventArgs>

MergedJavaScriptNameResolving

Raised to resolve duplicate JavaScript action names during merge.

Declaration
public event EventHandler<DuplicatedJavaScriptNameResolvingEventArgs> MergedJavaScriptNameResolving
Event Type
System.EventHandler<DuplicatedJavaScriptNameResolvingEventArgs>