Click or drag to resize
RadDocument Class
Inheritance Hierarchy
SystemObject
  Telerik.WinControlsDisposableObject
    Telerik.WinControlsRadObject
      Telerik.WinForms.Documents.ModelDocumentElement
        Telerik.WinForms.Documents.ModelRadDocument

Namespace: Telerik.WinForms.Documents.Model
Assembly: Telerik.WinControls.RichTextEditor (in Telerik.WinControls.RichTextEditor.dll) Version: 2017.3.1017.40 (2017.3.1017.40)
Syntax
[ContentPropertyAttribute("Sections")]
public class RadDocument : DocumentElement, 
	ISupportInitialize, INotifyPropertyChanged

The RadDocument type exposes the following members.

Constructors
  NameDescription
Public methodRadDocument
Initializes a new instance of the RadDocument class.
Top
Properties
  NameDescription
Public propertyBibliographicSources
Public propertyBibliographicStyles
Public propertyBindingContext
Gets or sets the BindingContext for the object.
(Inherited from RadObject.)
Protected propertyBitState
Gets the RadBitVector64 structure that holds all the bit states of the object.
(Inherited from DisposableObject.)
Public propertyCaptionDefinitions
Public propertyCaptions
Public propertyCaretPosition
Gets a value representing the current caret position.
Public propertyChildIndex (Inherited from DocumentElement.)
Public propertyChildren (Inherited from DocumentElement.)
Public propertyCodeFormatter
Public propertyCursor (Inherited from DocumentElement.)
Public propertyDefaultPageLayoutSettings Obsolete.
Deprecated.
Public propertyDefaultStyleSettings Obsolete.
This property is introduced for backward compatibility only. Please use Style instead.
(Overrides DocumentElementDefaultStyleSettings.)
Public propertyDefaultTabWidth
Gets or sets the default tab width.
Public propertyDesiredSize
Gets a value representing the desired layout size of the document.
Public propertyDocumentContentChangedInterval
Gets or sets a value how often to fire the DocumentContentChanged event.
Protected propertyDocumentElements (Inherited from DocumentElement.)
Public propertyDocumentLayoutBox
Gets a value representing the layout box of the document.
Public propertyDocumentVariableList
This property supports XAML serialization infrastructure and is not intended to be used directly from your code.
Public propertyDocumentVariables
Public propertyEndnotesFirstNumber
Gets or sets the endnotes starting number.
Public propertyEndnotesNumberingFormat
Gets or sets the endnotes numbering format.
Public propertyEndnotesNumberingRestartType
Gets or sets the type of the endnotes numbering restart.
Public propertyEndnotesPosition
Gets or sets the endnotes position.
Protected propertyEvents
Provides a simple list of delegates.
(Inherited from DisposableObject.)
Public propertyFieldsDisplayMode
Public propertyFirstLayoutBox (Inherited from DocumentElement.)
Public propertyFlowModePadding
Public propertyFootnotesFirstNumber
Gets or sets the footnotes starting number.
Public propertyFootnotesNumberingFormat
Gets or sets the footnotes numbering format.
Public propertyFootnotesNumberingRestartType
Gets or sets the type of the footnotes numbering restart.
Public propertyFootnotesPosition
Gets or sets the footnotes position.
Public propertyHasDifferentEvenAndOddHeadersFooters
Gets or sets a value indicating whether headers and footers are different in even and odd pages.
Public propertyHasStyle (Inherited from DocumentElement.)
Public propertyHistory
Gets the document history instance of this document.
Public propertyIsDesignMode
Determines whether the element is in design mode.
(Inherited from RadObject.)
Public propertyIsDisposed
Determines whether the object is already disposed.
(Inherited from DisposableObject.)
Public propertyIsDisposing
Determines whether the object is in a process of being disposed of.
(Inherited from DisposableObject.)
Public propertyIsEmpty
Gets a value indicating whether the document is empty.
Protected propertyIsFirstLayoutBoxInitialized (Inherited from DocumentElement.)
Public propertyIsStrictLineBreakingRuleEnabled
Gets or sets a value indicating whether the strict line breaking rule will be applied to Japanese text in this document.
Public propertyIsTrackChangesEnabled
Gets or sets a value indicating whether this instance is track changes enabled.
Public propertyLastLayoutBox
Traverses AssociatedLayoutBoxes to find the last
(Inherited from DocumentElement.)
Public propertyLayoutMode
Gets or sets a value representing the current layout mode.
Public propertyLineBreakingRuleLanguage
Gets or sets the language which rules should be used for line breaking in the paragraphs.
Public propertyLineSpacing
Gets or set the line spacing of this document.
Public propertyLineSpacingType
Gets or set the line spacing type of this document.
Public propertyListManager
Public propertyLists
Public propertyListStyles
Public propertyMailMergeDataSource
Public propertyNextSibling (Inherited from DocumentElement.)
Public propertyNoLineBreaksAfterRule
Gets or sets a rule determining which characters cannot end a line in East-Asian languages.
Public propertyNoLineBreaksBeforeRule
Gets or sets a rule determining which characters cannot start a line in East-Asian languages.
Public propertyOriginalProperties (Inherited from DocumentElement.)
Public propertyPageViewMargin Obsolete.
Deprecated.
Public propertyParagraphDefaultSpacingAfter
Gets or sets the default spacing after a paragraph.
Public propertyParagraphDefaultSpacingBefore
Gets or sets the default spacing before a paragraph.
Public propertyParent (Inherited from DocumentElement.)
Public propertyPreviousSibling (Inherited from DocumentElement.)
Public propertyPropertyFilter
Gets or sets a Filter instance, used to filter the ICustomPropertyDescriptor.GetProperties collection.
(Inherited from RadObject.)
Public propertyPropertyValues
Gets a collection containing property values.
(Inherited from RadObject.)
Public propertyProtectionSettings
Public propertyRadObjectType
Gets the RadObjectType which is associated with this system type.
(Inherited from RadObject.)
Public propertyRevisionInfo (Inherited from DocumentElement.)
Public propertySectionDefaultPageMargin
Gets or sets the default section page margin.
Public propertySectionDefaultPageOrientation
Gets or sets the default section page orientation
Public propertySectionDefaultPageSize
Gets or sets the default section page size.
Public propertySections
Gets a collection with the sections of the document.
Public propertySelectedBibliographicStyle
Public propertySelectedBibliographicStyleName
Public propertySelection
Gets a value representing the document selection.
Public propertyShowBookmarks
Gets or sets a value whether to show bookmarks.
Public propertyShowFormattingSymbols
Gets or sets a value whether to show formatting symbols.
Public propertyShowMergeFieldsHighlight
Public propertyShowReadOnlyRangesHighlight
Public propertyStructureChangeInProgress
Gets a value whether a structure change is in progress.
Public propertyStyle
(Inherited from DocumentElement.)
Public propertyStyleName (Inherited from DocumentElement.)
Public propertyStyleRepository
Public propertyStyles
Public propertyTag
String property that allows developers to attach custom data to the DocumentElement. The value of this property will be copied to DocumentElements created out of this DocumentElement during editing.
(Inherited from DocumentElement.)
Public propertyTheme
Top
Methods
  NameDescription
