Class RadRichTextBox

A feature-rich text editing control that provides comprehensive text formatting, document navigation, mail merge, and printing functionality. Supports multiple document formats including DOCX, RTF, HTML, and PDF.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
UIElement
FrameworkElement
RadRichTextBox
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.RichTextEditor
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class RadRichTextBox : FrameworkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop, IDocumentEditorPresenterContainer, IDocumentEditor, ITextInputCommandsHandler, IPrintable

Constructors

RadRichTextBox()

Initializes a new instance of the RadRichTextBox class with default settings. Sets up document providers, input handling, default styles, and initializes the document.

Declaration
public RadRichTextBox()

Fields

AcceptsReturnProperty

Declaration
public static readonly RadProperty AcceptsReturnProperty
Field Value
RadProperty

AcceptsTabProperty

Declaration
public static readonly RadProperty AcceptsTabProperty
Field Value
RadProperty

AllowScalingProperty

Declaration
public static readonly RadProperty AllowScalingProperty
Field Value
RadProperty

BorderColorProperty

Declaration
public static readonly RadProperty BorderColorProperty
Field Value
RadProperty

CaretColorProperty

Declaration
public static readonly RadProperty CaretColorProperty
Field Value
RadProperty

CommandsProperty

Declaration
public static readonly RadProperty CommandsProperty
Field Value
RadProperty

CommentTemplateContentMarginProperty

Declaration
public static readonly RadProperty CommentTemplateContentMarginProperty
Field Value
RadProperty

CurrentUserProperty

Declaration
public static readonly RadProperty CurrentUserProperty
Field Value
RadProperty

DocumentInheritsDefaultStyleSettingsProperty

Declaration
public static readonly RadProperty DocumentInheritsDefaultStyleSettingsProperty
Field Value
RadProperty

EnforcedPermissionRangeBrushProperty

Declaration
public static readonly RadProperty EnforcedPermissionRangeBrushProperty
Field Value
RadProperty

HorizontalScrollBarHeightProperty

Declaration
public static readonly RadProperty HorizontalScrollBarHeightProperty
Field Value
RadProperty

HorizontalScrollBarName

Declaration
public const string HorizontalScrollBarName = "HorizontalScrollBar"
Field Value
System.String

HorizontalScrollBarVisibilityProperty

Declaration
public static readonly RadProperty HorizontalScrollBarVisibilityProperty
Field Value
RadProperty

HyperlinkNavigationModeProperty

Declaration
public static readonly RadProperty HyperlinkNavigationModeProperty
Field Value
RadProperty

HyperlinkToolTipFormatStringProperty

Declaration
public static readonly RadProperty HyperlinkToolTipFormatStringProperty
Field Value
RadProperty

IsAdvancedSelectionEnabledProperty

Declaration
public static readonly RadProperty IsAdvancedSelectionEnabledProperty
Field Value
RadProperty

IsContextMenuEnabledProperty

Declaration
public static readonly RadProperty IsContextMenuEnabledProperty
Field Value
RadProperty

IsImageMiniToolBarEnabledProperty

Declaration
public static readonly RadProperty IsImageMiniToolBarEnabledProperty
Field Value
RadProperty

IsPasteOptionsPopupEnabledProperty

Declaration
public static readonly RadProperty IsPasteOptionsPopupEnabledProperty
Field Value
RadProperty

IsReadOnlyProperty

Declaration
public static readonly RadProperty IsReadOnlyProperty
Field Value
RadProperty

IsSelectionEnabledProperty

Declaration
public static readonly RadProperty IsSelectionEnabledProperty
Field Value
RadProperty

IsSelectionMiniToolBarEnabledProperty

Declaration
public static readonly RadProperty IsSelectionMiniToolBarEnabledProperty
Field Value
RadProperty

IsSpellCheckingEnabledProperty

Declaration
public static readonly RadProperty IsSpellCheckingEnabledProperty
Field Value
RadProperty

IsTrackChangesEnabledProperty

Declaration
public static readonly RadProperty IsTrackChangesEnabledProperty
Field Value
RadProperty

LayoutModeProperty

Declaration
public static readonly RadProperty LayoutModeProperty
Field Value
RadProperty

LineBreakingRuleLanguageProperty

Declaration
public static readonly RadProperty LineBreakingRuleLanguageProperty
Field Value
RadProperty

MaxScaleFactor

Represents the maximum scale factor the control supports for document zoom operations. The scale factor cannot be set above this value to maintain performance.

Declaration
public static readonly double MaxScaleFactor
Field Value
System.Double

MeasuringPanelName

Declaration
public const string MeasuringPanelName = "MeasuringPanel"
Field Value
System.String

MinScaleFactor

Represents the minimum scale factor the control supports for document zoom operations. The scale factor cannot be set below this value to maintain readability.

Declaration
public static readonly double MinScaleFactor
Field Value
System.Double

PrintingScreenName

Declaration
public const string PrintingScreenName = "PrintingScreen"
Field Value
System.String

ProtectionAuthenticationProviderProperty

Declaration
public static readonly RadProperty ProtectionAuthenticationProviderProperty
Field Value
RadProperty

ScaleFactorProperty

Declaration
public static readonly RadProperty ScaleFactorProperty
Field Value
RadProperty

SelectionFillColorProperty

Declaration
public static readonly RadProperty SelectionFillColorProperty
Field Value
RadProperty

SelectionFillProperty

Declaration
public static readonly RadProperty SelectionFillProperty
Field Value
RadProperty

SelectionStrokeColorProperty

Declaration
public static readonly RadProperty SelectionStrokeColorProperty
Field Value
RadProperty

SelectionStrokeProperty

Declaration
public static readonly RadProperty SelectionStrokeProperty
Field Value
RadProperty

ShowCommentsProperty

Declaration
public static readonly RadProperty ShowCommentsProperty
Field Value
RadProperty

ShowFormattingSymbolsProperty

Declaration
public static readonly RadProperty ShowFormattingSymbolsProperty
Field Value
RadProperty

ShowMergeFieldsHighlightProperty

Declaration
public static readonly RadProperty ShowMergeFieldsHighlightProperty
Field Value
RadProperty

VerticalScrollBarName

Declaration
public const string VerticalScrollBarName = "VerticalScrollBar"
Field Value
System.String

VerticalScrollBarVisibilityProperty

Declaration
public static readonly RadProperty VerticalScrollBarVisibilityProperty
Field Value
RadProperty

VerticalScrollBarWidthProperty

Declaration
public static readonly RadProperty VerticalScrollBarWidthProperty
Field Value
RadProperty

ViewContentPresenter

Declaration
public const string ViewContentPresenter = "ViewPresenter"
Field Value
System.String

Properties

AcceptsReturn

Gets or sets a value indicating whether pressing the RETURN key types a RETURN character in the control.

Declaration
public bool AcceptsReturn { get; set; }
Property Value
System.Boolean

Implements

AcceptsTab

Gets or sets a value indicating whether pressing the TAB key types a TAB character in the control instead of moving the focus to the next control in the tab order.

Declaration
public bool AcceptsTab { get; set; }
Property Value
System.Boolean

Implements

ActiveDocumentEditor

Gets the currently active editor.

Declaration
public IDocumentEditor ActiveDocumentEditor { get; }
Property Value
IDocumentEditor

ActiveEditor

Gets the currently active editor instance when using master-detail document scenarios. This is typically used in more complex document editing scenarios where multiple editor instances work together.

Declaration
public RadRichTextBox ActiveEditor { get; }
Property Value
RadRichTextBox

ActiveEditorPresenter

Gets or sets a value representing the active document presenter.

Declaration
public IDocumentEditorPresenter ActiveEditorPresenter { get; set; }
Property Value
IDocumentEditorPresenter

AddNewBibliographicSourceDialog

Gets or sets the dialog for adding bibliographic sources.

Declaration
public IAddNewBibliographicSourceDialog AddNewBibliographicSourceDialog { get; set; }
Property Value
IAddNewBibliographicSourceDialog

AllowScaling

Gets or sets a value indicating whether the scaling is enabled.

Declaration
public bool AllowScaling { get; set; }
Property Value
System.Boolean

Implements

BorderColor

Declaration
[VsbBrowsable(true)]
public Color BorderColor { get; set; }
Property Value
System.Drawing.Color

CaretColor

Gets or sets the color of the caret.

Declaration
public Color CaretColor { get; set; }
Property Value
Color

Implements

CaretFactory

Gets or sets an instance implementing ICaretFactory

Declaration
public ICaretFactory CaretFactory { get; set; }
Property Value
ICaretFactory

Implements

CaretWidth

Gets or sets the width of the caret.

Declaration
public float CaretWidth { get; set; }
Property Value
System.Single

ChangeEditingPermissionsDialog

Gets or sets the dialog for changing editing permissions of the document.

Declaration
public IChangeEditingPermissionsDialog ChangeEditingPermissionsDialog { get; set; }
Property Value
IChangeEditingPermissionsDialog

CheckBoxPropertiesDialog

Gets or sets a value representing the current dialog for editing CheckBox content control properties.

Declaration
public ICheckBoxPropertiesDialog CheckBoxPropertiesDialog { get; set; }
Property Value
ICheckBoxPropertiesDialog

CodeFormattingDialog

Gets or sets the dialog for formatting code blocks.

Declaration
public ICodeFormattingDialog CodeFormattingDialog { get; set; }
Property Value
ICodeFormattingDialog

Commands

Gets or sets a collection of commands that can be executed.

Declaration
public RichTextBoxCommands Commands { get; set; }
Property Value
RichTextBoxCommands

CommentPaneMinWidth

Gets or sets the minimum width of the panel containing comments.

Declaration
public double CommentPaneMinWidth { get; set; }
Property Value
System.Double

Implements

CommentTemplateContentMargin

Gets or sets the comment template content margin.

Declaration
public Thickness CommentTemplateContentMargin { get; set; }
Property Value
Thickness

Implements

ContextMenu

Gets or sets the context menu.

Declaration
public IContextMenu ContextMenu { get; set; }
Property Value
IContextMenu

CurrentEditingContext

Gets the current editing context which provides information about the document's editing state and active operations like selection, search, or special editing modes.

Declaration
public EditingContext CurrentEditingContext { get; }
Property Value
EditingContext

Implements

CurrentEditingStyle

Gets a value indicating the current editing style.

Declaration
public StyleDefinition CurrentEditingStyle { get; }
Property Value
StyleDefinition

Implements

CurrentParagraphStyle

Gets a paragraph object containing the style settings of the current paragraph.

Declaration
public Paragraph CurrentParagraphStyle { get; }
Property Value
Paragraph

CurrentSpanStyle

Gets a span object containing the style settings of the current span.

Declaration
public Span CurrentSpanStyle { get; }
Property Value
Span

CurrentUser

Gets or sets the currently active user.

Declaration
public UserInfo CurrentUser { get; set; }
Property Value
UserInfo

CurrentVisiblePage

Gets the index of the currently visible page.

Declaration
public int CurrentVisiblePage { get; }
Property Value
System.Int32

DatePickerPropertiesDialog

Gets or sets a value representing the current dialog for editing DatePicker content control properties.

Declaration
public IDatePickerPropertiesDialog DatePickerPropertiesDialog { get; set; }
Property Value
IDatePickerPropertiesDialog

DefaultTextRenderingMode

Declaration
public static TextBlockRenderingMode DefaultTextRenderingMode { get; set; }
Property Value
TextBlockRenderingMode

Document

Gets or sets the currently active document in the editor. This is the main document that contains all the content and formatting being edited. Changing this property will raise the DocumentChanging and DocumentChanged events.

Declaration
public RadDocument Document { get; set; }
Property Value
RadDocument

The RadDocument instance that contains the document's content and formatting.
Implements

DocumentInheritsDefaultStyleSettings

Gets or sets value indicating whether the edited Document instance should use by default the FontFamily, FontSize, ForeColor and other style properties applied to this RadRichTextBox using the DefaultStyleSettings.

Declaration
public bool DocumentInheritsDefaultStyleSettings { get; set; }
Property Value
System.Boolean

DropDownListPropertiesDialog

Gets or sets a value representing the current dialog for editing DropDownList content control properties.

Declaration
public IDropDownListPropertiesDialog DropDownListPropertiesDialog { get; set; }
Property Value
IDropDownListPropertiesDialog

EditCustomDictionaryDialog

Gets or sets the dialog for editing custom dictionaries.

Declaration
public IEditCustomDictionaryDialog EditCustomDictionaryDialog { get; set; }
Property Value
IEditCustomDictionaryDialog

EmailPattern

Gets or sets the pattern used for matching emails

Declaration
public string EmailPattern { get; set; }
Property Value
System.String

Implements

EnforcedPermissionRangeBrush

Gets or sets the brush used to visually highlight text ranges with enforced permissions in the document.

Declaration
public Brush EnforcedPermissionRangeBrush { get; set; }
Property Value
System.Drawing.Brush

Implements

FieldShadingMode

Gets or sets the field shading type/

