RadRichTextBox
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, IDocumentEditorInheritance: objectRadRichTextBox
Implements:
Constructors
Initializes a new instance of the RadRichTextBox class.
public RadRichTextBox()Fields
AcceptsReturnProperty
DependencyProperty
public static readonly DependencyProperty AcceptsReturnPropertyAcceptsTabProperty
DependencyProperty
public static readonly DependencyProperty AcceptsTabPropertyAllowScalingProperty
DependencyProperty
public static readonly DependencyProperty AllowScalingPropertyCaretColorProperty
DependencyProperty
public static readonly DependencyProperty CaretColorPropertyCaretWidthScaleFactorProperty
DependencyProperty
public static readonly DependencyProperty CaretWidthScaleFactorPropertyCommandsProperty
DependencyProperty
public static readonly DependencyProperty CommandsPropertyCommentTemplateContentMarginProperty
DependencyProperty
public static readonly DependencyProperty CommentTemplateContentMarginPropertyCurrentUserProperty
DependencyProperty
public static readonly DependencyProperty CurrentUserPropertyDocumentInheritsDefaultStyleSettingsProperty
DependencyProperty
public static readonly DependencyProperty DocumentInheritsDefaultStyleSettingsPropertyEnforcedPermissionRangeBrushProperty
DependencyProperty
public static readonly DependencyProperty EnforcedPermissionRangeBrushPropertyHasValidationErrorsProperty
DependencyProperty
public static readonly DependencyProperty HasValidationErrorsPropertypublic const string HorizontalScrollBarName = "HorizontalScrollBar"HorizontalScrollBarVisibilityProperty
DependencyProperty
public static readonly DependencyProperty HorizontalScrollBarVisibilityPropertyHyperlinkNavigationModeProperty
DependencyProperty
public static readonly DependencyProperty HyperlinkNavigationModePropertyHyperlinkToolTipFormatStringProperty
DependencyProperty
public static readonly DependencyProperty HyperlinkToolTipFormatStringPropertyIsAdvancedSelectionEnabledProperty
DependencyProperty
public static readonly DependencyProperty IsAdvancedSelectionEnabledPropertyIsContextMenuEnabledProperty
DependencyProperty
public static readonly DependencyProperty IsContextMenuEnabledPropertyIsFocusableProperty
DependencyProperty
public static readonly DependencyProperty IsFocusablePropertyIsImageMiniToolBarEnabledProperty
DependencyProperty
public static readonly DependencyProperty IsImageMiniToolBarEnabledPropertyIsInPagedLayoutModeProperty
DependencyProperty
public static readonly DependencyProperty IsInPagedLayoutModePropertyIsPasteOptionsPopupEnabledProperty
DependencyProperty
Represents the IsPasteOptionsPopupEnabled dependency property.
public static readonly DependencyProperty IsPasteOptionsPopupEnabledPropertyIsReadOnlyProperty
DependencyProperty
public static readonly DependencyProperty IsReadOnlyPropertyIsSelectionEnabledProperty
DependencyProperty
public static readonly DependencyProperty IsSelectionEnabledPropertyIsSelectionMiniToolBarEnabledProperty
DependencyProperty
public static readonly DependencyProperty IsSelectionMiniToolBarEnabledPropertyIsSpellCheckingEnabledProperty
DependencyProperty
public static readonly DependencyProperty IsSpellCheckingEnabledPropertyIsTrackChangesEnabledProperty
DependencyProperty
public static readonly DependencyProperty IsTrackChangesEnabledPropertyLayoutModeProperty
DependencyProperty
public static readonly DependencyProperty LayoutModePropertyLineBreakingRuleLanguageProperty
DependencyProperty
public static readonly DependencyProperty LineBreakingRuleLanguagePropertyRepresents the maximum scale factor the control supports.
public static readonly double MaxScaleFactorpublic const string MeasuringPanelName = "MeasuringPanel"Represents the minimum scale factor the control supports.
public static readonly double MinScaleFactorMouseOverBorderThicknessProperty
DependencyProperty
public static readonly DependencyProperty MouseOverBorderThicknessPropertypublic const string PrintingScreenName = "PrintingScreen"ProtectionAuthenticationProviderProperty
DependencyProperty
public static readonly DependencyProperty ProtectionAuthenticationProviderPropertyScaleFactorProperty
DependencyProperty
public static readonly DependencyProperty ScaleFactorPropertySelectionFillProperty
DependencyProperty
public static readonly DependencyProperty SelectionFillPropertySelectionStrokeProperty
DependencyProperty
public static readonly DependencyProperty SelectionStrokePropertyShowCommentsProperty
DependencyProperty
public static readonly DependencyProperty ShowCommentsPropertyShowFormattingSymbolsProperty
DependencyProperty
public static readonly DependencyProperty ShowFormattingSymbolsPropertyShowMergeFieldsHighlightProperty
DependencyProperty
public static readonly DependencyProperty ShowMergeFieldsHighlightPropertypublic const string VerticalScrollBarName = "VerticalScrollBar"VerticalScrollBarVisibilityProperty
DependencyProperty
public static readonly DependencyProperty VerticalScrollBarVisibilityPropertypublic const string ViewContentPresenter = "ViewPresenter"Properties
Gets or sets a value indicating whether pressing the RETURN key types a RETURN character in the control.
public bool AcceptsReturn { get; set; }Implements:
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.
public bool AcceptsTab { get; set; }Implements:
Gets the active document editor for the RadRichTextBox, allowing for manipulation and editing of the current document.
public IDocumentEditor ActiveDocumentEditor { get; }Gets or sets a value representing the active document presenter.
public IDocumentEditorPresenter ActiveEditorPresenter { get; set; }Gets or sets a value representing the current add new bibliographic reference dialog instance.
[Browsable(false)]
public IAddNewBibliographicSourceDialog AddNewBibliographicSourceDialog { get; set; }Gets or sets a value indicating whether the scaling is enabled.
public bool AllowScaling { get; set; }Implements:
Gets or sets a value indicating whether the RadRichTextBox automatically inserts hyperlinks when text is recognized as a URL.
public bool AutoInsertHyperlinks { get; set; }A boolean value, where true enables automatic hyperlink insertion and false disables it.
Implements:
CaretColor
Color
Gets or sets the color of the caret in the RadRichTextBox.
public Color CaretColor { get; set; }A Color representing the color of the caret.
Implements:
Gets the factory responsible for creating caret instances in the RadRichTextBox.
public ICaretFactory CaretFactory { get; set; }Implements:
Gets or sets a value representing the scale factor of the width of the caret.
public int CaretWidthScaleFactor { get; set; }Implements:
Gets or sets a value representing the current dialog for changing document permissions.
[Browsable(false)]
public IChangeEditingPermissionsDialog ChangeEditingPermissionsDialog { get; set; }Gets or sets a value representing the current dialog for editing CheckBox content control properties.
[Browsable(false)]
public ICheckBoxPropertiesDialog CheckBoxPropertiesDialog { get; set; }Gets or sets a value representing the current code formatting dialog instance.
[Browsable(false)]
public ICodeFormattingDialog CodeFormattingDialog { get; set; }Represents a collection of commands for the RadRichTextBox control.
public RichTextBoxCommands Commands { get; set; }Gets or sets the minimum width of the Comment Pane in the RadRichTextBox control.
public double CommentPaneMinWidth { get; set; }A double representing the minimum width in pixels. The default value is 200.
Implements:
CommentTemplateContentMargin
Thickness
Gets or sets the comment template content margin.
public Thickness CommentTemplateContentMargin { get; set; }Implements:
Gets or sets a value representing the current context menu.
public IContextMenu ContextMenu { get; set; }Gets the current editing context of the RadRichTextBox, which provides information about the current selection and editing actions.
public EditingContext CurrentEditingContext { get; }Implements:
Gets a value indicating the current editing style.
public StyleDefinition CurrentEditingStyle { get; }Implements:
public PasteContext CurrentPasteContext { get; }Gets or sets the name of the current user associated with the RadRichTextBox instance.
public UserInfo CurrentUser { get; set; }A string representing the name of the current user.
Gets the currently visible page index of the RadRichTextBox.
public int CurrentVisiblePage { get; }Gets or sets a value representing the current dialog for editing DatePicker content control properties.
[Browsable(false)]
public IDatePickerPropertiesDialog DatePickerPropertiesDialog { get; set; }DefaultInputBindings
InputBindingCollection
Gets the default input bindings for the RadRichTextBox control.
public static InputBindingCollection DefaultInputBindings { get; }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.
public StyleDefinition DefaultStyleSettings { get; }public static TextBlockRenderingMode DefaultTextRenderingMode { get; set; }Gets or sets the current document.
public RadDocument Document { get; set; }Implements:
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.
public bool DocumentInheritsDefaultStyleSettings { get; set; }Gets or sets a value representing the current dialog for editing DropDownList content control properties.
[Browsable(false)]
public IDropDownListPropertiesDialog DropDownListPropertiesDialog { get; set; }Gets or sets a value representing the current instance of the dialog for editing custom dictionaries.
[Browsable(false)]
public IEditCustomDictionaryDialog EditCustomDictionaryDialog { get; set; }Gets or sets the email pattern used for validation in the RadRichTextBox.
public string EmailPattern { get; set; }A string representing the regular expression pattern for validating email addresses.
Implements:
Gets or sets the brush used to visually indicate enforced permission ranges in the RadRichTextBox.
public Brush EnforcedPermissionRangeBrush { get; set; }A Brush object that determines the appearance of the enforced permission ranges. Defaults to null if not set.
Implements:
Specifies the shading mode for fields in the RadRichTextBox.
public FieldShadingType FieldShadingMode { get; set; }Implements:
Gets or sets a value representing the current find/replace dialog instance.
[Browsable(false)]
public IFindReplaceDialog FindReplaceDialog { get; set; }Gets or sets a value representing the current floating block properties dialog instance.
[Browsable(false)]
public IFloatingBlockPropertiesDialog FloatingBlockPropertiesDialog { get; set; }Gets or sets a value representing the current font properties dialog instance.
[Browsable(false)]
public IFontPropertiesDialog FontPropertiesDialog { get; set; }Gets the horizontal scroll position.
public double HorizontalOffset { get; }HorizontalScrollBar
ScrollBar
Gets the horizontal scroll bar instance of the control.
public virtual ScrollBar HorizontalScrollBar { get; }HorizontalScrollBarVisibility
ScrollBarVisibility
Gets or sets a value representing the horizontal scroll bar visibility.
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }Gets or sets the hyperlink navigation mode.
public HyperlinkNavigationMode HyperlinkNavigationMode { get; set; }The hyperlink navigation mode.
Represents the hyperlink formatting pattern in a RadRichTextBox.
Provides functionality for working with hyperlinks within the text document.
public string HyperlinkPattern { get; set; }Implements:
Gets or sets the hyperlink tool tip text.
public string HyperlinkToolTipFormatString { get; set; }The hyperlink tool tip.
Gets or sets an instance of IIgnoredWordDictionary that provides a list of words that would be ignored by spell checker.
public IIgnoredWordDictionary IgnoredWords { get; set; }Implements:
Gets or sets the image editor dialog.
[Browsable(false)]
public IImageEditorDialog ImageEditorDialog { get; set; }The image editor dialog.
Gets or sets the image mini toolbar.
public IImageMiniToolBar ImageMiniToolBar { get; set; }The image mini toolbar.
Represents the settings for the image selection adorner in the RadRichTextBox.
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }Implements:
Represents the input handler for the RadRichTextBox, managing user input and interactions.
public IRichTextBoxInputHandler InputHandler { get; set; }Gets or sets a value representing the current Insert Caption dialog instance.
[Browsable(false)]
public IInsertCaptionDialog InsertCaptionDialog { get; set; }Gets or sets a value representing the current insert cross-reference window instance.
public IInsertCrossReferenceWindow InsertCrossReferenceWindow { get; set; }Gets or sets a value representing the current spell checking dialog instance.
[Browsable(false)]
public IInsertDateTimeDialog InsertDateTimeDialog { get; set; }Gets or sets a value representing the current insert-hyperlink dialog instance.
[Browsable(false)]
public IInsertHyperlinkDialog InsertHyperlinkDialog { get; set; }Gets or sets a value representing the current insert symbol window.
[Browsable(false)]
public IInsertSymbolWindow InsertSymbolWindow { get; set; }Gets or sets a value representing the current insert table dialog instance.
[Browsable(false)]
public IInsertTableDialog InsertTableDialog { get; set; }Gets or sets a value representing the current insert Table of Contents window instance.
[Browsable(false)]
public IInsertTableOfContentsDialog InsertTableOfContentsDialog { get; set; }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.
public bool IsAdvancedSelectionEnabled { get; set; }Gets or sets a value indicating whether context menu is enabled.
public bool IsContextMenuEnabled { get; set; }Gets or sets a value that indicates whether a control is included in tab navigation.
public bool IsFocusable { get; set; }Implements:
Gets or sets value indicating whether image mini toolBar is enabled.
public bool IsImageMiniToolBarEnabled { get; set; }Gets a value indicating whether the RadRichTextBox is currently in header or footer edit mode.
public bool IsInHeaderFooterEditMode { get; set; }Implements:
Gets or sets a value indicating whether the paste options popup is displayed on paste.
public bool IsPasteOptionsPopupEnabled { get; set; }true if this instance is paste options popup enabled; otherwise, false.
Gets or sets a value indicating whether the control is read-only.
public bool IsReadOnly { get; set; }Implements:
Gets or sets a value indicating whether selection can be made in the document.
public bool IsSelectionEnabled { get; set; }Gets or sets value indicating whether selection mini toolBar is enabled.
public bool IsSelectionMiniToolBarEnabled { get; set; }Gets or sets a value indicating whether the spell checking is enabled for this document.
public bool IsSpellCheckingEnabled { get; set; }Implements:
Gets or sets a value indicating whether touch input is enabled for the RadRichTextBox.
public bool IsTouchEnabled { get; set; }true if touch input is enabled; otherwise, false.
Gets or sets a value indicating whether formatting symbols are shown in the document.
public bool IsTrackChangesEnabled { get; set; }true if formatting symbols are shown; otherwise, false.
Gets or sets the document layout mode.
public DocumentLayoutMode? LayoutMode { get; set; }The document layout mode.
Gets or sets the language which rules should be used for line breaking in the paragraphs.
public LineBreakingRuleLanguage LineBreakingRuleLanguage { get; set; }The line breaking characters rule language.
Gets or sets a value representing the current line numbering dialog.
[Browsable(false)]
public ILineNumberingDialog LineNumberingDialog { get; set; }Gets or sets a value representing the current Manage Bibliographic Sources reference dialog instance.
[Browsable(false)]
public IManageBibliographicSourcesDialog ManageBibliographicSourcesDialog { get; set; }Gets or sets a value representing the current manage bookmark dialog instance.
[Browsable(false)]
public IManageBookmarksDialog ManageBookmarksDialog { get; set; }Gets or sets a value representing the current manage styles dialog instance.
[Browsable(false)]
public IManageStylesDialog ManageStylesDialog { get; set; }Represents the context for mentions in the RadRichTextBox, allowing for customizable mention functionality.
public MentionContext MentionContext { get; set; }Gets or sets a value representing the current Notes dialog instance.
[Browsable(false)]
public INotesDialog NotesDialog { get; set; }Gets or sets a value representing the current paragraph properties dialog.
[Browsable(false)]
public IParagraphPropertiesDialog ParagraphPropertiesDialog { get; set; }public IPasteOptionsPopup PasteOptionsPopup { get; set; }Gets the current PasteSettings associated with RadRichTextBox
public PasteSettings PasteSettings { get; }Gets or sets a value representing the current dialog for editing Picture content control properties.
[Browsable(false)]
public IPicturePropertiesDialog PicturePropertiesDialog { get; set; }Gets or sets a value representing the current dialog for editing PlainText content control properties.
[Browsable(false)]
public IPlainTextPropertiesDialog PlainTextPropertiesDialog { get; set; }Gets or sets a value representing the current dialog for enforcing document protection.
[Browsable(false)]
public IProtectDocumentDialog ProtectDocumentDialog { get; set; }Provides authentication support for the protection mechanism of the RadRichTextBox control.
public IProtectionAuthenticationProvider ProtectionAuthenticationProvider { get; set; }public ApplicationCommandsCollection RegisteredApplicationCommands { get; }Gets or sets a value representing the current dialog for editing RepeatingSection content control properties.
[Browsable(false)]
public IRepeatingSectionPropertiesDialog RepeatingSectionPropertiesDialog { get; set; }Gets or sets a value representing the current dialog for editing RichText content control properties.
[Browsable(false)]
public IRichTextPropertiesDialog RichTextPropertiesDialog { get; set; }ScaleFactor
Size
Gets or sets a value representing the current view scale factor.
public Size ScaleFactor { get; set; }Implements:
Gets the height of the scrollable area in the RadRichTextBox.
public double ScrollableHeight { get; }Gets the width of the scrollable area within the RadRichTextBox control.
public double ScrollableWidth { get; }Gets or sets a value representing the current section columns dialog.
[Browsable(false)]
public ISectionColumnsDialog SectionColumnsDialog { get; set; }Gets or sets the currently focused comment in the document
public Comment SelectedComment { get; set; }Implements:
Gets or sets the currently focused note
public Note SelectedNote { get; set; }Implements:
SelectionFill
Brush
Gets or sets the fill color of the selected text in the RadRichTextBox.
public Brush SelectionFill { get; set; }Implements:
Gets or sets a value representing the current selection mini toolbar.
public ISelectionMiniToolBar SelectionMiniToolBar { get; set; }SelectionStroke
Brush
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.
public Brush SelectionStroke { get; set; }An object representing the stroke applied to the selection. The stroke can be customized to enhance the visual representation of selected text.
Implements:
Gets or sets a value representing the current Set Numbering Value reference dialog instance.
[Browsable(false)]
public ISetNumberingValueDialog SetNumberingValueDialog { get; set; }Gets or sets a value indicating whether the comments are shown.
public bool ShowComments { get; set; }Implements:
Gets or sets a value indicating whether formatting symbols are shown in the document.
public bool ShowFormattingSymbols { get; set; }true if formatting symbols are shown; otherwise, false.
Implements:
Displays the highlight for merge fields in the RadRichTextBox control.
public bool ShowMergeFieldsHighlight { get; set; }Gets or sets the ISpellChecker implementation used when proofing.
public ISpellChecker SpellChecker { get; set; }Implements:
Gets or sets a value representing the current spell checking dialog instance.
[Browsable(false)]
public ISpellCheckingDialog SpellCheckingDialog { get; set; }Gets or sets a value representing the current style formatting properties dialog instance.
[Browsable(false)]
public IStyleFormattingPropertiesDialog StyleFormattingPropertiesDialog { get; set; }Gets or sets a value representing the current table borders dialog instance.
[Browsable(false)]
public ITableBordersDialog TableBordersDialog { get; set; }Gets or sets a value representing the current table properties dialog instance.
[Browsable(false)]
public ITablePropertiesDialog TablePropertiesDialog { get; set; }Gets or sets a value representing the current tab stops properties dialog instance.
[Browsable(false)]
public ITabStopsPropertiesDialog TabStopsPropertiesDialog { get; set; }public TextBlockRenderingMode TextRenderingMode { get; set; }Gets or sets the options for tracking changes in the RadRichTextBox control.
public TrackChangesOptions TrackChangesOptions { get; }A TrackChangesOptions value that specifies how changes are tracked in the document.
Builds and configures the user interface layers for the RadRichTextBox control.
public UILayersBuilder UILayersBuilder { get; set; }Implements:
Gets or sets a value representing the current dialog for removing document protection.
[Browsable(false)]
public IUnprotectDocumentDialog UnprotectDocumentDialog { get; set; }Gets or sets whether you want to use the previous version of Microsoft IME. Must be synchronized with the option in the OS settings.
public bool UsePreviousVersionOfMicrosoftIme { get; set; }Implements:
Gets the collection of users associated with the RadRichTextBox instance.
public PermissionInfoCollection Users { get; set; }Gets the vertical scroll position.
public double VerticalOffset { get; }VerticalScrollBar
ScrollBar
Gets the vertical scroll bar instance of the control.
public virtual ScrollBar VerticalScrollBar { get; }VerticalScrollBarVisibility
ScrollBarVisibility
Gets or sets a value representing the vertical scroll bar visibility.
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }Gets the height of the viewport in the RadRichTextBox control.
public double ViewportHeight { get; }Gets the width of the viewport in the RadRichTextBox control.
public double ViewportWidth { get; }Gets or sets a value representing the current Watermark Settings dialog instance.
[Browsable(false)]
public IWatermarkSettingsDialog WatermarkSettingsDialog { get; set; }Methods
Accepts all revisions in the document.
public void AcceptAllRevisions()Implements:
Accepts a revision.
public void AcceptRevision(Revision revision)The revision.
Implements:
Initializes a text box element for a shape that does not have any.
public void AddShapeTextBox(ShapeInline shape)The ShapeInline.
Implements:
Adds a tab stop to the current paragraph.
Adds a tab stop range to the current paragraph.
public void AddTabStopRange(IEnumerable<TabStop> tabStops)The tab stop collection.
Implements:
Begins a new group of actions which will appear as a single item in the document history.
public void BeginUndoGroup()Implements:
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.
public void CancelUndoGroup()Implements:
Returns a value indicating whether the formatting can be copied according to the current selection.
public bool CanCopyFormatting()The value indicating whether the formatting can be copied.
Changes the display mode of all fields in the document.
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)The display mode which will be used for the fields.
Implements:
Changes the baseline alignment of the selected content.
public void ChangeBaselineAlignment(BaselineAlignment baselineAlignment)The baseline alignment to be applied.
Implements:
Changes the bibliographic style of all bibliography related fields in the document.
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)The new bibliographic style.
Implements:
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.
public void ChangeDifferentFirstPageHeaderFooter(bool 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:
Changes the value determining whether the sections should have different odd and even pages header/footer.
public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)true, if the even and odd page header/footer should differ.
Implements:
Changes default tab stop width for the document.
public void ChangeDocumentDefaultTabWidth(double tabWidth)Width of the tab.
Implements:
Changes the Tag property of a specified DocumentElement.
public void ChangeDocumentElementTag(DocumentElement element, string tag)The DocumentElement.
tagstringThe new tag value.
Implements:
Changes the first number of the endnotes in the document.
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the endnotes in the document.
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the endnotes in the document.
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the position of the endnotes in the document.
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)The position.
Implements:
Changes the first number of the footnotes in the document.
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the footnotes in the document.
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the endnotes in the document.
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the position of the footnotes in the document.
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)The footnotes position.
Implements:
Sets a value determining whether the strict line breaking rule will be applied to Japanese text in this document.
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)if set to true, the strict line breaking rule will be applied.
Implements:
Sets the language whose rules should be used for line breaking in the paragraphs.
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)The line breaking rule language.
Implements:
Sets a rule determining which characters cannot end a line in East-Asian languages.
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)The line breaking character rule.
Implements:
Sets a rule determining which characters cannot start a line in East-Asian languages.
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)The rule.
Implements:
Changes the display mode of a field.
public void ChangeFieldDisplayMode(FieldRangeStart fieldRangeStart, FieldDisplayMode displayMode)The field start.
displayModeFieldDisplayModeThe new display mode.
Implements:
Changes the font family of the selected content.
public void ChangeFontFamily(FontFamily fontFamily)The font family to be applied.
Implements:
Changes the size of the font of the selected content.
public void ChangeFontSize(double newFontSize)Size of the font.
Implements:
Changes the font style of the selected content.
public void ChangeFontStyle(FontStyle fontStyle)The font style.
Implements:
Changes the font weight of the selected content. If selection is not present, the current editing style is updated.
public void ChangeFontWeight(FontWeight fontWeight)The font weight.
Implements:
Changes the rotate angle of an image.
public void ChangeImageRotateAngle(ImageInline image, double angle)The ImageInline.
angledoubleThe new angle.
Implements:
Changes the size of an image.
public void ChangeImageSize(ImageInline image, Size size)The ImageInline whose size should be changed.
sizeSizeThe new size.
Implements:
Changes the layout mode.
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)The new layout mode to be applied.
Changes the restart type of line numberings for the selected sections.
public void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)The line numbering restart type.
Implements:
Changes the style of the list in the RadRichTextBox.
public void ChangeListStyle(ListStyle style)The new ListStyle to be applied to the list.
Changes the automatic spacing after of the selected paragraphs.
public void ChangeParagraphAutomaticSpacingAfter(bool value)If set to true, the automatic spacing after will be enabled.
Implements:
Changes the automatic spacing before of the selected paragraphs.
public void ChangeParagraphAutomaticSpacingBefore(bool value)If set to true, the automatic spacing before will be enabled.
Implements:
Changes the background of the selected paragraphs.
public void ChangeParagraphBackground(Color color)The color.
Implements:
Changes the first line indent of the selected paragraphs.
public void ChangeParagraphFirstLineIndent(double firstLineIndent)The first line indent.
Implements:
Changes the flow direction of the selected paragraphs.
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)The flow direction.
Implements:
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.
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)If set to true, East Asian typography rules will be applied to determine which characters may begin and end each line.
Implements:
Changes the left indent of the selected paragraphs.
public void ChangeParagraphLeftIndent(double leftIndent)The left indent.
Implements:
Changes the line spacing of the selected paragraphs.
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)The line spacing.
lineSpacingTypeLineSpacingTypeType of the line spacing.
Implements:
Changes the line spacing of the selected paragraphs.
public void ChangeParagraphLineSpacing(double lineSpacing)The line spacing.
Implements:
Changes the type of the line spacing of the selected paragraphs.
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)Type of the line spacing.
Implements:
Changes the list level of the selected paragraphs.
public void ChangeParagraphListLevel(int listLevel)The list level.
Implements:
Changes the right indent of the selected paragraphs.
public void ChangeParagraphRightIndent(double rightIndent)The right indent.
Implements:
Changes the spacing after of the selected paragraphs.
public void ChangeParagraphSpacingAfter(double spacingAfter)The spacing after.
Implements:
Changes the spacing before of the selected paragraphs.
public void ChangeParagraphSpacingBefore(double spacingBefore)The spacing before.
Implements:
Changes the paragraph style of the selected content.
public void ChangeParagraphStyle(StyleDefinition styleInfo)The style information.
Implements:
Changes a value that indicates whether shape's text box element will rotate when the shape is rotated.
public void ChangeRotateTextWithShape(ShapeInline shape, bool shouldRotate)The ShapeInline.
shouldRotateboolThe new value that indicates text box element rotation behavior.
Implements:
Changes the page margin of the selected sections respecting their current orientation.
public void ChangeSectionActualPageMargin(Padding sectionMargin)The margin.
Implements:
Changes the section columns for the selected sections.
public void ChangeSectionColumns(SectionColumnCollection sectionColumns)The section columns.
Implements:
Changes the section columns for a given collection of Section elements.
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)The section columns layout.
Implements:
Changes the first number of the endnotes in the selected sections.
public void ChangeSectionEndnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the endnotes in the selected sections.
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the endnotes in the selected sections.
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the first page number of the selected sections.
public void ChangeSectionFirstPageNumber(int? firstPageNumber)The first page number.
Implements:
Changes the footer bottom margin of the selected sections.
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)The section footer bottom margin.
Implements:
Changes the value indicating whether the section footer should be linked to the footer of the previous section.
public void ChangeSectionFooterLinkToPrevious(Section section, HeaderFooterType footerType, bool value)The section.
footerTypeHeaderFooterTypeType of the footer.
valuebooltrue if the footer should be linked.
Implements:
Changes the first number of the footnotes in the selected sections.
public void ChangeSectionFootnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the footnotes in the selected sections.
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the footnotes in the selected sections.
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the value indicating whether the section header should be linked to the header of the previous section.
public void ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value)The section.
headerTypeHeaderFooterTypeType of the header.
valuebooltrue if the header should be linked.
Implements:
Changes the header top margin of the selected sections.
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)The section header top margin.
Implements:
Changes the line numberings for the selected sections.
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)The line numbering.
Implements:
Changes the page margin of the selected sections.
public void ChangeSectionPageMargin(Padding sectionMargin)The margin.
Implements:
Changes the page orientation of the selected sections.
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)The page orientation.
Implements:
Changes the page size of the selected sections.
public void ChangeSectionPageSize(Size newSize)The new size. You can use the PaperTypes enumeration to get the desired size from the predefined values.
Implements:
Changes a value that indicates whether the parent shape should be horizontally resized in accordance to the text box element's width.
public void ChangeShapeAutoFitToText(ShapeInline shape, bool shouldAutoFit)The ShapeInline.
shouldAutoFitboolThe new value that indicates text box element wrap behavior.
Implements:
Changes the fill of a shape.
public void ChangeShapeFill(ShapeInline shape, IShapeFill fill)The ShapeInline.
fillIShapeFillThe new fill.
Implements:
Changes the dashing pattern of a shape outline.
public void ChangeShapeOutlineDash(ShapeInline shape, LineDashType dash)The ShapeInline.
dashLineDashTypeThe new dashing pattern.
Implements:
Changes the fill of a shape outline.
public void ChangeShapeOutlineFill(ShapeInline shape, IShapeOutlineFill fill)The ShapeInline.
fillIShapeOutlineFillThe new fill.
Implements:
Changes the width of a shape outline.
public void ChangeShapeOutlineWidth(ShapeInline shape, double width)The ShapeInline.
widthdoubleThe new outline width.
Implements:
Changes the rotate angle of a shape.
public void ChangeShapeRotateAngle(ShapeInline shape, double angle)The ShapeInline.
angledoubleThe new angle.
Implements:
Changes the size of a shape.
public void ChangeShapeSize(ShapeInline shape, Size size)The ShapeInline whose size should be changed.
sizeSizeThe new size.
Implements:
Changes the bottom margin (inset) of the shape's text box element.
public void ChangeShapeTextBottomMargin(ShapeInline shape, double margin)The ShapeInline.
margindoubleThe new bottom margin.
Implements:
Changes the fill of a shape's text.
public void ChangeShapeTextFill(ShapeInline shape, IShapeFill fill)The ShapeInline.
fillIShapeFillThe new fill.
Implements:
Changes the left margin (inset) of the shape's text box element.
public void ChangeShapeTextLeftMargin(ShapeInline shape, double margin)The ShapeInline.
margindoubleThe new left margin.
Implements:
Changes the dash of a shape's text outline dash.
public void ChangeShapeTextOutlineDash(ShapeInline shape, LineDashType dash)The ShapeInline which is modified.
dashLineDashTypeThe new dashing pattern.
Implements:
Changes the fill of a shape's text outline.
public void ChangeShapeTextOutlineFill(ShapeInline shape, IShapeOutlineFill fill)The ShapeInline.
fillIShapeOutlineFillThe new fill.
Implements:
Changes the width of a shape's outline width.
public void ChangeShapeTextOutlineWidth(ShapeInline shape, double width)The ShapeInline which is modified.
widthdoubleThe new width value.
Implements:
Changes the right margin (inset) of the shape's text box element.
public void ChangeShapeTextRightMargin(ShapeInline shape, double margin)The ShapeInline.
margindoubleThe new right margin.
Implements:
Changes the rotation angle of the shape's text box element.
public void ChangeShapeTextRotation(ShapeInline shape, TextRotation rotation)The ShapeInline.
rotationTextRotationThe new rotation angle (in degrees).
Implements:
Changes the top margin (inset) of the shape's text box element.
public void ChangeShapeTextTopMargin(ShapeInline shape, double margin)The ShapeInline.
margindoubleThe new top margin.
Implements:
Changes the vertical alignment of a shape text box element.
public void ChangeShapeTextVerticalAlignment(ShapeInline shape, RadVerticalAlignment alignment)The ShapeInline.
alignmentRadVerticalAlignmentThe new vertical alignment.
Implements:
Changes a value that indicates whether shape's text box element should wrap text vertically.
public void ChangeShapeTextWrap(ShapeInline shape, bool shouldWrap)The ShapeInline.
shouldWrapboolThe new value that indicates text box element wrap behavior.
Implements:
Changes the span style of the selected content.
public void ChangeSpanStyle(StyleDefinition styleInfo)The style information.
Implements:
Changes the strike-through of the selected content.
public void ChangeStrikethrough(bool isStrikethrough)If set to true, a strike-through will be applied to the selected content.
Implements:
Applies style with a given name to the selected elements in the document.
public void ChangeStyleName(string styleName)Name of the style to be applied.
Implements:
Changes the borders of the selected tables.
public void ChangeTableBorders(TableBorders tableBorders)The table borders.
Implements:
Changes the background of the selected table cells.
public void ChangeTableCellBackground(Color color)The color.
Implements:
Changes the borders of the selected table cells.
public void ChangeTableCellBorders(Border tableCellBorders)The border which will be used for all table cell borders.
Implements:
Changes the borders of the selected table cells.
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)The table cell borders.
Implements:
Changes the content alignment of the selected table cells.
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)The text alignment.
verticalAlignmentRadVerticalAlignmentThe vertical alignment.
Implements:
Changes the horizontal content alignment of the selected table cells.
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)The alignment.
Implements:
Changes the padding of the selected table cells.
public void ChangeTableCellPadding(Padding padding)The padding.
Implements:
Changes the cell spacing of the selected tables.
public void ChangeTableCellSpacing(double cellSpacing)The cell spacing.
Implements:
Changes the vertical content alignment of the selected table cells.
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)The alignment.
Implements:
Changes the default cell padding of the selected tables.
public void ChangeTableDefaultCellPadding(Padding padding)The padding which will be used as a default value.
Implements:
Changes the flow direction of the selected tables.
public void ChangeTableFlowDirection(FlowDirection flowDirection)The flow direction.
Implements:
Changes the width of a table column.
public void ChangeTableGridColumnWidth(Table table, int columnIndex, TableWidthUnit width)The table.
columnIndexintThe index of the column.
widthTableWidthUnitThe new value for the column width. If the type of the width is not specified, Fixed will be used.
Implements:
Changes the horizontal alignment of the selected tables.
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)The alignment.
Implements:
Changes the indent of the selected tables.
Changes the layout mode of the selected tables.
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)The table.
tableLayoutModeTableLayoutModeThe table layout mode.
Implements:
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.
public void ChangeTableLook(TableLook tableLook)The table look.
Implements:
Changes the preferred width of the selected tables.
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Width of the table.
Implements:
Depending on the current value, enables or disables the repetition of a table row on every page.
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)The table row.
Implements:
Changes the text alignment of the current run in the document.
public void ChangeTextAlignment(RadTextAlignment alignment)The new text alignment to be applied.
Changes the text foreground color of the current run in the document.
public void ChangeTextForeColor(Color newColor)The new foreground color to be applied.
Changes the text highligh color of the current run in the document.
public void ChangeTextHighlightColor(Color newColor)The new highlight color to be applied.
Changes the underline color of the selected content.
public void ChangeUnderlineColor(Color newColor)The color.
Implements:
Changes the underline decoration of the selected content.
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)The value.
Implements:
Clears all the formatting (character and paragraph) from the selected content.
public void ClearAllFormatting()Implements:
Clears the character formatting of the selected content.
public void ClearFormatting()Implements:
Clears the tab stops inside the selected paragraphs.
public void ClearTabStops()Implements:
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.
public bool ContinueListNumbering()A boolean value indicating whether the operation completed successfully.
Implements:
Copies the currently selected document elements into the clipboard.
public void Copy()Implements:
Copies the formatting of the current selection.
public bool CopyFormatting()A value indicating whether the copy was successful.
Implements:
Cuts the currently selected document elements into the clipboard.
public void Cut()Implements:
Decrements the size of the font of the selected content with 2 points.
public void DecrementFontSize()Implements:
Decrements the left indent of the current paragraph.
public void DecrementParagraphLeftIndent()Implements:
Decrements the list level the paragraph is currently in by 1.
public void DecrementParagraphListLevel()Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the CaretPosition.
public void Delete(bool deletePrevious)If the selection is empty, indicates whether to delete the character before or after the caret.
Deletes all comments in the document.
public void DeleteAllComments()Implements:
Deletes an annotation range.
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)The start of the range that will be deleted.
Implements:
Deletes a bookmark.
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)The bookmark range start.
Implements:
Deletes a bookmark.
public void DeleteBookmark(string bookmarkName)Name of the bookmark.
Implements:
Deletes a code block.
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)The CodeAnnotationRangeStart of the block to delete.
Implements:
Deletes the current comment.
public void DeleteComment()Implements:
Deletes a comment.
public void DeleteComment(CommentRangeStart commentRangeStart)The comment range start.
Implements:
Deletes a permission range.
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)The permission range start.
Implements:
Deletes the read only range at the current caret position or inside the current selection.
public void DeleteReadOnlyRange()Implements:
Deletes read only range.
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)The read only range that is to be deleted.
Implements:
Deletes the table the current caret position is in.
public void DeleteTable()Implements:
Deletes the current table column which is under the caret position.
public void DeleteTableColumn()Implements:
Deletes the table row under the caret position.
public void DeleteTableRow()Implements:
Disables the watermark feature in the RadRichTextBox.
public void DisableWatermark()Edits the list style of the RadRichTextBox in a dialog.
public void EditListStyleInDialog(ListStyle listStyle)The ListStyle object that defines the new style for the list.
Initiates editing of a shape's text box element.
public void EditShapeTextBox(ShapeInline shape)The ShapeInline.
Implements:
Closes current undo group.
public void EndUndoGroup()Implements:
Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
Ensures control template is applied and ensures ActiveEditorPresenter is initialized to its default value.
public bool EnsureActiveEditorPresenter()Whether the ActiveEditorPresenter has been created as a result of this method call.
Sets the keyboard focus to the RadRichTextBox control.
public void Focus()Focuses the footer of the current page.
public void FocusFooter()Focuses the header of the current page.
public void FocusHeader()Retrieves the appearance settings for a specified comment in the RadRichTextBox.
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)The comment for which to retrieve the appearance settings.
Returns:Returns the appearance settings associated with the specified comment.
Implements:
protected virtual Type GetDocumentEditorPresenterTypeForDocument(RadDocument document)Retrieves statistical information about the content within the RadRichTextBox.
public DocumentStatisticsInfo GetStatisticsInfo()An object containing various statistical metrics such as word count, character count, and other relevant information related to the text content.
Moves current position to the next comment.
public void GoToNextComment()Moves current position to the next endnote.
public void GoToNextEndnote()Moves current position to the next footnote.
public void GoToNextFootnote()Moves current position to the next revision.
public void GoToNextRevision()Moves current position to the previous comment.
public void GoToPreviousComment()Moves current position to the previous endnote.
public void GoToPreviousEndnote()Moves current position to the previous footnote.
public void GoToPreviousFootnote()Moves current position to the previous revision.
public void GoToPreviousRevision()Determines whether the current user has edit permissions for the RadRichTextBox.
public bool HasEditPermissions()A boolean value indicating if the user has edit permissions. Returns true if the user has permission to edit; otherwise, false.
Implements:
Increments the size of the font of the selected content with 2 points.
public void IncrementFontSize()Implements:
Increments the left indent of the current paragraph.
public void IncrementParagraphLeftIndent()Implements:
Increments the paragraph list level of the selected paragraphs.
public void IncrementParagraphListLevel()Inserts text into the document at the current caret position.
Inserts an annotation range.
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)The annotation range start.
rangeEndAnnotationRangeEndThe annotation range end.
Implements:
Inserts a bookmark around the current selection. If the selection is empty, the bookmark is inserted at the caret position.
public void InsertBookmark(string bookmarkName)Name of the bookmark.
Implements:
Inserts a caption around the current selection. If the selection is empty, the caption is inserted at the current caret position.
public void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)The definition of the caption.
captionstringThe caption text to be used.
includeLabelboolIf set to true, the label is included in the caption.
If set to true, the caption is inserted after the current selection.
Implements:
Inserts a code block at the caret position. If the caret position is in code block, replaces the current code block.
public void InsertCodeBlock(string code, CodeFormattingSettings settings)The code to insert.
settingsCodeFormattingSettingsThe settings which will be used for the code block.
Implements:
Inserts a column break into the document at the current caret position.
public void InsertColumnBreak()Implements:
Inserts a comment around the current selection. If the selection is empty, the comment is inserted at the caret position.
Inserts a cross-reference to a bookmark into the document at the current caret position.
public void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)Name of the bookmark.
contentTypeReferenceContentTypeType of the content.
insertAsHyperlinkboolIf set to true, the cross-reference is inserted as a hyperlink.
Implements:
Inserts a cross-reference to a caption into the document at the current caret position.
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)The paragraph containing the caption sequence field.
contentTypeReferenceContentTypeThe reference content type. If the paragraph doesn't have applied a Caption style, the method will not be executed.
insertAsHyperlinkboolA parameter indicating whether the cross-reference field should be a hyperlink.
Implements:
Inserts a cross-reference to a paragraph with Heading style into the document at the current caret position.
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)The paragraph. If the paragraph doesn't have applied a Heading style, the method will not be executed.
contentTypeReferenceContentTypeType of the content.
insertAsHyperlinkboolIf set to true, the cross-reference is inserted as a hyperlink.
Implements:
Inserts endnote at the current position.
public void InsertEndnote()Implements:
Inserts the endnote at the current position.
Inserts a field into the document at the current caret position in a specified display mode.
public bool InsertField(Field field, FieldDisplayMode displayMode)The field.
displayModeFieldDisplayModeThe display mode.
Returns:True, if the operation completed successfully.
Implements:
Inserts footnote at the current position.
public void InsertFootnote()Implements:
Inserts the footnote at the current position.
Inserts a fragment at a specified position. Document selection should be cleared in advance.
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)The fragment to insert.
documentPositionDocumentPositionThe document position to insert the fragment at.
Exceptions:Thrown when there is selection in the document.
Thrown when documentFragment or documentPosition is null.
Implements:
Document selection should be cleared before calling this method, otherwise exception may be thrown.
Inserts a fragment at the current caret position.
public void InsertFragment(DocumentFragment documentFragment)The fragment to insert.
Exceptions:Thrown when documentFragment is null.
Implements:
Inserts collection of inlines as hyperlink into the document.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)The hyperlink info.
inlinesIEnumerable<Inline>The inlines.
Implements:
Inserts a hyperlink in the document.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)The hyperlink info.
hyperlinkTextstringThe hyperlink text.
Inserts a hyperlink in the document. The hyperlink will be created around the current selection.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)The hyperlink info.
Implements:
Inserts inline element into the document at a specified caret position. Document selection should be cleared in advance.
public void InsertInline(Inline inline, DocumentPosition documentPosition)The inline element to insert.
documentPositionDocumentPositionThe document position to insert the inline at.
Exceptions:Thrown when there is selection in the document.
Thrown when inline or documentPosition is null.
Implements:
Document selection should be cleared before calling this method, otherwise exception may be thrown.
Inserts inline element into the document at the current caret position.
public void InsertInline(Inline inline)The inline element to insert.
Exceptions:Thrown when inline is null.
Implements:
Inserts text at the current caret position and adds a new paragraph after it.
Inserts a line break into the document at the current caret position.
public void InsertLineBreak()Implements:
Inserts a non-breaking space into the document at the current caret position.
public void InsertNonBreakingSpace()Inserts a page break into the document at the current caret position.
public void InsertPageBreak()Implements:
Inserts a new paragraph at the current caret position.
public void InsertParagraph()Implements:
Inserts a new permission range over the current selection. If the selection is empty, the permission range is inserted at the caret position.
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)The permissions for the new range.
Implements:
Inserts a read only range over the current selection. If the selection is empty, the range is inserted at the caret position.
public void InsertReadOnlyRange()Implements:
Inserts a section break into the document at the current caret position.
public void InsertSectionBreak()Implements:
Inserts a section break of the specified type into the document at the current caret position.
public void InsertSectionBreak(SectionBreakType sectionBreakType)The type of the section break.
Implements:
Inserts an inline shape into the document at the current caret position.
public void InsertShape(ShapeType shapeType, Size size)The type of shape.
sizeSizeShape's initial size.
Implements:
Inserts a default structured document tag (Content Control). The default type is RichText.
public void InsertStructuredDocumentTag()Inserts a structured document tag (Content Control) based on the provided properties.
public void InsertStructuredDocumentTag(SdtProperties insertProperties)Inserts a structured document tag (Content Control) of the given type.
Inserts a new table in the document.
Inserts a table column in the table which is under the caret position.
public void InsertTableColumn()Implements:
Inserts a table column to the left in the table which is under the caret position.
public void InsertTableColumnToTheLeft()Implements:
Inserts a table column to the right in the table which is under the caret position.
public void InsertTableColumnToTheRight()Implements:
Inserts a new table row in the table under the caret position.
public void InsertTableRow()Implements:
Inserts a table row above the one under the caret position.
public void InsertTableRowAbove()Implements:
Inserts a table row below the one under the caret position.
public void InsertTableRowBelow()Implements:
Inserts a placeholder text box element to the document. It comes with a default shape layout.
public void InsertTextBox()Implements:
Forces the control to invalidate the layout of its child elements.
public void InvalidateEditorLayout()Clears the spell-checking state of all words in the document and updates the UI.
public void InvalidateProofingErrors(bool invalidateIncorrectWordsOnly)True to invalidate incorrect word only.
Produces a mail merged document containing the results for all data records.
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)true, if each record should start on a new page.
The document containing the result of the operation.
Implements:
Creates a new RadDocument containing the result of merging the template with the values of the current data record.
Merges the currently selected table cells into one.
public void MergeTableCells()Implements:
Moves the current selection along with the selected document elements to a specified position.
public void MoveSelection(DocumentPosition movePosition, bool deleteSelection)The start position where the selection should be moved to.
deleteSelectionbooltrue, if the current selection and contained elements should be deleted on the original position.
Implements:
Invoked whenever application of the instance's template is required.
public override void OnApplyTemplate()protected virtual void OnCommandError(CommandErrorEventArgs args)Raises the event.
protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)The CommandExecutedEventArgs instance containing the event data.
Raises the event.
protected virtual void OnCommandExecuting(CommandExecutingEventArgs e)The CommandExecutingEventArgs instance containing the event data.
Raises the event.
protected virtual void OnCommentShowing(CommentShowingEventArgs e)The CommentShowingEventArgs instance containing the event data.
OnCreateAutomationPeer()
AutomationPeer
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF)/Silverlight infrastructure.
protected override AutomationPeer OnCreateAutomationPeer()AutomationPeer
The type-specific AutomationPeer implementation.
protected virtual void OnCurrentEditingStyleChanged()protected virtual void OnCurrentParagraphStyleChanged()protected virtual void OnCurrentSpanStyleChanged()protected virtual void OnCurrentVisiblePageChanged()protected virtual void OnDocumentArranged()protected virtual void OnDocumentChanged()protected virtual void OnDocumentChanging()protected virtual void OnDocumentContentChanged()protected virtual void OnDocumentLayoutModeChanged()protected virtual void OnDocumentPresentationChanged(PresentationChangedEventArgs e)protected override void OnGotFocus(RoutedEventArgs e)protected virtual void OnHyperlinkClicked(object sender, HyperlinkClickedEventArgs eventArgs)Raises the event.
protected virtual void OnHyperlinkToolTipShowing(HyperlinkToolTipShowingEventArgs e)The HyperlinkToolTipShowingEventArgs instance containing the event data.
Raises the event. This method is invoked whenever is set to true internally.
protected override void OnInitialized(EventArgs e)The RoutedEventArgs that contains the event data.
protected override void OnLostFocus(RoutedEventArgs e)protected virtual void OnMergeFieldToStringConverting(object sender, MergeFieldToStringConvertingEventArgs e)Raises the event.
protected virtual void OnNoteReferenceClicked(MouseButtonEventArgs args)The MouseButtonEventArgs instance containing the event data.
protected virtual void OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs e)Raises the event.
protected virtual void OnPrintCompleted(PrintCompletedEventArgs e)The PrintCompletedEventArgs instance containing the event data.
protected virtual void OnProtectionStateChanged()protected virtual void OnScaleFactorChanged()protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)Raises the event.
protected virtual void OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs e)The UntrackableCommandExecutingEventArgs instance containing the event data.
protected virtual void OnUserInfoChanged()Opens the context menu when the next spelling error is encountered.
public void OpenContextMenuOnNextSpellingError()This method is useful for providing users with quick access to spelling correction options during text editing in the RadRichTextBox control.
Pastes the content of the clipboard into the document.
public void Paste()Implements:
Pastes the content of the clipboard into the document.
Pastes the currently copied formatting on the current selection.
public bool PasteFormatting()A value indicating whether the paste was successful.
Implements:
Updates all fields in the document with the values evaluated using the first data record.
public bool PreviewFirstMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Updates all fields in the document with the values evaluated using the last data record.
public bool PreviewLastMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Updates all fields in the document with the values evaluated using the next data record.
public bool PreviewNextMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Updates all fields in the document with the values evaluated using the previous data record.
public bool PreviewPreviousMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Prints with the specified print dialog. The dialog should already be initialized.
public void Print(PrintDialog printDialog, PrintSettings printSettings)The print dialog.
printSettingsPrintSettingsThe print settings.
Re-executes the last undone command group.
public void Redo()Implements:
Registers a new command with the specified key and modifier keys for the RadRichTextBox.
public static void RegisterCommand(RoutedCommand command, Key key, ModifierKeys modifierKeys = 0, object commandParameter = null)The command to be registered.
keyKeyThe key associated with the command.
modifierKeysModifierKeysThe modifier keys that need to be held while pressing the key.
commandParameterobjectAn optional parameter associated with the command.
Rejects all revisions in the document.
public void RejectAllRevisions()Implements:
Rejects a revision.
public void RejectRevision(Revision revision)The revision.
Implements:
Removes the hyperlink on the caret position.
public void RemoveHyperlink()Removes a tab stop from the selected paragraphs.
Removes a collection of tab stops in the selected paragraphs.
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)The tab stops.
Implements:
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.
Creates a new list from the current paragraph. The paragraph must be in a list, otherwise this method does nothing.
public bool RestartListNumbering()A boolean value determining whether the operation completed successfully.
Implements:
Scrolls the contents of RadRichTextBox to the specified horizontal offset.
Scrolls the viewport so that a note becomes visible.
Scrolls the contents of RadRichTextBox to the specified vertical offset.
Sets the selected comment for the RadRichTextBox based on the provided CommentRangeStart.
public void SetSelectedComment(CommentRangeStart commentStart)The CommentRangeStart that represents the beginning of the comment range to be set.
Sets the currently selected note in the RadRichTextBox.
Sets a watermark to the selected sections.
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)The watermark settings describing the watermark that will be applied.
Implements:
Sets a predefined watermark to the selected sections.
public void SetWatermark(PredefinedWatermarkType predefinedType)Type of the predefined watermark.
Implements:
Sets the watermark image for the RadRichTextBox control.
public void SetWatermarkImage(WatermarkImageSettings settings)The settings that define the watermark image to be applied.
Sets the watermark text for the RadRichTextBox control.
public void SetWatermarkText(WatermarkTextSettings settings)The settings that define the watermark text properties.
Shows the Add New Bibliographic Source Dialog.
public void ShowAddNewBibliographicSourceDialog(string sourceName = null, bool insertFieldOnClose = true, Action<BibliographicSource> callBackOnClosed = null)Shows the dialog for changing editing permissions.
public void ShowChangeEditingPermissionsDialog()Shows the dialog for code formatting.
public void ShowCodeFormattingDialog()Displays the context menu at the specified document position within the RadRichTextBox.
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)The document position where the context menu should be shown.
Displays the context menu at the specified document position within the RadRichTextBox.
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)The screen coordinates where the context menu should appear.
positionDocumentPositionThe position in the document at which the context menu is related.
Shows dialog for creating new list style.
public void ShowDefineNewListStyleDialog()Shows the dialog for editing custom spellchecking dictionaries.
public void ShowEditCustomDictionaryDialog()Shows the find replace dialog.
public virtual void ShowFindReplaceDialog()Shows the floating block properties dialog.
public void ShowFloatingBlockPropertiesDialog()Shows the font properties dialog.
public void ShowFontPropertiesDialog()Shows the image editor dialog.
public void ShowImageEditorDialog()Shows the image editor dialog.
public void ShowImageEditorDialog(string executeToolName)Name of the tool to execute when the dialog is opened.
Shows the insert caption dialog.
public void ShowInsertCaptionDialog()Shows the insert cross reference window.
public void ShowInsertCrossReferenceWindow()Shows the insert date field dialog.
public void ShowInsertDateTimeDialog()Shows the insert hyperlink dialog.
public void ShowInsertHyperlinkDialog()Show the insert symbol dialog.
public void ShowInsertSymbolWindow()Shows the insert table dialog.
public void ShowInsertTableDialog()Shows the insert Table of Contents window.
public void ShowInsertTableOfContentsDialog()Show the line numbers dialog.
public void ShowLineNumberingDialog()Shows the Manage Bibliographic Sources Dialog.
public void ShowManageBibliographicSourcesDialog()Shows the dialog for managing bookmarks.
public void ShowManageBookmarksDialog()Shows the dialog for managing styles.
public void ShowManageStylesDialog()Shows the notes dialog.
public void ShowNotesDialog()Shows the paragraph properties dialog.
public void ShowParagraphPropertiesDialog()Shows the dialog for enforcing document protection.
public void ShowProtectDocumentDialog()Show the sections columns dialog.
public void ShowSectionColumnsDialog()Shows the Set Numbering Value Dialog.
public void ShowSetNumberingValueDialog()Shows the spell checking dialog.
public void ShowSpellCheckingDialog()Shows the dialog for adding new style.
public void ShowStyleFormattingPropertiesDialog()Shows the dialog for modifying style formatting.
public void ShowStyleFormattingPropertiesDialog(StyleDefinition styleDefinition)Shows the style formatting properties dialog.
public void ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings settings)The settings.
Shows the table borders dialog.
public void ShowTableBordersDialog()Shows the table properties dialog.
public void ShowTablePropertiesDialog()Shows the dialog for editing tab stops.
public void ShowTabStopsPropertiesDialog()Shows the dialog for removing document protection.
public void ShowUnprotectDocumentDialog()Shows the watermark settings dialog.
public void ShowWatermarkSettingsDialog()Splits an annotation range at the specified position, resulting in two new ranges.
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)The annotation range start to be split.
positionDocumentPositionThe position where the range start should be split.
Implements:
Splits an annotation range at the caret position, resulting in two new ranges.
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)The annotation range start to be split.
Implements:
Suppress the line numbering for selected paragraphs.
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)Implements:
Toggles the font weight of the selected content between and .
public void ToggleBold()Implements:
Toggles the visibility of the bookmarks in the document.
public void ToggleBookmarks()Toggles the visibility of the comments in the document.
public void ToggleComments()Toggles the visibility of the different first page header and footer in the RadRichTextBox.
public void ToggleDifferentFirstPageHeaderFooter()Toggles the visibility of different headers and footers for odd and even pages in the RadRichTextBox.
public void ToggleDifferentOddAndEvenPagesHeaderFooter()Toggles the display mode of a field.
public void ToggleFieldCodes(FieldRangeStart fieldStart)The field start.
Implements:
Toggles the visibility of the formatting symbols in the document.
public void ToggleFormattingSymbols()Toggles the headers/footers editing mode.
public void ToggleHeaderFooterEditingMode()Toggles the font style of the selected content between and .
public void ToggleItalic()Implements:
Toggles the highlighting of merge fields in the RadRichTextBox control.
public void ToggleMergeFieldsHighlight()Toggles the subscript state of the current run in the document.
public void ToggleStrikethrough()Implements:
Toggles the subscript state of the current run in the document.
public void ToggleSubscript()Changes the superscript state of the current run in the document.
public void ToggleSuperscript()Toggles the underline state of the current run in the document.
public void ToggleUnderline()Reverts the last executed command group.
public void Undo()Implements:
Splits the currently selected table cell.
public void UnmergeTableCells()Implements:
Updates all captions in the document related to a caption definition.
public void UpdateAllCaptions(CaptionDefinition captionDefinition)The caption definition.
Implements:
Updates all fields in the document.
public void UpdateAllFields()Implements:
Updates all fields in the document and displays them in the specified display mode.
public void UpdateAllFields(FieldDisplayMode displayMode)The display mode which will be used for the fields.
Implements:
Forces the control to update its layout and UI;
public void UpdateEditorLayout()Implements:
Forces the control to update its layout and UI.
public void UpdateEditorLayout(bool async)False to execute the update immediately. Otherwise it will be executed with slight delay using Dispatcher Timer for performance reasons.
Updates a field.
public void UpdateField(FieldRangeStart fieldStart)The field start.
Implements:
Updates the footer for a section.
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)The section of the footer.
footerTypeHeaderFooterTypeType of the footer.
footerFooterThe footer.
Updates the header for a section.
public void UpdateHeader(Section section, HeaderFooterType headerType, Header header)The section of the header.
headerTypeHeaderFooterTypeType of the header.
headerHeaderThe header.
Events
Occurs when active document editor changes.
public event EventHandler<ActiveDocumentEditorChangedEventArgs> ActiveDocumentEditorChangedOccurs on error while executing command.
public event EventHandler<CommandErrorEventArgs> CommandErrorOccurs after the execution of RichTextBoxCommandBase.
public event EventHandler<CommandExecutedEventArgs> CommandExecutedOccurs before the execution of RichTextBoxCommandBase.
public event EventHandler<CommandExecutingEventArgs> CommandExecutingOccurs when showing comment.
public event EventHandler<CommentShowingEventArgs> CommentShowingOccurs when the current editing style has changed.
public event EventHandler CurrentEditingStyleChangedOccurs when the current paragraph's style has changed.
public event EventHandler CurrentParagraphStyleChangedOccurs when the current span's style has changed.
public event EventHandler CurrentSpanStyleChangedOccurs when the CurrentPage property value has changed.
public event EventHandler CurrentVisiblePageChangedOccurs when the current document has been arranged.
public event EventHandler DocumentArrangedOccurs when the current document has changed.
public event EventHandler DocumentChangedOccurs when the current document is changing.
public event EventHandler DocumentChangingOccurs when the content of the current document has changed.
public event EventHandler DocumentContentChangedOccurs when the layout mode of the current document has changed.
public event EventHandler DocumentLayoutModeChangedpublic event EventHandler<PresentationChangedEventArgs> DocumentPresentationChangedOccurs when the users clicks on a hyperlink in the current document.
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClickedOccurs when showing the tooltip of a hyperlink hovered in the document.
public event EventHandler<HyperlinkToolTipShowingEventArgs> HyperlinkToolTipShowingOccurs when IsReadOnly property changes.
public event EventHandler IsReadOnlyChangedOccurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it became a result string value.
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConvertingpublic event PreviewEditorKeyEventHandler PreviewEditorKeyDownOccurs when print is completed.
public event EventHandler<PrintCompletedEventArgs> PrintCompletedOccurs when printing has started.
public event EventHandler PrintStartedOccurs when the current protection state has changed.
public event EventHandler ProtectionStateChangedImplements:
Occurs when the ScaleFactor property value has changed.
public event EventHandler ScaleFactorChangedImplements:
Occurs when currently selected layout box has changed.
public event EventHandler<SelectedLayoutBoxChangedEventArgs> SelectedLayoutBoxChangedOccurs when selection is changed.
public event EventHandler SelectionChangedpublic event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolvingOccurs when executing command that does not support track changes and track changes are enabled.
public event EventHandler<UntrackableCommandExecutingEventArgs> UntrackableCommandExecutingOccurs when the current user info has changed.
public event EventHandler UserInfoChanged