RadFixedDocument
RadFixedDocument is a core class in the Telerik Document Processing libraries, specifically within the PdfProcessing model.
What Is RadFixedDocument
RadFixedDocument is the main document unit of the PdfProcessing model. It represents the root element of a fixed-layout PDF document and serves as the container for all other document elements. RadFixedDocument holds a collection of RadFixedPage elements. It exposes the following public API:
| Property Name | Description |
|---|---|
Pages | The pages collection that contains all RadFixedPage instances in the document. |
Annotations | A read-only collection that contains all Annotations in the document. |
Destinations | A collection that contains all Destinations in the document. |
DocumentInfo | Contains additional meta information about the document such as author and title. |
Actions | Gets the document actions collection. (Introduced in Q4 2024) |
NamedDestinations | Gets the collection of named destinations that provide bookmark-like navigation points within the document. |
EmbeddedFiles | Gets the collection of files embedded within this document as attachments. |
AcroForm | Gets the interactive form (AcroForm) that manages form field elements within the document. |
Bookmarks | Gets the hierarchical collection of bookmarks (outline items) that provide structured navigation through the document. |
PageMode | Gets or sets the page display mode that determines how the document appears when first opened in a PDF viewer. |
HasLayers | Gets whether the document has layers. (Introduced in Q4 2024) |
Language | Gets or sets the language of the document. (Introduced in Q3 2025) |
StructureTree | Gets or sets the structure tree of the document. (Introduced in Q3 2025) |
AutoTag | Gets a value indicating whether the document is set to automatically tag elements. If true, the document automatically tags elements with structure tags when they are added. (Introduced in Q3 2025) |
ViewerPreferences | Gets the viewer preferences controlling the way the document is presented on the screen or in print. If no such dictionary is specified, viewing and printing applications behave in accordance with their own current user preference settings. (Introduced in Q3 2025) |
Portfolio | Gets the PDF Portfolio/Collection settings for enhanced presentation of embedded files. Set IsEnabled to true to enable portfolio mode. (Introduced in Q1 2026) |
| Method | Description |
|---|---|
Merge | Merge pages, form fields, destinations, actions, scripts, files, and bookmarks from the specified source document. |
Clone | Deep clone the document (pages, form fields, annotations, destinations, files, scripts, and bookmarks) into a new instance. |
Clone(int startPageIndex, int pageCount) | Creates a new RadFixedDocument containing deep copies of the pages in the specified range. Form fields with widgets on included pages, named destinations pointing to included pages, embedded files, JavaScript actions, and bookmarks are also cloned into the new document. |
ToSimpleTextDocument | Converts the current document to a plain text document. |
| Event | Description |
|---|---|
MergedFieldNameResolving | Occurs when trying to resolve conflicts between the field names while merging RadFixedDocument instances. |
MergedEmbeddedFileNameResolving | Occurs when trying to resolve conflicts between the embedded file names while merging RadFixedDocument instances. |
MergedJavaScriptNameResolving | Occurs when trying to resolve conflicts between the JavaScript names while merging RadFixedDocument instances. |
RadFixedDocument is typically used when:
- Creating a PDF document from scratch programmatically. A complete example is available in the PdfProcessing Basic Usage demo.
- Extracting or manipulating content from existing PDF documents. First import any existing PDF documents with the help of the PdfFormatProvider.
- Generating structured, fixed-layout documents with precise control over layout and formatting. FixedContentEditor and RadFixedDocumentEditor allow you to create a
RadFixedDocumenteither by managing the position or in a flow-like manner and insert all desired elements one after another.
A complete SDK example on how to generate a document is available in the GenerateDocument sample.
Example 1 shows how to create a new RadFixedDocument instance.
Example 1: Create RadFixedDocument
RadFixedDocument document = new RadFixedDocument();Operating with RadFixedDocument
You can execute different actions with the help of RadFixedDocument. For example, you can add a RadFixedPage to an existing document.
Example 2 adds a page to the document created in Example 1.
Example 2: Add Page to RadFixedDocument
RadFixedPage page = document.Pages.AddPage();Alternatively, you can create a new RadFixedPage and add it to the Pages collection of a document.
Example 3 creates a page and adds it to the document created in Example 1.
Example 3: Create and Add a Page to RadFixedDocument
RadFixedPage newPage = new RadFixedPage();
document.Pages.Add(newPage);Example 4 shows how to obtain a copy of a RadFixedDocument.
Example 4: Clone a Document
RadFixedDocument clonedDocument = document.Clone();You can merge PDF documents with the Merge() method of RadFixedDocument. This method clones the source document and appends it to the current instance of RadFixedDocument.
Example 5: Merge Documents
document.Merge(clonedDocument);The code from Example 5 merges the document created in Example 1 with another RadFixedDocument.
Document Information
RadFixedDocument exposes a DocumentInfo property of type RadFixedDocumentInfo, intended to hold additional information about the document.