Declaration
public FieldShadingType FieldShadingMode { get; set; }
Property Value
FieldShadingType

Implements

FindReplaceDialog

Gets or sets the find and replace dialog.

Declaration
public IFindReplaceDialog FindReplaceDialog { get; set; }
Property Value
IFindReplaceDialog

FloatingBlockPropertiesDialog

Gets or sets the dialog for editing floating block properties.

Declaration
public IFloatingBlockPropertiesDialog FloatingBlockPropertiesDialog { get; set; }
Property Value
IFloatingBlockPropertiesDialog

FlowDirection

Gets or sets the direction of flow of the elements.

Declaration
public override FlowDirection FlowDirection { get; }
Property Value
FlowDirection

Overrides

FontPropertiesDialog

Gets or sets the dialog for editing font properties.

Declaration
public IFontPropertiesDialog FontPropertiesDialog { get; set; }
Property Value
IFontPropertiesDialog

HorizontalScrollBar

Gets the horizontal scroll bar of the RadRichTextBox

Declaration
public RadScrollBarElement HorizontalScrollBar { get; }
Property Value
RadScrollBarElement

HorizontalScrollBarHeight

Gets or sets the height of the horizontal scroll bar.

Declaration
public int HorizontalScrollBarHeight { get; set; }
Property Value
System.Int32

HorizontalScrollBarVisibility

Gets or sets a value representing the horizontal scroll bar visibility.

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
ScrollBarVisibility

HyperlinkNavigationMode

Gets or sets the hyperlink navigation mode.

Declaration
public HyperlinkNavigationMode HyperlinkNavigationMode { get; set; }
Property Value
HyperlinkNavigationMode

The hyperlink navigation mode.

HyperlinkPattern

Gets or sets the pattern used for matching hyperlinks

Declaration
public string HyperlinkPattern { get; set; }
Property Value
System.String

Implements

HyperlinkToolTipFormatString

Gets or sets the hyperlink tool text.

Declaration
public string HyperlinkToolTipFormatString { get; set; }
Property Value
System.String

The hyperlink tool tip.

IgnoredWords

Gets or sets an instance of IIgnoredWordDictionary that provides a list of words that would be ignored by spell checker.

Declaration
public IIgnoredWordDictionary IgnoredWords { get; set; }
Property Value
IIgnoredWordDictionary

Implements
See Also

ImageEditorDialog

Gets or sets the dialog for editing images.

Declaration
public IImageEditorDialog ImageEditorDialog { get; set; }
Property Value
IImageEditorDialog

ImageMiniToolBar

Gets or sets the image mini toolbar.

Declaration
public IImageMiniToolBar ImageMiniToolBar { get; set; }
Property Value
IImageMiniToolBar

ImageSelectionAdornerSettings

Gets an object containing the options available for the Image selection adorner.

Declaration
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }
Property Value
ImageSelectionAdornerSettings

Implements

InputHandler

Gets or sets an instance of RichTextEditorInputBehavior that will handle user input.

Declaration
public RichTextEditorInputBehavior InputHandler { get; set; }
Property Value
RichTextEditorInputBehavior

InsertCaptionDialog

Gets or sets the dialog for inserting captions.

Declaration
public IInsertCaptionDialog InsertCaptionDialog { get; set; }
Property Value
IInsertCaptionDialog

InsertCrossReferenceWindow

Gets or sets the dialog for inserting cross-reference windows.

Declaration
public IInsertCrossReferenceWindow InsertCrossReferenceWindow { get; set; }
Property Value
IInsertCrossReferenceWindow

InsertDateTimeDialog

Gets or sets the dialog for inserting date time values.

Declaration
public IInsertDateTimeDialog InsertDateTimeDialog { get; set; }
Property Value
IInsertDateTimeDialog

InsertHyperlinkDialog

Gets or sets the dialog for inserting hyperlinks in the document.

Declaration
public IInsertHyperlinkDialog InsertHyperlinkDialog { get; set; }
Property Value
IInsertHyperlinkDialog

InsertSymbolWindow

Gets or sets the dialog for inserting symbols in the document.

Declaration
public IInsertSymbolWindow InsertSymbolWindow { get; set; }
Property Value
IInsertSymbolWindow

InsertTableDialog

Gets or sets the dialog for inserting tables in the document.

Declaration
public IInsertTableDialog InsertTableDialog { get; set; }
Property Value
IInsertTableDialog

InsertTableOfContentsDialog

Gets or sets the dialog for inserting table of contents.

Declaration
public IInsertTableOfContentsDialog InsertTableOfContentsDialog { get; set; }
Property Value
IInsertTableOfContentsDialog

IsAdvancedSelectionEnabled

Gets or sets a value that indicates whether a the advanced selection mode is enabled. If so, when the cursor leaves the initial word the selection continues by expanding with a whole word every time until the cursor moves in the opposite direction. When the cursor returns to the initial word the selection continues to expand one character at a time. More about this behavior can be learned in the documentation.

Declaration
public bool IsAdvancedSelectionEnabled { get; set; }
Property Value
System.Boolean

IsContextMenuEnabled

Gets or sets a value indicating whether context menu is enabled.

Declaration
public bool IsContextMenuEnabled { get; set; }
Property Value
System.Boolean

IsImageMiniToolBarEnabled

Gets or sets a value indicating whether the mini toolbar that appears when an image is selected is enabled. NOTE: not supported for WinForms

Declaration
public bool IsImageMiniToolBarEnabled { get; set; }
Property Value
System.Boolean

IsInHeaderFooterEditMode

Gets or sets a value indicating whether the editor is currently in Header/Footer edit mode.

Declaration
public bool IsInHeaderFooterEditMode { get; set; }
Property Value
System.Boolean

Implements

IsPasteOptionsPopupEnabled

Gets or sets a value indicating whether the paste options popup is displayed on paste.

Declaration
public bool IsPasteOptionsPopupEnabled { get; set; }
Property Value
System.Boolean

true if this instance is paste options popup enabled; otherwise, false.

IsReadOnly

Gets or sets a value indicating whether the control is read-only. When true, users can still navigate through the document, copy content, and perform search operations, but editing operations are disabled. This property is useful for documents intended for display only.

Declaration
public bool IsReadOnly { get; set; }
Property Value
System.Boolean

True if the document is in read-only mode; otherwise, false.
Implements

IsSelectionEnabled

Gets or sets a value indicating whether selection can be made in the document.

Declaration
public bool IsSelectionEnabled { get; set; }
Property Value
System.Boolean

IsSelectionMiniToolBarEnabled

Gets or sets a value indicating whether the mini toolbar that appears after a selection is enabled.

Declaration
public bool IsSelectionMiniToolBarEnabled { get; set; }
Property Value
System.Boolean

IsSpellCheckingEnabled

Gets or sets a value indicating whether the spell checking is enabled for this document.

Declaration
public bool IsSpellCheckingEnabled { get; set; }
Property Value
System.Boolean

Implements

IsTrackChangesEnabled

Gets or sets a value indicating whether formatting symbols are shown in the document.

Declaration
public bool IsTrackChangesEnabled { get; set; }
Property Value
System.Boolean

true if formatting symbols are shown; otherwise, false.

LayoutMode

Gets or sets the document layout mode.

Declaration
public DocumentLayoutMode? LayoutMode { get; set; }
Property Value
System.Nullable<DocumentLayoutMode>

The document 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 characters rule language.

LineNumberingDialog

Gets or sets a value representing the current line numbering dialog.

Declaration
public ILineNumberingDialog LineNumberingDialog { get; set; }
Property Value
ILineNumberingDialog

ManageBibliographicSourcesDialog

Gets or sets the dialog for managing bibliographics sources.

Declaration
public IManageBibliographicSourcesDialog ManageBibliographicSourcesDialog { get; set; }
Property Value
IManageBibliographicSourcesDialog

ManageBookmarksDialog

Gets or sets the dialog for managing bookmarks in the document.

Declaration
public IManageBookmarksDialog ManageBookmarksDialog { get; set; }
Property Value
IManageBookmarksDialog

ManageStylesDialog

Gets or sets the dialog for managing styles.

Declaration
public IManageStylesDialog ManageStylesDialog { get; set; }
Property Value
IManageStylesDialog

MeasuringPanel

Declaration
public Panel MeasuringPanel { get; set; }
Property Value
Panel

MentionBox

Declaration
public IMentionBox MentionBox { get; set; }
Property Value
IMentionBox

MentionContext

Declaration
public MentionContext MentionContext { get; set; }
Property Value
MentionContext

NotesDialog

Gets or sets the dialog for editing footnotes and endnotes properties.

Declaration
public INotesDialog NotesDialog { get; set; }
Property Value
INotesDialog

PageBackColor

Gets or sets the back color that should be applied to all pages.

Declaration
public Color PageBackColor { get; set; }
Property Value
System.Drawing.Color

ParagraphPropertiesDialog

Gets or sets the dialog for editing paragraph properties.

Declaration
public IParagraphPropertiesDialog ParagraphPropertiesDialog { get; set; }
Property Value
IParagraphPropertiesDialog

PasteOptionsPopup

Declaration
public IPasteOptionsPopup PasteOptionsPopup { get; set; }
Property Value
IPasteOptionsPopup

PasteSettings

Gets the current PasteSettings associated with RadRichTextBox

Declaration
public PasteSettings PasteSettings { get; }
Property Value
PasteSettings

PicturePropertiesDialog

Gets or sets a value representing the current dialog for editing Picture content control properties.

Declaration
public IPicturePropertiesDialog PicturePropertiesDialog { get; set; }
Property Value
IPicturePropertiesDialog

PlainTextPropertiesDialog

Gets or sets a value representing the current dialog for editing PlainText content control properties.

Declaration
public IPlainTextPropertiesDialog PlainTextPropertiesDialog { get; set; }
Property Value
IPlainTextPropertiesDialog

ProtectDocumentDialog

Gets or sets the dialog for editing protection settings for the document.

Declaration
public IProtectDocumentDialog ProtectDocumentDialog { get; set; }
Property Value
IProtectDocumentDialog

ProtectionAuthenticationProvider

Gets or sets the Protection Authentication Provider

Declaration
public IProtectionAuthenticationProvider ProtectionAuthenticationProvider { get; set; }
Property Value
IProtectionAuthenticationProvider

RepeatingSectionPropertiesDialog

Gets or sets a value representing the current dialog for editing RepeatingSection content control properties.

Declaration
public IRepeatingSectionPropertiesDialog RepeatingSectionPropertiesDialog { get; set; }
Property Value
IRepeatingSectionPropertiesDialog

RichTextPropertiesDialog

Gets or sets a value representing the current dialog for editing RichText content control properties.

Declaration
public IRichTextPropertiesDialog RichTextPropertiesDialog { get; set; }
Property Value
IRichTextPropertiesDialog

ScaleFactor

Gets or sets a value representing the current view scale factor.

Declaration
public Size ScaleFactor { get; set; }
Property Value
Size

Implements

SectionColumnsDialog

Gets or sets a value representing the current section columns dialog.

Declaration
public ISectionColumnsDialog SectionColumnsDialog { get; set; }
Property Value
ISectionColumnsDialog

SelectedComment

Gets or sets the currently selected comment in the document. When a comment is selected, its content becomes visible in the comment area and can be edited if permissions allow. Setting this property will clear any current document selection.

Declaration
public Comment SelectedComment { get; set; }
Property Value
Comment

The currently selected Comment instance, or null if no comment is selected.
Implements

SelectedNote

Gets or sets the currently selected note.

Declaration
public Note SelectedNote { get; set; }
Property Value
Note

Implements

SelectionFill

Gets or sets the color of the selection rectangle.

Declaration
public Brush SelectionFill { get; set; }
Property Value
System.Drawing.Brush

Implements

SelectionFillColor

Declaration
[VsbBrowsable(true)]
public Color SelectionFillColor { get; set; }
Property Value
System.Drawing.Color

SelectionMiniToolBar

Gets or sets the selection mini toolbar.

Declaration
public ISelectionMiniToolBar SelectionMiniToolBar { get; set; }
Property Value
ISelectionMiniToolBar

SelectionStroke

Gets or sets the brush for the selection rectangle border.

Declaration
public Brush SelectionStroke { get; set; }
Property Value
System.Drawing.Brush

Implements

SelectionStrokeColor

Declaration
[VsbBrowsable(true)]
public Color SelectionStrokeColor { get; set; }
Property Value
System.Drawing.Color

SetNumberingValueDialog

Gets or sets the dialog for setting numbering values.

Declaration
public ISetNumberingValueDialog SetNumberingValueDialog { get; set; }
Property Value
ISetNumberingValueDialog

ShouldChangeIconsOnThemeChange

Gets or sets a value indicating whether the control's icons should change when the theme changes.

Declaration
public virtual bool ShouldChangeIconsOnThemeChange { get; set; }
Property Value
System.Boolean

ShowComments

Gets or sets a value indicating whether the comments are shown.

Declaration
public bool ShowComments { get; set; }
Property Value
System.Boolean

