Class RadDocument
Represents the document object in RadRichTextBox.
Inherited Members
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Documents.dll
Syntax
public class RadDocument : DocumentElement, ISupportShouldSerialize, ISupportInitialize, INotifyPropertyChanged
Constructors
RadDocument()
Fields
DefaultTabWidthProperty
The default tab width style property.
Declaration
public static readonly StylePropertyDefinition<double? , DocumentProperties> DefaultTabWidthProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Double>, DocumentProperties>
|
EndnotesFirstNumberProperty
The endnotes first number style property.
Declaration
public static readonly StylePropertyDefinition<int? , DocumentProperties> EndnotesFirstNumberProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, DocumentProperties>
|
EndnotesNumberingFormatProperty
The endnotes numbering format style property.
Declaration
public static readonly StylePropertyDefinition<ListNumberingFormat? , DocumentProperties> EndnotesNumberingFormatProperty
Field Value
StylePropertyDefinition<System.Nullable<ListNumberingFormat>, DocumentProperties>
|
EndnotesNumberingRestartTypeProperty
The endnotes numbering restart type style property.
Declaration
public static readonly StylePropertyDefinition<NumberingRestartType? , DocumentProperties> EndnotesNumberingRestartTypeProperty
Field Value
StylePropertyDefinition<System.Nullable<NumberingRestartType>, DocumentProperties>
|
EndnotesPositionProperty
The endnotes position style property.
Declaration
public static readonly StylePropertyDefinition<EndnotesPosition? , DocumentProperties> EndnotesPositionProperty
Field Value
StylePropertyDefinition<System.Nullable<EndnotesPosition>, DocumentProperties>
|
FootnotesFirstNumberProperty
The footnotes first number style property.
Declaration
public static readonly StylePropertyDefinition<int? , DocumentProperties> FootnotesFirstNumberProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, DocumentProperties>
|
FootnotesNumberingFormatProperty
The footnotes numbering format style property.
Declaration
public static readonly StylePropertyDefinition<ListNumberingFormat? , DocumentProperties> FootnotesNumberingFormatProperty
Field Value
StylePropertyDefinition<System.Nullable<ListNumberingFormat>, DocumentProperties>
|
FootnotesNumberingRestartTypeProperty
The footnotes numbering restart type style property.
Declaration
public static readonly StylePropertyDefinition<NumberingRestartType? , DocumentProperties> FootnotesNumberingRestartTypeProperty
Field Value
StylePropertyDefinition<System.Nullable<NumberingRestartType>, DocumentProperties>
|
FootnotesPositionProperty
The footnotes position style property.
Declaration
public static readonly StylePropertyDefinition<FootnotesPosition? , DocumentProperties> FootnotesPositionProperty
Field Value
StylePropertyDefinition<System.Nullable<FootnotesPosition>, DocumentProperties>
|
MAX_DOCUMENT_SIZE
Represent the maximum document size.
Declaration
public static readonly SizeF MAX_DOCUMENT_SIZE
Field Value
SizeF
|
SectionDefaultPageMarginProperty
The section default page margin style property.
Declaration
public static readonly StylePropertyDefinition<Padding? , DocumentProperties> SectionDefaultPageMarginProperty
Field Value
StylePropertyDefinition<System.Nullable<Padding>, DocumentProperties>
|
SectionDefaultPageOrientationProperty
The section default page orientation style property.
Declaration
public static readonly StylePropertyDefinition<PageOrientation? , DocumentProperties> SectionDefaultPageOrientationProperty
Field Value
StylePropertyDefinition<System.Nullable<Telerik.Windows.Documents.Model.PageOrientation>, DocumentProperties>
|
SectionDefaultPageSizeProperty
The section default page size style property.
Declaration
public static readonly StylePropertyDefinition<Size? , DocumentProperties> SectionDefaultPageSizeProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Windows.Size>, DocumentProperties>
|
Properties
BibliographicSources
Gets or sets a collection of BibliographicSource objects.
Declaration
[XamlCompositePropertySerializable]
public NotifiableCollection<BibliographicSource> BibliographicSources { get; set; }
Property Value
NotifiableCollection<BibliographicSource>
|
BibliographicStyles
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
System.Collections.Generic.Dictionary<System.String, BibliographicReferenceStyleBase>
|
CaptionDefinitions
Gets the caption definitions inside the document.
Declaration
public Dictionary<string, CaptionDefinition> CaptionDefinitions { get; }
Property Value
System.Collections.Generic.Dictionary<System.String, CaptionDefinition>
The caption definitions. |
Captions
Gets or sets the captions.
Declaration
[XamlCompositePropertySerializable]
public List<CaptionDefinition> Captions { get; set; }
Property Value
System.Collections.Generic.List<CaptionDefinition>
The captions. |
CaretPosition
Gets a DocumentPosition representing the current caret position.
Declaration
public DocumentPosition CaretPosition { get; }
Property Value
DocumentPosition
The current position of the caret. |
CodeFormatter
Gets or sets the formatter used for code blocks.
Declaration
public CodeFormatter CodeFormatter { get; set; }
Property Value
CodeFormatter
The code formatter. |
DefaultPageLayoutSettings
Deprecated.
Declaration
[Obsolete("This property is deprecated. Please use RadDocument.SectionDefaultPageSize instead.")]
public PageLayoutSettings DefaultPageLayoutSettings { get; set; }
Property Value
PageLayoutSettings
|
DefaultStyleSettings
This property is introduced for backward compatibility only. Please use Style instead.
Declaration
[Obsolete("Use RadDocument's Style property instead.")]
public override StyleDefinition DefaultStyleSettings { get; }
Property Value
StyleDefinition
|
Overrides
DefaultTabWidth
Gets or sets the default tab width.
Declaration
[XamlSerializable]
public double DefaultTabWidth { get; set; }
Property Value
System.Double
|
DesiredSize
Gets a value representing the desired layout size of the document.
Declaration
public SizeF DesiredSize { get; }
Property Value
SizeF
A SizeF representing the desired size. |
DocumentContentChangedInterval
Gets or sets a value determining how often to fire the DocumentContentChanged event.
Declaration
public TimeSpan DocumentContentChangedInterval { get; set; }
Property Value
System.TimeSpan
|
DocumentLayoutBox
Gets a value representing the layout box of the document.
Declaration
public DocumentLayoutBox DocumentLayoutBox { get; }
Property Value
DocumentLayoutBox
The DocumentLayoutBox. |
DocumentVariableList
This property supports XAML serialization infrastructure and is not intended to be used directly from your code.
Declaration
[XamlCompositePropertySerializable]
public List<DocumentVariableInfo> DocumentVariableList { get; set; }
Property Value
System.Collections.Generic.List<DocumentVariableInfo>
|
DocumentVariables
Gets the document variables.
Declaration
public DocumentVariableCollection DocumentVariables { get; }
Property Value
DocumentVariableCollection
The document variables. |
EndnotesFirstNumber
Gets or sets the endnotes starting number.
Declaration
[XamlSerializable(1)]
public int EndnotesFirstNumber { get; set; }
Property Value
System.Int32
|
EndnotesNumberingFormat
Gets or sets the endnotes numbering format.
Declaration
[XamlSerializable(ListNumberingFormat.LowerRoman)]
public ListNumberingFormat EndnotesNumberingFormat { get; set; }
Property Value
ListNumberingFormat
|
EndnotesNumberingRestartType
Gets or sets the type of the endnotes numbering restart.
Declaration
[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType EndnotesNumberingRestartType { get; set; }
Property Value
NumberingRestartType
|
EndnotesPosition
Gets or sets the endnotes position.
Declaration
[XamlSerializable(EndnotesPosition.DocumentEnd)]
public EndnotesPosition EndnotesPosition { get; set; }
Property Value
EndnotesPosition
|
FieldsDisplayMode
Gets or sets the display mode for the fields in this document.
Declaration
public FieldDisplayMode FieldsDisplayMode { get; set; }
Property Value
FieldDisplayMode
The fields display mode. |
FootnotesFirstNumber
Gets or sets the footnotes starting number.
Declaration
[XamlSerializable(1)]
public int FootnotesFirstNumber { get; set; }
Property Value
System.Int32
|
FootnotesNumberingFormat
Gets or sets the footnotes numbering format.
Declaration
[XamlSerializable(ListNumberingFormat.Decimal)]
public ListNumberingFormat FootnotesNumberingFormat { get; set; }
Property Value
ListNumberingFormat
|
FootnotesNumberingRestartType
Gets or sets the type of the footnotes numbering restart.
Declaration
[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType FootnotesNumberingRestartType { get; set; }
Property Value
NumberingRestartType
|
FootnotesPosition
Gets or sets the footnotes position.
Declaration
[XamlSerializable(FootnotesPosition.PageBottom)]
public FootnotesPosition FootnotesPosition { get; set; }
Property Value
FootnotesPosition
|
HasDifferentEvenAndOddHeadersFooters
History
Gets the history of changes in this document.
Declaration
public DocumentHistory History { get; }
Property Value
DocumentHistory
|
IsEmpty
Gets a value indicating whether the document is empty.
Declaration
public bool IsEmpty { get; }
Property Value
System.Boolean
|
IsStrictLineBreakingRuleEnabled
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
System.Boolean
|
IsTrackChangesEnabled
Gets or sets a value indicating whether this instance has track changes enabled.
Declaration
[XamlSerializable(false)]
public bool IsTrackChangesEnabled { get; set; }
Property Value
System.Boolean
|
LayoutMode
Gets or sets a value representing the current layout mode.
Declaration
[XamlSerializable]
public DocumentLayoutMode LayoutMode { get; set; }
Property Value
DocumentLayoutMode
The layout mode. |
LineBreakingRuleLanguage
Gets or sets the language which rules should be used for line breaking in the paragraphs.
Declaration
public LineBreakingRuleLanguage LineBreakingRuleLanguage { get; set; }
Property Value
LineBreakingRuleLanguage
The line breaking rule language. |
LineSpacing
Gets or set the line spacing of this document.
Declaration
[XamlSerializable]
public double LineSpacing { get; set; }
Property Value
System.Double
|
LineSpacingType
Gets or set the line spacing type of this document.
Declaration
[XamlSerializable]
public LineSpacingType LineSpacingType { get; set; }
Property Value
LineSpacingType
|
ListManager
Gets the list manager.
Declaration
public ListManager ListManager { get; }
Property Value
ListManager
The ListManager instance responsible for this document. |
Lists
Gets or sets the lists.
Declaration
[XamlCompositePropertySerializable]
public List<ListSerializationData> Lists { get; set; }
Property Value
System.Collections.Generic.List<ListSerializationData>
The lists. |
ListStyles
Gets or sets the list styles.
Declaration
[XamlCompositePropertySerializable]
public List<ListStyle> ListStyles { get; set; }
Property Value
System.Collections.Generic.List<ListStyle>
The list styles. |
MailMergeDataSource
Gets the data source used for mail merge operations with this document.
Declaration
public MailMergeDataSource MailMergeDataSource { get; }
Property Value
MailMergeDataSource
The mail merge data source. |
NoLineBreaksAfterRule
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
LineBreakingRule
|
NoLineBreaksBeforeRule
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
LineBreakingRule
|
PageViewMargin
Deprecated.
Declaration
[Obsolete("Use Section.PageMargin property of the corresponding document section.")]
public SizeF PageViewMargin { get; set; }
Property Value
SizeF
|
ParagraphDefaultSpacingAfter
Gets or sets the default spacing after a paragraph.
Declaration
[XamlSerializable]
public double ParagraphDefaultSpacingAfter { get; set; }
Property Value
System.Double
|
ParagraphDefaultSpacingBefore
Gets or sets the default spacing before a paragraph.
Declaration
[XamlSerializable]
public double ParagraphDefaultSpacingBefore { get; set; }
Property Value
System.Double
|
ProtectionSettings
Gets or sets the protection settings.
Declaration
[XamlCompositePropertySerializable]
public DocumentProtectionSettings ProtectionSettings { get; set; }
Property Value
DocumentProtectionSettings
The protection settings. |
SectionDefaultPageMargin
Gets or sets the default section page margin.
Declaration
[XamlSerializable]
public Padding SectionDefaultPageMargin { get; set; }
Property Value
Padding
|
SectionDefaultPageOrientation
Gets or sets the default section page orientation
Declaration
[XamlSerializable]
public PageOrientation SectionDefaultPageOrientation { get; set; }
Property Value
Telerik.Windows.Documents.Model.PageOrientation
|
SectionDefaultPageSize
Gets or sets the default section page size.
Declaration
[XamlSerializable]
public Size SectionDefaultPageSize { get; set; }
Property Value
System.Windows.Size
|
Sections
Gets a collection with the sections of the document.
Declaration
public SectionCollection Sections { get; }
Property Value
SectionCollection
A SectionCollection representing the sections of the document. |
SelectedBibliographicStyle
Gets or sets the selected bibliographic style.
Declaration
public BibliographicReferenceStyleBase SelectedBibliographicStyle { get; set; }
Property Value
BibliographicReferenceStyleBase
The selected bibliographic style. |
SelectedBibliographicStyleName
Gets or sets the name of the selected bibliographic style.
Declaration
[XamlSerializable("")]
public string SelectedBibliographicStyleName { get; set; }
Property Value
System.String
The name of the selected bibliographic style. |
Selection
Gets a DocumentSelection representing the document selection.
Declaration
public DocumentSelection Selection { get; }
Property Value
DocumentSelection
The document selection. |
ShowBookmarks
Gets or sets a value indicating whether to show bookmarks.
Declaration
public bool ShowBookmarks { get; set; }
Property Value
System.Boolean
|
ShowFormattingSymbols
Gets or sets a value indicating whether to show formatting symbols.
Declaration
public bool ShowFormattingSymbols { get; set; }
Property Value
System.Boolean
|
ShowMergeFieldsHighlight
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
System.Boolean
|
ShowReadOnlyRangesHighlight
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
System.Boolean
|
StructureChangeInProgress
Gets a value indicating whether a structure change is in progress.
Declaration
public bool StructureChangeInProgress { get; }
Property Value
System.Boolean
|
StyleRepository
Gets the collection of styles inside the document.
Declaration
public StyleCollection StyleRepository { get; }
Property Value
StyleCollection
The style repository. |
Styles
Gets or sets the styles. This property is used for XAML export/import only.
Declaration
[XamlCompositePropertySerializable]
public List<StyleDefinition> Styles { get; set; }
Property Value
System.Collections.Generic.List<StyleDefinition>
The styles. |
Theme
Gets or sets the theme. This property is used for XAML export/import only.
Declaration
[XamlCompositePropertySerializable]
public Theme Theme { get; set; }
Property Value
Theme
The theme. |
Methods
AddCustomListStyle(ListStyle)
Adds a custom list style to the document.
Declaration
public ListStyle AddCustomListStyle(ListStyle listStyle)
Parameters
ListStyle
listStyle
The list style. |
Returns
ListStyle
The inserted ListStyle instance. |
Arrange(RectangleF)
Arranges the document.
Declaration
public void Arrange(RectangleF arrangeRect)
Parameters
RectangleF
arrangeRect
The rectangle to arrange in. |
BeginStylesUpdate()
Marks the start of styles editing and temporarily suspends the updates of the styles.
Declaration
public void BeginStylesUpdate()
BeginUpdate()
This method supports control infrastructure and is not intended for use directly from your code.
Declaration
public void BeginUpdate()
CallOnDocumentContentChanged()
CanUnprotectDocument(String)
Determines whether this instance can be unprotected using the specified password.
Declaration
public bool CanUnprotectDocument(string password)
Parameters
System.String
password
The password. |
Returns
System.Boolean
|
ChangeAllFieldsDisplayMode(FieldDisplayMode)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.ChangeAllFieldsDisplayMode method instead.")]
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode
displayMode
|
ChangeBibliographicStyle(BibliographicReferenceStyleBase)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.ChangeBibliographicStyle method instead.")]
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)
Parameters
BibliographicReferenceStyleBase
newBibliographicStyle
|
ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.ChangeFieldDisplayMode method instead.")]
public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)
Parameters
FieldRangeStart
fieldStart
|
FieldDisplayMode
displayMode
|
ContainsAnnotationMarkersOfType<T>()
Determines whether the document contains annotation markers of type T.
Declaration
public bool ContainsAnnotationMarkersOfType<T>()
where T : AnnotationMarkerBase
Returns
System.Boolean
|
Type Parameters
T
|
CopyPropertiesFromOverride(DocumentElement)
Copies the properties from another RadDocument to the current instance.
Declaration
protected override void CopyPropertiesFromOverride(DocumentElement element)
Parameters
DocumentElement
element
The RadDocument to copy the properties from. |
Overrides
CreateDeepCopy()
Creates a deep copy of the document.
Declaration
public override DocumentElement CreateDeepCopy()
Returns
DocumentElement
The copied element. |
Overrides
CreateLayoutBox(DocumentStructureCollection)
Creates a DocumentLayoutBox for the element.
Declaration
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters
DocumentStructureCollection
documentCollection
The document collection. |
Returns
LayoutBox
Thew new DocumentLayoutBox. |
Overrides
CreateNewElementInstance()
Creates a new RadDocument instance.
Declaration
protected override DocumentElement CreateNewElementInstance()
Returns
DocumentElement
The new instance. |
Overrides
Delete(Boolean)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.Delete method instead.")]
public void Delete(bool deletePrevious)
Parameters
System.Boolean
deletePrevious
|
Delete(Boolean, DocumentPosition)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.Delete method instead.")]
public void Delete(bool deletePrevious, DocumentPosition documentPosition)
Parameters
System.Boolean
deletePrevious
|
DocumentPosition
documentPosition
|
DeleteAtDocumentPosition(DocumentPosition, Boolean)
Deprecated.
Declaration
[Obsolete("Use Delete method of RadDocument.")]
public void DeleteAtDocumentPosition(DocumentPosition documentPosition, bool deletePrevious)
Parameters
DocumentPosition
documentPosition
|
System.Boolean
deletePrevious
|
DeleteBookmark(String)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.DeleteBookmark method instead.")]
public void DeleteBookmark(string bookmarkName)
Parameters
System.String
bookmarkName
|
DeleteBookmark(BookmarkRangeStart)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.DeleteBookmark method instead.")]
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)
Parameters
BookmarkRangeStart
bookmarkRangeStart
|
DeleteComment(CommentRangeStart)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.DeleteComment method instead.")]
public void DeleteComment(CommentRangeStart commentStart)
Parameters
CommentRangeStart
commentStart
|
DeleteCustomAnnotationRange(AnnotationRangeStart)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.DeleteAnnotationRange method instead.")]
public void DeleteCustomAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart
rangeStart
|
DeletePermissionRange(PermissionRangeStart)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.DeletePermissionRange method instead.")]
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)
Parameters
PermissionRangeStart
permissionRangeStart
|
DeleteRange(DocumentPosition, DocumentPosition)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.Delete method with appropriate document selection instead.")]
public void DeleteRange(DocumentPosition fromPosition, DocumentPosition toPosition)
Parameters
DocumentPosition
fromPosition
|
DocumentPosition
toPosition
|
DeleteReadOnlyRange(ReadOnlyRangeStart)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.DeleteReadOnlyRange method instead.")]
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)
Parameters
ReadOnlyRangeStart
readOnlyRangeStart
|
EndStylesUpdate()
Marks the end of styles editing and resumes the updates of the styles.
Declaration
public void EndStylesUpdate()
EndUpdate()
This method supports control infrastructure and is not intended for use directly from your code.
Declaration
public void EndUpdate()
EnsureDocumentMeasuredAndArranged()
Ensures document layout is performed and layout-boxes have been created.
Declaration
public void EnsureDocumentMeasuredAndArranged()
Remarks
Call this method if the document is created in code and you need to access document's layout boxes.
GetAllBookmarks()
Gets all bookmarks in the document.
Declaration
public IEnumerable<BookmarkRangeStart> GetAllBookmarks()
Returns
System.Collections.Generic.IEnumerable<BookmarkRangeStart>
A collection of BookmarkRangeStart objects. |
GetAllPermissionInfos()
Gets all PermissionRangeInfos for this document.
Declaration
public IEnumerable<PermissionRangeInfo> GetAllPermissionInfos()
Returns
System.Collections.Generic.IEnumerable<PermissionRangeInfo>
A collecction of PermissionRangeInfo objects. |
GetAllRevisions()
Gets all revisions.
Declaration
public IEnumerable<Revision> GetAllRevisions()
Returns
System.Collections.Generic.IEnumerable<Revision>
|
GetAnnotationMarkersOfType<T>()
Gets all annotation markers of type T in the document.
Declaration
public IEnumerable<T> GetAnnotationMarkersOfType<T>()
where T : AnnotationMarkerBase
Returns
System.Collections.Generic.IEnumerable<T>
|
Type Parameters
T
|
GetBibliographicSource(String)
Tries to find a Bibliographic Source in the document. Returns null if none is found.
Declaration
public BibliographicSource GetBibliographicSource(string tagName)
Parameters
System.String
tagName
The tag name of the Source to be found. |
Returns
BibliographicSource
|
GetBookmarkByName(String)
Gets a bookmark by its name.
Declaration
public BookmarkRangeStart GetBookmarkByName(string bookmarkName)
Parameters
System.String
bookmarkName
The name of the bookmark. |
Returns
BookmarkRangeStart
The BookmarkRangeStart representing the bookmark. |
GetCommentRangeStartByComment(Comment)
Gets the CommentRangeStart by comment.
Declaration
public CommentRangeStart GetCommentRangeStartByComment(Comment comment)
Parameters
Comment
comment
The comment. |
Returns
CommentRangeStart
|
GetContainingAnnotationRanges<TRangeStart>(HierarchicalIndex, HierarchicalIndex)
Gets the annotation ranges of type TRangeStart surrounding specific positions.
Declaration
public IEnumerable<TRangeStart> GetContainingAnnotationRanges<TRangeStart>(HierarchicalIndex start, HierarchicalIndex end)
where TRangeStart : AnnotationRangeStart
Parameters
HierarchicalIndex
start
The start. |
HierarchicalIndex
end
The end. |
Returns
System.Collections.Generic.IEnumerable<TRangeStart>
|
Type Parameters
TRangeStart
The type of the range start. |
GetContainingAnnotationRanges<TRangeStart>(Inline, Boolean)
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
Inline
inline
The inline. |
System.Boolean
inclusive
Specifies whether to return the inline itself if it is a TRangeStart. |
Returns
System.Collections.Generic.IEnumerable<TRangeStart>
|
Type Parameters
TRangeStart
|
GetContainingAnnotationRanges<TRangeStart>(Inline, Predicate<TRangeStart>, Boolean)
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
Inline
inline
The inline. |
System.Predicate<TRangeStart>
filter
The filter. |
System.Boolean
inclusive
Specifies whether to return the inline itself if it is a TRangeStart. |
Returns
System.Collections.Generic.IEnumerable<TRangeStart>
|
Type Parameters
TRangeStart
|
GetCurrentPermissions()
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
System.Collections.Generic.IEnumerable<PermissionRangeInfo>
A collection of PermissionRangeInfo objects. |
GetCurrentRevision()
GetLayoutBoxByPosition(PointF)
Gets a layout box that intersects with a position.
Declaration
public LayoutBox GetLayoutBoxByPosition(PointF position)
Parameters
PointF
position
The position to intersect with. |
Returns
LayoutBox
|
GetNextComment()
Gets the next comment.
Declaration
public CommentRangeStart GetNextComment()
Returns
CommentRangeStart
|
GetNextRevision()
GetPermissions(Inline)
Gets the permission ranges included in a specified Inline.
Declaration
public IEnumerable<PermissionRangeInfo> GetPermissions(Inline inline)
Parameters
Inline
inline
The inline element from which PermissionRangeInfos should be obtained. |
Returns
System.Collections.Generic.IEnumerable<PermissionRangeInfo>
A collection of PermissionRangeInfos inside the inline. |
GetPreviousComment()
Gets the previous comment.
Declaration
public CommentRangeStart GetPreviousComment()
Returns
CommentRangeStart
|
GetPreviousRevision()
GetStatisticsInfo()
Gets the statistical information about the document.
Declaration
public DocumentStatisticsInfo GetStatisticsInfo()
Returns
DocumentStatisticsInfo
|
GoToBookmark(String)
Moves the CaretPosition to the beginning of a bookmark.
Declaration
public void GoToBookmark(string bookmarkName)
Parameters
System.String
bookmarkName
The name of the bookmark. |
GoToBookmark(BookmarkRangeStart)
Moves the CaretPosition to the beginning of a bookmark.
Declaration
public void GoToBookmark(BookmarkRangeStart bookmarkStart)
Parameters
BookmarkRangeStart
bookmarkStart
The bookmark start. |
GoToComment(Comment)
Selects a comment.
Declaration
public void GoToComment(Comment comment)
Parameters
Comment
comment
The comment. |
GoToComment(CommentRangeStart)
Selects a comment.
Declaration
public void GoToComment(CommentRangeStart commentRangeStart)
Parameters
CommentRangeStart
commentRangeStart
The comment range start. |
GoToNextComment()
Selects next comment.
Declaration
public CommentRangeStart GoToNextComment()
Returns
CommentRangeStart
|
GoToNextEndnote()
Moves current position to the next endnote.
Declaration
public void GoToNextEndnote()
GoToNextFootnote()
Moves current position to the next footnote.
Declaration
public void GoToNextFootnote()
GoToNextRevision()
GoToPreviousComment()
Selects previous comment.
Declaration
public CommentRangeStart GoToPreviousComment()
Returns
CommentRangeStart
|
GoToPreviousEndnote()
Moves current position to the previous endnote.
Declaration
public void GoToPreviousEndnote()
GoToPreviousFootnote()
Moves current position to the previous footnote.
Declaration
public void GoToPreviousFootnote()
GoToPreviousRevision()
GoToRevision(Revision)
Selects revision.
Declaration
public void GoToRevision(Revision revision)
Parameters
Revision
revision
The revision. |
Insert(String, StyleDefinition)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertInline method instead.")]
public void Insert(string text, StyleDefinition style)
Parameters
System.String
text
|
StyleDefinition
style
|
Insert(String, StyleDefinition, DocumentPosition)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertInline method instead.")]
public void Insert(string text, StyleDefinition style, DocumentPosition position)
Parameters
System.String
text
|
StyleDefinition
style
|
DocumentPosition
position
|
InsertBookmark(DocumentPosition, DocumentPosition, String)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertBookmark method instead.")]
public BookmarkRangeStart InsertBookmark(DocumentPosition startPosition, DocumentPosition endPosition, string bookmarkName)
Parameters
DocumentPosition
startPosition
|
DocumentPosition
endPosition
|
System.String
bookmarkName
|
Returns
BookmarkRangeStart
|
InsertComment(DocumentPosition, DocumentPosition, Comment)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertComment method instead.")]
public CommentRangeStart InsertComment(DocumentPosition startPosition, DocumentPosition endPosition, Comment comment)
Parameters
DocumentPosition
startPosition
|
DocumentPosition
endPosition
|
Comment
comment
|
Returns
CommentRangeStart
|
InsertComment(Comment)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertComment method instead.")]
public CommentRangeStart InsertComment(Comment comment)
Parameters
Comment
comment
|
Returns
CommentRangeStart
|
InsertCustomAnnotationRange(DocumentPosition, DocumentPosition, AnnotationRangeStart, AnnotationRangeEnd)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertAnnotationRange method instead.")]
public void InsertCustomAnnotationRange(DocumentPosition startPosition, DocumentPosition endPosition, AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)
Parameters
DocumentPosition
startPosition
|
DocumentPosition
endPosition
|
AnnotationRangeStart
rangeStart
|
AnnotationRangeEnd
rangeEnd
|
InsertEndnote()
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertEndnote method instead.")]
public void InsertEndnote()
InsertEndnote(Note)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertEndnote method instead.")]
public void InsertEndnote(Note endnote)
Parameters
Note
endnote
|
InsertField(Field)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertField method instead.")]
public bool InsertField(Field field)
Parameters
Field
field
|
Returns
System.Boolean
|
InsertField(Field, FieldDisplayMode)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertField method instead.")]
public bool InsertField(Field field, FieldDisplayMode displayMode)
Parameters
Field
field
|
FieldDisplayMode
displayMode
|
Returns
System.Boolean
|
InsertFootnote()
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertFootnote method instead.")]
public void InsertFootnote()
InsertFootnote(Note)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertFootnote method instead.")]
public void InsertFootnote(Note footnote)
Parameters
Note
footnote
|
InsertFragment(DocumentFragment)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertFragment method instead.")]
public void InsertFragment(DocumentFragment fragment)
Parameters
DocumentFragment
fragment
|
InsertFragment(DocumentFragment, DocumentPosition)
Inserts a document fragment into the document.
Declaration
[Obsolete("Use RadDocumentEditor.InsertFramgment(DocumentFragment, DocumentPosition) method instead.")]
public void InsertFragment(DocumentFragment fragment, DocumentPosition position)
Parameters
DocumentFragment
fragment
The fragment to insert. |
DocumentPosition
position
The position to insert the fragment at. |
InsertHyperlink(DocumentPosition, DocumentPosition, HyperlinkInfo)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertHyperlink method instead.")]
public HyperlinkRangeStart InsertHyperlink(DocumentPosition startPosition, DocumentPosition endPosition, HyperlinkInfo hyperlinkInfo)
Parameters
DocumentPosition
startPosition
|
DocumentPosition
endPosition
|
HyperlinkInfo
hyperlinkInfo
|
Returns
HyperlinkRangeStart
|
InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertHyperlink method instead.")]
public HyperlinkRangeStart InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> hyperlinkInlines)
Parameters
HyperlinkInfo
hyperlinkInfo
|
System.Collections.Generic.IEnumerable<Inline>
hyperlinkInlines
|
Returns
HyperlinkRangeStart
|
InsertInline(Inline)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertInline method instead.")]
public void InsertInline(Inline inline)
Parameters
Inline
inline
|
InsertInline(Inline, DocumentPosition)
Inserts an inline element into the document.
Declaration
[Obsolete("This method is deprecated.")]
public void InsertInline(Inline inline, DocumentPosition position)
Parameters
Inline
inline
The element to insert. |
DocumentPosition
position
The position to insert the element at. |
InsertLineBreak()
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor methods instead.")]
public void InsertLineBreak()
InsertPageBreak()
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor methods instead.")]
public void InsertPageBreak()
InsertPermissionRange(DocumentPosition, DocumentPosition, PermissionRangeInfo)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertPermissionRange method instead.")]
public PermissionRangeStart InsertPermissionRange(DocumentPosition startPosition, DocumentPosition endPosition, PermissionRangeInfo permissionInfo)
Parameters
DocumentPosition
startPosition
|
DocumentPosition
endPosition
|
PermissionRangeInfo
permissionInfo
|
Returns
PermissionRangeStart
|
InsertReadOnlyRange(DocumentPosition, DocumentPosition)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertReadOnlyRange method instead.")]
public ReadOnlyRangeStart InsertReadOnlyRange(DocumentPosition startPosition, DocumentPosition endPosition)
Parameters
DocumentPosition
startPosition
|
DocumentPosition
endPosition
|
Returns
ReadOnlyRangeStart
|
InsertSectionBreak(DocumentPosition, StyleDefinition, SectionBreakType)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.InsertSectionBreak method instead.")]
public void InsertSectionBreak(DocumentPosition position, StyleDefinition style, SectionBreakType sectionBreakType)
Parameters
DocumentPosition
position
|
StyleDefinition
style
|
SectionBreakType
sectionBreakType
|
IsInAnnotationRange<TRangeStart>(Inline, Boolean)
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
Inline
inline
The inline. |
System.Boolean
inclusive
Specifies whether to return the inline itself if it is a TRangeStart. |
Returns
System.Boolean
|
Type Parameters
TRangeStart
|
IsInAnnotationRange<TRangeStart>(Inline, Predicate<TRangeStart>, Boolean)
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
Inline
inline
The inline. |
System.Predicate<TRangeStart>
filter
The filter. |
System.Boolean
inclusive
Specifies whether to return the inline itself if it is a TRangeStart. |
Returns
System.Boolean
|
Type Parameters
TRangeStart
|
MailMerge(Boolean)
Mail merges the document using the MailMergeDataSource.
Declaration
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)
Parameters
System.Boolean
startEachRecordOnNewPage
A boolean value indicating whether the records should start each on a new page. |
Returns
RadDocument
A RadDocument instance representing the result of the merge. |
MailMergeCurrentRecord()
Mail merges the document using the current record from the MailMergeDataSource.
Declaration
public RadDocument MailMergeCurrentRecord()
Returns
RadDocument
A RadDocument instance representing the result of the merge. |
Measure(SizeF)
Measures the document.
Declaration
public void Measure(SizeF measureSize)
Parameters
SizeF
measureSize
The size to measure in. |
MeasureAndArrangeInDefaultSize()
Forces document layout update, measuring document in MAX_DOCUMENT_SIZE.
Declaration
public void MeasureAndArrangeInDefaultSize()
MergeSpansWithSameStyles()
Merges adjacent spans with same style properties into one.
Declaration
public void MergeSpansWithSameStyles()
Remarks
This method is automatically called when document is measured during the layout process.
Calling it explicitly is generally not needed and may only be useful in case spans are manually added to Paragraph.Inlines collection.
OnDocumentArranged()
Called after arranging the document.
Declaration
protected virtual void OnDocumentArranged()
OnDocumentContentChanged()
Called when document content has been changed.
Declaration
protected virtual void OnDocumentContentChanged()
OnLayoutModeChanged()
Called after changing the LayoutMode. Raises LayoutModeChanged event.
Declaration
protected virtual void OnLayoutModeChanged()
OnMergeFieldToStringConverting(MergeFieldToStringConvertingEventArgs)
Raises the MergeFieldToStringConverting event.
Declaration
protected virtual void OnMergeFieldToStringConverting(MergeFieldToStringConvertingEventArgs e)
Parameters
MergeFieldToStringConvertingEventArgs
e
The MergeFieldToStringConvertingEventArgs instance containing the event data. |
OnPresentationChanged(PresentationChangedEventArgs)
Raises the PresentationChanged event.
Declaration
protected virtual void OnPresentationChanged(PresentationChangedEventArgs e)
Parameters
PresentationChangedEventArgs
e
The PresentationChangedEventArgs instance containing the event data. |
OnPresentationChanging()
Called when changing the document presentation.
Declaration
protected virtual void OnPresentationChanging()
OnProtectionSettingsChanged()
Called when the protection settings of the document has been changed.
Declaration
protected virtual void OnProtectionSettingsChanged()
OnRequestCurrentUserInfo(RequestCurrentUserInfoEventArgs)
Raises the RequestCurrentUserInfo event.
Declaration
protected virtual void OnRequestCurrentUserInfo(RequestCurrentUserInfoEventArgs e)
Parameters
RequestCurrentUserInfoEventArgs
e
The RequestCurrentUserInfoEventArgs instance containing the event data. |
OnStreamFromUriResolving(StreamFromUriResolvingEventArgs)
Raises the StreamFromUriResolving event.
Declaration
protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)
Parameters
StreamFromUriResolvingEventArgs
e
The StreamFromUriResolvingEventArgs instance containing the event data. |
OnStyleChanged()
Called after the style of a document element has been changed.
Declaration
protected override void OnStyleChanged()
Overrides
OnUserAuthenticationRequest(UserAuthenticationRequestEventArgs)
Raises the UserAuthenticationRequest event.
Declaration
protected virtual void OnUserAuthenticationRequest(UserAuthenticationRequestEventArgs e)
Parameters
UserAuthenticationRequestEventArgs
e
The UserAuthenticationRequestEventArgs instance containing the event data. |
ProtectDocument(DocumentProtectionMode, String)
Protects the document.
Declaration
public void ProtectDocument(DocumentProtectionMode protectionMode, string password)
Parameters
DocumentProtectionMode
protectionMode
The protection mode. |
System.String
password
The password. |
Exceptions
System.InvalidOperationException
Cannot protect a document that is already protected. |
RegisterDefaultHeadingStyles()
Creates and registers the "Heading X" styles with the default settings.
Declaration
public void RegisterDefaultHeadingStyles()
SetCurrentEditingSpanStyleName(String)
Sets the name of the current editing span style.
Declaration
public void SetCurrentEditingSpanStyleName(string styleName)
Parameters
System.String
styleName
Name of the style. |
ToggleFieldCodes(FieldRangeStart)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.ToggleFieldCodes method instead.")]
public void ToggleFieldCodes(FieldRangeStart fieldStart)
Parameters
FieldRangeStart
fieldStart
|
UnprotectDocument(String)
Removes the protection from the document.
Declaration
public bool UnprotectDocument(string password)
Parameters
System.String
password
The password. |
Returns
System.Boolean
|
Exceptions
System.InvalidOperationException
Cannot unprotect a document that is not protected. |
UpdateAllFields()
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.UpdateAllFields method instead.")]
public void UpdateAllFields()
UpdateAllFields(FieldDisplayMode)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.UpdateAllFields method instead.")]
public void UpdateAllFields(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode
displayMode
|
UpdateField(FieldRangeStart)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.UpdateField method instead.")]
public void UpdateField(FieldRangeStart fieldStart)
Parameters
FieldRangeStart
fieldStart
|
UpdateLayout()
Forces the document to update its layout.
Declaration
public void UpdateLayout()
UpdatePermissionRanges(IEnumerable<PermissionRangeInfo>, IEnumerable<PermissionRangeInfo>)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor.UpdatePermissionRanges method instead.")]
public void UpdatePermissionRanges(IEnumerable<PermissionRangeInfo> permissionsToAdd, IEnumerable<PermissionRangeInfo> permissionsToRemove)
Parameters
System.Collections.Generic.IEnumerable<PermissionRangeInfo>
permissionsToAdd
|
System.Collections.Generic.IEnumerable<PermissionRangeInfo>
permissionsToRemove
|
UpdateSectionsStyle(IEnumerable<Section>, UpdateDocumentElementDelegate<Section>)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor methods instead.")]
public void UpdateSectionsStyle(IEnumerable<Section> sections, UpdateDocumentElementDelegate<Section> updateSection)
Parameters
System.Collections.Generic.IEnumerable<Section>
sections
|
UpdateDocumentElementDelegate<Section>
updateSection
|
UpdateSelectedParagraphsStyle(UpdateDocumentElementDelegate<Paragraph>)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor methods instead.")]
public void UpdateSelectedParagraphsStyle(UpdateDocumentElementDelegate<Paragraph> updateParagraph)
Parameters
UpdateDocumentElementDelegate<Paragraph>
updateParagraph
|
UpdateSelectedSectionsStyle(UpdateDocumentElementDelegate<Section>)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor methods instead.")]
public void UpdateSelectedSectionsStyle(UpdateDocumentElementDelegate<Section> updateSection)
Parameters
UpdateDocumentElementDelegate<Section>
updateSection
|
UpdateSelectedSpansStyle(UpdateDocumentElementDelegate<Span>)
Deprecated.
Declaration
[Obsolete("Use RadDocumentEditor methods instead.")]
public void UpdateSelectedSpansStyle(UpdateDocumentElementDelegate<Span> updateSpan)
Parameters
UpdateDocumentElementDelegate<Span>
updateSpan
|
UpdateStyles()
Updates the styles inside the document.
Declaration
public void UpdateStyles()
Events
DocumentArranged
Occurs when the document has been arranged.
Declaration
public event EventHandler DocumentArranged
Event Type
System.EventHandler
|
DocumentContentChanged
Occurs when the document content has changed.
Declaration
public event EventHandler DocumentContentChanged
Event Type
System.EventHandler
|
DocumentElementAdded
Occurs when a document element is added in the whole document tree.
Declaration
public event EventHandler<DocumentElementAddedEventArgs> DocumentElementAdded
Event Type
System.EventHandler<DocumentElementAddedEventArgs>
|
DocumentElementRemoved
Occurs when a document element is removed from the whole document tree.
Declaration
public event EventHandler<DocumentElementRemovedEventArgs> DocumentElementRemoved
Event Type
System.EventHandler<DocumentElementRemovedEventArgs>
|
DocumentVariableEvaluating
Occurs when the result of a document variable is being evaluated.
Declaration
public event EventHandler<DocumentVariableEvaluatingEventArgs> DocumentVariableEvaluating
Event Type
System.EventHandler<DocumentVariableEvaluatingEventArgs>
|
HyperlinkClicked
Occurs when the users clicks on a hyperlink in the current document.
Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked
Event Type
System.EventHandler<HyperlinkClickedEventArgs>
|
LayoutModeChanged
Occurs when the LayoutMode property value has changed.
Declaration
public event EventHandler LayoutModeChanged
Event Type
System.EventHandler
|
MergeFieldToStringConverting
Occurs when merge field is being converted to System.String.
Declaration
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConverting
Event Type
System.EventHandler<MergeFieldToStringConvertingEventArgs>
|
PresentationChanged
Occurs when document presentation is changed.
Declaration
public event EventHandler<PresentationChangedEventArgs> PresentationChanged
Event Type
System.EventHandler<PresentationChangedEventArgs>
|
PresentationChanging
Occurs when the document presenter is changing.
Declaration
public event EventHandler PresentationChanging
Event Type
System.EventHandler
|
ProtectionSettingsChanged
Occurs when the protection settings of the document has been changed.
Declaration
public event EventHandler ProtectionSettingsChanged
Event Type
System.EventHandler
|
RequestCurrentUserInfo
Occurs when an information for the current user is needed.
Declaration
public event EventHandler<RequestCurrentUserInfoEventArgs> RequestCurrentUserInfo
Event Type
System.EventHandler<RequestCurrentUserInfoEventArgs>
|
StreamFromUriResolving
Occurs when trying to create a System.IO.Stream from a System.Uri.
Declaration
public event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolving
Event Type
System.EventHandler<StreamFromUriResolvingEventArgs>
|
UserAuthenticationRequest
Occurs when a user should be authenticated.
Declaration
public event EventHandler<UserAuthenticationRequestEventArgs> UserAuthenticationRequest
Event Type
System.EventHandler<UserAuthenticationRequestEventArgs>
|