Public methodAddCustomListStyle
Protected methodAddStylePropertySetting
Registers a style setting for this instance.
(Inherited from RadObject.)
Public methodArrange
Arranges the document.
Public methodBeginStylesUpdate
Public methodBeginUpdate
This method supports control infrastructure and is not intended for use directly from your code.
Public methodBindProperty
Binds the specified property to a property of the provided binding source object.
(Inherited from RadObject.)
Protected methodCallOnDocumentContentChanged
Protected methodCanRaisePropertyChangeNotifications
Determines whether the object can raise PropertyChanging and PropertyChanged notifications. Current implementation checks whether the object is disposing or is already disposed of.
(Inherited from RadObject.)
Public methodCanUnprotectDocument
Public methodChangeAllFieldsDisplayMode Obsolete.
Deprecated.
Public methodChangeBibliographicStyle Obsolete.
Deprecated.
Public methodChangeFieldDisplayMode Obsolete.
Deprecated.
Protected methodClearPropertyStore
Removes all references to external property modifiers such as property bindings, style settings and animations.
(Inherited from RadObject.)
Public methodClearValue (Inherited from DocumentElement.)
Protected methodCoerceValue
Allows inheritors to force a coersion of the current calculated value for the given property.
(Inherited from RadObject.)
Public methodContainsAnnotationMarkersOfTypeT
Determines whether the document contains annotation markers of type T.
Public methodCopyPropertiesFrom (Inherited from DocumentElement.)
Protected methodCopyPropertiesFromOverride (Overrides DocumentElementCopyPropertiesFromOverride(DocumentElement).)
Public methodCopyPropertiesFromStyle (Inherited from DocumentElement.)
Public methodCreateDeepCopy (Overrides DocumentElementCreateDeepCopy.)
Protected methodCreateLayoutBox (Inherited from DocumentElement.)
Public methodCreateLayoutBox(DocumentStructureCollection) (Overrides DocumentElementCreateLayoutBox(DocumentStructureCollection).)
Protected methodCreateNewElementInstance (Overrides DocumentElementCreateNewElementInstance.)
Public methodCreateShallowCopy (Inherited from DocumentElement.)
Public methodDelete(Boolean) Obsolete.
Deprecated.
Public methodDelete(Boolean, DocumentPosition) Obsolete.
Deprecated.
Public methodDeleteAtDocumentPosition Obsolete.
Deprecated.
Public methodDeleteBookmark(String) Obsolete.
Deprecated.
Public methodDeleteBookmark(BookmarkRangeStart) Obsolete.
Deprecated.
Public methodDeleteComment Obsolete.
Deprecated.
Public methodDeleteCustomAnnotationRange Obsolete.
Deprecated.
Public methodDeletePermissionRange Obsolete.
Deprecated.
Public methodDeleteRange Obsolete.
Deprecated.
Public methodDeleteReadOnlyRange Obsolete.
Deprecated.
Public methodDispose
Releases all resources associated with this object.
(Inherited from DisposableObject.)
Protected methodDispose(Boolean)
Performs the actual Dispose logic.
(Inherited from DisposableObject.)
Protected methodDisposeManagedResources
(Inherited from RadObject.)
Protected methodDisposeUnmanagedResources
Releases any UNMANAGED resources used by this object. NOTE: If you declare some unmanaged resources in your class, you should override its finalizer and put disposing logic there also.
(Inherited from DisposableObject.)
Public methodEndStylesUpdate
Public methodEndUpdate
This method supports control infrastructure and is not intended for use directly from your code.
Public methodEnsureDocumentMeasuredAndArranged
Ensures document layout is performed and layout-boxes have been created.
Public methodEnumerateChildrenOfTypeT (Inherited from DocumentElement.)
Public methodExtractStyleFromLocalProperties (Inherited from DocumentElement.)
Public methodExtractStyleFromProperties (Inherited from DocumentElement.)
Public methodGetAllBookmarks
Public methodGetAllPermissionInfos
Public methodGetAllRevisions
Gets all revisions.
Public methodGetAnnotationMarkersOfTypeT
Gets all annotation markers of type T in the document.
Public methodGetAssociatedLayoutBoxes (Inherited from DocumentElement.)
Public methodGetBibliographicSource
Tries to find a Bibliographic Source in the document. Returns null if none is found.
Protected methodGetBitState
Gets the current bit state for the object, defined by the provided key.
(Inherited from DisposableObject.)
Public methodGetBookmarkByName
Public methodGetCommentRangeStartByComment
Gets the comment range start by comment.
Public methodGetContainingAnnotationRangesTRangeStart(HierarchicalIndex, HierarchicalIndex)
Public methodGetContainingAnnotationRangesTRangeStart(Inline, Boolean)
Gets the annotation ranges of type TRangeStart surrounding an inline.
Public methodGetContainingAnnotationRangesTRangeStart(Inline, PredicateTRangeStart, Boolean)
Gets the annotation ranges of type TRangeStart surrounding an inline that match a condition.
Public methodGetCurrentPermissions
Public methodGetCurrentRevision
Gets the current revision.
Protected methodGetDefaultValue
Allows inheritors to provide custom default value.
(Inherited from RadObject.)
Protected methodGetInheritedValue
Searches up in the chain of InheritanceParents for a value for the specified property.
(Inherited from RadObject.)
Public methodGetLayoutBoxByPosition
Gets a layout box that intersects with a position.
Public methodGetNextComment
Gets the next comment.
Public methodGetNextRevision
Gets the next revision.
Public methodGetParentOfTypeT (Inherited from DocumentElement.)
Public methodGetPermissions
Public methodGetPreviousComment
Gets the previous comment.
Public methodGetPreviousRevision
Gets the previous revision.
Public methodGetPropertyValue
Gets the RadPropertyValue structure that holds information about the specified property's effective value for this instance. May be null if no effective value is recorded.
(Inherited from RadObject.)
Public methodGetPropertyValueSource (Inherited from DocumentElement.)
Public methodGetRegisteredRadProperty
Gets the registered property with the specified name.
(Inherited from RadObject.)
Public methodGetRootDocument (Inherited from DocumentElement.)
Public methodGetStatisticsInfo
Gets the statistical information about the document.
Public methodGetStyleProperty(String) (Inherited from DocumentElement.)
Public methodGetStyleProperty(IStylePropertyDefinition) (Inherited from DocumentElement.)
Public methodGetValue
Retrieves the current value for the specified property.
(Inherited from RadObject.)
Public methodGetValueSource
Gets the source of the current value for the specified property.
(Inherited from RadObject.)
Public methodGoToBookmark(String)
Public methodGoToBookmark(BookmarkRangeStart)
Public methodGoToComment(Comment)
Selects comment.
Public methodGoToComment(CommentRangeStart)
Selects comment.
Public methodGoToNextComment
Selects next comment.
Public methodGoToNextEndnote
Moves current position to the next endnote.
Public methodGoToNextFootnote
Moves current position to the next footnote.
Public methodGoToNextRevision
Selects next revision.
Public methodGoToPreviousComment
Selects previous comment.
Public methodGoToPreviousEndnote
Moves current position to the previous endnote.
Public methodGoToPreviousFootnote
Moves current position to the previous footnote.
Public methodGoToPreviousRevision
Selects previous revision.
Public methodGoToRevision
Selects revision.
Public methodInsert(String, StyleDefinition) Obsolete.
Deprecated.
Public methodInsert(String, StyleDefinition, DocumentPosition) Obsolete.
Deprecated.
Public methodInsertBookmark Obsolete.
Deprecated.
Public methodInsertComment(Comment) Obsolete.
Deprecated.
Public methodInsertComment(DocumentPosition, DocumentPosition, Comment) Obsolete.
Deprecated.
Public methodInsertCustomAnnotationRange Obsolete.
Deprecated.
Public methodInsertEndnote Obsolete.
Deprecated.
Public methodInsertEndnote(Note) Obsolete.
Deprecated.
Public methodInsertField(Field) Obsolete.
Deprecated.
Public methodInsertField(Field, FieldDisplayMode) Obsolete.
Deprecated.
Public methodInsertFootnote Obsolete.
Deprecated.
Public methodInsertFootnote(Note) Obsolete.
Deprecated.
Public methodInsertFragment(DocumentFragment) Obsolete.
Deprecated.
Public methodInsertFragment(DocumentFragment, DocumentPosition) Obsolete.
Inserts a document fragment into the document.
Public methodInsertHyperlink(HyperlinkInfo, IEnumerableInline) Obsolete.
Deprecated.
Public methodInsertHyperlink(DocumentPosition, DocumentPosition, HyperlinkInfo) Obsolete.
Deprecated.
Public methodInsertInline(Inline) Obsolete.
Deprecated.
Public methodInsertInline(Inline, DocumentPosition) Obsolete.
Inserts an inline element into the document.
Public methodInsertLineBreak Obsolete.
Deprecated.
Public methodInsertPageBreak Obsolete.
Deprecated.
Public methodInsertPermissionRange Obsolete.
Deprecated.
Public methodInsertReadOnlyRange Obsolete.
Deprecated.
Public methodInsertSectionBreak Obsolete.
Deprecated.
Protected methodInvalidateAssociatedBoxesArrange (Inherited from DocumentElement.)
Public methodInvalidateAssociatedBoxesLayout (Inherited from DocumentElement.)
Protected methodInvalidateAssociatedBoxesMeasure (Inherited from DocumentElement.)
Public methodIsInAnnotationRangeTRangeStart(Inline, Boolean)
Determines whether the specified inline is in annotation range of type TRangeStart.
Public methodIsInAnnotationRangeTRangeStart(Inline, PredicateTRangeStart, Boolean)
Determines whether the specified inline is in annotation range of type TRangeStart that matches a condition.
Protected methodIsPropertyCancelable
Determines whether the specified property may be canceled.
(Inherited from RadObject.)
Public methodMailMerge
Public methodMailMergeCurrentRecord
Public methodMeasure
Measures the document.
Public methodMeasureAndArrangeInDefaultSize
Forces document layout update, measuring document in RadDocument.MAX_DOCUMENT_SIZE
Public methodMergeSpansWithSameStyles
Merges adjacent spans with same style properties into one.
Protected methodOnBitStateChanged
Notifies the object for a change in its bit state.
(Inherited from DisposableObject.)
Protected methodOnDocumentArranged
Protected methodOnDocumentContentChanged
Protected methodOnLayoutModeChanged
Protected methodOnMergeFieldToStringConverting
Protected methodOnNotifyPropertyChanged(PropertyChangedEventArgs)
Raises the standard .NET PropertyChanged event.
(Inherited from RadObject.)
Protected methodOnNotifyPropertyChanged(String)
Raises the PropertyChanged event.
(Inherited from RadObject.)
Protected methodOnParentChanged (Inherited from DocumentElement.)
Protected methodOnParentChanging (Inherited from DocumentElement.)
Protected methodOnPresentationChanged
Raises the [E:PresentationChanged] event.
Protected methodOnPresentationChanging
Protected methodOnPropertyChanged
Raises the PropertyChanged event.
(Inherited from RadObject.)
Protected methodOnPropertyChanging
Raises the RadPropertyChanging event.
(Inherited from RadObject.)
Protected methodOnProtectionSettingsChanged
Protected methodOnRemoved (Inherited from DocumentElement.)
Protected methodOnRequestCurrentUserInfo
Protected methodOnStreamFromUriResolving
Protected methodOnStyleChanged (Overrides DocumentElementOnStyleChanged.)
Protected methodOnStyleChanging (Inherited from DocumentElement.)
Protected methodOnStylePropertyChanged (Inherited from DocumentElement.)
Protected methodOnUserAuthenticationRequest
Protected methodPerformDispose
Performs the core resources release logic.
(Inherited from DisposableObject.)
Public methodProtectDocument
Public methodRegisterDefaultHeadingStyles
Creates and registers the "Heading X" styles with the default settings.
Public methodRemoveStylePropertySetting(IPropertySetting)
Called when element style condition changes. This method is used internally.
(Inherited from RadObject.)
Public methodRemoveStylePropertySetting(RadProperty)
Called when element style condition changes. This method is used internally.
(Inherited from RadObject.)
Public methodResetValue(RadProperty)
Resets the current value of the specified property. This method will remove any effective value modifier (such as style or animation setting) for the specified property.
(Inherited from RadObject.)
Public methodResetValue(RadProperty, ValueResetFlags)
Resets the current value of the specified property using the provided flags.
(Inherited from RadObject.)
Protected methodResetValueCore
Resets the specified property value, using the provided reset flags.
(Inherited from RadObject.)
Public methodResumePropertyNotifications
Resumes property notifications after a previous SuspendPropertyNotifications call.
(Inherited from RadObject.)
Protected methodSetBitState
Applies the specified boolean value to the BitVector of the object.
(Inherited from DisposableObject.)
Public methodSetCurrentEditingSpanStyleName
Public methodSetDefaultValueOverride
Applies the provided value as an override of the Default value provided by the specified property's metadata.
(Inherited from RadObject.)
Public methodSetValue
Applies the provided value as Local for the specified property.
(Inherited from RadObject.)
Public methodSetValueAtDesignTime
Applies the specified value as Local for the desired property and raises the flag IsLocalValueSetAtDesignTime for that property. All design-time direct property modifications (e.g. item.Text = "Item1") should be done through this method for the property to be properly serialized. If a property is modified through a property grid, the custom property descriptor will automatically apply this logic. This method is used internally.
(Inherited from RadObject.)
Protected methodSetValueCore
Performs the core logic of updating property value.
(Inherited from RadObject.)
Public methodShouldSerializeProperty
Determines whether the property defined by the provided property descriptor should be serialized.
(Inherited from RadObject.)
Public methodSuspendPropertyNotifications
Allows PropertyChanging and PropertyChanged notifications to be temporary suspended.
(Inherited from RadObject.)
Public methodToggleFieldCodes Obsolete.
Deprecated.
Public methodUnbindProperty
Removes the binding for the specified property.
(Inherited from RadObject.)
Public methodUnprotectDocument
Public methodUpdateAllFields Obsolete.
Deprecated.
Public methodUpdateAllFields(FieldDisplayMode) Obsolete.
Deprecated.
Public methodUpdateField Obsolete.
Deprecated.
Public methodUpdateLayout
Forces the document to update its layout.
Public methodUpdatePermissionRanges Obsolete.
Deprecated.
Public methodUpdateSectionsStyle Obsolete.
Deprecated.
Public methodUpdateSelectedParagraphsStyle Obsolete.
Deprecated.
Public methodUpdateSelectedSectionsStyle Obsolete.
Deprecated.
Public methodUpdateSelectedSpansStyle Obsolete.
Deprecated.
Public methodUpdateStyles
Public methodUpdateValue
Forces re-evaluation of the current value for the specified property.
(Inherited from RadObject.)
Protected methodUpdateValueCore
Performs the core value update logic.
(Inherited from RadObject.)
Top
Events
  NameDescription