Implements

ShowFormattingSymbols

Gets or sets a value indicating whether formatting symbols are shown in the document.

Declaration
public bool ShowFormattingSymbols { get; set; }
Property Value
System.Boolean

true if formatting symbols are shown; otherwise, false.
Implements

ShowMergeFieldsHighlight

Gets or sets a value indicating whether Merge Fields will be highlighted.

Declaration
public bool ShowMergeFieldsHighlight { get; set; }
Property Value
System.Boolean

SpellChecker

Gets or sets the ISpellChecker implementation used when proofing.

Declaration
public ISpellChecker SpellChecker { get; set; }
Property Value
ISpellChecker

Implements

SpellCheckingDialog

Gets or sets the dialog for spell checking.

Declaration
public ISpellCheckingDialog SpellCheckingDialog { get; set; }
Property Value
ISpellCheckingDialog

StyleFormattingPropertiesDialog

Gets or sets the dialog for editing style properties.

Declaration
public IStyleFormattingPropertiesDialog StyleFormattingPropertiesDialog { get; set; }
Property Value
IStyleFormattingPropertiesDialog

TableBordersDialog

Gets or sets the dialog for editing table borders.

Declaration
public ITableBordersDialog TableBordersDialog { get; set; }
Property Value
ITableBordersDialog

TablePropertiesDialog

Gets or sets the dialog for editing table properties.

Declaration
public ITablePropertiesDialog TablePropertiesDialog { get; set; }
Property Value
ITablePropertiesDialog

TabStopsPropertiesDialog

Gets or sets the dialog for editing tab stop properties.

Declaration
public ITabStopsPropertiesDialog TabStopsPropertiesDialog { get; set; }
Property Value
ITabStopsPropertiesDialog

TrackChangesOptions

Gets the object containing options available for Track changes.

Declaration
public TrackChangesOptions TrackChangesOptions { get; }
Property Value
TrackChangesOptions

UILayersBuilder

Gets or sets an instance of UILayersBuilder.

Declaration
public UILayersBuilder UILayersBuilder { get; set; }
Property Value
UILayersBuilder

Implements

UnprotectDocumentDialog

Gets or sets the dialog for removing protection restrictions on the document.

Declaration
public IUnprotectDocumentDialog UnprotectDocumentDialog { get; set; }
Property Value
IUnprotectDocumentDialog

Users

Gets or sets a collection containing the users' permissions on the current document.

Declaration
public PermissionInfoCollection Users { get; set; }
Property Value
PermissionInfoCollection

VerticalScrollBar

Gets the vertical scroll bar of the RadRichTextBox

Declaration
public RadScrollBarElement VerticalScrollBar { get; }
Property Value
RadScrollBarElement

VerticalScrollBarVisibility

Gets or sets a value representing the vertical scroll bar visibility.

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
ScrollBarVisibility

VerticalScrollBarWidth

Gets or sets the width of the vertical scroll bar.

Declaration
public int VerticalScrollBarWidth { get; set; }
Property Value
System.Int32

WatermarkSettingsDialog

Gets or sets the dialog for editing watermark settings.

Declaration
public IWatermarkSettingsDialog WatermarkSettingsDialog { get; set; }
Property Value
IWatermarkSettingsDialog

Methods

AcceptAllRevisions()

Accepts all revisions in the current document.

Declaration
public void AcceptAllRevisions()
Implements

AcceptRevision(Revision)

Accepts revision.

Declaration
public void AcceptRevision(Revision revision)
Parameters
Revision revision

The revision.
Implements

AddTabStop(TabStop)

Adds a tab stop at the current position in the document.

Declaration
public void AddTabStop(TabStop tabStop)
Parameters
TabStop tabStop

The tab stop to add.
Implements

AddTabStopRange(IEnumerable<TabStop>)

Adds the enumeration of tab stops.

Declaration
public void AddTabStopRange(IEnumerable<TabStop> tabStops)
Parameters
System.Collections.Generic.IEnumerable<TabStop> tabStops

The tab stops to add.
Implements

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BeginUndoGroup()

Begins new undo group.

Declaration
public void BeginUndoGroup()
Implements

CancelUndoGroup()

Cancels current undo group.

Declaration
public void CancelUndoGroup()
Implements

CanCopyFormatting()

Returns a value indicating whether the formatting can be copied according to the current selection.

Declaration
public bool CanCopyFormatting()
Returns
System.Boolean

The value indicating whether the formatting can be copied.

ChangeAllFieldsDisplayMode(FieldDisplayMode)

Changes the display mode of all fields in the document.

Declaration
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

The display mode.
Implements

ChangeBaselineAlignment(BaselineAlignment)

Changes the baseline alignment of the current run in the document.

Declaration
public void ChangeBaselineAlignment(BaselineAlignment newBaselineAlignment)
Parameters
BaselineAlignment newBaselineAlignment

The new baseline alignment to be applied.
Implements

ChangeBibliographicStyle(BibliographicReferenceStyleBase)

Changes the bibliographic style of all bibliography related fields in the document.

Declaration
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)
Parameters
BibliographicReferenceStyleBase newBibliographicStyle

The new bibliographic style.
Implements

ChangeDifferentFirstPageHeaderFooter(Boolean)

Sets a value indicating whether the first page header and footer would be different than the rest of the pages.

Declaration
public void ChangeDifferentFirstPageHeaderFooter(bool value)
Parameters
System.Boolean value

true if the header and footer will be different, otherwise false.
Implements

ChangeDifferentOddAndEvenPagesHeaderFooter(Boolean)

Sets a value indicating whether even and odd pages headers and footers would be different.

Declaration
public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)
Parameters
System.Boolean value

true if the headers and footers will be different, otherwise false.
Implements

ChangeDocumentDefaultTabWidth(Double)

Changes the space a single Tab (\t) character takes.

Declaration
public void ChangeDocumentDefaultTabWidth(double tabWidth)
Parameters
System.Double tabWidth

The new width.
Implements

ChangeDocumentElementTag(DocumentElement, String)

Changes the Tag property of a specified DocumentElement.

Declaration
public void ChangeDocumentElementTag(DocumentElement element, string tag)
Parameters
DocumentElement element

The DocumentElement.
System.String tag

The new tag value.
Implements

ChangeDocumentEndnotesFirstNumber(Int32)

Changes the first number for endnotes for the entire document.

Declaration
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

The new start number.
Implements

ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)

Changes the endnotes numbering format for the entire document.

Declaration
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

The new numbering format.
Implements

ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)

Changes where endtnote numbers will stop incrementing and will start from the first one for the entire document.

Declaration
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The new restart type.
Implements

ChangeDocumentEndnotesPosition(EndnotesPosition)

Changes the position of the endnotes for the entire document.

Declaration
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)
Parameters
EndnotesPosition endnotesPosition

Implements

ChangeDocumentFootnotesFirstNumber(Int32)

Changes the first number for footnotes for the entire document.

Declaration
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

The new start number.
Implements

ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)

Changes the footnotes numbering format for the entire document.

Declaration
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

The new numbering format.
Implements

ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)

Changes where footnote numbers will stop incrementing and will start from the first one for the entire document.

Declaration
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The new restart type.
Implements

ChangeDocumentFootnotesPosition(FootnotesPosition)

Changes the position of the footnoes for the entire document.

Declaration
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)
Parameters
FootnotesPosition footnotesPosition

The new footnotes position.
Implements

ChangeDocumentIsStrictLineBreakingRuleEnabled(Boolean)

Sets a value indicating whether strict line brealing rule is enabled.

Declaration
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)
Parameters
System.Boolean value

true if rule should be enabled otherwise false.
Implements

ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)

Changes the language for which line breaking rules are currently applied in the document.

Declaration
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)
Parameters
LineBreakingRuleLanguage lineBreakingRuleLanguage

The new language for which line breaking rules are applied.
Implements

ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)

Changes the characters after which a line break cannot be placed.

Declaration
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

The new rule for line breaks after a character.
Implements

ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)

Changes the characters before which a line break cannot be placed.

Declaration
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

The new rule for line breaks before a character.
Implements

ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)

Changes the field display mode.

Declaration
public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)
Parameters
FieldRangeStart fieldStart

The field start.
FieldDisplayMode displayMode

The new display mode.
Implements

ChangeFontFamily(FontFamily)

Changes the font family of the current run in the document.

Declaration
public void ChangeFontFamily(FontFamily fontFamily)
Parameters
FontFamily fontFamily

The new font family to be applied.
Implements

ChangeFontSize(Double)

Changes the font size of the current run in the document.

Declaration
public void ChangeFontSize(double newFontSize)
Parameters
System.Double newFontSize

The new font size to be applied.
Implements

ChangeFontStyle(FontStyle)

Changes the font style of the current run in the document.

Declaration
public void ChangeFontStyle(FontStyle fontStyle)
Parameters
System.Drawing.FontStyle fontStyle

The new font style.

ChangeFontStyle(FontStyle)

Changes the font style of the current run in the document.

Declaration
public void ChangeFontStyle(FontStyle fontStyle)
Parameters
FontStyle fontStyle

The new font style.
Implements

ChangeFontWeight(FontWeight)

Changes the font weight of the current run in the document.

Declaration
public void ChangeFontWeight(FontWeight fontWeight)
Parameters
FontWeight fontWeight

The new font weight.
Implements

ChangeImageRotateAngle(ImageInline, Double)

Changes the image rotate angle.

Declaration
public void ChangeImageRotateAngle(ImageInline image, double angle)
Parameters
ImageInline image

The ImageInline.
System.Double angle

The new angle.
Implements

ChangeImageSize(ImageInline, Size)

Changes the size of the image.

Declaration
public void ChangeImageSize(ImageInline image, Size size)
Parameters
ImageInline image

The ImageInline.
Size size

The new size.
Implements

ChangeLayoutMode(DocumentLayoutMode)

Changes the layout mode.

Declaration
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)
Parameters
DocumentLayoutMode layoutMode

The new layout mode to be applied.

ChangeLineNumberingRestartType(LineNumberingRestartType)

Changes the restart type of line numberings for the selected sections.

Declaration
public void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)
Parameters
LineNumberingRestartType restartType

The line numbering restart type.
Implements

ChangeListStyle(ListStyle)

Changes the paragraph style of the current paragraph.

Declaration
public void ChangeListStyle(ListStyle style)
Parameters
ListStyle style

The new style to be applied.

ChangeParagraphAutomaticSpacingAfter(Boolean)

Controls whether automatic spacing is applied after the current paragraph.

Declaration
public void ChangeParagraphAutomaticSpacingAfter(bool value)
Parameters
System.Boolean value

True if automatic spacing should be applied, otherwise false.
Implements

ChangeParagraphAutomaticSpacingBefore(Boolean)

Controls whether automatic spacing is applied before the current paragraph.

Declaration
public void ChangeParagraphAutomaticSpacingBefore(bool value)
Parameters
System.Boolean value

True if automatic spacing should be applied, otherwise false.
Implements

ChangeParagraphBackground(Color)

Changes the background color of the selected paragraphs in the document.

Declaration
public void ChangeParagraphBackground(Color color)
Parameters
Color color

The new background color to be applied.
Implements

ChangeParagraphFirstLineIndent(Double)

Changes the left indent of the current paragraph.

Declaration
public void ChangeParagraphFirstLineIndent(double firstLineIndent)
Parameters
System.Double firstLineIndent

The new left indent to be applied.
Implements

ChangeParagraphFlowDirection(FlowDirection)

Changes the flow direction of the selected paragraphs in the document.

Declaration
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)
Parameters
FlowDirection flowDirection

The new flow direction to be applied.
Implements

ChangeParagraphIsLineBreakingRuleEnabled(Boolean)

Sets a value indicating whether line brealing rules are enabled.

Declaration
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)
Parameters
System.Boolean value

true if rules should be enabled otherwise false.
Implements

ChangeParagraphLeftIndent(Double)

Changes the left indent of the current paragraph.

Declaration
public void ChangeParagraphLeftIndent(double leftIndent)
Parameters
System.Double leftIndent

The new left indent to be applied.
Implements

ChangeParagraphLineSpacing(Double)

Changes the lines spacing inside the current paragraph.

Declaration
public void ChangeParagraphLineSpacing(double lineSpacing)
Parameters
System.Double lineSpacing

The new line spacing to be applied.
Implements

ChangeParagraphLineSpacing(Double, LineSpacingType)

Changes the line spacing inside the current paragraph.

Declaration
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)
Parameters
System.Double lineSpacing

The new line spacing to be applied.
LineSpacingType lineSpacingType

The type of the line spacing to be applied.
Implements

ChangeParagraphLineSpacingType(LineSpacingType)

Changes the line spacing type inside the current paragraph.

Declaration
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)
Parameters
LineSpacingType lineSpacingType

The new line spacing type to be applied.
Implements

ChangeParagraphListLevel(Int32)

Changes the list level the paragraph is currently in.

Declaration
public void ChangeParagraphListLevel(int listLevel)
Parameters
System.Int32 listLevel

