Class RadFlowDocument

Hosts flow document content.

Inheritance

System.Object

DocumentElementBase

RadFlowDocument

Inherited Members

DocumentElementBase.EnumerateChildrenOfType<T>()

DocumentElementBase.OnChildAdded(DocumentElementBase)

DocumentElementBase.OnChildRemoved(DocumentElementBase)

DocumentElementBase.Parent

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.Flow.Model

Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public sealed class RadFlowDocument : DocumentElementBase, IElementWithProperties, IChildrenList

Constructors

RadFlowDocument()

Initializes a new instance of the RadFlowDocument class.

Declaration

public RadFlowDocument()

Fields

DefaultTabStopWidthPropertyDefinition

Holds the property definition for the DefaultTabStopWidth property.

Declaration

public static readonly StylePropertyDefinition<double? > DefaultTabStopWidthPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

HasDifferentEvenOddPageHeadersFootersPropertyDefinition

Holds the property definition for the HasDifferentEvenOddPageHeadersFooters property.

Declaration

public static readonly StylePropertyDefinition<bool? > HasDifferentEvenOddPageHeadersFootersPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

ViewTypePropertyDefinition

Holds the property definition for the ViewType property.

Declaration

public static readonly StylePropertyDefinition<DocumentViewType? > ViewTypePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<DocumentViewType>>

Properties

Comments

Gets the comments of the document.

Declaration

public CommentCollection Comments { get; }

Property Value

CommentCollection The comments.

DefaultStyle

Gets the default styling of the document.

Declaration

public DocumentDefaultStyle DefaultStyle { get; }

Property Value

DocumentDefaultStyle The default style.

DefaultTabStopWidth

Gets or sets the default width of the tab stop.

Declaration

public double DefaultTabStopWidth { get; set; }

Property Value

System.Double The default width of the tab stop.

Document

Gets the document to which this document element is associated.

Declaration

public override RadFlowDocument Document { get; }

Property Value

RadFlowDocument The document.

Overrides

DocumentElementBase.Document

DocumentInfo

Gets or sets metadata information for the document file.

Declaration

public DocumentInfo DocumentInfo { get; set; }

Property Value

DocumentInfo The metadata.

DocumentVariables

Gets the document variables.

Declaration

public DocumentVariableCollection DocumentVariables { get; }

Property Value

DocumentVariableCollection The document variables.

HasDifferentEvenOddPageHeadersFooters

Gets or sets a value indicating whether pages in this document will have different headers and footers for even and odd pages.

Declaration

public bool HasDifferentEvenOddPageHeadersFooters { get; set; }

Property Value

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

Lists

Gets the lists associated with this document.

Declaration

public ListCollection Lists { get; }

Property Value

ListCollection The lists.

Properties

Gets the styling properties of this document.

Declaration

public DocumentProperties Properties { get; }

Property Value

DocumentProperties The properties.

ProtectionSettings

Gets or sets the protection settings.

Declaration

public ProtectionSettings ProtectionSettings { get; }

Property Value

ProtectionSettings The protection settings.

Sections

Gets the sections of the flow document.

Declaration

public SectionCollection Sections { get; }

Property Value

SectionCollection The sections.

StyleRepository

Gets the style repository.

Declaration

public StyleRepository StyleRepository { get; }

Property Value

StyleRepository The style repository.

Theme

Gets or sets the theme.

Declaration

public DocumentTheme Theme { get; set; }

Property Value

DocumentTheme The theme.

ViewType

Gets or sets a value indicating the view type of the document.

Declaration

public DocumentViewType ViewType { get; set; }

Property Value

DocumentViewType The type of the view.

Methods

Clone()

Creates deep copy of this document.

Declaration

public RadFlowDocument Clone()

Returns

RadFlowDocument The cloned document.

MailMerge(IEnumerable)

Performs mail merge on the document with the specified collection of records.

Declaration

public RadFlowDocument MailMerge(IEnumerable collection)

Parameters

System.Collections.IEnumerable collection The collection of records.

Returns

RadFlowDocument The merged document.

Merge(RadFlowDocument)

Merges this document with the specified source document.

Declaration

public void Merge(RadFlowDocument sourceDocument)

Parameters

RadFlowDocument sourceDocument The source document.

Merge(RadFlowDocument, MergeOptions)

Merges this document with the specified source document.

Declaration

public void Merge(RadFlowDocument sourceDocument, MergeOptions mergeOptions)

Parameters

RadFlowDocument sourceDocument The source document.

MergeOptions mergeOptions The merge options.

UpdateFields()

Updates all supported fields in the document.

Declaration

public void UpdateFields()

Explicit Interface Implementations

IElementWithProperties.Properties

Gets the properties.

Declaration

DocumentElementPropertiesBase IElementWithProperties.Properties { get; }

Returns

DocumentElementPropertiesBase The properties.

Implements

IElementWithProperties.Properties