ClassRadRichTextBox
Represents rich text box control, which can be used to visualize and edit RadDocument.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
[TelerikToolboxCategory("Documents")]
public class RadRichTextBox : Control, IDocumentEditorPresenterContainer, IDocumentEditor
Inheritance: objectRadRichTextBox
Implements:
Constructors
RadRichTextBox()
Initializes a new instance of the RadRichTextBox class.
Declaration
public RadRichTextBox()
Fields
AcceptsReturnProperty
Declaration
public static readonly DependencyProperty AcceptsReturnProperty
Field Value
DependencyProperty
AcceptsTabProperty
Declaration
public static readonly DependencyProperty AcceptsTabProperty
Field Value
DependencyProperty
AllowScalingProperty
Declaration
public static readonly DependencyProperty AllowScalingProperty
Field Value
DependencyProperty
CaretColorProperty
Declaration
public static readonly DependencyProperty CaretColorProperty
Field Value
DependencyProperty
CaretWidthScaleFactorProperty
Declaration
public static readonly DependencyProperty CaretWidthScaleFactorProperty
Field Value
DependencyProperty
CommandsProperty
Declaration
public static readonly DependencyProperty CommandsProperty
Field Value
DependencyProperty
CommentTemplateContentMarginProperty
Declaration
public static readonly DependencyProperty CommentTemplateContentMarginProperty
Field Value
DependencyProperty
CurrentUserProperty
Declaration
public static readonly DependencyProperty CurrentUserProperty
Field Value
DependencyProperty
DocumentInheritsDefaultStyleSettingsProperty
Declaration
public static readonly DependencyProperty DocumentInheritsDefaultStyleSettingsProperty
Field Value
DependencyProperty
EnforcedPermissionRangeBrushProperty
Declaration
public static readonly DependencyProperty EnforcedPermissionRangeBrushProperty
Field Value
DependencyProperty
HasValidationErrorsProperty
Declaration
public static readonly DependencyProperty HasValidationErrorsProperty
Field Value
DependencyProperty
HorizontalScrollBarName
Declaration
public const string HorizontalScrollBarName = "HorizontalScrollBar"
Field Value
HorizontalScrollBarVisibilityProperty
Declaration
public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty
Field Value
DependencyProperty
HyperlinkNavigationModeProperty
Declaration
public static readonly DependencyProperty HyperlinkNavigationModeProperty
Field Value
DependencyProperty
HyperlinkToolTipFormatStringProperty
Declaration
public static readonly DependencyProperty HyperlinkToolTipFormatStringProperty
Field Value
DependencyProperty
IsAdvancedSelectionEnabledProperty
Declaration
public static readonly DependencyProperty IsAdvancedSelectionEnabledProperty
Field Value
DependencyProperty
IsContextMenuEnabledProperty
Declaration
public static readonly DependencyProperty IsContextMenuEnabledProperty
Field Value
DependencyProperty
IsFocusableProperty
Declaration
public static readonly DependencyProperty IsFocusableProperty
Field Value
DependencyProperty
IsImageMiniToolBarEnabledProperty
Declaration
public static readonly DependencyProperty IsImageMiniToolBarEnabledProperty
Field Value
DependencyProperty
IsInPagedLayoutModeProperty
Declaration
public static readonly DependencyProperty IsInPagedLayoutModeProperty
Field Value
DependencyProperty
IsPasteOptionsPopupEnabledProperty
Represents the IsPasteOptionsPopupEnabled dependency property.
Declaration
public static readonly DependencyProperty IsPasteOptionsPopupEnabledProperty
Field Value
DependencyProperty
IsReadOnlyProperty
Declaration
public static readonly DependencyProperty IsReadOnlyProperty
Field Value
DependencyProperty
IsSelectionEnabledProperty
Declaration
public static readonly DependencyProperty IsSelectionEnabledProperty
Field Value
DependencyProperty
IsSelectionMiniToolBarEnabledProperty
Declaration
public static readonly DependencyProperty IsSelectionMiniToolBarEnabledProperty
Field Value
DependencyProperty
IsSpellCheckingEnabledProperty
Declaration
public static readonly DependencyProperty IsSpellCheckingEnabledProperty
Field Value
DependencyProperty
IsTrackChangesEnabledProperty
Declaration
public static readonly DependencyProperty IsTrackChangesEnabledProperty
Field Value
DependencyProperty
LayoutModeProperty
Declaration
public static readonly DependencyProperty LayoutModeProperty
Field Value
DependencyProperty
LineBreakingRuleLanguageProperty
Declaration
public static readonly DependencyProperty LineBreakingRuleLanguageProperty
Field Value
DependencyProperty
MaxScaleFactor
Represents the maximum scale factor the control supports.
MeasuringPanelName
Declaration
public const string MeasuringPanelName = "MeasuringPanel"
Field Value
MinScaleFactor
Represents the minimum scale factor the control supports.
MouseOverBorderThicknessProperty
Declaration
public static readonly DependencyProperty MouseOverBorderThicknessProperty
Field Value
DependencyProperty
PrintingScreenName
Declaration
public const string PrintingScreenName = "PrintingScreen"
Field Value
ProtectionAuthenticationProviderProperty
Declaration
public static readonly DependencyProperty ProtectionAuthenticationProviderProperty
Field Value
DependencyProperty
ScaleFactorProperty
Declaration
public static readonly DependencyProperty ScaleFactorProperty
Field Value
DependencyProperty
SelectionFillProperty
Declaration
public static readonly DependencyProperty SelectionFillProperty
Field Value
DependencyProperty
SelectionStrokeProperty
Declaration
public static readonly DependencyProperty SelectionStrokeProperty
Field Value
DependencyProperty
ShowCommentsProperty
Declaration
public static readonly DependencyProperty ShowCommentsProperty
Field Value
DependencyProperty
ShowFormattingSymbolsProperty
Declaration
public static readonly DependencyProperty ShowFormattingSymbolsProperty
Field Value
DependencyProperty
ShowMergeFieldsHighlightProperty
Declaration
public static readonly DependencyProperty ShowMergeFieldsHighlightProperty
Field Value
DependencyProperty
VerticalScrollBarName
Declaration
public const string VerticalScrollBarName = "VerticalScrollBar"
Field Value
VerticalScrollBarVisibilityProperty
Declaration
public static readonly DependencyProperty VerticalScrollBarVisibilityProperty
Field Value
DependencyProperty
ViewContentPresenter
Declaration
public const string ViewContentPresenter = "ViewPresenter"
Field Value
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
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.
ActiveDocumentEditor
Gets the active document editor for the RadRichTextBox, allowing for manipulation and editing of the current document.
Declaration
public IDocumentEditor ActiveDocumentEditor { get; }
Property Value
ActiveEditorPresenter
Gets or sets a value representing the active document presenter.
Declaration
public IDocumentEditorPresenter ActiveEditorPresenter { get; set; }
Property Value
AddNewBibliographicSourceDialog
Gets or sets a value representing the current add new bibliographic reference dialog instance.
Declaration
[Browsable(false)]
public IAddNewBibliographicSourceDialog AddNewBibliographicSourceDialog { get; set; }
Property Value
AllowScaling
Gets or sets a value indicating whether the scaling is enabled.
AutoInsertHyperlinks
Gets or sets a value indicating whether the RadRichTextBox automatically inserts hyperlinks when text is recognized as a URL.
Declaration
public bool AutoInsertHyperlinks { get; set; }
Property Value
A boolean value, where true enables automatic hyperlink insertion and false disables it.
Implements
CaretColor
Gets or sets the color of the caret in the RadRichTextBox.
Declaration
public Color CaretColor { get; set; }
Property Value
Color
A Color representing the color of the caret.
Implements
CaretFactory
Gets the factory responsible for creating caret instances in the RadRichTextBox.
Declaration
public ICaretFactory CaretFactory { get; set; }
Property Value
Implements
CaretWidthScaleFactor
Gets or sets a value representing the scale factor of the width of the caret.
Declaration
public int CaretWidthScaleFactor { get; set; }
Property Value
Implements
ChangeEditingPermissionsDialog
Gets or sets a value representing the current dialog for changing document permissions.
Declaration
[Browsable(false)]
public IChangeEditingPermissionsDialog ChangeEditingPermissionsDialog { get; set; }
Property Value
CheckBoxPropertiesDialog
Gets or sets a value representing the current dialog for editing CheckBox content control properties.
Declaration
[Browsable(false)]
public ICheckBoxPropertiesDialog CheckBoxPropertiesDialog { get; set; }
Property Value
CodeFormattingDialog
Gets or sets a value representing the current code formatting dialog instance.
Declaration
[Browsable(false)]
public ICodeFormattingDialog CodeFormattingDialog { get; set; }
Property Value
Commands
Represents a collection of commands for the RadRichTextBox control.
Declaration
public RichTextBoxCommands Commands { get; set; }
Property Value
CommentPaneMinWidth
Gets or sets the minimum width of the Comment Pane in the RadRichTextBox control.
Declaration
public double CommentPaneMinWidth { get; set; }
Property Value
A double representing the minimum width in pixels. The default value is 200.
Implements
CommentTemplateContentMargin
Gets or sets the comment template content margin.
Declaration
public Thickness CommentTemplateContentMargin { get; set; }
Property Value
Thickness
Implements
ContextMenu
Gets or sets a value representing the current context menu.
Declaration
public IContextMenu ContextMenu { get; set; }
Property Value
CurrentEditingContext
Gets the current editing context of the RadRichTextBox, which provides information about the current selection and editing actions.
Declaration
public EditingContext CurrentEditingContext { get; }
Property Value
Implements
CurrentEditingStyle
Gets a value indicating the current editing style.
Declaration
public StyleDefinition CurrentEditingStyle { get; }
Property Value
Implements
CurrentPasteContext
Declaration
public PasteContext CurrentPasteContext { get; }
Property Value
CurrentUser
Gets or sets the name of the current user associated with the RadRichTextBox instance.
Declaration
public UserInfo CurrentUser { get; set; }
Property Value
A string representing the name of the current user.
CurrentVisiblePage
Gets the currently visible page index of the RadRichTextBox.
DatePickerPropertiesDialog
Gets or sets a value representing the current dialog for editing DatePicker content control properties.
Declaration
[Browsable(false)]
public IDatePickerPropertiesDialog DatePickerPropertiesDialog { get; set; }
Property Value
DefaultInputBindings
Gets the default input bindings for the RadRichTextBox control.
Declaration
public static InputBindingCollection DefaultInputBindings { get; }
Property Value
InputBindingCollection
DefaultStyleSettings
Gets a StyleDefinition instance that stores default values for span and paragraph properties.
If DocumentInheritsDefaultStyleSettings is set to true, these properties are used as default style properties for the document elements in Document.
Declaration
public StyleDefinition DefaultStyleSettings { get; }
Property Value
DefaultTextRenderingMode
Declaration
public static TextBlockRenderingMode DefaultTextRenderingMode { get; set; }
Property Value
Document
Gets or sets the current document.
Declaration
public RadDocument Document { get; set; }
Property Value
Implements
DocumentInheritsDefaultStyleSettings
Gets or sets a value indicating whether FontFamily, FontSize, Foreground, FontWeight and FontStyle properties of this instance, or the properties from DefaultStyleSettings, should be used as default style properties for the document elements in Document.
Declaration
public bool DocumentInheritsDefaultStyleSettings { get; set; }
Property Value
DropDownListPropertiesDialog
Gets or sets a value representing the current dialog for editing DropDownList content control properties.
Declaration
[Browsable(false)]
public IDropDownListPropertiesDialog DropDownListPropertiesDialog { get; set; }
Property Value
EditCustomDictionaryDialog
Gets or sets a value representing the current instance of the dialog for editing custom dictionaries.
Declaration
[Browsable(false)]
public IEditCustomDictionaryDialog EditCustomDictionaryDialog { get; set; }
Property Value
EmailPattern
Gets or sets the email pattern used for validation in the RadRichTextBox.
Declaration
public string EmailPattern { get; set; }
Property Value
A string representing the regular expression pattern for validating email addresses.
Implements
EnforcedPermissionRangeBrush
Gets or sets the brush used to visually indicate enforced permission ranges in the RadRichTextBox.
Declaration
public Brush EnforcedPermissionRangeBrush { get; set; }
Property Value
Brush
A Brush object that determines the appearance of the enforced permission ranges. Defaults to null if not set.
Implements
FieldShadingMode
Specifies the shading mode for fields in the RadRichTextBox.
Declaration
public FieldShadingType FieldShadingMode { get; set; }
Property Value
Implements
FindReplaceDialog
Gets or sets a value representing the current find/replace dialog instance.
Declaration
[Browsable(false)]
public IFindReplaceDialog FindReplaceDialog { get; set; }
Property Value
FloatingBlockPropertiesDialog
Gets or sets a value representing the current floating block properties dialog instance.
Declaration
[Browsable(false)]
public IFloatingBlockPropertiesDialog FloatingBlockPropertiesDialog { get; set; }
Property Value
FontPropertiesDialog
Gets or sets a value representing the current font properties dialog instance.
Declaration
[Browsable(false)]
public IFontPropertiesDialog FontPropertiesDialog { get; set; }
Property Value
HorizontalOffset
Gets the horizontal scroll position.
HorizontalScrollBar
Gets the horizontal scroll bar instance of the control.
Declaration
public virtual ScrollBar HorizontalScrollBar { get; }
Property Value
ScrollBar
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
The hyperlink navigation mode.
HyperlinkPattern
Represents the hyperlink formatting pattern in a RadRichTextBox.
Provides functionality for working with hyperlinks within the text document.
Declaration
public string HyperlinkPattern { get; set; }
Property Value
Implements
HyperlinkToolTipFormatString
Gets or sets the hyperlink tool tip text.
Declaration
public string HyperlinkToolTipFormatString { get; set; }
Property Value
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
Implements
ImageEditorDialog
Gets or sets the image editor dialog.
Declaration
[Browsable(false)]
public IImageEditorDialog ImageEditorDialog { get; set; }
Property Value
The image editor dialog.
ImageMiniToolBar
Gets or sets the image mini toolbar.
Declaration
public IImageMiniToolBar ImageMiniToolBar { get; set; }
Property Value
The image mini toolbar.
ImageSelectionAdornerSettings
Represents the settings for the image selection adorner in the RadRichTextBox.
Declaration
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }
Property Value
Implements
InputHandler
Represents the input handler for the RadRichTextBox, managing user input and interactions.
Declaration
public IRichTextBoxInputHandler InputHandler { get; set; }
Property Value
InsertCaptionDialog
Gets or sets a value representing the current Insert Caption dialog instance.
Declaration
[Browsable(false)]
public IInsertCaptionDialog InsertCaptionDialog { get; set; }
Property Value
InsertCrossReferenceWindow
Gets or sets a value representing the current insert cross-reference window instance.
Declaration
public IInsertCrossReferenceWindow InsertCrossReferenceWindow { get; set; }
Property Value
InsertDateTimeDialog
Gets or sets a value representing the current spell checking dialog instance.
Declaration
[Browsable(false)]
public IInsertDateTimeDialog InsertDateTimeDialog { get; set; }
Property Value
InsertHyperlinkDialog
Gets or sets a value representing the current insert-hyperlink dialog instance.
Declaration
[Browsable(false)]
public IInsertHyperlinkDialog InsertHyperlinkDialog { get; set; }
Property Value
InsertSymbolWindow
Gets or sets a value representing the current insert symbol window.
Declaration
[Browsable(false)]
public IInsertSymbolWindow InsertSymbolWindow { get; set; }
Property Value
InsertTableDialog
Gets or sets a value representing the current insert table dialog instance.
Declaration
[Browsable(false)]
public IInsertTableDialog InsertTableDialog { get; set; }
Property Value
InsertTableOfContentsDialog
Gets or sets a value representing the current insert Table of Contents window instance.
Declaration
[Browsable(false)]
public IInsertTableOfContentsDialog InsertTableOfContentsDialog { get; set; }
Property Value
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
IsContextMenuEnabled
Gets or sets a value indicating whether context menu is enabled.
IsFocusable
Gets or sets a value that indicates whether a control is included in tab navigation.
IsImageMiniToolBarEnabled
Gets or sets value indicating whether image mini toolBar is enabled.
Declaration
public bool IsImageMiniToolBarEnabled { get; set; }
Property Value
IsInHeaderFooterEditMode
Gets a value indicating whether the RadRichTextBox is currently in header or footer edit mode.
Declaration
public bool IsInHeaderFooterEditMode { get; set; }
Property Value
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
true if this instance is paste options popup enabled; otherwise, false.
IsReadOnly
Gets or sets a value indicating whether the control is read-only.
IsSelectionEnabled
Gets or sets a value indicating whether selection can be made in the document.
IsSelectionMiniToolBarEnabled
Gets or sets value indicating whether selection mini toolBar is enabled.
Declaration
public bool IsSelectionMiniToolBarEnabled { get; set; }
Property Value
IsSpellCheckingEnabled
Gets or sets a value indicating whether the spell checking is enabled for this document.
Declaration
public bool IsSpellCheckingEnabled { get; set; }
Property Value
Implements
IsTouchEnabled
Gets or sets a value indicating whether touch input is enabled for the RadRichTextBox.
Declaration
public bool IsTouchEnabled { get; set; }
Property Value
true if touch input is enabled; otherwise, false.
IsTrackChangesEnabled
Gets or sets a value indicating whether formatting symbols are shown in the document.
Declaration
public bool IsTrackChangesEnabled { get; set; }
Property Value
true if formatting symbols are shown; otherwise, false.
LayoutMode
Gets or sets the document layout mode.
Declaration
public DocumentLayoutMode? LayoutMode { get; set; }
Property Value
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
The line breaking characters rule language.
LineNumberingDialog
Gets or sets a value representing the current line numbering dialog.
Declaration
[Browsable(false)]
public ILineNumberingDialog LineNumberingDialog { get; set; }
Property Value
ManageBibliographicSourcesDialog
Gets or sets a value representing the current Manage Bibliographic Sources reference dialog instance.
Declaration
[Browsable(false)]
public IManageBibliographicSourcesDialog ManageBibliographicSourcesDialog { get; set; }
Property Value
ManageBookmarksDialog
Gets or sets a value representing the current manage bookmark dialog instance.
Declaration
[Browsable(false)]
public IManageBookmarksDialog ManageBookmarksDialog { get; set; }
Property Value
ManageStylesDialog
Gets or sets a value representing the current manage styles dialog instance.
Declaration
[Browsable(false)]
public IManageStylesDialog ManageStylesDialog { get; set; }
Property Value
MentionContext
Represents the context for mentions in the RadRichTextBox, allowing for customizable mention functionality.
Declaration
public MentionContext MentionContext { get; set; }
Property Value
NotesDialog
Gets or sets a value representing the current Notes dialog instance.
Declaration
[Browsable(false)]
public INotesDialog NotesDialog { get; set; }
Property Value
ParagraphPropertiesDialog
Gets or sets a value representing the current paragraph properties dialog.
Declaration
[Browsable(false)]
public IParagraphPropertiesDialog ParagraphPropertiesDialog { get; set; }
Property Value
PasteOptionsPopup
Declaration
public IPasteOptionsPopup PasteOptionsPopup { get; set; }
Property Value
PasteSettings
Gets the current PasteSettings associated with RadRichTextBox
Declaration
public PasteSettings PasteSettings { get; }
Property Value
PicturePropertiesDialog
Gets or sets a value representing the current dialog for editing Picture content control properties.
Declaration
[Browsable(false)]
public IPicturePropertiesDialog PicturePropertiesDialog { get; set; }
Property Value
PlainTextPropertiesDialog
Gets or sets a value representing the current dialog for editing PlainText content control properties.
Declaration
[Browsable(false)]
public IPlainTextPropertiesDialog PlainTextPropertiesDialog { get; set; }
Property Value
ProtectDocumentDialog
Gets or sets a value representing the current dialog for enforcing document protection.
Declaration
[Browsable(false)]
public IProtectDocumentDialog ProtectDocumentDialog { get; set; }
Property Value
ProtectionAuthenticationProvider
Provides authentication support for the protection mechanism of the RadRichTextBox control.
Declaration
public IProtectionAuthenticationProvider ProtectionAuthenticationProvider { get; set; }
Property Value
RegisteredApplicationCommands
Declaration
public ApplicationCommandsCollection RegisteredApplicationCommands { get; }
Property Value
RepeatingSectionPropertiesDialog
Gets or sets a value representing the current dialog for editing RepeatingSection content control properties.
Declaration
[Browsable(false)]
public IRepeatingSectionPropertiesDialog RepeatingSectionPropertiesDialog { get; set; }
Property Value
RichTextPropertiesDialog
Gets or sets a value representing the current dialog for editing RichText content control properties.
Declaration
[Browsable(false)]
public IRichTextPropertiesDialog RichTextPropertiesDialog { get; set; }
Property Value
ScaleFactor
Gets or sets a value representing the current view scale factor.
Declaration
public Size ScaleFactor { get; set; }
Property Value
Size
Implements
ScrollableHeight
Gets the height of the scrollable area in the RadRichTextBox.
ScrollableWidth
Gets the width of the scrollable area within the RadRichTextBox control.
SectionColumnsDialog
Gets or sets a value representing the current section columns dialog.
Declaration
[Browsable(false)]
public ISectionColumnsDialog SectionColumnsDialog { get; set; }
Property Value
SelectedComment
Gets or sets the currently focused comment in the document
Declaration
public Comment SelectedComment { get; set; }
Property Value
Implements
SelectedNote
Gets or sets the currently focused note
SelectionFill
Gets or sets the fill color of the selected text in the RadRichTextBox.
Declaration
public Brush SelectionFill { get; set; }
Property Value
Brush
Implements
SelectionMiniToolBar
Gets or sets a value representing the current selection mini toolbar.
Declaration
public ISelectionMiniToolBar SelectionMiniToolBar { get; set; }
Property Value
SelectionStroke
Gets or sets the selection stroke of the RadRichTextBox. This property defines the visual appearance of the selection in the rich text box, such as its color and thickness.
Declaration
public Brush SelectionStroke { get; set; }
Property Value
Brush
An object representing the stroke applied to the selection. The stroke can be customized to enhance the visual representation of selected text.
Implements
SetNumberingValueDialog
Gets or sets a value representing the current Set Numbering Value reference dialog instance.
Declaration
[Browsable(false)]
public ISetNumberingValueDialog SetNumberingValueDialog { get; set; }
Property Value
ShowComments
Gets or sets a value indicating whether the comments are shown.
ShowFormattingSymbols
Gets or sets a value indicating whether formatting symbols are shown in the document.
Declaration
public bool ShowFormattingSymbols { get; set; }
Property Value
true if formatting symbols are shown; otherwise, false.
Implements
ShowMergeFieldsHighlight
Displays the highlight for merge fields in the RadRichTextBox control.
Declaration
public bool ShowMergeFieldsHighlight { get; set; }
Property Value
SpellChecker
Gets or sets the ISpellChecker implementation used when proofing.
Declaration
public ISpellChecker SpellChecker { get; set; }
Property Value
Implements
SpellCheckingDialog
Gets or sets a value representing the current spell checking dialog instance.
Declaration
[Browsable(false)]
public ISpellCheckingDialog SpellCheckingDialog { get; set; }
Property Value
StyleFormattingPropertiesDialog
Gets or sets a value representing the current style formatting properties dialog instance.
Declaration
[Browsable(false)]
public IStyleFormattingPropertiesDialog StyleFormattingPropertiesDialog { get; set; }
Property Value
TabStopsPropertiesDialog
Gets or sets a value representing the current tab stops properties dialog instance.
Declaration
[Browsable(false)]
public ITabStopsPropertiesDialog TabStopsPropertiesDialog { get; set; }
Property Value
TableBordersDialog
Gets or sets a value representing the current table borders dialog instance.
Declaration
[Browsable(false)]
public ITableBordersDialog TableBordersDialog { get; set; }
Property Value
TablePropertiesDialog
Gets or sets a value representing the current table properties dialog instance.
Declaration
[Browsable(false)]
public ITablePropertiesDialog TablePropertiesDialog { get; set; }
Property Value
TextRenderingMode
Declaration
public TextBlockRenderingMode TextRenderingMode { get; set; }
Property Value
TrackChangesOptions
Gets or sets the options for tracking changes in the RadRichTextBox control.
Declaration
public TrackChangesOptions TrackChangesOptions { get; }
Property Value
A TrackChangesOptions value that specifies how changes are tracked in the document.
UILayersBuilder
Builds and configures the user interface layers for the RadRichTextBox control.
Declaration
public UILayersBuilder UILayersBuilder { get; set; }
Property Value
Implements
UnprotectDocumentDialog
Gets or sets a value representing the current dialog for removing document protection.
Declaration
[Browsable(false)]
public IUnprotectDocumentDialog UnprotectDocumentDialog { get; set; }
Property Value
UsePreviousVersionOfMicrosoftIme
Gets or sets whether you want to use the previous version of Microsoft IME. Must be synchronized with the option in the OS settings.
Declaration
public bool UsePreviousVersionOfMicrosoftIme { get; set; }
Property Value
Implements
Users
Gets the collection of users associated with the RadRichTextBox instance.
Declaration
public PermissionInfoCollection Users { get; set; }
Property Value
VerticalOffset
Gets the vertical scroll position.
VerticalScrollBar
Gets the vertical scroll bar instance of the control.
Declaration
public virtual ScrollBar VerticalScrollBar { get; }
Property Value
ScrollBar
VerticalScrollBarVisibility
Gets or sets a value representing the vertical scroll bar visibility.
Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
ScrollBarVisibility
ViewportHeight
Gets the height of the viewport in the RadRichTextBox control.
ViewportWidth
Gets the width of the viewport in the RadRichTextBox control.
WatermarkSettingsDialog
Gets or sets a value representing the current Watermark Settings dialog instance.
Declaration
[Browsable(false)]
public IWatermarkSettingsDialog WatermarkSettingsDialog { get; set; }
Property Value
Methods
AcceptAllRevisions()
Accepts all revisions in the document.
Declaration
public void AcceptAllRevisions()
Implements
AcceptRevision(Revision)
Accepts a revision.
Declaration
public void AcceptRevision(Revision revision)
Parameters
revision
The revision.
Implements
AddShapeTextBox(ShapeInline)
Initializes a text box element for a shape that does not have any.
Declaration
public void AddShapeTextBox(ShapeInline shape)
Parameters
shape
The ShapeInline.
Implements
AddTabStop(TabStop)
Adds a tab stop to the current paragraph.
Declaration
public void AddTabStop(TabStop tabStop)
Parameters
tabStop
The tab stop.
Implements
AddTabStopRange(IEnumerable<TabStop>)
Adds a tab stop range to the current paragraph.
Declaration
public void AddTabStopRange(IEnumerable<TabStop> tabStops)
Parameters
tabStops
The tab stop collection.
Implements
BeginUndoGroup()
Begins a new group of actions which will appear as a single item in the document history.
Declaration
public void BeginUndoGroup()
Implements
CanCopyFormatting()
Returns a value indicating whether the formatting can be copied according to the current selection.
Declaration
public bool CanCopyFormatting()
Returns
The value indicating whether the formatting can be copied.
CancelUndoGroup()
Cancels the currently started undo-able group, started with BeginUndoGroup() and undoes the actions executed since the starting of the group.
If an undo group is not started, an InvalidOperationException is thrown.
Declaration
public void CancelUndoGroup()
Implements
ChangeAllFieldsDisplayMode(FieldDisplayMode)
Changes the display mode of all fields in the document.
Declaration
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)
Parameters
displayMode
The display mode which will be used for the fields.
Implements
ChangeBaselineAlignment(BaselineAlignment)
Changes the baseline alignment of the selected content.
Declaration
public void ChangeBaselineAlignment(BaselineAlignment baselineAlignment)
Parameters
baselineAlignment
The 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
newBibliographicStyle
BibliographicReferenceStyleBase
The new bibliographic style.
Implements
ChangeDifferentFirstPageHeaderFooter(bool)
Sets a value determining whether the headers and footers of the first page in the selected sections are different than the ones of the other pages.
Declaration
public void ChangeDifferentFirstPageHeaderFooter(bool value)
Parameters
value
If set to true, the header and footer of the first page will be different than the rest of the pages in the section.
Implements
ChangeDifferentOddAndEvenPagesHeaderFooter(bool)
Changes the value determining whether the sections should have different odd and even pages header/footer.
Declaration
public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)
Parameters
value
true, if the even and odd page header/footer should differ.
Implements
ChangeDocumentDefaultTabWidth(double)
Changes default tab stop width for the document.
Declaration
public void ChangeDocumentDefaultTabWidth(double tabWidth)
Parameters
tabWidth
Width of the tab.
Implements
ChangeDocumentElementTag(DocumentElement, string)
Changes the Tag property of a specified DocumentElement.
Declaration
public void ChangeDocumentElementTag(DocumentElement element, string tag)
Parameters
element
The DocumentElement.
tag
The new tag value.
Implements
ChangeDocumentEndnotesFirstNumber(int)
Changes the first number of the endnotes in the document.
Declaration
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)
Parameters
firstNumber
The first number.
Implements
ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the endnotes in the document.
Declaration
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
numberingFormat
The numbering format.
Implements
ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the document.
Declaration
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
numberingRestartType
The type of restart for the numbering.
Implements
ChangeDocumentEndnotesPosition(EndnotesPosition)
Changes the position of the endnotes in the document.
Declaration
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)
Parameters
endnotesPosition
The position.
Implements
ChangeDocumentFootnotesFirstNumber(int)
Changes the first number of the footnotes in the document.
Declaration
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)
Parameters
firstNumber
The first number.
Implements
ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the footnotes in the document.
Declaration
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
numberingFormat
The numbering format.
Implements
ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the document.
Declaration
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
numberingRestartType
The type of restart for the numbering.
Implements
ChangeDocumentFootnotesPosition(FootnotesPosition)
Changes the position of the footnotes in the document.
Declaration
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)
Parameters
footnotesPosition
The footnotes position.
Implements
ChangeDocumentIsStrictLineBreakingRuleEnabled(bool)
Sets a value determining whether the strict line breaking rule will be applied to Japanese text in this document.
Declaration
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)
Parameters
value
if set to true, the strict line breaking rule will be applied.
Implements
ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)
Sets the language whose rules should be used for line breaking in the paragraphs.
Declaration
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)
Parameters
lineBreakingRuleLanguage
The line breaking rule language.
Implements
ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)
Sets a rule determining which characters cannot end a line in East-Asian languages.
Declaration
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
lineBreakingCharacterRule
The line breaking character rule.
Implements
ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)
Sets a rule determining which characters cannot start a line in East-Asian languages.
Declaration
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
lineBreakingCharacterRule
The rule.
Implements
ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)
Changes the display mode of a field.
Declaration
public void ChangeFieldDisplayMode(FieldRangeStart fieldRangeStart, FieldDisplayMode displayMode)
Parameters
fieldRangeStart
The field start.
displayMode
The new display mode.
Implements
ChangeFontFamily(FontFamily)
Changes the font family of the selected content.
Declaration
public void ChangeFontFamily(FontFamily fontFamily)
Parameters
fontFamily
FontFamily
The font family to be applied.
Implements
ChangeFontSize(double)
Changes the size of the font of the selected content.
Declaration
public void ChangeFontSize(double newFontSize)
Parameters
newFontSize
Size of the font.
Implements
ChangeFontStyle(FontStyle)
Changes the font style of the selected content.
Declaration
public void ChangeFontStyle(FontStyle fontStyle)
Parameters
fontStyle
FontStyle
The font style.
Implements
ChangeFontWeight(FontWeight)
Changes the font weight of the selected content. If selection is not present, the current editing style is updated.
Declaration
public void ChangeFontWeight(FontWeight fontWeight)
Parameters
fontWeight
FontWeight
The font weight.
Implements
ChangeImageRotateAngle(ImageInline, double)
Changes the rotate angle of an image.
Declaration
public void ChangeImageRotateAngle(ImageInline image, double angle)
Parameters
image
The ImageInline.
angle
The new angle.
Implements
ChangeImageSize(ImageInline, Size)
Changes the size of an image.
Declaration
public void ChangeImageSize(ImageInline image, Size size)
Parameters
image
The ImageInline whose size should be changed.
size
Size
The new size.
Implements
ChangeLayoutMode(DocumentLayoutMode)
Changes the layout mode.
Declaration
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)
Parameters
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
restartType
The line numbering restart type.
Implements
ChangeListStyle(ListStyle)
Changes the style of the list in the RadRichTextBox.
Declaration
public void ChangeListStyle(ListStyle style)
Parameters
style
The new ListStyle to be applied to the list.
ChangeParagraphAutomaticSpacingAfter(bool)
Changes the automatic spacing after of the selected paragraphs.
Declaration
public void ChangeParagraphAutomaticSpacingAfter(bool value)
Parameters
value
If set to true, the automatic spacing after will be enabled.
Implements
ChangeParagraphAutomaticSpacingBefore(bool)
Changes the automatic spacing before of the selected paragraphs.
Declaration
public void ChangeParagraphAutomaticSpacingBefore(bool value)
Parameters
value
If set to true, the automatic spacing before will be enabled.
Implements
ChangeParagraphBackground(Color)
Changes the background of the selected paragraphs.
Declaration
public void ChangeParagraphBackground(Color color)
Parameters
color
Color
The color.
Implements
ChangeParagraphFirstLineIndent(double)
Changes the first line indent of the selected paragraphs.
Declaration
public void ChangeParagraphFirstLineIndent(double firstLineIndent)
Parameters
firstLineIndent
The first line indent.
Implements
ChangeParagraphFlowDirection(FlowDirection)
Changes the flow direction of the selected paragraphs.
Declaration
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)
Parameters
flowDirection
FlowDirection
The flow direction.
Implements
ChangeParagraphIsLineBreakingRuleEnabled(bool)
Changes the IsLineBreakingRuleEnabled property. This property indicates whether East Asian typography rules will be applied to determine which characters may begin and end each line.
Declaration
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)
Parameters
value
If set to true, East Asian typography rules will be applied to determine which characters may begin and end each line.
Implements
ChangeParagraphLeftIndent(double)
Changes the left indent of the selected paragraphs.
Declaration
public void ChangeParagraphLeftIndent(double leftIndent)
Parameters
leftIndent
The left indent.
Implements
ChangeParagraphLineSpacing(double)
Changes the line spacing of the selected paragraphs.
Declaration
public void ChangeParagraphLineSpacing(double lineSpacing)
Parameters
lineSpacing
The line spacing.
Implements
ChangeParagraphLineSpacing(double, LineSpacingType)
Changes the line spacing of the selected paragraphs.
Declaration
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)
Parameters
lineSpacing
The line spacing.
lineSpacingType
Type of the line spacing.
Implements
ChangeParagraphLineSpacingType(LineSpacingType)
Changes the type of the line spacing of the selected paragraphs.
Declaration
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)
Parameters
lineSpacingType
Type of the line spacing.
Implements
ChangeParagraphListLevel(int)
Changes the list level of the selected paragraphs.
Declaration
public void ChangeParagraphListLevel(int listLevel)
Parameters
listLevel
The list level.
Implements
ChangeParagraphRightIndent(double)
Changes the right indent of the selected paragraphs.
Declaration
public void ChangeParagraphRightIndent(double rightIndent)
Parameters
rightIndent
The right indent.
Implements
ChangeParagraphSpacingAfter(double)
Changes the spacing after of the selected paragraphs.
Declaration
public void ChangeParagraphSpacingAfter(double spacingAfter)
Parameters
spacingAfter
The spacing after.
Implements
ChangeParagraphSpacingBefore(double)
Changes the spacing before of the selected paragraphs.
Declaration
public void ChangeParagraphSpacingBefore(double spacingBefore)
Parameters
spacingBefore
The spacing before.
Implements
ChangeParagraphStyle(StyleDefinition)
Changes the paragraph style of the selected content.
Declaration
public void ChangeParagraphStyle(StyleDefinition styleInfo)
Parameters
styleInfo
The style information.
Implements
ChangeRotateTextWithShape(ShapeInline, bool)
Changes a value that indicates whether shape's text box element will rotate when the shape is rotated.
Declaration
public void ChangeRotateTextWithShape(ShapeInline shape, bool shouldRotate)
Parameters
shape
The ShapeInline.
shouldRotate
The new value that indicates text box element rotation behavior.
Implements
ChangeSectionActualPageMargin(Padding)
Changes the page margin of the selected sections respecting their current orientation.
Declaration
public void ChangeSectionActualPageMargin(Padding sectionMargin)
Parameters
sectionMargin
The margin.
Implements
ChangeSectionColumns(SectionColumnCollection)
Changes the section columns for the selected sections.
Declaration
public void ChangeSectionColumns(SectionColumnCollection sectionColumns)
Parameters
sectionColumns
The section columns.
Implements
ChangeSectionColumns(SectionColumnsLayout)
Changes the section columns for a given collection of Section elements.
Declaration
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)
Parameters
sectionColumnsLayout
The section columns layout.
Implements
ChangeSectionEndnotesFirstNumber(int)
Changes the first number of the endnotes in the selected sections.
Declaration
public void ChangeSectionEndnotesFirstNumber(int firstNumber)
Parameters
firstNumber
The first number.
Implements
ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the endnotes in the selected sections.
Declaration
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
numberingFormat
The numbering format.
Implements
ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the selected sections.
Declaration
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
numberingRestartType
The type of restart for the numbering.
Implements
ChangeSectionFirstPageNumber(int?)
Changes the first page number of the selected sections.
Declaration
public void ChangeSectionFirstPageNumber(int? firstPageNumber)
Parameters
firstPageNumber
int?
The first page number.
Implements
ChangeSectionFooterBottomMargin(int)
Changes the footer bottom margin of the selected sections.
Declaration
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)
Parameters
sectionFooterBottomMargin
The section footer bottom margin.
Implements
ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, bool)
Changes the value indicating whether the section footer should be linked to the footer of the previous section.
Declaration
public void ChangeSectionFooterLinkToPrevious(Section section, HeaderFooterType footerType, bool value)
Parameters
section
The section.
footerType
Type of the footer.
value
true if the footer should be linked.
Implements
ChangeSectionFootnotesFirstNumber(int)
Changes the first number of the footnotes in the selected sections.
Declaration
public void ChangeSectionFootnotesFirstNumber(int firstNumber)
Parameters
firstNumber
The first number.
Implements
ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the footnotes in the selected sections.
Declaration
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
numberingFormat
The numbering format.
Implements
ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the footnotes in the selected sections.
Declaration
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
numberingRestartType
The type of restart for the numbering.
Implements
ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, bool)
Changes the value indicating whether the section header should be linked to the header of the previous section.
Declaration
public void ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value)
Parameters
section
The section.
headerType
Type of the header.
value
true if the header should be linked.
Implements
ChangeSectionHeaderTopMargin(int)
Changes the header top margin of the selected sections.
Declaration
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)
Parameters
sectionHeaderTopMargin
The section header top margin.
Implements
ChangeSectionLineNumbering(LineNumbering)
Changes the line numberings for the selected sections.
Declaration
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)
Parameters
lineNumbering
The line numbering.
Implements
ChangeSectionPageMargin(Padding)
Changes the page margin of the selected sections.
Declaration
public void ChangeSectionPageMargin(Padding sectionMargin)
Parameters
sectionMargin
The margin.
Implements
ChangeSectionPageOrientation(PageOrientation)
Changes the page orientation of the selected sections.
Declaration
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)
Parameters
sectionPageOrientation
PageOrientation
The page orientation.
Implements
ChangeSectionPageSize(Size)
Changes the page size of the selected sections.
Declaration
public void ChangeSectionPageSize(Size newSize)
Parameters
newSize
Size
The new size. You can use the PaperTypes enumeration to get the desired size from the predefined values.
Implements
ChangeShapeAutoFitToText(ShapeInline, bool)
Changes a value that indicates whether the parent shape should be horizontally resized in accordance to the text box element's width.
Declaration
public void ChangeShapeAutoFitToText(ShapeInline shape, bool shouldAutoFit)
Parameters
shape
The ShapeInline.
shouldAutoFit
The new value that indicates text box element wrap behavior.
Implements
ChangeShapeFill(ShapeInline, IShapeFill)
Changes the fill of a shape.
Declaration
public void ChangeShapeFill(ShapeInline shape, IShapeFill fill)
Parameters
shape
The ShapeInline.
fill
The new fill.
Implements
ChangeShapeOutlineDash(ShapeInline, LineDashType)
Changes the dashing pattern of a shape outline.
Declaration
public void ChangeShapeOutlineDash(ShapeInline shape, LineDashType dash)
Parameters
shape
The ShapeInline.
dash
The new dashing pattern.
Implements
ChangeShapeOutlineFill(ShapeInline, IShapeOutlineFill)
Changes the fill of a shape outline.
Declaration
public void ChangeShapeOutlineFill(ShapeInline shape, IShapeOutlineFill fill)
Parameters
shape
The ShapeInline.
fill
The new fill.
Implements
ChangeShapeOutlineWidth(ShapeInline, double)
Changes the width of a shape outline.
Declaration
public void ChangeShapeOutlineWidth(ShapeInline shape, double width)
Parameters
shape
The ShapeInline.
width
The new outline width.
Implements
ChangeShapeRotateAngle(ShapeInline, double)
Changes the rotate angle of a shape.
Declaration
public void ChangeShapeRotateAngle(ShapeInline shape, double angle)
Parameters
shape
The ShapeInline.
angle
The new angle.
Implements
ChangeShapeSize(ShapeInline, Size)
Changes the size of a shape.
Declaration
public void ChangeShapeSize(ShapeInline shape, Size size)
Parameters
shape
The ShapeInline whose size should be changed.
size
Size
The new size.
Implements
ChangeShapeTextBottomMargin(ShapeInline, double)
Changes the bottom margin (inset) of the shape's text box element.
Declaration
public void ChangeShapeTextBottomMargin(ShapeInline shape, double margin)
Parameters
shape
The ShapeInline.
margin
The new bottom margin.
Implements
ChangeShapeTextFill(ShapeInline, IShapeFill)
Changes the fill of a shape's text.
Declaration
public void ChangeShapeTextFill(ShapeInline shape, IShapeFill fill)
Parameters
shape
The ShapeInline.
fill
The new fill.
Implements
ChangeShapeTextLeftMargin(ShapeInline, double)
Changes the left margin (inset) of the shape's text box element.
Declaration
public void ChangeShapeTextLeftMargin(ShapeInline shape, double margin)
Parameters
shape
The ShapeInline.
margin
The new left margin.
Implements
ChangeShapeTextOutlineDash(ShapeInline, LineDashType)
Changes the dash of a shape's text outline dash.
Declaration
public void ChangeShapeTextOutlineDash(ShapeInline shape, LineDashType dash)
Parameters
shape
The ShapeInline which is modified.
dash
The new dashing pattern.
Implements
ChangeShapeTextOutlineFill(ShapeInline, IShapeOutlineFill)
Changes the fill of a shape's text outline.
Declaration
public void ChangeShapeTextOutlineFill(ShapeInline shape, IShapeOutlineFill fill)
Parameters
shape
The ShapeInline.
fill
The new fill.
Implements
ChangeShapeTextOutlineWidth(ShapeInline, double)
Changes the width of a shape's outline width.
Declaration
public void ChangeShapeTextOutlineWidth(ShapeInline shape, double width)
Parameters
shape
The ShapeInline which is modified.
width
The new width value.
Implements
ChangeShapeTextRightMargin(ShapeInline, double)
Changes the right margin (inset) of the shape's text box element.
Declaration
public void ChangeShapeTextRightMargin(ShapeInline shape, double margin)
Parameters
shape
The ShapeInline.
margin
The new right margin.
Implements
ChangeShapeTextRotation(ShapeInline, TextRotation)
Changes the rotation angle of the shape's text box element.
Declaration
public void ChangeShapeTextRotation(ShapeInline shape, TextRotation rotation)
Parameters
shape
The ShapeInline.
rotation
The new rotation angle (in degrees).
Implements
ChangeShapeTextTopMargin(ShapeInline, double)
Changes the top margin (inset) of the shape's text box element.
Declaration
public void ChangeShapeTextTopMargin(ShapeInline shape, double margin)
Parameters
shape
The ShapeInline.
margin
The new top margin.
Implements
ChangeShapeTextVerticalAlignment(ShapeInline, RadVerticalAlignment)
Changes the vertical alignment of a shape text box element.
Declaration
public void ChangeShapeTextVerticalAlignment(ShapeInline shape, RadVerticalAlignment alignment)
Parameters
shape
The ShapeInline.
alignment
The new vertical alignment.
Implements
ChangeShapeTextWrap(ShapeInline, bool)
Changes a value that indicates whether shape's text box element should wrap text vertically.
Declaration
public void ChangeShapeTextWrap(ShapeInline shape, bool shouldWrap)
Parameters
shape
The ShapeInline.
shouldWrap
The new value that indicates text box element wrap behavior.
Implements
ChangeSpanStyle(StyleDefinition)
Changes the span style of the selected content.
Declaration
public void ChangeSpanStyle(StyleDefinition styleInfo)
Parameters
styleInfo
The style information.
Implements
ChangeStrikethrough(bool)
Changes the strike-through of the selected content.
Declaration
public void ChangeStrikethrough(bool isStrikethrough)
Parameters
isStrikethrough
If set to true, a strike-through will be applied to the selected content.
Implements
ChangeStyleName(string)
Applies style with a given name to the selected elements in the document.
Declaration
public void ChangeStyleName(string styleName)
Parameters
styleName
Name of the style to be applied.
Implements
ChangeStyleName(string, bool)
Applies style with a given name to the selected elements in the document.
ChangeTableBorders(TableBorders)
Changes the borders of the selected tables.
Declaration
public void ChangeTableBorders(TableBorders tableBorders)
Parameters
tableBorders
The table borders.
Implements
ChangeTableCellBackground(Color)
Changes the background of the selected table cells.
Declaration
public void ChangeTableCellBackground(Color color)
Parameters
color
Color
The color.
Implements
ChangeTableCellBorders(Border)
Changes the borders of the selected table cells.
Declaration
public void ChangeTableCellBorders(Border tableCellBorders)
Parameters
tableCellBorders
The border which will be used for all table cell borders.
Implements
ChangeTableCellBorders(TableCellBorders)
Changes the borders of the selected table cells.
Declaration
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)
Parameters
tableCellBorders
The table cell borders.
Implements
ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)
Changes the content alignment of the selected table cells.
Declaration
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)
Parameters
textAlignment
The text alignment.
verticalAlignment
The vertical alignment.
Implements
ChangeTableCellHorizontalContentAlignment(RadTextAlignment)
Changes the horizontal content alignment of the selected table cells.
Declaration
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)
Parameters
textAlignment
The alignment.
Implements
ChangeTableCellPadding(Padding)
Changes the padding of the selected table cells.
Declaration
public void ChangeTableCellPadding(Padding padding)
Parameters
padding
The padding.
Implements
ChangeTableCellSpacing(double)
Changes the cell spacing of the selected tables.
Declaration
public void ChangeTableCellSpacing(double cellSpacing)
Parameters
cellSpacing
The cell spacing.
Implements
ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)
Changes the vertical content alignment of the selected table cells.
Declaration
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)
Parameters
verticalAlignment
The alignment.
Implements
ChangeTableDefaultCellPadding(Padding)
Changes the default cell padding of the selected tables.
Declaration
public void ChangeTableDefaultCellPadding(Padding padding)
Parameters
padding
The padding which will be used as a default value.
Implements
ChangeTableFlowDirection(FlowDirection)
Changes the flow direction of the selected tables.
Declaration
public void ChangeTableFlowDirection(FlowDirection flowDirection)
Parameters
flowDirection
FlowDirection
The flow direction.
Implements
ChangeTableGridColumnWidth(Table, int, TableWidthUnit)
Changes the width of a table column.
Declaration
public void ChangeTableGridColumnWidth(Table table, int columnIndex, TableWidthUnit width)
Parameters
table
The table.
columnIndex
The index of the column.
width
The new value for the column width. If the type of the width is not specified, Fixed will be used.
Implements
ChangeTableHorizontalAlignment(RadHorizontalAlignment)
Changes the horizontal alignment of the selected tables.
Declaration
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)
Parameters
alignment
The alignment.
Implements
ChangeTableIndent(double)
Changes the indent of the selected tables.
Declaration
public void ChangeTableIndent(double indent)
Parameters
indent
The indent.
Implements
ChangeTableLayoutMode(Table, TableLayoutMode)
Changes the layout mode of the selected tables.
Declaration
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)
Parameters
table
The table.
tableLayoutMode
The table layout mode.
Implements
ChangeTableLook(TableLook)
Changes the look of the selected tables.
The look of a table defines the components of the conditional formatting which will be applied to it.
Declaration
public void ChangeTableLook(TableLook tableLook)
Parameters
tableLook
The table look.
Implements
ChangeTablePreferredWidth(TableWidthUnit)
Changes the preferred width of the selected tables.
Declaration
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)
Parameters
tableWidth
Width of the table.
Implements
ChangeTableRowHeight(TableRow, double)
Changes the height of a table row.
ChangeTableRowRepeatOnEveryPage(TableRow)
Depending on the current value, enables or disables the repetition of a table row on every page.
Declaration
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)
Parameters
tableRow
The table row.
Implements
ChangeTextAlignment(RadTextAlignment)
Changes the text alignment of the current run in the document.
Declaration
public void ChangeTextAlignment(RadTextAlignment alignment)
Parameters
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
newColor
Color
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
newColor
Color
The new highlight color to be applied.
ChangeUnderlineColor(Color)
Changes the underline color of the selected content.
Declaration
public void ChangeUnderlineColor(Color newColor)
Parameters
newColor
Color
The color.
Implements
ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)
Changes the underline decoration of the selected content.
Declaration
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)
Parameters
decoration
IUnderlineUIDecorationProvider
The value.
Implements
ClearAllFormatting()
Clears all the formatting (character and paragraph) from the selected content.
Declaration
public void ClearAllFormatting()
Implements
ClearFormatting()
Clears the character formatting of the selected content.
Declaration
public void ClearFormatting()
Implements
ClearTabStops()
Clears the tab stops inside the 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 must be in a list and should be first in the list, otherwise this method does nothing.
Declaration
public bool ContinueListNumbering()
Returns
A boolean value indicating whether the operation completed successfully.
Implements
Copy()
Copies the 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
A value indicating whether the copy was successful.
Implements
Cut()
Cuts the currently selected document elements into the clipboard.
Declaration
public void Cut()
Implements
DecrementFontSize()
Decrements the size of the font of the selected content with 2 points.
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(bool)
Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the CaretPosition.
Declaration
public void Delete(bool deletePrevious)
Parameters
deletePrevious
If the selection is empty, indicates whether to delete the character before or after the caret.
DeleteAllComments()
Deletes all comments in the document.
Declaration
public void DeleteAllComments()
Implements
DeleteAnnotationRange(AnnotationRangeStart)
Deletes an annotation range.
Declaration
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
rangeStart
The start of the range that will be deleted.
Implements
DeleteBookmark(BookmarkRangeStart)
Deletes a bookmark.
Declaration
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)
Parameters
bookmarkRangeStart
The bookmark range start.
Implements
DeleteBookmark(string)
Deletes a bookmark.
Declaration
public void DeleteBookmark(string bookmarkName)
Parameters
bookmarkName
Name of the bookmark.
Implements
DeleteCodeBlock(CodeAnnotationRangeStart)
Deletes a code block.
Declaration
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)
Parameters
rangeStart
The CodeAnnotationRangeStart 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
The comment range start.
Implements
DeletePermissionRange(PermissionRangeStart)
Deletes a permission range.
Declaration
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)
Parameters
permissionRangeStart
The permission range start.
Implements
DeleteReadOnlyRange()
Deletes the read only range at the current caret position or inside the current selection.
Declaration
public void DeleteReadOnlyRange()
Implements
DeleteReadOnlyRange(ReadOnlyRangeStart)
Deletes read only range.
Declaration
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)
Parameters
readOnlyRangeStart
The read only range that is to be deleted.
Implements
DeleteTable()
Deletes the table the current caret position is in.
Declaration
public void DeleteTable()
Implements
DeleteTable(Table)
Deletes a table.
DeleteTableColumn()
Deletes the current table column which is under the caret position.
Declaration
public void DeleteTableColumn()
Implements
DeleteTableRow()
Deletes the table row under the caret position.
Declaration
public void DeleteTableRow()
Implements
DeleteTableRow(TableRow)
Deletes a table row.
DisableWatermark()
Disables the watermark feature in the RadRichTextBox.
Declaration
public void DisableWatermark()
EditListStyleInDialog(ListStyle)
Edits the list style of the RadRichTextBox in a dialog.
Declaration
public void EditListStyleInDialog(ListStyle listStyle)
Parameters
listStyle
The ListStyle object that defines the new style for the list.
EditShapeTextBox(ShapeInline)
Initiates editing of a shape's text box element.
Declaration
public void EditShapeTextBox(ShapeInline shape)
Parameters
shape
The ShapeInline.
Implements
EndUndoGroup()
Closes current undo group.
Declaration
public void EndUndoGroup()
Implements
EndUndoGroup(string)
Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
Declaration
public void EndUndoGroup(string groupDisplayText)
Parameters
groupDisplayText
Implements
EnsureActiveEditorPresenter()
Ensures control template is applied and ensures ActiveEditorPresenter is initialized to its default value.
Declaration
public bool EnsureActiveEditorPresenter()
Returns
Whether the ActiveEditorPresenter has been created as a result of this method call.
Focus()
Sets the keyboard focus to the RadRichTextBox control.
Declaration
public void Focus()
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)
Retrieves the appearance settings for a specified comment in the RadRichTextBox.
Declaration
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)
Parameters
comment
The comment for which to retrieve the appearance settings.
Returns
Returns the appearance settings associated with the specified comment.
Implements
GetContent(string)
Gets the content in various formats.
GetDocumentEditorPresenterTypeForDocument(RadDocument)
Declaration
protected virtual Type GetDocumentEditorPresenterTypeForDocument(RadDocument document)
Parameters
document
Returns
GetStatisticsInfo()
Retrieves statistical information about the content within the RadRichTextBox.
Declaration
public DocumentStatisticsInfo GetStatisticsInfo()
Returns
An object containing various statistical metrics such as word count, character count, and other relevant information related to the text content.
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()
HasEditPermissions()
Determines whether the current user has edit permissions for the RadRichTextBox.
Declaration
public bool HasEditPermissions()
Returns
A boolean value indicating if the user has edit permissions. Returns true if the user has permission to edit; otherwise, false.
Implements
IncrementFontSize()
Increments the size of the font of the selected content with 2 points.
Declaration
public void IncrementFontSize()
Implements
IncrementParagraphLeftIndent()
Increments the left indent of the current paragraph.
Declaration
public void IncrementParagraphLeftIndent()
Implements
IncrementParagraphListLevel()
Increments the paragraph list level of the selected paragraphs.
Declaration
public void IncrementParagraphListLevel()
Insert(string)
Inserts text into the document at the current caret position.
Declaration
public void Insert(string text)
Parameters
text
The text to insert.
InsertAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)
Inserts an annotation range.
Declaration
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)
Parameters
rangeStart
The annotation range start.
rangeEnd
The annotation range end.
Implements
InsertBookmark(string)
Inserts a bookmark around the current selection. If the selection is empty, the bookmark is inserted at the caret position.
Declaration
public void InsertBookmark(string bookmarkName)
Parameters
bookmarkName
Name of the bookmark.
Implements
InsertCaption(CaptionDefinition, string, bool, bool)
Inserts a caption around the current selection. If the selection is empty, the caption is inserted at the current caret position.
Declaration
public void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)
Parameters
definition
The definition of the caption.
caption
The caption text to be used.
includeLabel
If set to true, the label is included in the caption.
insertBelow
If set to true, the caption is inserted after the current selection.
Implements
InsertCodeBlock(string, CodeFormattingSettings)
Inserts a code block at the caret position. If the caret position is in code block, replaces the current code block.
Declaration
public void InsertCodeBlock(string code, CodeFormattingSettings settings)
Parameters
code
The code to insert.
settings
The settings which will be used for the code block.
Implements
InsertColumnBreak()
Inserts a column break into the document at the current caret position.
Declaration
public void InsertColumnBreak()
Implements
InsertComment(Comment)
Inserts a comment around the current selection. If the selection is empty, the comment is inserted at the caret position.
Declaration
public void InsertComment(Comment comment)
Parameters
comment
The comment.
Implements
InsertCrossReferenceToBookmark(string, ReferenceContentType, bool)
Inserts a cross-reference to a bookmark into the document at the current caret position.
Declaration
public void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
bookmarkName
Name of the bookmark.
contentType
Type of the content.
insertAsHyperlink
If set to true, the cross-reference is inserted as a hyperlink.
Implements
InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, bool)
Inserts a cross-reference to a caption into the document at the current caret position.
Declaration
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
captionParagraph
The paragraph containing the caption sequence field.
contentType
The reference content type. If the paragraph doesn't have applied a Caption style, the method will not be executed.
insertAsHyperlink
A parameter indicating whether the cross-reference field should be a hyperlink.
Implements
InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, bool)
Inserts a cross-reference to a paragraph with Heading style into the document at the current caret position.
Declaration
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
headingParagraph
The paragraph. If the paragraph doesn't have applied a Heading style, the method will not be executed.
contentType
Type of the content.
insertAsHyperlink
If set to true, the cross-reference is inserted as a hyperlink.
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
endnote
The endnote.
Implements
InsertField(Field)
Inserts a field into the document at the current caret position.
InsertField(Field, FieldDisplayMode)
Inserts a field into the document at the current caret position in a specified display mode.
Declaration
public bool InsertField(Field field, FieldDisplayMode displayMode)
Parameters
field
The field.
displayMode
The display mode.
Returns
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
footnote
The footnote.
Implements
InsertFragment(DocumentFragment)
Inserts a fragment at the current caret position.
Declaration
public void InsertFragment(DocumentFragment documentFragment)
Parameters
documentFragment
The fragment to insert.
Exceptions
Thrown when documentFragment is null.
Implements
InsertFragment(DocumentFragment, DocumentPosition)
Inserts a fragment at a specified position. Document selection should be cleared in advance.
Declaration
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)
Parameters
documentFragment
The fragment to insert.
documentPosition
The document position to insert the fragment at.
Exceptions
Thrown when there is selection in the document.
Thrown when documentFragment or documentPosition is null.
Implements
Remarks
Document selection should be cleared before calling this method, otherwise exception may be thrown.
InsertHyperlink(HyperlinkInfo)
Inserts a hyperlink in the document. The hyperlink will be created around the current selection.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)
Parameters
hyperlinkInfo
The hyperlink info.
Implements
InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)
Inserts collection of inlines as hyperlink into the document.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)
Parameters
hyperlinkInfo
The hyperlink info.
inlines
The inlines.
Implements
InsertHyperlink(HyperlinkInfo, string)
Inserts a hyperlink in the document.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)
Parameters
hyperlinkInfo
The hyperlink info.
hyperlinkText
The hyperlink text.
InsertImage(Stream, string)
Inserts an inline image into the document at the current caret position.
InsertInline(Inline)
Inserts inline element into the document at the current caret position.
Declaration
public void InsertInline(Inline inline)
Parameters
inline
The inline element to insert.
Exceptions
Thrown when inline is null.
Implements
InsertInline(Inline, DocumentPosition)
Inserts inline element into the document at a specified caret position. Document selection should be cleared in advance.
Declaration
public void InsertInline(Inline inline, DocumentPosition documentPosition)
Parameters
inline
The inline element to insert.
documentPosition
The document position to insert the inline at.
Exceptions
Thrown when there is selection in the document.
Thrown when inline or documentPosition is null.
Implements
Remarks
Document selection should be cleared before calling this method, otherwise exception may be thrown.
InsertLine(string)
Inserts text at the current caret position and adds a new paragraph after it.
Declaration
public void InsertLine(string text)
Parameters
text
The text.
Implements
InsertLineBreak()
Inserts a line break into the document at the current caret position.
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 into the document at the current caret position.
Declaration
public void InsertPageBreak()
Implements
InsertParagraph()
Inserts a new paragraph at the current caret position.
Declaration
public void InsertParagraph()
Implements
InsertPermissionRange(IEnumerable<PermissionRangeInfo>)
Inserts a new permission range over the current selection. If the selection is empty, the permission range is inserted at the caret position.
Declaration
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)
Parameters
permissionInfos
IEnumerable<PermissionRangeInfo>
The permissions for the new range.
Implements
InsertReadOnlyRange()
Inserts a read only range over the current selection. If the selection is empty, the range is inserted at the caret position.
Declaration
public void InsertReadOnlyRange()
Implements
InsertSectionBreak()
Inserts a section break into the document at the current caret position.
Declaration
public void InsertSectionBreak()
Implements
InsertSectionBreak(SectionBreakType)
Inserts a section break of the specified type into the document at the current caret position.
Declaration
public void InsertSectionBreak(SectionBreakType sectionBreakType)
Parameters
sectionBreakType
The type of the section break.
Implements
InsertShape(ShapeType, Size)
Inserts an inline shape into the document at the current caret position.
Declaration
public void InsertShape(ShapeType shapeType, Size size)
Parameters
shapeType
The type of shape.
size
Size
Shape's initial size.
Implements
InsertStructuredDocumentTag()
Inserts a default structured document tag (Content Control). The default type is RichText.
Declaration
public void InsertStructuredDocumentTag()
InsertStructuredDocumentTag(SdtProperties)
Inserts a structured document tag (Content Control) based on the provided properties.
Declaration
public void InsertStructuredDocumentTag(SdtProperties insertProperties)
Parameters
insertProperties
InsertStructuredDocumentTag(SdtType)
Inserts a structured document tag (Content Control) of the given type.
Declaration
public void InsertStructuredDocumentTag(SdtType insertType)
Parameters
insertType
InsertTable(Table)
Inserts a table in the document.
Note: 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 using the same object.
Declaration
public void InsertTable(Table table)
Parameters
table
The table.
Implements
InsertTable(Table, bool)
Inserts the table.
Declaration
public void InsertTable(Table table, bool shouldInsertParagraphBeforeTable)
Parameters
table
The table.
shouldInsertParagraphBeforeTable
if set to true, an additional empty paragraph is 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.
InsertTable(int, int)
Inserts a new table in the document.
InsertTable(int, int, bool)
Inserts a new table in the document.
Declaration
public void InsertTable(int rows, int columns, bool shouldInsertParagraphBeforeTable)
Parameters
rows
Number of the rows in the table.
columns
Number of the columns in the table.
shouldInsertParagraphBeforeTable
if set to true, an additional empty paragraph is inserted before the table.
InsertTableColumn()
Inserts a table column in the table which is under the caret position.
Declaration
public void InsertTableColumn()
Implements
InsertTableColumnToTheLeft()
Inserts a table column to the left in the table which is under the caret position.
Declaration
public void InsertTableColumnToTheLeft()
Implements
InsertTableColumnToTheRight()
Inserts a table column to the right in the table which is under the caret position.
Declaration
public void InsertTableColumnToTheRight()
Implements
InsertTableRow()
Inserts a new table row in the table under the caret position.
Declaration
public void InsertTableRow()
Implements
InsertTableRowAbove()
Inserts a table row above the one under the caret position.
Declaration
public void InsertTableRowAbove()
Implements
InsertTableRowBelow()
Inserts a table row below the one under the caret position.
Declaration
public void InsertTableRowBelow()
Implements
InsertTextBox()
Inserts a placeholder text box element to the document. It comes with a default shape layout.
Declaration
public void InsertTextBox()
Implements
InvalidateEditorLayout()
Forces the control to invalidate the layout of its child elements.
Declaration
public void InvalidateEditorLayout()
InvalidateProofingErrors(bool)
Clears the spell-checking state of all words in the document and updates the UI.
Declaration
public void InvalidateProofingErrors(bool invalidateIncorrectWordsOnly)
Parameters
invalidateIncorrectWordsOnly
True to invalidate incorrect word only.
MailMerge(bool)
Produces a mail merged document containing the results for all data records.
Declaration
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)
Parameters
startEachRecordOnNewPage
true, if each record should start on a new page.
Returns
The document containing the result of the operation.
Implements
MailMergeCurrentRecord()
Creates a new RadDocument containing the result of merging the template with the values of the current data record.
Declaration
public RadDocument MailMergeCurrentRecord()
Returns
The document.
Implements
MergeTableCells()
Merges the currently selected table cells into one.
Declaration
public void MergeTableCells()
Implements
MoveSelection(DocumentPosition, bool)
Moves the current selection along with the selected document elements to a specified position.
Declaration
public void MoveSelection(DocumentPosition movePosition, bool deleteSelection)
Parameters
movePosition
The start position where the selection should be moved to.
deleteSelection
true, if the current selection and contained elements should be deleted on the original position.
Implements
OnApplyTemplate()
Invoked whenever application of the instance's template is required.
Declaration
public override void OnApplyTemplate()
OnCommandError(CommandErrorEventArgs)
Declaration
protected virtual void OnCommandError(CommandErrorEventArgs args)
Parameters
args
OnCommandExecuted(CommandExecutedEventArgs)
Raises the event.
Declaration
protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)
Parameters
e
The CommandExecutedEventArgs instance containing the event data.
OnCommandExecuting(CommandExecutingEventArgs)
Raises the event.
Declaration
protected virtual void OnCommandExecuting(CommandExecutingEventArgs e)
Parameters
e
The CommandExecutingEventArgs instance containing the event data.
OnCommentShowing(CommentShowingEventArgs)
Raises the event.
Declaration
protected virtual void OnCommentShowing(CommentShowingEventArgs e)
Parameters
e
The CommentShowingEventArgs instance containing the event data.
OnCreateAutomationPeer()
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF)/Silverlight infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
AutomationPeer
The type-specific AutomationPeer implementation.
OnCurrentEditingStyleChanged()
Declaration
protected virtual void OnCurrentEditingStyleChanged()
OnCurrentParagraphStyleChanged()
Declaration
protected virtual void OnCurrentParagraphStyleChanged()
OnCurrentSpanStyleChanged()
Declaration
protected virtual void OnCurrentSpanStyleChanged()
OnCurrentVisiblePageChanged()
Declaration
protected virtual void OnCurrentVisiblePageChanged()
OnDocumentArranged()
Declaration
protected virtual void OnDocumentArranged()
OnDocumentChanged()
Declaration
protected virtual void OnDocumentChanged()
OnDocumentChanging()
Declaration
protected virtual void OnDocumentChanging()
OnDocumentContentChanged()
Declaration
protected virtual void OnDocumentContentChanged()
OnDocumentLayoutModeChanged()
Declaration
protected virtual void OnDocumentLayoutModeChanged()
OnDocumentPresentationChanged(PresentationChangedEventArgs)
Declaration
protected virtual void OnDocumentPresentationChanged(PresentationChangedEventArgs e)
Parameters
e
OnGotFocus(RoutedEventArgs)
Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
e
RoutedEventArgs
OnHyperlinkClicked(object, HyperlinkClickedEventArgs)
Declaration
protected virtual void OnHyperlinkClicked(object sender, HyperlinkClickedEventArgs eventArgs)
Parameters
sender
eventArgs
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
The RoutedEventArgs that contains the event data.
OnIsReadOnlyChanged(EventArgs)
Raises the event.
OnLostFocus(RoutedEventArgs)
Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
e
RoutedEventArgs
OnMergeFieldToStringConverting(object, MergeFieldToStringConvertingEventArgs)
Declaration
protected virtual void OnMergeFieldToStringConverting(object sender, MergeFieldToStringConvertingEventArgs e)
Parameters
sender
e
OnNoteReferenceClicked(MouseButtonEventArgs)
Raises the event.
Declaration
protected virtual void OnNoteReferenceClicked(MouseButtonEventArgs args)
Parameters
args
MouseButtonEventArgs
The MouseButtonEventArgs instance containing the event data.
OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs)
Declaration
protected virtual void OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs e)
Parameters
e
OnPrintCompleted(PrintCompletedEventArgs)
Raises the event.
Declaration
protected virtual void OnPrintCompleted(PrintCompletedEventArgs e)
Parameters
e
The PrintCompletedEventArgs instance containing the event data.
OnPrintStarted(EventArgs)
Raises the event.
OnProtectionStateChanged()
Declaration
protected virtual void OnProtectionStateChanged()
OnScaleFactorChanged()
Declaration
protected virtual void OnScaleFactorChanged()
OnSelectionChanged(EventArgs)
Raises the event.
OnStreamFromUriResolving(StreamFromUriResolvingEventArgs)
Declaration
protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)
Parameters
e
OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs)
Raises the event.
Declaration
protected virtual void OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs e)
Parameters
e
UntrackableCommandExecutingEventArgs
The UntrackableCommandExecutingEventArgs instance containing the event data.
OnUserInfoChanged()
Declaration
protected virtual void OnUserInfoChanged()
OpenContextMenuOnNextSpellingError()
Opens the context menu when the next spelling error is encountered.
Declaration
public void OpenContextMenuOnNextSpellingError()
Remarks
This method is useful for providing users with quick access to spelling correction options during text editing in the RadRichTextBox control.
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.
Declaration
public void Paste(PasteOption pasteOption)
Parameters
pasteOption
Implements
PasteFormatting()
Pastes the currently copied formatting on the current selection.
Declaration
public bool PasteFormatting()
Returns
A value indicating whether the paste was successful.
Implements
PreviewFirstMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the first data record.
Declaration
public bool PreviewFirstMailMergeDataRecord()
Returns
True, if the operation completed successfully.
Implements
PreviewLastMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the last data record.
Declaration
public bool PreviewLastMailMergeDataRecord()
Returns
True, if the operation completed successfully.
Implements
PreviewMailMergeDataRecordAtIndex(int)
Updates all fields in the document with the values evaluated using a specified data record.
PreviewNextMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the next data record.
Declaration
public bool PreviewNextMailMergeDataRecord()
Returns
True, if the operation completed successfully.
Implements
PreviewPreviousMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the previous data record.
Declaration
public bool PreviewPreviousMailMergeDataRecord()
Returns
True, if the operation completed successfully.
Implements
Print(PrintDialog, PrintSettings)
Prints with the specified print dialog. The dialog should already be initialized.
Declaration
public void Print(PrintDialog printDialog, PrintSettings printSettings)
Parameters
printDialog
PrintDialog
The print dialog.
printSettings
The print settings.
Print(PrintSettings)
Declaration
public void Print(PrintSettings printSettings)
Parameters
printSettings
Print(string, PrintMode)
Initializes printing of the current document.
Redo()
Re-executes the last undone command group.
Declaration
public void Redo()
Implements
RegisterCommand(RoutedCommand, Key, ModifierKeys, object)
Registers a new command with the specified key and modifier keys for the RadRichTextBox.
Declaration
public static void RegisterCommand(RoutedCommand command, Key key, ModifierKeys modifierKeys = 0, object commandParameter = null)
Parameters
command
RoutedCommand
The command to be registered.
key
Key
The key associated with the command.
modifierKeys
ModifierKeys
The modifier keys that need to be held while pressing the key.
commandParameter
An optional parameter associated with the command.
RejectAllRevisions()
Rejects all revisions in the document.
Declaration
public void RejectAllRevisions()
Implements
RejectRevision(Revision)
Rejects a revision.
Declaration
public void RejectRevision(Revision revision)
Parameters
revision
The revision.
Implements
RemoveHyperlink()
Removes the hyperlink on the caret position.
Declaration
public void RemoveHyperlink()
RemoveTabStop(TabStop)
Removes a tab stop from the selected paragraphs.
Declaration
public void RemoveTabStop(TabStop tabStop)
Parameters
tabStop
The tab stop.
Implements
RemoveTabStopRange(IEnumerable<TabStop>)
Removes a collection of tab stops in the selected paragraphs.
Declaration
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)
Parameters
tabStops
The tab stops.
Implements
ReplaceTabStop(TabStop, TabStop)
Replaces a tab stop inside the selected paragraphs.
ResizeTableColumn(Table, int, double)
Changes the width of a table column. The specified width value will be applied with width type Fixed. You could specify different width type through the ChangeTableGridColumnWidth(Table, int, TableWidthUnit) method.
RestartListNumbering()
Creates a new list from the current paragraph. The paragraph must be in a list, otherwise this method does nothing.
Declaration
public bool RestartListNumbering()
Returns
A boolean value determining whether the operation completed successfully.
Implements
ScrollToHorizontalOffset(double)
Scrolls the contents of RadRichTextBox to the specified horizontal offset.
Declaration
public void ScrollToHorizontalOffset(double offset)
Parameters
offset
ScrollToNote(Note)
Scrolls the viewport so that a note becomes visible.
Declaration
public void ScrollToNote(Note note)
Parameters
note
The note.
Implements
ScrollToVerticalOffset(double)
Scrolls the contents of RadRichTextBox to the specified vertical offset.
Declaration
public void ScrollToVerticalOffset(double offset)
Parameters
offset
SetSelectedComment(CommentRangeStart)
Sets the selected comment for the RadRichTextBox based on the provided CommentRangeStart.
Declaration
public void SetSelectedComment(CommentRangeStart commentStart)
Parameters
commentStart
The CommentRangeStart that represents the beginning of the comment range to be set.
SetSelectedNote(Note)
Sets the currently selected note in the RadRichTextBox.
Declaration
public void SetSelectedNote(Note note)
Parameters
note
The note to be selected.
SetWatermark(DocumentWatermarkSettings)
Sets a watermark to the selected sections.
Declaration
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)
Parameters
watermarkSettings
The watermark settings describing the watermark that will be applied.
Implements
SetWatermark(PredefinedWatermarkType)
Sets a predefined watermark to the selected sections.
Declaration
public void SetWatermark(PredefinedWatermarkType predefinedType)
Parameters
predefinedType
Type of the predefined watermark.
Implements
SetWatermarkImage(WatermarkImageSettings)
Sets the watermark image for the RadRichTextBox control.
Declaration
public void SetWatermarkImage(WatermarkImageSettings settings)
Parameters
settings
The settings that define the watermark image to be applied.
SetWatermarkText(WatermarkTextSettings)
Sets the watermark text for the RadRichTextBox control.
Declaration
public void SetWatermarkText(WatermarkTextSettings settings)
Parameters
settings
The settings that define the watermark text properties.
ShowAddNewBibliographicSourceDialog(string, bool, Action<BibliographicSource>)
Shows the Add New Bibliographic Source Dialog.
Declaration
public void ShowAddNewBibliographicSourceDialog(string sourceName = null, bool insertFieldOnClose = true, Action<BibliographicSource> callBackOnClosed = null)
Parameters
sourceName
insertFieldOnClose
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(DocumentPosition)
Displays the context menu at the specified document position within the RadRichTextBox.
Declaration
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)
Parameters
position
The document position where the context menu should be shown.
ShowContextMenuAtDocumentPosition(Point, DocumentPosition)
Displays the context menu at the specified document position within the RadRichTextBox.
Declaration
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)
Parameters
proposedLocation
Point
The screen coordinates where the context menu should appear.
position
The position in the document at which the context menu is related.
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
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()
ShowParagraphPropertiesDialog()
Shows the paragraph properties dialog.
Declaration
public void ShowParagraphPropertiesDialog()
ShowProtectDocumentDialog()
Shows the dialog for enforcing document protection.
Declaration
public void ShowProtectDocumentDialog()
ShowSectionColumnsDialog()
Show the sections 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
ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings)
Shows the style formatting properties dialog.
Declaration
public void ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings settings)
Parameters
settings
StyleFormattingPropertiesDialogSettings
The settings.
ShowTabStopsPropertiesDialog()
Shows the dialog for editing tab stops.
Declaration
public void ShowTabStopsPropertiesDialog()
ShowTableBordersDialog()
Shows the table borders dialog.
Declaration
public void ShowTableBordersDialog()
ShowTablePropertiesDialog()
Shows the table properties dialog.
Declaration
public void ShowTablePropertiesDialog()
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, resulting in two new ranges.
Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
rangeStart
The annotation range start to be split.
Implements
SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)
Splits an annotation range at the specified position, resulting in two new ranges.
Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)
Parameters
rangeStart
The annotation range start to be split.
position
The position where the range start should be split.
Implements
SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph>)
Suppress the line numbering for selected paragraphs.
Declaration
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)
Parameters
paragraphs
Implements
ToggleBold()
Toggles the font weight of the selected content between and .
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 the visibility of the different first page header and footer in the RadRichTextBox.
Declaration
public void ToggleDifferentFirstPageHeaderFooter()
ToggleDifferentOddAndEvenPagesHeaderFooter()
Toggles the visibility of different headers and footers for odd and even pages in the RadRichTextBox.
Declaration
public void ToggleDifferentOddAndEvenPagesHeaderFooter()
ToggleFieldCodes(FieldRangeStart)
Toggles the display mode of a field.
Declaration
public void ToggleFieldCodes(FieldRangeStart fieldStart)
Parameters
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 font style of the selected content between and .
Declaration
public void ToggleItalic()
Implements
ToggleMergeFieldsHighlight()
Toggles the highlighting of merge fields in the RadRichTextBox control.
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 the last executed command group.
Declaration
public void Undo()
Implements
UnmergeTableCells()
Splits the currently selected table cell.
Declaration
public void UnmergeTableCells()
Implements
UpdateAllCaptions(CaptionDefinition)
Updates all captions in the document related to a caption definition.
Declaration
public void UpdateAllCaptions(CaptionDefinition captionDefinition)
Parameters
captionDefinition
The caption definition.
Implements
UpdateAllFields()
Updates all fields in the document.
Declaration
public void UpdateAllFields()
Implements
UpdateAllFields(FieldDisplayMode)
Updates all fields in the document and displays them in the specified display mode.
Declaration
public void UpdateAllFields(FieldDisplayMode displayMode)
Parameters
displayMode
The display mode which will be used for the fields.
Implements
UpdateEditorLayout()
Forces the control to update its layout and UI;
Declaration
public void UpdateEditorLayout()
Implements
UpdateEditorLayout(bool)
Forces the control to update its layout and UI.
Declaration
public void UpdateEditorLayout(bool async)
Parameters
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
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
The section of the footer.
footerType
Type of the 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
The section of the header.
headerType
Type of the header.
header
The header.
Events
ActiveDocumentEditorChanged
Occurs when active document editor changes.
Declaration
public event EventHandler<ActiveDocumentEditorChangedEventArgs> ActiveDocumentEditorChanged
Event Value
CommandError
Occurs on error while executing command.
Declaration
public event EventHandler<CommandErrorEventArgs> CommandError
Event Value
CommandExecuted
Occurs after the execution of RichTextBoxCommandBase.
Declaration
public event EventHandler<CommandExecutedEventArgs> CommandExecuted
Event Value
CommandExecuting
Occurs before the execution of RichTextBoxCommandBase.
Declaration
public event EventHandler<CommandExecutingEventArgs> CommandExecuting
Event Value
CommentShowing
Occurs when showing comment.
Declaration
public event EventHandler<CommentShowingEventArgs> CommentShowing
Event Value
CurrentEditingStyleChanged
Occurs when the current editing style has changed.
Declaration
public event EventHandler CurrentEditingStyleChanged
Event Value
CurrentParagraphStyleChanged
Occurs when the current paragraph's style has changed.
Declaration
public event EventHandler CurrentParagraphStyleChanged
Event Value
CurrentSpanStyleChanged
Occurs when the current span's style has changed.
Declaration
public event EventHandler CurrentSpanStyleChanged
Event Value
CurrentVisiblePageChanged
Occurs when the CurrentPage property value has changed.
Declaration
public event EventHandler CurrentVisiblePageChanged
Event Value
DocumentArranged
Occurs when the current document has been arranged.
DocumentChanged
Occurs when the current document has changed.
DocumentChanging
Occurs when the current document is changing.
DocumentContentChanged
Occurs when the content of the current document has changed.
Declaration
public event EventHandler DocumentContentChanged
Event Value
DocumentLayoutModeChanged
Occurs when the layout mode of the current document has changed.
Declaration
public event EventHandler DocumentLayoutModeChanged
Event Value
DocumentPresentationChanged
Declaration
public event EventHandler<PresentationChangedEventArgs> DocumentPresentationChanged
Event Value
HyperlinkClicked
Occurs when the users clicks on a hyperlink in the current document.
Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked
Event Value
IsReadOnlyChanged
Occurs when IsReadOnly property changes.
MergeFieldToStringConverting
Occurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it became a result string value.
Declaration
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConverting
Event Value
PreviewEditorKeyDown
Declaration
public event PreviewEditorKeyEventHandler PreviewEditorKeyDown
Event Value
PrintCompleted
Occurs when print is completed.
Declaration
public event EventHandler<PrintCompletedEventArgs> PrintCompleted
Event Value
PrintStarted
Occurs when printing has started.
ProtectionStateChanged
Occurs when the current protection state has changed.
Declaration
public event EventHandler ProtectionStateChanged
Event Value
Implements
ScaleFactorChanged
Occurs when the ScaleFactor property value has changed.
Declaration
public event EventHandler ScaleFactorChanged
Event Value
Implements
SelectedLayoutBoxChanged
Occurs when currently selected layout box has changed.
Declaration
public event EventHandler<SelectedLayoutBoxChangedEventArgs> SelectedLayoutBoxChanged
Event Value
SelectionChanged
Occurs when selection is changed.
StreamFromUriResolving
Declaration
public event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolving
Event Value
UntrackableCommandExecuting
Occurs when executing command that does not support track changes and track changes are enabled.
Declaration
public event EventHandler<UntrackableCommandExecutingEventArgs> UntrackableCommandExecuting
Event Value
UserInfoChanged
Occurs when the current user info has changed.