The list level to be applied.
Implements

ChangeParagraphRightIndent(Double)

Changes the right indent of the current paragraph.

Declaration
public void ChangeParagraphRightIndent(double rightIndent)
Parameters
System.Double rightIndent

The new right indent to be applied.
Implements

ChangeParagraphSpacingAfter(Double)

Changes the spacing after the current paragraph.

Declaration
public void ChangeParagraphSpacingAfter(double spacingAfter)
Parameters
System.Double spacingAfter

The new spacing to be applied.
Implements

ChangeParagraphSpacingBefore(Double)

Changes the spacing before the current paragraph.

Declaration
public void ChangeParagraphSpacingBefore(double spacingBefore)
Parameters
System.Double spacingBefore

The new spacing to be applied.
Implements

ChangeParagraphStyle(StyleDefinition)

Changes the paragraph style of the current paragraph.

Declaration
public void ChangeParagraphStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The new style to be applied.
Implements

ChangeSectionActualPageMargin(Padding)

Changes the actual page margin (regarding the page orientation) of the section.

Declaration
public void ChangeSectionActualPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The section margin.
Implements

ChangeSectionColumns(SectionColumnCollection)

ChangeSectionColumns

Declaration
public void ChangeSectionColumns(SectionColumnCollection columnCollection)
Parameters
SectionColumnCollection columnCollection

columns

Implements

ChangeSectionColumns(SectionColumnsLayout)

ChangeSectionColumns

Declaration
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)
Parameters
SectionColumnsLayout sectionColumnsLayout

Section Columns Layout

Implements

ChangeSectionEndnotesFirstNumber(Int32)

Changes the first number for endnotes for the current section.

Declaration
public void ChangeSectionEndnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

The new start number.
Implements

ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)

Changes the endnotes numbering format for the current section.

Declaration
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

The new numbering format.
Implements

ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)

Changes where endtnote numbers will stop incrementing and will start from the first one for the current section.

Declaration
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The new restart type.
Implements

ChangeSectionFirstPageNumber(Nullable<Int32>)

Changes the first page number of the current section. Set null continue numeration form the previous section.

Declaration
public void ChangeSectionFirstPageNumber(int? firstPageNumber)
Parameters
System.Nullable<System.Int32> firstPageNumber

The new first page number value.
Implements

ChangeSectionFooterBottomMargin(Int32)

Changes the bottom margin of the footer of the current section.

Declaration
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)
Parameters
System.Int32 sectionFooterBottomMargin

Footer bottom margin to be applied.
Implements

ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, Boolean)

Changes the value indicated whether the a section footer should be linked to the footer of the previous section.

Declaration
public void ChangeSectionFooterLinkToPrevious(Section section, HeaderFooterType footerType, bool value)
Parameters
Section section

The section.
HeaderFooterType footerType

Type of the footer.
System.Boolean value

true if the footer should be linked.
Implements

ChangeSectionFootnotesFirstNumber(Int32)

Changes the first number for footnotes for the current section.

Declaration
public void ChangeSectionFootnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

The new start number.
Implements

ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)

Changes the footnotes numbering format for the current section.

Declaration
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

The new numbering format.
Implements

ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)

Changes where footnote numbers will stop incrementing and will start from the first one for the current section.

Declaration
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The new restart type.
Implements

ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, Boolean)

Changes the value indicated whether the a section header should be linked to the header of the previous section.

Declaration
public void ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value)
Parameters
Section section

The section.
HeaderFooterType headerType

Type of the header.
System.Boolean value

true if the header should be linked.
Implements

ChangeSectionHeaderTopMargin(Int32)

Changes the top margin of the header of the current section.

Declaration
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)
Parameters
System.Int32 sectionHeaderTopMargin

Header top margin to be applied.
Implements

ChangeSectionLineNumbering(LineNumbering)

Changes the line numberings for the selected sections.

Declaration
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)
Parameters
LineNumbering lineNumbering

The line numbering.
Implements

ChangeSectionPageMargin(Padding)

Changes the page margin of the current section.

Declaration
public void ChangeSectionPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The new margin to be applied.
Implements

ChangeSectionPageOrientation(PageOrientation)

Changes the page orientation of the current section.

Declaration
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)
Parameters
PageOrientation sectionPageOrientation

The new page orientation to be applied.
Implements

ChangeSectionPageSize(Size)

Changes the page size of the current section.

Declaration
public void ChangeSectionPageSize(Size size)
Parameters
Size size

The new page size to be applied.
Implements

ChangeSpanStyle(StyleDefinition)

Changes the style of current run in the document.

Declaration
public void ChangeSpanStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The new style to be applied.
Implements

ChangeStrikethrough(Boolean)

Changes the strikethrough of the current run in the document.

Declaration
public void ChangeStrikethrough(bool isStrikethrough)
Parameters
System.Boolean isStrikethrough

The new strikethrough value.
Implements

ChangeStyleName(String)

Applies style with a given name to the selected elements in the document.

Declaration
public void ChangeStyleName(string styleName)
Parameters
System.String styleName

Name of the style.
Implements

ChangeStyleName(String, Boolean)

Applies style with a given name to the selected elements in the document.

Declaration
public void ChangeStyleName(string styleName, bool useLinkedStyle)
Parameters
System.String styleName

Name of the style.
System.Boolean useLinkedStyle

If true, the linked style may be used depending on the selection.
Implements

ChangeStyleNameToActiveEditor(String)

Changes the style name of the current run in the document.

Declaration
public void ChangeStyleNameToActiveEditor(string newStyleName)
Parameters
System.String newStyleName

ChangeTableBorders(TableBorders)

Changes the borders of the current table.

Declaration
public void ChangeTableBorders(TableBorders borders)
Parameters
TableBorders borders

The new table borders.
Implements

ChangeTableCellBackground(Color)

Changes the back color of the current cell.

Declaration
public void ChangeTableCellBackground(Color color)
Parameters
Color color

The new cell back color.
Implements

ChangeTableCellBorders(Border)

Changes the borders style of the current cell.

Declaration
public void ChangeTableCellBorders(Border border)
Parameters
Border border

The new borders style.
Implements

ChangeTableCellBorders(TableCellBorders)

Changes the cell border styles of the current table.

Declaration
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)
Parameters
TableCellBorders tableCellBorders

The new cell border styles.
Implements

ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)

Changes the content alignment of the currently selected cells.

Declaration
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)
Parameters
RadTextAlignment textAlignment

The new horizontal alignment.
RadVerticalAlignment verticalAlignment

The new vertical alignment.
Implements

ChangeTableCellHorizontalContentAlignment(RadTextAlignment)

Changes the horizontal alignment of the currently selected cells.

Declaration
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)
Parameters
RadTextAlignment textAlignment

The new horizontal alignment.
Implements

ChangeTableCellPadding(Padding)

Changes the cell padding for the currently selected cells.

Declaration
public void ChangeTableCellPadding(Padding padding)
Parameters
Padding padding

The new padding.
Implements

ChangeTableCellSpacing(Double)

Changes the cell spacing of the current table.

Declaration
public void ChangeTableCellSpacing(double cellSpacing)
Parameters
System.Double cellSpacing

The new cell spacing.
Implements

ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)

Changes the vertical alignment of the currently selected cells.

Declaration
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)
Parameters
RadVerticalAlignment verticalAlignment

The new vertical alignment.
Implements

ChangeTableDefaultCellPadding(Padding)

Changes the default padding applied to cells of the current table.

Declaration
public void ChangeTableDefaultCellPadding(Padding padding)
Parameters
Padding padding

The new padding.
Implements

ChangeTableFlowDirection(FlowDirection)

Changes the flow direction of the current table.

Declaration
public void ChangeTableFlowDirection(FlowDirection flowDirection)
Parameters
FlowDirection flowDirection

The new flow direction.
Implements

ChangeTableGridColumnWidth(Table, Int32, TableWidthUnit)

Changes the width of the column at the given index in the given table.

Declaration
public void ChangeTableGridColumnWidth(Table table, int gridColumnIndex, TableWidthUnit width)
Parameters
Table table

The table containing the column.
System.Int32 gridColumnIndex

The index of the column in the table.
TableWidthUnit width

The new column width.
Implements

ChangeTableHorizontalAlignment(RadHorizontalAlignment)

Changhes the table horizontal alignment.

Declaration
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)
Parameters
RadHorizontalAlignment alignment

The new alignment.
Implements

ChangeTableIndent(Double)

Changes the table indent.

Declaration
public void ChangeTableIndent(double indent)
Parameters
System.Double indent

The new indent.
Implements

ChangeTableLayoutMode(Table, TableLayoutMode)

Changes the layout mode of the given table.

Declaration
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)
Parameters
Table table

The table to change the layout of.
TableLayoutMode tableLayoutMode

The new layout mode.
Implements

ChangeTableLook(TableLook)

Changes the visual appearance of the current table.

Declaration
public void ChangeTableLook(TableLook tableLook)
Parameters
TableLook tableLook

The new visual settings.
Implements

ChangeTablePreferredWidth(TableWidthUnit)

Changes the preferred width for the current table.

Declaration
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)
Parameters
TableWidthUnit tableWidth

Implements

ChangeTableRowHeight(TableRow, Double)

Changes the height of the given table row.

Declaration
public void ChangeTableRowHeight(TableRow tableRow, double height)
Parameters
TableRow tableRow

The row to change the height of.
System.Double height

The new height.
Implements

ChangeTableRowRepeatOnEveryPage(TableRow)

ChangeTableRowRepeatOnEveryPage

Declaration
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)
Parameters
TableRow tableRow

Implements

ChangeTextAlignment(RadTextAlignment)

Changes the text alignment of the current run in the document.

Declaration
public void ChangeTextAlignment(RadTextAlignment alignment)
Parameters
RadTextAlignment alignment

The new text alignment to be applied.

ChangeTextForeColor(Color)

Changes the text foreground color of the current run in the document.

Declaration
public void ChangeTextForeColor(Color newColor)
Parameters
Color newColor

The new foreground color to be applied.

ChangeTextHighlightColor(Color)

Changes the text highligh color of the current run in the document.

Declaration
public void ChangeTextHighlightColor(Color newColor)
Parameters
Color newColor

The new highlight color to be applied.

ChangeUnderlineColor(Color)

Changes the underline color of the current run in the document.

Declaration
public void ChangeUnderlineColor(Color newColor)
Parameters
Color newColor

The new underline color to be applied.
Implements

ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)

Changes the underline decoration of the current run in the document.

Declaration
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)
Parameters
IUnderlineUIDecorationProvider decoration

The new underline decoration provider to be applied.
Implements

ClearAllFormatting()

Clears all of the formatting of the current paragraph and run in the document.

Declaration
public void ClearAllFormatting()
Implements

ClearFormatting()

Clears the formatting of the current run in the document.

Declaration
public void ClearFormatting()
Implements

ClearTabStops()

Removes all tab stops from the currently selected paragraphs.

Declaration
public void ClearTabStops()
Implements

ContinueListNumbering()

Removes all paragraphs from the current list and continues the first possible list before that paragraph. The paragraph should be in list and should be first in the list, otherwise this method does nothing.

Declaration
public bool ContinueListNumbering()
Returns
System.Boolean

Implements

Copy()

Copies currently selected document elements into the clipboard

Declaration
public void Copy()
Implements

CopyFormatting()

Copies the formatting of the current selection.

Declaration
public bool CopyFormatting()
Returns
System.Boolean

A value indicating whether the copy was successful.
Implements

CreatePrintDocument()

Declaration
protected virtual RadPrintDocument CreatePrintDocument()
Returns
RadPrintDocument

Cut()

Executes the Cut command.

Declaration
public void Cut()
Implements

DecrementFontSize()

Decrements the font size of the current run in the document.

Declaration
public void DecrementFontSize()
Implements

DecrementParagraphLeftIndent()

Decrements the left indent of the current paragraph.

Declaration
public void DecrementParagraphLeftIndent()
Implements

DecrementParagraphListLevel()

Decrements the list level the paragraph is currently in by 1.

Declaration
public void DecrementParagraphListLevel()

Delete(Boolean)

Deletes from the document respecting CaretPosition and Selection.

Declaration
public void Delete(bool deletePrevious)
Parameters
System.Boolean deletePrevious

If the selection is empty, indicates whether to delete the character before or after the caret.

DeleteAllComments()

Deletes all comments in the current document.

Declaration
public void DeleteAllComments()
Implements

DeleteAnnotationRange(AnnotationRangeStart)

Deletes an annotation range.

Declaration
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The start of the range that is to be deleted.
Implements

DeleteBookmark(String)

Deletes a bookmark.

Declaration
public void DeleteBookmark(string bookmarkName)
Parameters
System.String bookmarkName

Name of the bookmark.
Implements

DeleteBookmark(BookmarkRangeStart)

Deletes a bookmark.

Declaration
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)
Parameters
BookmarkRangeStart bookmarkRangeStart

The bookmark range start.
Implements

