Class
RadFlowDocument

Root container for flow document content, managing sections, styles, lists, comments, resources, and document-wide settings for word processing documents.

Definition

Namespace:Telerik.Windows.Documents.Flow.Model

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public sealed class RadFlowDocument : DocumentElementBase, IElementWithProperties

Inheritance: objectDocumentElementBaseRadFlowDocument

Implements: IElementWithProperties

Inherited Members DocumentElementBase.EnumerateChildrenOfType<T>()DocumentElementBase.Parent

Constructors

RadFlowDocument()

Initializes a new instance of the RadFlowDocument class.

Declaration

cs-api-definition
public RadFlowDocument()

Fields

DefaultTabStopWidthPropertyDefinition

Defines the default spacing between automatic tab stops when no custom tab stops are defined, measured in device-independent pixels.

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<double?> DefaultTabStopWidthPropertyDefinition

Field Value

StylePropertyDefinition<double?>

HasDifferentEvenOddPageHeadersFootersPropertyDefinition

Defines whether documents use separate headers and footers for even and odd pages in facing-page layouts.

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<bool?> HasDifferentEvenOddPageHeadersFootersPropertyDefinition

Field Value

StylePropertyDefinition<bool?>

ViewTypePropertyDefinition

Defines the preferred view mode for displaying documents (e.g., print layout, web layout, outline).

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<DocumentViewType?> ViewTypePropertyDefinition

Field Value

StylePropertyDefinition<DocumentViewType?>

Properties

Comments

Gets the collection of comments (annotations with author and date) attached to document content ranges.

Declaration

cs-api-definition
public CommentCollection Comments { get; }

Property Value

CommentCollection

The comments.

DefaultStyle

Gets the document-wide default character and paragraph formatting applied as the baseline for all content.

Declaration

cs-api-definition
public DocumentDefaultStyle DefaultStyle { get; }

Property Value

DocumentDefaultStyle

The default style.

DefaultTabStopWidth

Gets or sets the default spacing between automatic tab stops when no custom tab stops are defined, measured in device-independent pixels.

Declaration

cs-api-definition
public double DefaultTabStopWidth { get; set; }

Property Value

double

The default width of the tab stop.

Document

Gets the root document for this element, which returns itself since this is the document root.

Declaration

cs-api-definition
public override RadFlowDocument Document { get; }

Property Value

RadFlowDocument

The document.

Overrides DocumentElementBase.Document

DocumentInfo

Gets or sets the document metadata including title, author, subject, keywords, and other file properties.

Declaration

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

Property Value

DocumentInfo

The metadata.

DocumentVariables

Gets the collection of document variables that store custom name-value pairs for field references and document-specific data.

Declaration

cs-api-definition
public DocumentVariableCollection DocumentVariables { get; }

Property Value

DocumentVariableCollection

The document variables.

HasDifferentEvenOddPageHeadersFooters

Gets or sets whether the document uses separate headers and footers for even and odd pages to support facing-page layouts.

Declaration

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

Property Value

bool

true if pages in this document will have different headers and footers for even and odd pages; otherwise, false.

Lists

Gets the collection of list definitions that provide numbering and bullet formatting for list items.

Declaration

cs-api-definition
public ListCollection Lists { get; }

Property Value

ListCollection

The lists.

Properties

Gets the document-level properties container providing access to view settings, tab stops, and header/footer configuration.

Declaration

cs-api-definition
public DocumentProperties Properties { get; }

Property Value

DocumentProperties

The properties.

ProtectionSettings

Gets the document protection configuration that controls editing restrictions and password-based security.

Declaration

cs-api-definition
public ProtectionSettings ProtectionSettings { get; }

Property Value

ProtectionSettings

The protection settings.

Sections

Gets the collection of sections that define page layout settings and contain the document's block-level content.

Declaration

cs-api-definition
public SectionCollection Sections { get; }

Property Value

SectionCollection

The sections.

StyleRepository

Gets the central registry of paragraph, character, table, and numbering styles available in the document.

Declaration

cs-api-definition
public StyleRepository StyleRepository { get; }

Property Value

StyleRepository

The style repository.

Theme

Gets or sets the document theme that defines color schemes, font schemes, and formatting effects for theme-aware styling.

Declaration

cs-api-definition
public DocumentTheme Theme { get; set; }

Property Value

DocumentTheme

The theme.

ViewType

Gets or sets the preferred view mode for displaying the document (e.g., print layout, web layout, outline).

Declaration

cs-api-definition
public DocumentViewType ViewType { get; set; }

Property Value

DocumentViewType

The type of the view.

Methods

Clone()

Creates a deep copy of the entire document including all sections, styles, lists, and content with independent instances of all elements.

Declaration

cs-api-definition
public RadFlowDocument Clone()

Returns

RadFlowDocument

The cloned document.

MailMerge(IEnumerable)

Executes mail merge using the specified collection of data records and returns a new document with MERGEFIELD fields replaced by actual values.

Declaration

cs-api-definition
public RadFlowDocument MailMerge(IEnumerable collection)

Parameters

collection

IEnumerable

The collection of records.

Returns

RadFlowDocument

The merged document.

Merge(RadFlowDocument)

Appends all sections, styles, lists, and content from the source document into this document using default merge options.

Declaration

cs-api-definition
public void Merge(RadFlowDocument sourceDocument)

Parameters

sourceDocument

RadFlowDocument

The source document.

Merge(RadFlowDocument, MergeOptions)

Appends all sections, styles, lists, and content from the source document into this document with specified conflict resolution options.

Declaration

cs-api-definition
public void Merge(RadFlowDocument sourceDocument, MergeOptions mergeOptions)

Parameters

sourceDocument

RadFlowDocument

The source document.

mergeOptions

MergeOptions

The merge options.

ToSimpleTextDocument(TimeSpan?)

Converts the document to plain text format and returns a simple text representation with optional timeout constraint.

Declaration

cs-api-definition
public SimpleTextDocument ToSimpleTextDocument(TimeSpan? timeout)

Parameters

timeout

TimeSpan?

The maximum time allowed for the export operation. If null, the operation will not be time-limited.

Returns

SimpleTextDocument

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

UpdateFields()

Recalculates and updates the result text for all fields in the document, including page numbers, dates, references, and conditional fields.

Declaration

cs-api-definition
public void UpdateFields()