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:
public sealed class RadFlowDocument : DocumentElementBase, IElementWithPropertiesInheritance: objectDocumentElementBaseRadFlowDocument
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadFlowDocument class.
public RadFlowDocument()Fields
Defines the default spacing between automatic tab stops when no custom tab stops are defined, measured in device-independent pixels.
public static readonly StylePropertyDefinition<double?> DefaultTabStopWidthPropertyDefinitionDefines whether documents use separate headers and footers for even and odd pages in facing-page layouts.
public static readonly StylePropertyDefinition<bool?> HasDifferentEvenOddPageHeadersFootersPropertyDefinitionDefines the preferred view mode for displaying documents (e.g., print layout, web layout, outline).
public static readonly StylePropertyDefinition<DocumentViewType?> ViewTypePropertyDefinitionMethods
Creates a deep copy of the entire document including all sections, styles, lists, and content with independent instances of all elements.
Executes mail merge using the specified collection of data records and returns a new document with MERGEFIELD fields replaced by actual values.
public RadFlowDocument MailMerge(IEnumerable collection)The collection of records.
Returns:The merged document.
Appends all sections, styles, lists, and content from the source document into this document with specified conflict resolution options.
public void Merge(RadFlowDocument sourceDocument, MergeOptions mergeOptions)The source document.
mergeOptionsMergeOptionsThe merge options.
Appends all sections, styles, lists, and content from the source document into this document using default merge options.
public void Merge(RadFlowDocument sourceDocument)The source document.
Converts the document to plain text format and returns a simple text representation with optional timeout constraint.
public SimpleTextDocument ToSimpleTextDocument(TimeSpan? timeout)The maximum time allowed for the export operation. If null, the operation will not be time-limited.
Returns:An instance of SimpleTextDocument representing the plain text version of the document.
Recalculates and updates the result text for all fields in the document, including page numbers, dates, references, and conditional fields.
public void UpdateFields()Properties
Gets the collection of comments (annotations with author and date) attached to document content ranges.
public CommentCollection Comments { get; }The comments.
Gets the document-wide default character and paragraph formatting applied as the baseline for all content.
public DocumentDefaultStyle DefaultStyle { get; }The default style.
Gets or sets the default spacing between automatic tab stops when no custom tab stops are defined, measured in device-independent pixels.
public double DefaultTabStopWidth { get; set; }The default width of the tab stop.
Gets the root document for this element, which returns itself since this is the document root.
public override RadFlowDocument Document { get; }The document.
Overrides:
Gets or sets the document metadata including title, author, subject, keywords, and other file properties.
public DocumentInfo DocumentInfo { get; set; }The metadata.
Gets the collection of document variables that store custom name-value pairs for field references and document-specific data.
public DocumentVariableCollection DocumentVariables { get; }The document variables.
Gets or sets whether the document uses separate headers and footers for even and odd pages to support facing-page layouts.
public bool HasDifferentEvenOddPageHeadersFooters { get; set; }true if pages in this document will have different headers and footers for even and odd pages; otherwise, false.
Gets the collection of list definitions that provide numbering and bullet formatting for list items.
public ListCollection Lists { get; }The lists.
Gets the document-level properties container providing access to view settings, tab stops, and header/footer configuration.
public DocumentProperties Properties { get; }The properties.
Gets the document protection configuration that controls editing restrictions and password-based security.
public ProtectionSettings ProtectionSettings { get; }The protection settings.
Gets the collection of sections that define page layout settings and contain the document's block-level content.
public SectionCollection Sections { get; }The sections.
Gets the central registry of paragraph, character, table, and numbering styles available in the document.
public StyleRepository StyleRepository { get; }The style repository.
Gets or sets the document theme that defines color schemes, font schemes, and formatting effects for theme-aware styling.
public DocumentTheme Theme { get; set; }The theme.
Gets or sets the preferred view mode for displaying the document (e.g., print layout, web layout, outline).
public DocumentViewType ViewType { get; set; }The type of the view.