DeleteCodeBlock(CodeAnnotationRangeStart)

Deletes a code block.

Declaration
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)
Parameters
CodeAnnotationRangeStart rangeStart

The code range start of the block to delete.
Implements

DeleteComment()

Deletes the current comment.

Declaration
public void DeleteComment()
Implements

DeleteComment(CommentRangeStart)

Deletes a comment.

Declaration
public void DeleteComment(CommentRangeStart commentRangeStart)
Parameters
CommentRangeStart commentRangeStart

The comment range start.
Implements

DeletePermissionRange(PermissionRangeStart)

Deletes a permission range.

Declaration
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)
Parameters
PermissionRangeStart permissionRangeStart

The permission range start.
Implements

DeleteReadOnlyRange()

Deletes the current read only range.

Declaration
public void DeleteReadOnlyRange()
Implements

DeleteReadOnlyRange(ReadOnlyRangeStart)

Deletes the read only range.

Declaration
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)
Parameters
ReadOnlyRangeStart readOnlyRangeStart

The read only range that is to be deleted.
Implements

DeleteTable()

Deletes the current table.

Declaration
public void DeleteTable()
Implements

DeleteTable(Table)

Deletes the provided table from the document.

Declaration
public void DeleteTable(Table table)
Parameters
Table table

The table to delete.
Implements

DeleteTableColumn()

Deletes the current column.

Declaration
public void DeleteTableColumn()
Implements

DeleteTableRow()

Deletes the current row from the table.

Declaration
public void DeleteTableRow()
Implements

DeleteTableRow(TableRow)

Deletes the given row from the table.

Declaration
public void DeleteTableRow(TableRow row)
Parameters
TableRow row

The TableRow to delete.
Implements

DisableWatermark()

Removes the currently applied watermark.

Declaration
public void DisableWatermark()

DisposeDialogs()

Declaration
protected virtual void DisposeDialogs()

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

DisposeUnmanagedResources()

Declaration
protected override void DisposeUnmanagedResources()
Overrides

EditListStyleInDialog(ListStyle)

Shows the dialog for editing list styles.

Declaration
public void EditListStyleInDialog(ListStyle listStyle)
Parameters
ListStyle listStyle

EndUndoGroup()

Closes current undo group.

Declaration
public void EndUndoGroup()
Implements

EndUndoGroup(String)

Closes current undo group.

Declaration
public void EndUndoGroup(string groupDisplayText)
Parameters
System.String groupDisplayText

The display text which will be used for the undo group.
Implements

FocusFooter()

Focuses the footer of the current page.

Declaration
public void FocusFooter()

FocusHeader()

Focuses the header of the current page.

Declaration
public void FocusHeader()

GetApperanceSettingsForComment(Comment)

Gets an object containing the appearance settings for the given comment.

Declaration
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)
Parameters
Comment comment

The Comment to get the settings for.
Returns
CommentAppearanceSettings

Implements

GetContent(String)

Gets the content in various formats.

Declaration
public string GetContent(string format)
Parameters
System.String format

The format to export into.
Returns
System.String

String representation of the content.

GetDocumentEditorPresenterTypeForDocument(RadDocument)

Declaration
protected virtual Type GetDocumentEditorPresenterTypeForDocument(RadDocument document)
Parameters
RadDocument document

Returns
System.Type

GetLayersBuilder()

Gets the component responsible for building the UI layers of the editor.

Declaration
protected virtual UILayersBuilder GetLayersBuilder()
Returns
UILayersBuilder

GoToNextComment()

Moves current position to the next comment.

Declaration
public void GoToNextComment()

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()

Moves current position to the next revision.

Declaration
public void GoToNextRevision()

GoToPreviousComment()

Moves current position to the previous comment.

Declaration
public void GoToPreviousComment()

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()

Moves current position to the previous revision.

Declaration
public void GoToPreviousRevision()

IncrementFontSize()

Increments the font size of the current run in the document.

Declaration
public void IncrementFontSize()
Implements

IncrementParagraphLeftIndent()

Increments the left indent of the current paragraph.

Declaration
public void IncrementParagraphLeftIndent()
Implements

IncrementParagraphListLevel()

Increments the list level the paragraph is currently in by 1.

Declaration
public void IncrementParagraphListLevel()

Insert(String)

Inserts text into the document at the current caret position, applying the current formatting. This is the primary method for adding textual content to the document programmatically.

Declaration
public void Insert(string text)
Parameters
System.String text

The text to insert into the document.

Insert(String, DocumentPosition)

Inserts text into the document at the specified position.

Declaration
public void Insert(string text, DocumentPosition insertionPosition)
Parameters
System.String text

The text to insert.
DocumentPosition insertionPosition

The position where the text will be inserted.

InsertAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)

Inserts an annotation range.

Declaration
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)
Parameters
AnnotationRangeStart rangeStart

The annotation range start.
AnnotationRangeEnd rangeEnd

The annotation range end.
Implements

InsertBookmark(String)

Inserts a bookmark at the current selection or caret position, which can be used for quick navigation within the document.

Declaration
public void InsertBookmark(string bookmarkName)
Parameters
System.String bookmarkName

The unique name for the bookmark to be inserted.
Implements

InsertCaption(CaptionDefinition, String, Boolean, Boolean)

Inserts a caption.

Declaration
public void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)
Parameters
CaptionDefinition definition

The definition.
System.String caption

The caption text to be used.
System.Boolean includeLabel

if set to true the label is included in the caption.
System.Boolean insertBelow

if set to true the caption is inserted after the current selection.
Implements

InsertCodeBlock(String, CodeFormattingSettings)

Inserts code block into the document at caret position. If caret position is in code block, replaces the current code block.

Declaration
public void InsertCodeBlock(string code, CodeFormattingSettings settings)
Parameters
System.String code

CodeFormattingSettings settings

Implements

InsertColumnBreak()

Inserts a column break at the current caret position, forcing the following content to begin in the next column.

Declaration
public void InsertColumnBreak()
Implements

InsertComment(Comment)

Inserts a comment.

Declaration
public void InsertComment(Comment comment)
Parameters
Comment comment

The comment.
Implements

InsertCrossReferenceToBookmark(String, ReferenceContentType, Boolean)

Inserts a Cross-Reference to a bookmark into the document at current caret position.

Declaration
public void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
System.String bookmarkName

ReferenceContentType contentType

System.Boolean insertAsHyperlink

Implements

InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, Boolean)

Inserts a Cross-Reference to a caption into the document at current caret position.

Declaration
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
Paragraph captionParagraph

ReferenceContentType contentType

System.Boolean insertAsHyperlink

Implements

InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, Boolean)

Inserts a Cross-Reference to a heading paragraph into the document at current caret position.

Declaration
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
Paragraph headingParagraph

ReferenceContentType contentType

System.Boolean insertAsHyperlink

Implements

InsertEndnote()

Inserts endnote at the current position.

Declaration
public void InsertEndnote()
Implements

InsertEndnote(Note)

Inserts the endnote at the current position.

Declaration
public void InsertEndnote(Note endnote)
Parameters
Note endnote

The endnote.
Implements

InsertField(Field)

Inserts a field into the document at current caret position.

Declaration
public bool InsertField(Field field)
Parameters
Field field

The field.
Returns
System.Boolean

True if the operation completed successfully
Implements

InsertField(Field, FieldDisplayMode)

Inserts a field into the document at current caret position in a specified display mode.

Declaration
public bool InsertField(Field field, FieldDisplayMode displayMode)
Parameters
Field field

The field.
FieldDisplayMode displayMode

The display mode.
Returns
System.Boolean

True if the operation completed successfully
Implements

InsertFootnote()

Inserts footnote at the current position.

Declaration
public void InsertFootnote()
Implements

InsertFootnote(Note)

Inserts the footnote at the current position.

Declaration
public void InsertFootnote(Note footnote)
Parameters
Note footnote

The footnote.
Implements

InsertFragment(DocumentFragment)

Inserts a document fragment.

Declaration
public void InsertFragment(DocumentFragment documentFragment)
Parameters
DocumentFragment documentFragment

The document fragment to insert.
Implements

InsertFragment(DocumentFragment, DocumentPosition)

Inserts a fragment at specified position.

Declaration
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)
Parameters
DocumentFragment documentFragment

The fragment to insert.
DocumentPosition documentPosition

The document position to insert the fragment at.
Implements

InsertHyperlink(HyperlinkInfo)

Creates a hyperlink from the current text selection, applying the provided link information.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink information containing URL, tooltip, and other link properties.
Implements

InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)

Inserts a collection of inline elements as a hyperlink into the document at the current position.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink information containing URL, tooltip, and other link properties.
System.Collections.Generic.IEnumerable<Inline> inlines

The collection of inline elements to be displayed as the hyperlink text.
Implements

InsertHyperlink(HyperlinkInfo, String)

Inserts a hyperlink with the specified text into the document at the current position.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink information containing URL, tooltip, and other link properties.
System.String hyperlinkText

The text to display for the hyperlink.

InsertImage(Stream, String)

Inserts an image as an inline element into the document at the current position.

Declaration
public void InsertImage(Stream imageStream, string extension)
Parameters
System.IO.Stream imageStream

The stream containing the image data to be inserted.
System.String extension

The file extension specifying the image format (e.g., "jpg", "png", "gif").
Implements

InsertInline(Inline)

Inserts inline element into the document.

Declaration
public void InsertInline(Inline inline)
Parameters
Inline inline

The inline element to insert.
Implements

InsertInline(Inline, DocumentPosition)

Inserts inline element into the document.

Declaration
public void InsertInline(Inline inline, DocumentPosition documentPosition)
Parameters
Inline inline

The inline element to insert.
DocumentPosition documentPosition

The document position to insert the inline at.
Implements

InsertLine(String)

Inserts text and adds new paragraph after it.

Declaration
public void InsertLine(string text)
Parameters
System.String text

The text.
Implements

InsertLineBreak()

Inserts a line break at the current caret position, creating a new line without starting a new paragraph.

Declaration
public void InsertLineBreak()
Implements

InsertNonBreakingSpace()

Inserts a non-breaking space into the document at the current caret position.

Declaration
public void InsertNonBreakingSpace()

InsertPageBreak()

Inserts a page break at the current caret position, forcing the following content to begin on a new page.

Declaration
public void InsertPageBreak()
Implements

InsertParagraph()

Inserts a new paragraph.

Declaration
public void InsertParagraph()
Implements

InsertPermissionRange(IEnumerable<PermissionRangeInfo>)

Inserts a new permission range at the current selection, allowing control over who can edit specific parts of the document.

Declaration
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)
Parameters
System.Collections.Generic.IEnumerable<PermissionRangeInfo> permissionInfos

A collection of permission settings that define user access rights for the new range.
Implements

InsertReadOnlyRange()

Inserts a read only range.

Declaration
public void InsertReadOnlyRange()
Implements

InsertSectionBreak()

Inserts a section break at the current caret position, using the default NextPage section break type.

Declaration
public void InsertSectionBreak()
Implements

InsertSectionBreak(SectionBreakType)

Inserts a section break of the specified type at the current caret position, allowing independent formatting of different sections.

Declaration
public void InsertSectionBreak(SectionBreakType sectionBreakType)
Parameters
SectionBreakType sectionBreakType

The type of the section break to insert.
Implements

InsertStructuredDocumentTag()

Inserts a default structured document tag (Content Control) at the current selection. The default type is RichText.

Declaration
public void InsertStructuredDocumentTag()

InsertStructuredDocumentTag(SdtProperties)

Inserts a structured document tag (Content Control) with the specified properties at the current selection.

Declaration
public void InsertStructuredDocumentTag(SdtProperties insertProperties)
Parameters
SdtProperties insertProperties

The properties to configure the structured document tag.

InsertStructuredDocumentTag(SdtType)

Inserts a structured document tag (Content Control) of the specified type at the current selection.

Declaration
public void InsertStructuredDocumentTag(SdtType insertType)
Parameters
SdtType insertType

The type of structured document tag to insert.

InsertTable(Int32, Int32)

Inserts a new table with the specified number of rows and columns at the current caret position.

Declaration
public void InsertTable(int rows, int columns)
Parameters
System.Int32 rows

The number of rows.
System.Int32 columns

The number of columns.
Implements

InsertTable(Int32, Int32, Boolean)

Inserts a new table with the specified number of rows and columns at the current caret position.

Declaration
public void InsertTable(int rows, int columns, bool shouldInsertParagraphBeforeTable)
Parameters
System.Int32 rows

The number of rows.
System.Int32 columns

The number of columns.
System.Boolean shouldInsertParagraphBeforeTable

Indicate whether a new paragraph should be inserted before the table.

InsertTable(Table)

Inserts the given table at the current caret position with a paragraph before it. This is a convenience method that calls InsertTable(table, true).

Declaration
public void InsertTable(Table table)
Parameters
Table table

The table to insert.
Implements

InsertTable(Table, Boolean)

Inserts the given table at the current caret position with an option to include a paragraph before it.

