Class

RadDocument

Initializes a new instance of the RadDocument class.

Declaration

public RadDocument()

The default tab width style property.

Declaration

public static readonly StylePropertyDefinition<double?, DocumentProperties> DefaultTabWidthProperty

Field Value

The endnotes first number style property.

Declaration

public static readonly StylePropertyDefinition<int?, DocumentProperties> EndnotesFirstNumberProperty

Field Value

The endnotes numbering format style property.

Declaration

public static readonly StylePropertyDefinition<ListNumberingFormat?, DocumentProperties> EndnotesNumberingFormatProperty

Field Value

The endnotes numbering restart type style property.

Declaration

public static readonly StylePropertyDefinition<NumberingRestartType?, DocumentProperties> EndnotesNumberingRestartTypeProperty

Field Value

The endnotes position style property.

Declaration

public static readonly StylePropertyDefinition<EndnotesPosition?, DocumentProperties> EndnotesPositionProperty

Field Value

The footnotes first number style property.

Declaration

public static readonly StylePropertyDefinition<int?, DocumentProperties> FootnotesFirstNumberProperty

Field Value

The footnotes numbering format style property.

Declaration

public static readonly StylePropertyDefinition<ListNumberingFormat?, DocumentProperties> FootnotesNumberingFormatProperty

Field Value

The footnotes numbering restart type style property.

Declaration

public static readonly StylePropertyDefinition<NumberingRestartType?, DocumentProperties> FootnotesNumberingRestartTypeProperty

Field Value

The footnotes position style property.

Declaration

public static readonly StylePropertyDefinition<FootnotesPosition?, DocumentProperties> FootnotesPositionProperty

Field Value

Represent the maximum document size.

Declaration

public static readonly SizeF MAX_DOCUMENT_SIZE

Field Value

The section default page margin style property.

Declaration

public static readonly StylePropertyDefinition<Padding?, DocumentProperties> SectionDefaultPageMarginProperty

Field Value

The section default page orientation style property.

Declaration

public static readonly StylePropertyDefinition<PageOrientation?, DocumentProperties> SectionDefaultPageOrientationProperty

Field Value

The section default page size style property.

Declaration

public static readonly StylePropertyDefinition<Size?, DocumentProperties> SectionDefaultPageSizeProperty

Field Value

Gets or sets a collection of BibliographicSource objects.

Declaration

[XamlCompositePropertySerializable]
public NotifiableCollection<BibliographicSource> BibliographicSources { get; set; }

Property Value

Gets or sets a dictionary keeping the styles used for the bibliographic references inside the document.

Declaration

public Dictionary<string, BibliographicReferenceStyleBase> BibliographicStyles { get; set; }

Property Value

Gets the caption definitions inside the document.

Declaration

public Dictionary<string, CaptionDefinition> CaptionDefinitions { get; }

Property Value

Gets a DocumentPosition representing the current caret position.

Declaration

public DocumentPosition CaretPosition { get; }

Property Value

Gets or sets the formatter used for code blocks.

Declaration

public CodeFormatter CodeFormatter { get; set; }

Property Value

Gets or sets the default tab width.

Declaration

[XamlSerializable]
public double DefaultTabWidth { get; set; }

Property Value

Gets a value representing the desired layout size of the document.

Declaration

public SizeF DesiredSize { get; }

Property Value

Gets or sets a value determining how often to fire the DocumentContentChanged event.

Declaration

public TimeSpan DocumentContentChangedInterval { get; set; }

Property Value

Gets a value representing the layout box of the document.

Declaration

public DocumentLayoutBox DocumentLayoutBox { get; }

Property Value

Gets the document variables.

Declaration

public DocumentVariableCollection DocumentVariables { get; }

Property Value

Gets or sets the endnotes starting number.

Declaration

[XamlSerializable(1)]
public int EndnotesFirstNumber { get; set; }

Property Value

Gets or sets the endnotes numbering format.

Declaration