Public eventCommandExecuted
Public eventDisposed (Inherited from DisposableObject.)
Public eventDisposing (Inherited from DisposableObject.)
Public eventDocumentArranged
Occurs when the document has been arranged.
Public eventDocumentContentChanged
Public eventDocumentElementAdded
Occurs when when a document element is added in the whole document tree.
Public eventDocumentElementRemoved
Occurs when when a document element is removed from the whole document tree.
Public eventDocumentVariableEvaluating
Public eventHyperlinkClicked
Occurs when the users clicks on a hyperlink in the current document
Public eventLayoutModeChanged
Occurs when the LayoutMode property value has changed
Public eventMergeFieldToStringConverting
Public eventParentChanged (Inherited from DocumentElement.)
Public eventParentChanging (Inherited from DocumentElement.)
Public eventPresentationChanged
Occurs when document presentation is changed.
Public eventPresentationChanging
Occurs when the document presenter is changing.
Public eventPropertyChanged
Occurs when a property of an object changes. Note: if a property which is not a RadProperty changes, the developer is responsible for firing this event by using the INotifyPropertyChanged API.
(Inherited from RadObject.)
Public eventPropertyValueChanged (Inherited from DocumentElement.)
Public eventProtectionSettingsChanged
Public eventRadPropertyChanged
Occurs when a property of a RadObject changes.
(Inherited from RadObject.)
Public eventRadPropertyChanging
Occurs prior to property of a RadObject changes.
(Inherited from RadObject.)
Public eventRequestCurrentUserInfo
Public eventStreamFromUriResolving
Public eventStyleChanged (Inherited from DocumentElement.)
Public eventStyleChanging (Inherited from DocumentElement.)
Public eventStylePropertyChanged (Inherited from DocumentElement.)
Public eventUserAuthenticationRequest
Top
Fields
Extension Methods
  NameDescription
Public Extension MethodCheckAccessOverloaded. (Defined by DispatcherExtensions.)
Public Extension MethodCheckAccessOverloaded. (Defined by DispatcherExtensions.)
Public Extension MethodCheckAccessOverloaded. (Defined by DispatcherExtensions.)
Public Extension MethodClearIfNoBindingAndSet
Clears if set.
(Defined by CommonExtensions.)
Public Extension MethodClearIfSet
Clears the property if a value has been set.
(Defined by CommonExtensions.)
Public Extension MethodIsLocalValueSet
Determines whether the specified dependency property local value is set.
(Defined by CommonExtensions.)
Public Extension MethodSetIfDifferent
Sets the value of the dependencyProperty property if it's hasn't that value currently.
(Defined by CommonExtensions.)
Top
See Also