Declaration
public void InsertTable(Table table, bool shouldInsertParagraphBeforeTable)
Parameters
Table table

The table to insert.
System.Boolean shouldInsertParagraphBeforeTable

Indicates whether a new paragraph should be inserted before the table.
Remarks

The Table instance inserted in the document is a cloning of the one passed for the table parameter. Making subsequent changes to the Table is not possible.

InsertTableColumn()

Inserts a column to the right of the last table column.

Declaration
public void InsertTableColumn()
Implements

InsertTableColumnToTheLeft()

Inserts a column to the left of the current column.

Declaration
public void InsertTableColumnToTheLeft()
Implements

InsertTableColumnToTheRight()

Inserts a column to the right of the current column.

Declaration
public void InsertTableColumnToTheRight()
Implements

InsertTableRow()

Inserts a row at the bottom of the table.

Declaration
public void InsertTableRow()
Implements

InsertTableRowAbove()

Inserts a row above the current row in the table.

Declaration
public void InsertTableRowAbove()
Implements

InsertTableRowBelow()

Inserts a row below the current row in the table.

Declaration
public void InsertTableRowBelow()
Implements

InvalidateEditorLayout()

Invalidates the active editor presenter layout, causing the editor to remeasure and rearrange its elements.

Declaration
public void InvalidateEditorLayout()

InvalidateProofingErrors(Boolean)

Clears the spell-checking state of words in the document and updates the UI to reflect the changes.

Declaration
public void InvalidateProofingErrors(bool invalidateIncorrectWordsOnly)
Parameters
System.Boolean invalidateIncorrectWordsOnly

True to invalidate only words marked as incorrect, false to invalidate all words.

MailMerge(Boolean)

Produces a mail merge document for all the mail merge data records.

Declaration
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)
Parameters
System.Boolean startEachRecordOnNewPage

true if each record should start on a new page.
Returns
RadDocument

The document
Implements

MailMergeCurrentRecord()

Produces a mail merge document for the current mail merge data record.

Declaration
public RadDocument MailMergeCurrentRecord()
Returns
RadDocument

The document
Implements

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

MergeTableCells()

Merges the currently selected cells.

Declaration
public void MergeTableCells()
Implements

MoveSelection(DocumentPosition, Boolean)

Moves current document selection to a specified position.

Declaration
public void MoveSelection(DocumentPosition position, bool deleteSelection)
Parameters
DocumentPosition position

The move position.
System.Boolean deleteSelection

Indicates whether the current selection should be deleted.
Implements

OnApplyTemplate()

Called when the template is applied to the control.

Declaration
public override void OnApplyTemplate()
Overrides

OnBeforeOpenFile(OpenFileDialogEventArgs)

Raises the BeforeOpenFile event before a file is opened.

Declaration
protected virtual void OnBeforeOpenFile(OpenFileDialogEventArgs args)
Parameters
OpenFileDialogEventArgs args

An OpenFileDialogEventArgs object that contains the event data.
Remarks

This method is called to trigger the BeforeOpenFile event, allowing subscribers to perform actions before a file is opened. Override this method in a derived class to provide additional functionality when the event is raised.

OnBeforeSaveFile(SaveFileDialogEventArgs)

Raises the BeforeSaveFile event before a file is saved.

Declaration
protected virtual void OnBeforeSaveFile(SaveFileDialogEventArgs e)
Parameters
SaveFileDialogEventArgs e

An SaveFileDialogEventArgs object that contains the event data.
Remarks

This method is called to trigger the BeforeSaveFile event, allowing subscribers to perform actions before the file save operation occurs.

OnBoundsChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnBubbleEvent(RadElement, RoutedEventArgs)

Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

RoutedEventArgs args

Overrides

OnCommandError(CommandErrorEventArgs)

Raises the CommandError event.

Declaration
protected virtual void OnCommandError(CommandErrorEventArgs args)
Parameters
CommandErrorEventArgs args

The CommandErrorEventArgs instance containing the event data.

OnCommandExecuted(CommandExecutedEventArgs)

Raises the CommandExecuted event.

Declaration
protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)
Parameters
CommandExecutedEventArgs e

The CommandExecutedEventArgs instance containing the event data.

OnCommandExecuting(CommandExecutingEventArgs)

Raises the CommandExecuting event.

Declaration
protected virtual void OnCommandExecuting(CommandExecutingEventArgs e)
Parameters
CommandExecutingEventArgs e

The CommandExecutingEventArgs instance containing the event data.

OnCommentShowing(CommentShowingEventArgs)

Raises the CommentShowing event.

Declaration
protected virtual void OnCommentShowing(CommentShowingEventArgs e)
Parameters
CommentShowingEventArgs e

The CommentShowingEventArgs instance containing the event data.

OnCurrentEditingStyleChanged()

Raises the CurrentEditingStyleChanged event.

Declaration
protected virtual void OnCurrentEditingStyleChanged()

OnCurrentParagraphStyleChanged()

Raises the CurrentParagraphStyleChanged event.

Declaration
protected virtual void OnCurrentParagraphStyleChanged()

OnCurrentSpanStyleChanged()

Raises the CurrentSpanStyleChanged event.

Declaration
protected virtual void OnCurrentSpanStyleChanged()

OnCurrentVisiblePageChanged()

Raises the CurrentVisiblePageChanged event.

Declaration
protected virtual void OnCurrentVisiblePageChanged()

OnDocumentArranged()

Raises the DocumentArranged event.

Declaration
protected virtual void OnDocumentArranged()

OnDocumentChanged()

Raises the DocumentChanged event.

Declaration
protected virtual void OnDocumentChanged()

OnDocumentChanging()

Raises the DocumentChanging event.

Declaration
protected virtual void OnDocumentChanging()

OnDocumentContentChanged()

Raises the DocumentContentChanged event.

Declaration
protected virtual void OnDocumentContentChanged()

OnDocumentLayoutModeChanged()

Raises the DocumentLayoutModeChanged event.

Declaration
protected virtual void OnDocumentLayoutModeChanged()

OnDocumentPresentationChanged(PresentationChangedEventArgs)

Raises the DocumentPresentationChanged event.

Declaration
protected virtual void OnDocumentPresentationChanged(PresentationChangedEventArgs e)
Parameters
PresentationChangedEventArgs e

The PresentationChangedEventArgs instance containing the event data.

OnGotFocus(EventArgs)

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnHyperlinkClicked(Object, HyperlinkClickedEventArgs)

Raises the HyperlinkClicked event.

Declaration
protected virtual void OnHyperlinkClicked(object sender, HyperlinkClickedEventArgs eventArgs)
Parameters
System.Object sender

The sender of the event.
HyperlinkClickedEventArgs eventArgs

The HyperlinkClickedEventArgs instance containing the event data.

OnIsReadOnlyChanged(EventArgs)

Raises the IsReadOnlyChanged event.

Declaration
protected virtual void OnIsReadOnlyChanged(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnLoaded()

Called when the control is loaded.

Declaration
protected override void OnLoaded()
Overrides

OnLostFocus(EventArgs)

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMergeFieldToStringConverting(Object, MergeFieldToStringConvertingEventArgs)

Raises the MergeFieldToStringConverting event.

Declaration
protected virtual void OnMergeFieldToStringConverting(object sender, MergeFieldToStringConvertingEventArgs e)
Parameters
System.Object sender

The sender of the event.
MergeFieldToStringConvertingEventArgs e

The MergeFieldToStringConvertingEventArgs instance containing the event data.

OnNoteReferenceClicked(MouseButtonEventArgs)

Raises the NoteReferenceClicked event.

Declaration
protected virtual void OnNoteReferenceClicked(MouseButtonEventArgs args)
Parameters
MouseButtonEventArgs args

The MouseButtonEventArgs instance containing the event data.

OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs)

Raises the PreviewEditorKeyDown event.

Declaration
protected virtual void OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs e)
Parameters
PreviewEditorKeyEventArgs e

The PreviewEditorKeyEventArgs instance containing the event data.

OnPrintCompleted(PrintCompletedEventArgs)

Raises the PrintCompleted event.

Declaration
protected virtual void OnPrintCompleted(PrintCompletedEventArgs e)
Parameters
PrintCompletedEventArgs e

The PrintCompletedEventArgs instance containing the event data.

OnPrintStarted(EventArgs)

Raises the PrintStarted event.

Declaration
protected virtual void OnPrintStarted(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnProtectionStateChanged()

Raises the ProtectionStateChanged event.

Declaration
protected virtual void OnProtectionStateChanged()

OnProviderUILayerInitialized(ProviderUILayerBase, Canvas, UILayerUpdateContext)

Declaration
protected virtual void OnProviderUILayerInitialized(ProviderUILayerBase layer, Canvas container, UILayerUpdateContext context)
Parameters
ProviderUILayerBase layer

Canvas container

UILayerUpdateContext context

OnScaleFactorChanged()

Raises the ScaleFactorChanged event.

Declaration
protected virtual void OnScaleFactorChanged()

OnSelectionChanged(EventArgs)

Raises the SelectionChanged event.

Declaration
protected virtual void OnSelectionChanged(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs 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.

OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs)

Raises the UntrackableCommandExecuting event.

Declaration
protected virtual void OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs e)
Parameters
UntrackableCommandExecutingEventArgs e

The UntrackableCommandExecutingEventArgs instance containing the event data.

OnUserInfoChanged()

Raises the UserInfoChanged event.

Declaration
protected virtual void OnUserInfoChanged()

OpenContextMenuOnNextSpellingError()

Opens the context menu next to the next spelling error in the document.

Declaration
public void OpenContextMenuOnNextSpellingError()

Paste()

Pastes the content of the clipboard into the document.

Declaration
public void Paste()
Implements

Paste(PasteOption)

Pastes the content of the clipboard into the document using the specified paste option.

Declaration
public void Paste(PasteOption pasteOption)
Parameters
PasteOption pasteOption

Implements

PasteFormatting()

Pastes the currently copied formatting on the current selection.

Declaration
public bool PasteFormatting()
Returns
System.Boolean

A value indicating whether the paste was successful.
Implements

PreviewFirstMailMergeDataRecord()

Previews the first mail merge data record.

Declaration
public bool PreviewFirstMailMergeDataRecord()
Returns
System.Boolean

Implements

PreviewLastMailMergeDataRecord()

Previews the last mail merge data record.

Declaration
public bool PreviewLastMailMergeDataRecord()
Returns
System.Boolean

Implements

PreviewMailMergeDataRecordAtIndex(Int32)

Previews the the mail merge data record at a specified index.

Declaration
public bool PreviewMailMergeDataRecordAtIndex(int index)
Parameters
System.Int32 index

The index of the record to be shown.
Returns
System.Boolean

Implements

PreviewNextMailMergeDataRecord()

Previews the next mail merge data record.

Declaration
public bool PreviewNextMailMergeDataRecord()
Returns
System.Boolean

Implements

PreviewPreviousMailMergeDataRecord()

Previews the previous mail merge data record.

Declaration
public bool PreviewPreviousMailMergeDataRecord()
Returns
System.Boolean

Implements

Print()

Directly prints the RadRichTextEditor document to the default printer.

Declaration
public virtual void Print()

Print(Boolean)

Directly prints the RadRichTextEditor document to the default printer or shows printer settings and then prints the RadRichTextEditor document.

Declaration
public virtual void Print(bool showPrinterSettings)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.

Print(Boolean, RadPrintDocument)

Directly prints the RadRichTextEditor document to the default printer or shows printer settings and then prints the RadRichTextEditor document.

Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

PrintPreview()

Shows a RadPrintPreviewDialog for editing the RadRichTextEditor print settings.

Declaration
public virtual void PrintPreview()

PrintPreview(RadPrintDocument)

Shows a RadPrintPreviewDialog for editing the RadRichTextEditor print settings.

Declaration
public virtual void PrintPreview(RadPrintDocument document)
Parameters
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

Redo()

Re-executes the last undone command group.

Declaration
public void Redo()
Implements

RejectAllRevisions()

Rejects all revisions in the current document.

Declaration
public void RejectAllRevisions()
Implements

RejectRevision(Revision)

Rejects revision.

Declaration
public void RejectRevision(Revision revision)
Parameters
Revision revision

The revision.
Implements

RemoveTabStop(TabStop)

Removes the given tab stop from the currently selected paragraphs.

Declaration
public void RemoveTabStop(TabStop tabStop)
Parameters
TabStop tabStop

The tab stop to be removed.
Implements

RemoveTabStopRange(IEnumerable<TabStop>)

Removes the enumeration of tab stops.

Declaration
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)
Parameters
System.Collections.Generic.IEnumerable<TabStop> tabStops

The tab stops to remove.
Implements

ReplaceTabStop(TabStop, TabStop)

Replaces the old tab stop with the new one in the currently selected paragraphs.

Declaration
public void ReplaceTabStop(TabStop oldTabStop, TabStop newTabStop)
Parameters
TabStop oldTabStop

TabStop newTabStop

Implements