[XamlSerializable(ListNumberingFormat.LowerRoman)]
public ListNumberingFormat EndnotesNumberingFormat { get; set; }

Property Value

Gets or sets the type of the endnotes numbering restart.

Declaration

[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType EndnotesNumberingRestartType { get; set; }

Property Value

Gets or sets the endnotes position.

Declaration

[XamlSerializable(EndnotesPosition.DocumentEnd)]
public EndnotesPosition EndnotesPosition { get; set; }

Property Value

Gets or sets the display mode for the fields in this document.

Declaration

public FieldDisplayMode FieldsDisplayMode { get; set; }

Property Value

Gets or sets the footnotes starting number.

Declaration

[XamlSerializable(1)]
public int FootnotesFirstNumber { get; set; }

Property Value

Gets or sets the footnotes numbering format.

Declaration

[XamlSerializable(ListNumberingFormat.Decimal)]
public ListNumberingFormat FootnotesNumberingFormat { get; set; }

Property Value

Gets or sets the type of the footnotes numbering restart.

Declaration

[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType FootnotesNumberingRestartType { get; set; }

Property Value

Gets or sets the footnotes position.

Declaration

[XamlSerializable(FootnotesPosition.PageBottom)]
public FootnotesPosition FootnotesPosition { get; set; }

Property Value

Gets or sets a value indicating whether headers and footers are different in even and odd pages.

Declaration

[XamlSerializable(false)]
public bool HasDifferentEvenAndOddHeadersFooters { get; set; }

Property Value

Gets the history of changes in this document.

Declaration

public DocumentHistory History { get; }

Property Value

Gets a value indicating whether the document is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Gets or sets a value indicating whether the strict line breaking rule will be applied to Japanese text in this document.

Declaration

[XamlSerializable(false)]
public bool IsStrictLineBreakingRuleEnabled { get; set; }

Property Value

Gets or sets a value indicating whether this instance has track changes enabled.

Declaration

[XamlSerializable(false)]
public bool IsTrackChangesEnabled { get; set; }

Property Value

Gets or sets a value representing the current layout mode.

Declaration

[XamlSerializable]
public DocumentLayoutMode LayoutMode { get; set; }

Property Value

Gets or sets the language which rules should be used for line breaking in the paragraphs.

Declaration

public LineBreakingRuleLanguage LineBreakingRuleLanguage { get; set; }

Property Value

Gets or set the line spacing of this document.

Declaration

[XamlSerializable]
public double LineSpacing { get; set; }

Property Value

Gets or set the line spacing type of this document.

Declaration

[XamlSerializable]
public LineSpacingType LineSpacingType { get; set; }

Property Value

Gets the list manager.

Declaration

public ListManager ListManager { get; }

Property Value

Gets the data source used for mail merge operations with this document.

Declaration

public MailMergeDataSource MailMergeDataSource { get; }

Property Value

Gets or sets a rule determining which characters cannot end a line in East-Asian languages.

Declaration

[XamlCompositePropertySerializable]
public LineBreakingRule NoLineBreaksAfterRule { get; set; }

Property Value

Gets or sets a rule determining which characters cannot start a line in East-Asian languages.

Declaration

[XamlCompositePropertySerializable]
public LineBreakingRule NoLineBreaksBeforeRule { get; set; }

Property Value

Gets or sets the default spacing after a paragraph.

Declaration

[XamlSerializable]
public double ParagraphDefaultSpacingAfter { get; set; }

Property Value

Gets or sets the default spacing before a paragraph.

Declaration

[XamlSerializable]
public double ParagraphDefaultSpacingBefore { get; set; }

Property Value

Gets or sets the protection settings.

Declaration

[XamlCompositePropertySerializable]
public DocumentProtectionSettings ProtectionSettings { get; set; }

Property Value

Gets or sets the default section page margin.

Declaration

[XamlSerializable]
public Padding SectionDefaultPageMargin { get; set; }

Property Value

Gets or sets the default section page orientation

Declaration

[XamlSerializable]
public PageOrientation SectionDefaultPageOrientation { get; set; }

Property Value

Gets or sets the default section page size.

Declaration

[XamlSerializable]
public Size SectionDefaultPageSize { get; set; }

Property Value

Gets a collection with the sections of the document.

Declaration

public SectionCollection Sections { get; }

Property Value

Gets or sets the selected bibliographic style.

Declaration

public BibliographicReferenceStyleBase SelectedBibliographicStyle { get; set; }

Property Value

Gets a DocumentSelection representing the document selection.

Declaration

public DocumentSelection Selection { get; }

Property Value

Gets or sets a value indicating whether to show bookmarks.

Declaration

public bool ShowBookmarks { get; set; }

Property Value

Gets or sets a value indicating whether to show formatting symbols.

Declaration

public bool ShowFormattingSymbols { get; set; }

Property Value

Gets or sets a value indicating whether the merge fields in the document should have a highlight.

Declaration

public bool ShowMergeFieldsHighlight { get; set; }

Property Value

Gets or sets a value indicating whether the read only ranges in the document should have a highlight.

Declaration

public bool ShowReadOnlyRangesHighlight { get; set; }

Property Value

Gets a value indicating whether a structure change is in progress.

Declaration

public bool StructureChangeInProgress { get; }

Property Value

Gets the collection of styles inside the document.

Declaration

public StyleCollection StyleRepository { get; }

Property Value

Adds a custom list style to the document.

Declaration

public ListStyle AddCustomListStyle(ListStyle listStyle)

Parameters

Returns

Arranges the document.

Declaration

public void Arrange(RectangleF arrangeRect)

Parameters

Marks the start of styles editing and temporarily suspends the updates of the styles.

Declaration

public void BeginStylesUpdate()

Calls the DocumentContentChanged event.

Declaration

protected void CallOnDocumentContentChanged()

Determines whether this instance can be unprotected using the specified password.

Declaration

public bool CanUnprotectDocument(string password)

Parameters

Returns

Determines whether the document contains annotation markers of type T.

Declaration

public bool ContainsAnnotationMarkersOfType<T>() where T : AnnotationMarkerBase

Returns

Copies the properties from another RadDocument to the current instance.

Declaration

protected override void CopyPropertiesFromOverride(DocumentElement element)

Parameters

Overrides DocumentElement.CopyPropertiesFromOverride(DocumentElement)

Creates a deep copy of the document.

Declaration

public override DocumentElement CreateDeepCopy()

Returns

Overrides DocumentElement.CreateDeepCopy()

Creates a DocumentLayoutBox for the element.

Declaration

public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)

Parameters

Returns

Overrides DocumentElement.CreateLayoutBox(DocumentStructureCollection)

Creates a new RadDocument instance.

Declaration

protected override DocumentElement CreateNewElementInstance()

Returns

Overrides DocumentElement.CreateNewElementInstance()

Marks the end of styles editing and resumes the updates of the styles.

Declaration

public void EndStylesUpdate()

Ensures document layout is performed and layout-boxes have been created.

Declaration

public void EnsureDocumentMeasuredAndArranged()

Remarks

Gets all bookmarks in the document.

Declaration

public IEnumerable<BookmarkRangeStart> GetAllBookmarks()

Returns

Gets all PermissionRangeInfos for this document.

Declaration

public IEnumerable<PermissionRangeInfo> GetAllPermissionInfos()

Returns

Gets all revisions.

Declaration

public IEnumerable<Revision> GetAllRevisions()

Returns

Gets all annotation markers of type T in the document.

Declaration

public IEnumerable<T> GetAnnotationMarkersOfType<T>() where T : AnnotationMarkerBase

Returns

Tries to find a Bibliographic Source in the document. Returns null if none is found.

Declaration

public BibliographicSource GetBibliographicSource(string tagName)

Parameters

Returns

Gets a bookmark by its name.

Declaration

public BookmarkRangeStart GetBookmarkByName(string bookmarkName)

Parameters

Returns

Gets the CommentRangeStart by comment.

Declaration

public CommentRangeStart GetCommentRangeStartByComment(Comment comment)

Parameters

Returns

Gets the annotation ranges of type TRangeStart surrounding specific positions.

Declaration

public IEnumerable<TRangeStart> GetContainingAnnotationRanges<TRangeStart>(HierarchicalIndex start, HierarchicalIndex end) where TRangeStart : AnnotationRangeStart

Parameters

Returns

Gets the annotation ranges of type TRangeStart surrounding an inline that match a condition.

Declaration

public IEnumerable<TRangeStart> GetContainingAnnotationRanges<TRangeStart>(Inline inline, Predicate<TRangeStart> filter, bool inclusive = false) where TRangeStart : AnnotationRangeStart

Parameters

Returns

Gets the annotation ranges of type TRangeStart surrounding an inline.

Declaration

public IEnumerable<TRangeStart> GetContainingAnnotationRanges<TRangeStart>(Inline inline, bool inclusive = false) where TRangeStart : AnnotationRangeStart

Parameters

Returns

Gets the permission ranges included in the Selection. If the Selection is empty, the GetPermissions(Inline) method is invoked with the Inline under the CaretPosition.

Declaration

public IEnumerable<PermissionRangeInfo> GetCurrentPermissions()

Returns

Gets the current revision.

Declaration

public Revision GetCurrentRevision()

Returns

Gets a layout box that intersects with a position.

Declaration

public LayoutBox GetLayoutBoxByPosition(PointF position)

Parameters

Returns

Gets the next comment.

Declaration

public CommentRangeStart GetNextComment()

Returns

Gets the next revision.

Declaration

public Revision GetNextRevision()

Returns

Gets the permission ranges included in a specified Inline.

Declaration

public IEnumerable<PermissionRangeInfo> GetPermissions(Inline inline)

Parameters

Returns

Gets the previous comment.

Declaration

public CommentRangeStart GetPreviousComment()

Returns

Gets the previous revision.

Declaration

public Revision GetPreviousRevision()

Returns

Gets the statistical information about the document.

Declaration

public DocumentStatisticsInfo GetStatisticsInfo()

Returns

Moves the CaretPosition to the beginning of a bookmark.

Declaration

public void GoToBookmark(BookmarkRangeStart bookmarkStart)

Parameters

Moves the CaretPosition to the beginning of a bookmark.

Declaration

public void GoToBookmark(string bookmarkName)

Parameters

Selects a comment.

Declaration

public void GoToComment(Comment comment)

Parameters

Selects a comment.

Declaration

public void GoToComment(CommentRangeStart commentRangeStart)

Parameters

Selects next comment.

Declaration

public CommentRangeStart GoToNextComment()

Returns

Moves current position to the next endnote.

Declaration

public void GoToNextEndnote()

Moves current position to the next footnote.

Declaration

public void GoToNextFootnote()

Selects next revision.

Declaration

public Revision GoToNextRevision()

Returns

Selects previous comment.

Declaration

public CommentRangeStart GoToPreviousComment()

Returns

Moves current position to the previous endnote.

Declaration

public void GoToPreviousEndnote()

Moves current position to the previous footnote.

Declaration

public void GoToPreviousFootnote()

Selects previous revision.

Declaration

public Revision GoToPreviousRevision()

Returns

Selects revision.

Declaration

public void GoToRevision(Revision revision)

Parameters

Determines whether the specified inline is in annotation range of type TRangeStart that matches a condition.

Declaration

public bool IsInAnnotationRange<TRangeStart>(Inline inline, Predicate<TRangeStart> filter, bool inclusive = false) where TRangeStart : AnnotationRangeStart

Parameters

Returns

Determines whether the specified inline is in annotation range of type TRangeStart.

Declaration

public bool IsInAnnotationRange<TRangeStart>(Inline inline, bool inclusive = false) where TRangeStart : AnnotationRangeStart

Parameters

Returns

Mail merges the document using the MailMergeDataSource.

Declaration

public RadDocument MailMerge(bool startEachRecordOnNewPage = true)

Parameters

Returns

Mail merges the document using the current record from the MailMergeDataSource.

Declaration

public RadDocument MailMergeCurrentRecord()

Returns

Measures the document.

Declaration

public void Measure(SizeF measureSize)

Parameters

Forces document layout update, measuring document in MAX_DOCUMENT_SIZE.

Declaration

public void MeasureAndArrangeInDefaultSize()

Merges adjacent spans with same style properties into one.

Declaration

public void MergeSpansWithSameStyles()

Remarks

Called after arranging the document.

Declaration

protected virtual void OnDocumentArranged()

Called when document content has been changed.

Declaration

protected virtual void OnDocumentContentChanged()

Called after changing the LayoutMode. Raises LayoutModeChanged event.

Declaration

protected virtual void OnLayoutModeChanged()

Raises the event.

Declaration

protected virtual void OnMergeFieldToStringConverting(MergeFieldToStringConvertingEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnPresentationChanged(PresentationChangedEventArgs e)

Parameters

Called when changing the document presentation.

Declaration

protected virtual void OnPresentationChanging()

Called when the protection settings of the document has been changed.

Declaration

protected virtual void OnProtectionSettingsChanged()

Raises the event.

Declaration

protected virtual void OnRequestCurrentUserInfo(RequestCurrentUserInfoEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)

Parameters

Called after the style of a document element has been changed.

Declaration

protected override void OnStyleChanged()

Overrides DocumentElement.OnStyleChanged()

Raises the event.

Declaration

protected virtual void OnUserAuthenticationRequest(UserAuthenticationRequestEventArgs e)

Parameters

Protects the document.

Declaration

public void ProtectDocument(DocumentProtectionMode protectionMode, string password)

Parameters

Exceptions

Removes the protection from the document.

Declaration

public bool UnprotectDocument(string password)

Parameters

Returns

Exceptions

Forces the document to update its layout.

Declaration

public void UpdateLayout()

Updates the styles inside the document.

Declaration

public void UpdateStyles()

Occurs when the document has been arranged.

Declaration

public event EventHandler DocumentArranged

Event Value

Occurs when the document content has changed.

Declaration

public event EventHandler DocumentContentChanged

Event Value

Occurs when a document element is added in the whole document tree.

Declaration

public event EventHandler<DocumentElementAddedEventArgs> DocumentElementAdded

Event Value

Occurs when a document element is removed from the whole document tree.

Declaration

public event EventHandler<DocumentElementRemovedEventArgs> DocumentElementRemoved

Event Value

Occurs when the result of a document variable is being evaluated.

Declaration

public event EventHandler<DocumentVariableEvaluatingEventArgs> DocumentVariableEvaluating

Event Value

Occurs when the users clicks on a hyperlink in the current document.

Declaration

public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked

Event Value

Occurs when the LayoutMode property value has changed.

Declaration

public event EventHandler LayoutModeChanged

Event Value

Occurs when merge field is being converted to string.

Declaration

public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConverting

Event Value

Occurs when document presentation is changed.

Declaration

public event EventHandler<PresentationChangedEventArgs> PresentationChanged

Event Value

Occurs when the document presenter is changing.

Declaration

public event EventHandler PresentationChanging

Event Value

Occurs when the protection settings of the document has been changed.

Declaration

public event EventHandler ProtectionSettingsChanged

Event Value

Occurs when an information for the current user is needed.

Declaration

public event EventHandler<RequestCurrentUserInfoEventArgs> RequestCurrentUserInfo

Event Value

Occurs when trying to create a Stream from a Uri.

Declaration

public event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolving

Event Value

Occurs when a user should be authenticated.

Declaration

public event EventHandler<UserAuthenticationRequestEventArgs> UserAuthenticationRequest

Event Value