ResetFormatPainter()

Declaration
protected virtual void ResetFormatPainter()

ResizeTableColumn(Table, Int32, Double)

Changes the width of the column at the specified index in the given table.

Declaration
public void ResizeTableColumn(Table table, int columnIndex, double columnWidth)
Parameters
Table table

The table containing the column.
System.Int32 columnIndex

The index of the column in the table.
System.Double columnWidth

The new column width.
Implements

RestartListNumbering()

Creates a new list from the current paragraph. The paragraph should be in list, otherwise this method does nothing.

Declaration
public bool RestartListNumbering()
Returns
System.Boolean

Implements

ResumeUpdateLayout(Boolean)

This method supports control infrastructure and is not intended for use directly from your code. Resumes layout updates suspended by calls to SuspendUpdateLayout() method.

Declaration
public void ResumeUpdateLayout(bool updateLayout = true)
Parameters
System.Boolean updateLayout

True to call UpdateEditorLayout once all "resume" calls are equal to the "suspend" calls.

ScrollToNote(Note)

Scrolls the viewport so that a note becomes visible.

Declaration
public void ScrollToNote(Note note)
Parameters
Note note

The note.
Implements

SetSelectedComment(CommentRangeStart)

Sets the provided comment as selected.

Declaration
public void SetSelectedComment(CommentRangeStart commentStart)
Parameters
CommentRangeStart commentStart

The comment to select.

SetSelectedNote(Note)

Sets the provided note as selected.

Declaration
public void SetSelectedNote(Note note)
Parameters
Note note

The note to select.

SetWatermark(DocumentWatermarkSettings)

Sets a watermark with the provided settings.

Declaration
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)
Parameters
DocumentWatermarkSettings watermarkSettings

The settings to apply to the watermark.
Implements

SetWatermark(PredefinedWatermarkType)

Sets one of the predefined watermarks.

Declaration
public void SetWatermark(PredefinedWatermarkType predefinedType)
Parameters
PredefinedWatermarkType predefinedType

The predefined watermark to apply.
Implements

SetWatermarkImage(WatermarkImageSettings)

Sets an image watermark with the provided settings.

Declaration
public void SetWatermarkImage(WatermarkImageSettings settings)
Parameters
WatermarkImageSettings settings

The settings to apply to the watermark.

SetWatermarkText(WatermarkTextSettings)

Sets a text watermark with the provided settings.

Declaration
public void SetWatermarkText(WatermarkTextSettings settings)
Parameters
WatermarkTextSettings settings

The settings to apply to the watermark.

ShouldArrangeChild(RadElement)

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ShouldCreateNewContextMenu(IContextMenu)

Declaration
protected virtual bool ShouldCreateNewContextMenu(IContextMenu menu)
Parameters
IContextMenu menu

Returns
System.Boolean

ShouldMeasureChild(RadElement)

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ShowAddNewBibliographicSourceDialog(String, Boolean, Action<BibliographicSource>)

Shows the Add New Bibliographic Source Dialog.

Declaration
public void ShowAddNewBibliographicSourceDialog(string sourceName = null, bool insertFieldOnClose = true, Action<BibliographicSource> callBackOnClosed = null)
Parameters
System.String sourceName

System.Boolean insertFieldOnClose

System.Action<BibliographicSource> callBackOnClosed

ShowChangeEditingPermissionsDialog()

Shows the dialog for changing editing permissions.

Declaration
public void ShowChangeEditingPermissionsDialog()

ShowCodeFormattingDialog()

Shows the dialog for code formatting.

Declaration
public void ShowCodeFormattingDialog()

ShowContextMenuAtDocumentPosition(Point, DocumentPosition)

Opens the context menu at the specified document position.

Declaration
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)
Parameters
Point proposedLocation

A point where the context menu should appear without taking into account element obstruction.
DocumentPosition position

The DocumentPosition for indicating the element for which the context menu is being shown.

ShowContextMenuAtDocumentPosition(DocumentPosition)

Opens the context menu at the specified document position.

Declaration
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)
Parameters
DocumentPosition position

The DocumentPosition where the context menu will be opened.

ShowDefineNewListStyleDialog()

Shows dialog for creating new list style.

Declaration
public void ShowDefineNewListStyleDialog()

ShowEditCustomDictionaryDialog()

Shows the dialog for editing custom spellchecking dictionaries.

Declaration
public void ShowEditCustomDictionaryDialog()

ShowFindReplaceDialog()

Shows the find replace dialog.

Declaration
public virtual void ShowFindReplaceDialog()

ShowFloatingBlockPropertiesDialog()

Shows the floating block properties dialog.

Declaration
public void ShowFloatingBlockPropertiesDialog()

ShowFontPropertiesDialog()

Shows the font properties dialog.

Declaration
public void ShowFontPropertiesDialog()

ShowImageEditorDialog()

Shows the image editor dialog.

Declaration
public void ShowImageEditorDialog()

ShowImageEditorDialog(String)

Shows the image editor dialog.

Declaration
public void ShowImageEditorDialog(string executeToolName)
Parameters
System.String executeToolName

Name of the tool to execute when the dialog is opened.

ShowInsertCaptionDialog()

Shows the insert caption dialog.

Declaration
public void ShowInsertCaptionDialog()

ShowInsertCrossReferenceWindow()

Shows the insert cross reference window.

Declaration
public void ShowInsertCrossReferenceWindow()

ShowInsertDateTimeDialog()

Shows the insert date field dialog.

Declaration
public void ShowInsertDateTimeDialog()

ShowInsertHyperlinkDialog()

Shows the insert hyperlink dialog.

Declaration
public void ShowInsertHyperlinkDialog()

ShowInsertSymbolWindow()

Show the insert symbol dialog.

Declaration
public void ShowInsertSymbolWindow()

ShowInsertTableDialog()

Shows the insert table dialog.

Declaration
public void ShowInsertTableDialog()

ShowInsertTableOfContentsDialog()

Shows the insert Table of Contents window.

Declaration
public void ShowInsertTableOfContentsDialog()

ShowLineNumberingDialog()

Show the line numbers dialog.

Declaration
public void ShowLineNumberingDialog()

ShowManageBibliographicSourcesDialog()

Shows the Manage Bibliographic Sources Dialog.

Declaration
public void ShowManageBibliographicSourcesDialog()

ShowManageBookmarksDialog()

Shows the dialog for managing bookmarks.

Declaration
public void ShowManageBookmarksDialog()

ShowManageStylesDialog()

Shows the dialog for managing styles.

Declaration
public void ShowManageStylesDialog()

ShowNotesDialog()

Shows the notes dialog.

Declaration
public void ShowNotesDialog()

ShowParagraphPropertiesDialog()

Shows the paragraph properties dialog.

Declaration
public void ShowParagraphPropertiesDialog()

ShowProtectDocumentDialog()

Shows the dialog for enforcing document protection.

Declaration
public void ShowProtectDocumentDialog()

ShowSectionColumnsDialog()

Shows the section columns dialog.

Declaration
public void ShowSectionColumnsDialog()

ShowSetNumberingValueDialog()

Shows the Set Numbering Value Dialog.

Declaration
public void ShowSetNumberingValueDialog()

ShowSpellCheckingDialog()

Shows the spell checking dialog.

Declaration
public void ShowSpellCheckingDialog()

ShowStyleFormattingPropertiesDialog()

Shows the dialog for adding new style.

Declaration
public void ShowStyleFormattingPropertiesDialog()

ShowStyleFormattingPropertiesDialog(StyleDefinition)

Shows the dialog for modifying style formatting.

Declaration
public void ShowStyleFormattingPropertiesDialog(StyleDefinition styleDefinition)
Parameters
StyleDefinition styleDefinition

ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings)

Shows the style formatting properties dialog.

Declaration
public void ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings settings)
Parameters
StyleFormattingPropertiesDialogSettings settings

The settings.

ShowTableBordersDialog()

Shows the table borders dialog.

Declaration
public void ShowTableBordersDialog()

ShowTablePropertiesDialog()

Shows the table properties dialog.

Declaration
public void ShowTablePropertiesDialog()

ShowTabStopsPropertiesDialog()

Shows the dialog for editing tab stops.

Declaration
public void ShowTabStopsPropertiesDialog()

ShowUnprotectDocumentDialog()

Shows the dialog for removing document protection.

Declaration
public void ShowUnprotectDocumentDialog()

ShowWatermarkSettingsDialog()

Shows the watermark settings dialog.

Declaration
public void ShowWatermarkSettingsDialog()

SplitAnnotationRange(AnnotationRangeStart)

Splits an annotation range at the caret position.

Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The start of the range that is to be split.
Implements

SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)

Splits an annotation range at the specified position.

Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)
Parameters
AnnotationRangeStart rangeStart

The start of the range that is to be split.
DocumentPosition position

The position where the range is to be split.
Implements

SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph>)

Suppress the line numbering for selected paragraphs.

Declaration
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)
Parameters
System.Collections.Generic.IEnumerable<Paragraph> paragraphs

Implements

SuspendUpdateLayout()

This method supports control infrastructure and is not intended for use directly from your code. Suspends layout updates forced by document editing operations (e.g. multiple insert/delete operations). Each call to to this method should be followed by a call to ResumeUpdateLayout(Boolean) method.

Declaration
public void SuspendUpdateLayout()
Remarks

Use this method when you have to do sequence of updates to the document, to improve performance and avoid unnecessary layout and UI updates.

ToggleBold()

Toggles the bold state of the current run in the document.

Declaration
public void ToggleBold()
Implements

ToggleBookmarks()

Toggles the visibility of the bookmarks in the document.

Declaration
public void ToggleBookmarks()

ToggleComments()

Toggles the visibility of the comments in the document.

Declaration
public void ToggleComments()

ToggleDifferentFirstPageHeaderFooter()

Toggles between different first page header and footer and same header and footer for all pages.

Declaration
public void ToggleDifferentFirstPageHeaderFooter()

ToggleDifferentOddAndEvenPagesHeaderFooter()

Toggles between different odd and eventpage header and footer and same header and footer for all pages.

Declaration
public void ToggleDifferentOddAndEvenPagesHeaderFooter()

ToggleFieldCodes(FieldRangeStart)

Toggles the display mode of a field.

Declaration
public void ToggleFieldCodes(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.
Implements

ToggleFormattingSymbols()

Toggles the visibility of the formatting symbols in the document.

Declaration
public void ToggleFormattingSymbols()

ToggleHeaderFooterEditingMode()

Toggles the headers/footers editing mode.

Declaration
public void ToggleHeaderFooterEditingMode()

ToggleItalic()

Toggles the italic state of the current run in the document.

Declaration
public void ToggleItalic()
Implements

ToggleMergeFieldsHighlight()

Toggles between highlighting and not highlighting Merge Fields.

Declaration
public void ToggleMergeFieldsHighlight()

ToggleStrikethrough()

Toggles the subscript state of the current run in the document.

Declaration
public void ToggleStrikethrough()
Implements

ToggleSubscript()

Toggles the subscript state of the current run in the document.

Declaration
public void ToggleSubscript()

ToggleSuperscript()

Changes the superscript state of the current run in the document.

Declaration
public void ToggleSuperscript()

ToggleUnderline()

Toggles the underline state of the current run in the document.

Declaration
public void ToggleUnderline()

Undo()

Reverts last executed command group.

Declaration
public void Undo()
Implements

UnmergeTableCells()

Unmerges the currently selected cells.

Declaration
public void UnmergeTableCells()
Implements

UpdateAllCaptions(CaptionDefinition)

Updates all captions related to caption definition.

Declaration
public void UpdateAllCaptions(CaptionDefinition captionDefinition)
Parameters
CaptionDefinition captionDefinition

The caption definition.
Implements

UpdateAllFields()

Updates all fields in the document.

Declaration
public void UpdateAllFields()
Implements

UpdateAllFields(FieldDisplayMode)

Updates all fields and displays them in the specified display mode.

Declaration
public void UpdateAllFields(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

The display mode.
Implements

UpdateEditorLayout()

Forces the control to update its layout and UI;

Declaration
public void UpdateEditorLayout()
Implements

UpdateEditorLayout(Boolean)

Forces the control to update its layout and UI.

Declaration
public void UpdateEditorLayout(bool async)
Parameters
System.Boolean async

False to execute the update immediately. Otherwise it will be executed with slight delay using Dispatcher Timer for performance reasons.

UpdateField(FieldRangeStart)

Updates a field.

Declaration
public void UpdateField(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.
Implements

UpdateFooter(Section, HeaderFooterType, Footer)

Updates the footer for a section.

Declaration
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)
Parameters
Section section

The section of the footer.
HeaderFooterType footerType

Type of the footer.
Footer footer

The footer.

UpdateHeader(Section, HeaderFooterType, Header)

Updates the header for a section.

Declaration
public void UpdateHeader(Section section, HeaderFooterType headerType, Header header)
Parameters
Section section

The section of the header.
HeaderFooterType headerType

Type of the header.
Header header

The header.

Events

ActiveDocumentEditorChanged

Occurs when active document editor changes.

Declaration
public event EventHandler<ActiveDocumentEditorChangedEventArgs> ActiveDocumentEditorChanged
Event Type
System.EventHandler<ActiveDocumentEditorChangedEventArgs>

BeforeOpenFile

Occurs before a file is opened, before the open file dialog is shown.

Declaration
public event EventHandler<OpenFileDialogEventArgs> BeforeOpenFile
Event Type
System.EventHandler<OpenFileDialogEventArgs>

Remarks

Subscribe to this event to customize the OpenFileDialog properties (like Filter, InitialDirectory, etc.) before it is displayed to the user. Handlers can also cancel the open file operation by setting the Cancel property of the event arguments to true.

BeforeSaveFile

Occurs before the file is saved, before the save file dialog is shown.

Declaration
public event EventHandler<SaveFileDialogEventArgs> BeforeSaveFile
Event Type
System.EventHandler<SaveFileDialogEventArgs>

Remarks

Subscribe to this event to customize the SaveFileDialog properties (like Filter, InitialDirectory, etc.) before it is displayed to the user. Handlers can also cancel the open file operation by setting the Cancel property of the event arguments to true.

CommandError

Occurs on error while executing command.

Declaration
public event EventHandler<CommandErrorEventArgs> CommandError
Event Type
System.EventHandler<CommandErrorEventArgs>

CommandExecuted

Occurs after the execution of RichTextBoxCommandBase.

Declaration
public event EventHandler<CommandExecutedEventArgs> CommandExecuted
Event Type
System.EventHandler<CommandExecutedEventArgs>

CommandExecuting

Occurs before the execution of RichTextBoxCommandBase.

Declaration
public event EventHandler<CommandExecutingEventArgs> CommandExecuting
Event Type
System.EventHandler<CommandExecutingEventArgs>

CommentShowing

Occurs when showing comment.

Declaration
public event EventHandler<CommentShowingEventArgs> CommentShowing
Event Type
System.EventHandler<CommentShowingEventArgs>

CurrentEditingStyleChanged

Occurs when the current editing style has changed.

Declaration
public event EventHandler CurrentEditingStyleChanged
Event Type
System.EventHandler

CurrentParagraphStyleChanged

Occurs when the current paragraph's style has changed.

Declaration
public event EventHandler CurrentParagraphStyleChanged
Event Type
System.EventHandler

CurrentSpanStyleChanged

Occurs when the current span's style has changed.

Declaration
public event EventHandler CurrentSpanStyleChanged
Event Type
System.EventHandler

CurrentVisiblePageChanged

Occurs when the CurrentPage property value has changed.

Declaration
public event EventHandler CurrentVisiblePageChanged
Event Type
System.EventHandler

DocumentArranged

Occurs when the current document has been arranged.

Declaration
public event EventHandler DocumentArranged
Event Type
System.EventHandler

DocumentChanged

Occurs when the current document has changed.

Declaration
public event EventHandler DocumentChanged
Event Type
System.EventHandler

DocumentChanging

Occurs when the current document is changing.

Declaration
public event EventHandler DocumentChanging
Event Type
System.EventHandler

DocumentContentChanged

Occurs when the content of the current document has changed.

Declaration
public event EventHandler DocumentContentChanged
Event Type
System.EventHandler

DocumentLayoutModeChanged

Occurs when the layout mode of the current document has changed.

Declaration
public event EventHandler DocumentLayoutModeChanged
Event Type
System.EventHandler

DocumentPresentationChanged

Occurs when the presentation of the current document has changed.

Declaration
public event EventHandler<PresentationChangedEventArgs> DocumentPresentationChanged
Event Type
System.EventHandler<PresentationChangedEventArgs>

HyperlinkClicked

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

Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked
Event Type
System.EventHandler<HyperlinkClickedEventArgs>

IsInHeaderFooterEditModeChanged

Occurs when going in or out of header/footer editing mode.

Declaration
public event EventHandler IsInHeaderFooterEditModeChanged
Event Type
System.EventHandler

IsReadOnlyChanged

Occurs when IsReadOnly property changes.

Declaration
public event EventHandler IsReadOnlyChanged
Event Type
System.EventHandler

MergeFieldToStringConverting

Occurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it becames a result string value.

Declaration
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConverting
Event Type
System.EventHandler<MergeFieldToStringConvertingEventArgs>

PreviewEditorKeyDown

Occurs when a key is pressed while and editor is focused.

Declaration
public event PreviewEditorKeyEventHandler PreviewEditorKeyDown
Event Type
PreviewEditorKeyEventHandler

PrintCompleted

Occurs when print is completed.

Declaration
public event EventHandler<PrintCompletedEventArgs> PrintCompleted
Event Type
System.EventHandler<PrintCompletedEventArgs>

PrintStarted

Occurs when printing has started.

Declaration
public event EventHandler PrintStarted
Event Type
System.EventHandler

ProtectionStateChanged

Occurs when the current protection state has changed.

Declaration
public event EventHandler ProtectionStateChanged
Event Type
System.EventHandler

Implements

ProviderUILayerInitialized

Occurs when the child elements of an UI layer have been initialized and added to its container.

Declaration
public event EventHandler<ProviderUILayerInitilizedEventArgs> ProviderUILayerInitialized
Event Type
System.EventHandler<ProviderUILayerInitilizedEventArgs>

ScaleFactorChanged

Occurs when the ScaleFactor property value has changed.

Declaration
public event EventHandler ScaleFactorChanged
Event Type
System.EventHandler

Implements

SelectedLayoutBoxChanged

Occurs when currently selected layout box has changed.

Declaration
public event EventHandler<SelectedLayoutBoxChangedEventArgs> SelectedLayoutBoxChanged
Event Type
System.EventHandler<SelectedLayoutBoxChangedEventArgs>

SelectionChanged

Occurs when selection is changed.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

StreamFromUriResolving

Occurs when resolving a URI tfor a stram object.

Declaration
public event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolving
Event Type
System.EventHandler<StreamFromUriResolvingEventArgs>

UntrackableCommandExecuting

Occurs when executing command that does not support track changes and track changes are enabled.

Declaration
public event EventHandler<UntrackableCommandExecutingEventArgs> UntrackableCommandExecuting
Event Type
System.EventHandler<UntrackableCommandExecutingEventArgs>

UserInfoChanged

Occurs when the current user info has changed.

Declaration
public event EventHandler UserInfoChanged
Event Type
System.EventHandler

Explicit Interface Implementations

IPrintable.BeginPrint(RadPrintDocument, PrintEventArgs)

Declaration
int IPrintable.BeginPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Int32

Implements

IPrintable.EndPrint(RadPrintDocument, PrintEventArgs)

Declaration
bool IPrintable.EndPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Boolean

Implements

IPrintable.GetSettingsDialog(RadPrintDocument)

Declaration
Form IPrintable.GetSettingsDialog(RadPrintDocument document)
Parameters
RadPrintDocument document

Returns
System.Windows.Forms.Form

Implements

IPrintable.PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)

Declaration
bool IPrintable.PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)
Parameters
System.Int32 pageNumber

RadPrintDocument sender

System.Drawing.Printing.PrintPageEventArgs args

Returns
System.Boolean

Implements

IDocumentEditor.ChangeForeColor(Color)

Declaration
void IDocumentEditor.ChangeForeColor(Color newColor)
Parameters
Color newColor

Implements

IDocumentEditor.ChangeHighlightColor(Color)

Declaration
void IDocumentEditor.ChangeHighlightColor(Color newColor)
Parameters
Color newColor

Implements

IDocumentEditor.ChangeParagraphListStyle(ListStyle)

Declaration
void IDocumentEditor.ChangeParagraphListStyle(ListStyle style)
Parameters
ListStyle style

Implements

IDocumentEditor.ChangeParagraphTextAlignment(RadTextAlignment)

Declaration
void IDocumentEditor.ChangeParagraphTextAlignment(RadTextAlignment alignment)
Parameters
RadTextAlignment alignment

Implements

IDocumentEditor.ChangeSectionFooter(Section, HeaderFooterType, Footer)

Declaration
void IDocumentEditor.ChangeSectionFooter(Section section, HeaderFooterType footerType, Footer footer)
Parameters
Section section

HeaderFooterType footerType

Footer footer

Implements

IDocumentEditor.ChangeSectionHeader(Section, HeaderFooterType, Header)

Declaration
void IDocumentEditor.ChangeSectionHeader(Section section, HeaderFooterType headerType, Header header)
Parameters
Section section

HeaderFooterType headerType

Header header

Implements

IDocumentEditor.Delete(Boolean)

Deletes from the document respecting CaretPosition and Selection.

Declaration
bool IDocumentEditor.Delete(bool deletePrevious)
Parameters
System.Boolean deletePrevious

If the selection is empty, indicates whether to delete the character before or after the caret.
Returns
System.Boolean

True if the command was executed successfully.
Implements

IDocumentEditor.DeleteHyperlink(HyperlinkRangeStart)

Declaration
void IDocumentEditor.DeleteHyperlink(HyperlinkRangeStart rangeStart)
Parameters
HyperlinkRangeStart rangeStart

Implements

IDocumentEditor.Insert(String)

Inserts text into the document at current caret position.

Declaration
bool IDocumentEditor.Insert(string text)
Parameters
System.String text

The text to insert.
Returns
System.Boolean

True if the command was executed successfully.
Implements

IDocumentEditor.SetListNumbering(Int32)

Declaration
bool IDocumentEditor.SetListNumbering(int numbersToSkip)
Parameters
System.Int32 numbersToSkip

Returns
System.Boolean

Implements

IDocumentEditor.UpdatePermissionRanges(IEnumerable<PermissionRangeInfo>, IEnumerable<PermissionRangeInfo>)

Declaration
void IDocumentEditor.UpdatePermissionRanges(IEnumerable<PermissionRangeInfo> permissionsToAdd, IEnumerable<PermissionRangeInfo> permissionsToRemove)
Parameters
System.Collections.Generic.IEnumerable<PermissionRangeInfo> permissionsToAdd

System.Collections.Generic.IEnumerable<PermissionRangeInfo> permissionsToRemove

Implements

IDocumentEditorPresenterContainer.CallOnNoteReferenceClicked(MouseButtonEventArgs)

Declaration
void IDocumentEditorPresenterContainer.CallOnNoteReferenceClicked(MouseButtonEventArgs args)
Parameters
MouseButtonEventArgs args

Implements

IDocumentEditorPresenterContainer.DocumentEditor

Declaration
IDocumentEditor IDocumentEditorPresenterContainer.DocumentEditor { get; }
Returns
IDocumentEditor

Implements

IDocumentEditorPresenterContainer.GetUIProviderRegistry()

Declaration
UIProviderRegistry IDocumentEditorPresenterContainer.GetUIProviderRegistry()
Returns
UIProviderRegistry

Implements

IDocumentEditorPresenterContainer.HeaderFooterUIContext

Declaration
HeaderFooterUIContext IDocumentEditorPresenterContainer.HeaderFooterUIContext { get; }
Returns
HeaderFooterUIContext

Implements

IDocumentEditorPresenterContainer.HideSelectionMarkers()

Declaration
void IDocumentEditorPresenterContainer.HideSelectionMarkers()
Implements

IDocumentEditorPresenterContainer.InvalidateEditorArrange()

Declaration
void IDocumentEditorPresenterContainer.InvalidateEditorArrange()
Implements

IDocumentEditorPresenterContainer.InvalidateEditorMeasure()

Declaration
void IDocumentEditorPresenterContainer.InvalidateEditorMeasure()
Implements

IDocumentEditorPresenterContainer.SetActiveDocumentEditor(IDocumentEditor, DocumentEditorType)

Declaration
void IDocumentEditorPresenterContainer.SetActiveDocumentEditor(IDocumentEditor documentEditor, DocumentEditorType documentEditorType)
Parameters
IDocumentEditor documentEditor

DocumentEditorType documentEditorType

Implements

IDocumentEditorPresenterContainer.ShouldShowSelectionMarkers

Declaration
bool IDocumentEditorPresenterContainer.ShouldShowSelectionMarkers { get; }
Returns
System.Boolean

Implements

IDocumentEditorPresenterContainer.ShowSelectionMarkers()

Declaration
void IDocumentEditorPresenterContainer.ShowSelectionMarkers()
Implements

IDocumentEditorPresenterContainer.TrackCurrentEditingStyles()

Declaration
void IDocumentEditorPresenterContainer.TrackCurrentEditingStyles()
Implements

IDocumentEditorPresenterContainer.UpdateCurrentEditingStyle()

Declaration
void IDocumentEditorPresenterContainer.UpdateCurrentEditingStyle()
Implements

IDocumentEditorPresenterContainer.UpdateCurrentVisiblePage(Int32)

Declaration
void IDocumentEditorPresenterContainer.UpdateCurrentVisiblePage(int newValue)
Parameters
System.Int32 newValue

Implements

Extension Methods