RadRichTextBox
A feature-rich text editing control that provides comprehensive text formatting, document navigation, mail merge, and printing functionality. Supports multiple document formats including DOCX, RTF, HTML, and PDF.
Definition
Namespace:Telerik.WinForms.RichTextEditor
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class RadRichTextBox : FrameworkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop, IDocumentEditorPresenterContainer, IDocumentEditor, IPrintableInheritance: objectDisposableObjectRadObjectRadElementVisualElementUIElementFrameworkElementRadRichTextBox...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadRichTextBox class with default settings. Sets up document providers, input handling, default styles, and initializes the document.
public RadRichTextBox()Fields
public static readonly RadProperty AcceptsReturnPropertypublic static readonly RadProperty AcceptsTabPropertypublic static readonly RadProperty AllowScalingPropertypublic static readonly RadProperty BorderColorPropertypublic static readonly RadProperty CaretColorPropertypublic static readonly RadProperty CommandsPropertypublic static readonly RadProperty CommentTemplateContentMarginPropertypublic static readonly RadProperty CurrentUserPropertypublic static readonly RadProperty DocumentInheritsDefaultStyleSettingsPropertypublic static readonly RadProperty EnforcedPermissionRangeBrushPropertypublic static readonly RadProperty HorizontalScrollBarHeightPropertypublic const string HorizontalScrollBarName = "HorizontalScrollBar"public static readonly RadProperty HorizontalScrollBarVisibilityPropertypublic static readonly RadProperty HyperlinkNavigationModePropertypublic static readonly RadProperty HyperlinkToolTipFormatStringPropertypublic static readonly RadProperty IsAdvancedSelectionEnabledPropertypublic static readonly RadProperty IsContextMenuEnabledPropertypublic static readonly RadProperty IsImageMiniToolBarEnabledPropertypublic static readonly RadProperty IsPasteOptionsPopupEnabledPropertypublic static readonly RadProperty IsReadOnlyPropertypublic static readonly RadProperty IsSelectionEnabledPropertypublic static readonly RadProperty IsSelectionMiniToolBarEnabledPropertypublic static readonly RadProperty IsSpellCheckingEnabledPropertypublic static readonly RadProperty IsTrackChangesEnabledPropertypublic static readonly RadProperty LayoutModePropertypublic static readonly RadProperty LineBreakingRuleLanguagePropertyRepresents the maximum scale factor the control supports for document zoom operations. The scale factor cannot be set above this value to maintain performance.
public static readonly double MaxScaleFactorpublic const string MeasuringPanelName = "MeasuringPanel"Represents the minimum scale factor the control supports for document zoom operations. The scale factor cannot be set below this value to maintain readability.
public static readonly double MinScaleFactorpublic const string PrintingScreenName = "PrintingScreen"public static readonly RadProperty ProtectionAuthenticationProviderPropertypublic static readonly RadProperty ScaleFactorPropertypublic static readonly RadProperty SelectionFillColorPropertypublic static readonly RadProperty SelectionFillPropertypublic static readonly RadProperty SelectionStrokeColorPropertypublic static readonly RadProperty SelectionStrokePropertypublic static readonly RadProperty ShowCommentsPropertypublic static readonly RadProperty ShowFormattingSymbolsPropertypublic static readonly RadProperty ShowMergeFieldsHighlightPropertypublic const string VerticalScrollBarName = "VerticalScrollBar"public static readonly RadProperty VerticalScrollBarVisibilityPropertypublic static readonly RadProperty VerticalScrollBarWidthPropertypublic 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 currently active editor.
public IDocumentEditor ActiveDocumentEditor { get; }Gets the currently active editor instance when using master-detail document scenarios. This is typically used in more complex document editing scenarios where multiple editor instances work together.
public RadRichTextBox ActiveEditor { get; }Gets or sets a value representing the active document presenter.
public IDocumentEditorPresenter ActiveEditorPresenter { get; set; }Gets or sets the dialog for adding bibliographic sources.
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 hyperlinks should be automatically detected.
public bool AutoInsertHyperlinks { get; set; }Implements:
[VsbBrowsable(true)]
public Color BorderColor { get; set; }Gets or sets the color of the caret.
public Color CaretColor { get; set; }Implements:
Gets or sets an instance implementing ICaretFactory
public ICaretFactory CaretFactory { get; set; }Implements:
Gets or sets the width of the caret.
public float CaretWidth { get; set; }Gets or sets the dialog for changing editing permissions of the document.
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 the dialog for formatting code blocks.
public ICodeFormattingDialog CodeFormattingDialog { get; set; }Gets or sets a collection of commands that can be executed.
public RichTextBoxCommands Commands { get; set; }Gets or sets the minimum width of the panel containing comments.
public double CommentPaneMinWidth { get; set; }Implements:
Gets or sets the comment template content margin.
public Thickness CommentTemplateContentMargin { get; set; }Implements:
Gets or sets the context menu.
public IContextMenu ContextMenu { get; set; }Gets the current editing context which provides information about the document's editing state and active operations like selection, search, or special editing modes.
public EditingContext CurrentEditingContext { get; }Implements:
Gets a value indicating the current editing style.
public StyleDefinition CurrentEditingStyle { get; }Implements:
Gets a paragraph object containing the style settings of the current paragraph.
public Paragraph CurrentParagraphStyle { get; }Gets a span object containing the style settings of the current span.
public Span CurrentSpanStyle { get; }Gets or sets the currently active user.
public UserInfo CurrentUser { get; set; }Gets the index of the currently visible page.
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; }Gets or sets the currently active document in the editor. This is the main document that contains all the content and formatting being edited. Changing this property will raise the DocumentChanging and DocumentChanged events.
public RadDocument Document { get; set; }The RadDocument instance that contains the document's content and formatting.
Implements:
Gets or sets value indicating whether the edited Document instance should use by default the FontFamily, FontSize, ForeColor and other style properties applied to this RadRichTextBox using the DefaultStyleSettings.
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 the dialog for editing custom dictionaries.
public IEditCustomDictionaryDialog EditCustomDictionaryDialog { get; set; }Gets or sets the pattern used for matching emails
public string EmailPattern { get; set; }Implements:
Gets or sets the brush used to visually highlight text ranges with enforced permissions in the document.
public Brush EnforcedPermissionRangeBrush { get; set; }Implements:
Gets or sets the field shading type/
public FieldShadingType FieldShadingMode { get; set; }Implements:
Gets or sets the find and replace dialog.
public IFindReplaceDialog FindReplaceDialog { get; set; }Gets or sets the dialog for editing floating block properties.
public IFloatingBlockPropertiesDialog FloatingBlockPropertiesDialog { get; set; }Gets or sets the direction of flow of the elements.
public override FlowDirection FlowDirection { get; }Overrides:
Gets or sets the dialog for editing font properties.
public IFontPropertiesDialog FontPropertiesDialog { get; set; }Gets the horizontal scroll bar of the RadRichTextBox
public RadScrollBarElement HorizontalScrollBar { get; }Gets or sets the height of the horizontal scroll bar.
public int HorizontalScrollBarHeight { get; set; }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.
Gets or sets the pattern used for matching hyperlinks
public string HyperlinkPattern { get; set; }Implements:
Gets or sets the hyperlink tool 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 dialog for editing images.
public IImageEditorDialog ImageEditorDialog { get; set; }Gets or sets the image mini toolbar.
public IImageMiniToolBar ImageMiniToolBar { get; set; }Gets an object containing the options available for the Image selection adorner.
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }Implements:
Gets or sets an instance of RichTextEditorInputBehavior that will handle user input.
public RichTextEditorInputBehavior InputHandler { get; set; }Gets or sets the dialog for inserting captions.
public IInsertCaptionDialog InsertCaptionDialog { get; set; }Gets or sets the dialog for inserting cross-reference windows.
public IInsertCrossReferenceWindow InsertCrossReferenceWindow { get; set; }Gets or sets the dialog for inserting date time values.
public IInsertDateTimeDialog InsertDateTimeDialog { get; set; }Gets or sets the dialog for inserting hyperlinks in the document.
public IInsertHyperlinkDialog InsertHyperlinkDialog { get; set; }Gets or sets the dialog for inserting symbols in the document.
public IInsertSymbolWindow InsertSymbolWindow { get; set; }Gets or sets the dialog for inserting tables in the document.
public IInsertTableDialog InsertTableDialog { get; set; }Gets or sets the dialog for inserting table of contents.
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 indicating whether the editor is currently in Header/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. When true, users can still navigate through the document, copy content, and perform search operations, but editing operations are disabled. This property is useful for documents intended for display only.
public bool IsReadOnly { get; set; }True if the document is in read-only mode; otherwise, false.
Implements:
Gets or sets a value indicating whether selection can be made in the document.
public bool IsSelectionEnabled { get; set; }Gets or sets a value indicating whether the mini toolbar that appears after a selection 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 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 the dialog for managing bibliographics sources.
public IManageBibliographicSourcesDialog ManageBibliographicSourcesDialog { get; set; }Gets or sets the dialog for managing bookmarks in the document.
public IManageBookmarksDialog ManageBookmarksDialog { get; set; }Gets or sets the dialog for managing styles.
public IManageStylesDialog ManageStylesDialog { get; set; }public Panel MeasuringPanel { get; set; }public IMentionBox MentionBox { get; set; }public MentionContext MentionContext { get; set; }Gets or sets the dialog for editing footnotes and endnotes properties.
public INotesDialog NotesDialog { get; set; }Gets or sets the back color that should be applied to all pages.
public Color PageBackColor { get; set; }Gets or sets the dialog for editing paragraph properties.
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 the dialog for editing protection settings for the document.
public IProtectDocumentDialog ProtectDocumentDialog { get; set; }Gets or sets the Protection Authentication Provider
public IProtectionAuthenticationProvider ProtectionAuthenticationProvider { get; set; }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; }Gets or sets a value representing the current view scale factor.
public Size ScaleFactor { get; set; }Implements:
Gets or sets a value representing the current section columns dialog.
public ISectionColumnsDialog SectionColumnsDialog { get; set; }Gets or sets the currently selected comment in the document. When a comment is selected, its content becomes visible in the comment area and can be edited if permissions allow. Setting this property will clear any current document selection.
public Comment SelectedComment { get; set; }The currently selected Comment instance, or null if no comment is selected.
Implements:
Gets or sets the currently selected note.
public Note SelectedNote { get; set; }Implements:
Gets or sets the color of the selection rectangle.
public Brush SelectionFill { get; set; }Implements:
Gets or sets the selection mini toolbar.
public ISelectionMiniToolBar SelectionMiniToolBar { get; set; }Gets or sets the brush for the selection rectangle border.
public Brush SelectionStroke { get; set; }Implements:
Gets or sets the dialog for setting numbering values.
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:
Gets or sets a value indicating whether Merge Fields will be highlighted.
public bool ShowMergeFieldsHighlight { get; set; }Gets or sets the ISpellChecker implementation used when proofing.
public ISpellChecker SpellChecker { get; set; }Implements:
Gets or sets the dialog for spell checking.
public ISpellCheckingDialog SpellCheckingDialog { get; set; }Gets or sets the dialog for editing style properties.
public IStyleFormattingPropertiesDialog StyleFormattingPropertiesDialog { get; set; }Gets or sets the dialog for editing table borders.
public ITableBordersDialog TableBordersDialog { get; set; }Gets or sets the dialog for editing table properties.
public ITablePropertiesDialog TablePropertiesDialog { get; set; }Gets or sets the dialog for editing tab stop properties.
public ITabStopsPropertiesDialog TabStopsPropertiesDialog { get; set; }Gets the object containing options available for Track changes.
public TrackChangesOptions TrackChangesOptions { get; }Gets or sets an instance of UILayersBuilder.
public UILayersBuilder UILayersBuilder { get; set; }Implements:
Gets or sets the dialog for removing protection restrictions on the document.
public IUnprotectDocumentDialog UnprotectDocumentDialog { get; set; }Gets or sets a collection containing the users' permissions on the current document.
public PermissionInfoCollection Users { get; set; }Gets the vertical scroll bar of the RadRichTextBox
public RadScrollBarElement VerticalScrollBar { get; }Gets or sets a value representing the vertical scroll bar visibility.
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }Gets or sets the width of the vertical scroll bar.
public int VerticalScrollBarWidth { get; set; }Gets or sets the dialog for editing watermark settings.
public IWatermarkSettingsDialog WatermarkSettingsDialog { get; set; }Methods
Accepts all revisions in the current document.
public void AcceptAllRevisions()Implements:
Accepts revision.
public void AcceptRevision(Revision revision)The revision.
Implements:
Adds a tab stop at the current position in the document.
Adds the enumeration of tab stops.
public void AddTabStopRange(IEnumerable<TabStop> tabStops)The tab stops to add.
Implements:
Arranges the RadElement to its final location. The element must call the Arrange method of each of its children.
protected override SizeF ArrangeOverride(SizeF finalSize)The size that is available for element.
Returns:The rectangle occupied by the element. Usually finalSize. Should you return different size, the Layout system will restart measuring and rearranging the items. That could lead to infinite recursion.
Overrides:
In this method call to the Arrange method of each child must be made.
Begins new undo group.
public void BeginUndoGroup()Implements:
Cancels current undo group.
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.
Implements:
Changes the baseline alignment of the current run in the document.
public void ChangeBaselineAlignment(BaselineAlignment newBaselineAlignment)The new 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 indicating whether the first page header and footer would be different than the rest of the pages.
public void ChangeDifferentFirstPageHeaderFooter(bool value)true if the header and footer will be different, otherwise false.
Implements:
Sets a value indicating whether even and odd pages headers and footers would be different.
public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)true if the headers and footers will be different, otherwise false.
Implements:
Changes the space a single Tab (\t) character takes.
public void ChangeDocumentDefaultTabWidth(double tabWidth)The new width.
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 for endnotes for the entire document.
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)The new start number.
Implements:
Changes the endnotes numbering format for the entire document.
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)The new numbering format.
Implements:
Changes where endtnote numbers will stop incrementing and will start from the first one for the entire document.
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The new restart type.
Implements:
Changes the position of the endnotes for the entire document.
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)Implements:
Changes the first number for footnotes for the entire document.
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)The new start number.
Implements:
Changes the footnotes numbering format for the entire document.
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)The new numbering format.
Implements:
Changes where footnote numbers will stop incrementing and will start from the first one for the entire document.
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The new restart type.
Implements:
Changes the position of the footnoes for the entire document.
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)The new footnotes position.
Implements:
Sets a value indicating whether strict line brealing rule is enabled.
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)true if rule should be enabled otherwise false.
Implements:
Changes the language for which line breaking rules are currently applied in the document.
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)The new language for which line breaking rules are applied.
Implements:
Changes the characters after which a line break cannot be placed.
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)The new rule for line breaks after a character.
Implements:
Changes the characters before which a line break cannot be placed.
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)The new rule for line breaks before a character.
Implements:
Changes the field display mode.
public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)The field start.
displayModeFieldDisplayModeThe new display mode.
Implements:
Changes the font family of the current run in the document.
public void ChangeFontFamily(FontFamily fontFamily)The new font family to be applied.
Implements:
Changes the font size of the current run in the document.
public void ChangeFontSize(double newFontSize)The new font size to be applied.
Implements:
Changes the font style of the current run in the document.
public void ChangeFontStyle(FontStyle fontStyle)The new font style.
Implements:
Changes the font style of the current run in the document.
public void ChangeFontStyle(FontStyle fontStyle)The new font style.
Changes the font weight of the current run in the document.
public void ChangeFontWeight(FontWeight fontWeight)The new font weight.
Implements:
Changes the image rotate angle.
public void ChangeImageRotateAngle(ImageInline image, double angle)The ImageInline.
angledoubleThe new angle.
Implements:
Changes the size of the image.
public void ChangeImageSize(ImageInline image, Size size)The ImageInline.
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 paragraph style of the current paragraph.
public void ChangeListStyle(ListStyle style)The new style to be applied.
Controls whether automatic spacing is applied after the current paragraph.
public void ChangeParagraphAutomaticSpacingAfter(bool value)True if automatic spacing should be applied, otherwise false.
Implements:
Controls whether automatic spacing is applied before the current paragraph.
public void ChangeParagraphAutomaticSpacingBefore(bool value)True if automatic spacing should be applied, otherwise false.
Implements:
Changes the background color of the selected paragraphs in the document.
public void ChangeParagraphBackground(Color color)The new background color to be applied.
Implements:
Changes the left indent of the current paragraph.
public void ChangeParagraphFirstLineIndent(double firstLineIndent)The new left indent to be applied.
Implements:
Changes the flow direction of the selected paragraphs in the document.
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)The new flow direction to be applied.
Implements:
Sets a value indicating whether line brealing rules are enabled.
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)true if rules should be enabled otherwise false.
Implements:
Changes the left indent of the current paragraph.
public void ChangeParagraphLeftIndent(double leftIndent)The new left indent to be applied.
Implements:
Changes the line spacing inside the current paragraph.
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)The new line spacing to be applied.
lineSpacingTypeLineSpacingTypeThe type of the line spacing to be applied.
Implements:
Changes the lines spacing inside the current paragraph.
public void ChangeParagraphLineSpacing(double lineSpacing)The new line spacing to be applied.
Implements:
Changes the line spacing type inside the current paragraph.
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)The new line spacing type to be applied.
Implements:
Changes the list level the paragraph is currently in.
public void ChangeParagraphListLevel(int listLevel)The list level to be applied.
Implements:
Changes the right indent of the current paragraph.
public void ChangeParagraphRightIndent(double rightIndent)The new right indent to be applied.
Implements:
Changes the spacing after the current paragraph.
public void ChangeParagraphSpacingAfter(double spacingAfter)The new spacing to be applied.
Implements:
Changes the spacing before the current paragraph.
public void ChangeParagraphSpacingBefore(double spacingBefore)The new spacing to be applied.
Implements:
Changes the paragraph style of the current paragraph.
public void ChangeParagraphStyle(StyleDefinition styleInfo)The new style to be applied.
Implements:
Changes the actual page margin (regarding the page orientation) of the section.
public void ChangeSectionActualPageMargin(Padding sectionMargin)The section margin.
Implements:
ChangeSectionColumns
public void ChangeSectionColumns(SectionColumnCollection columnCollection)columns
Implements:
ChangeSectionColumns
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)Section Columns Layout
Implements:
Changes the first number for endnotes for the current section.
public void ChangeSectionEndnotesFirstNumber(int firstNumber)The new start number.
Implements:
Changes the endnotes numbering format for the current section.
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)The new numbering format.
Implements:
Changes where endtnote numbers will stop incrementing and will start from the first one for the current section.
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The new restart type.
Implements:
Changes the first page number of the current section. Set null continue numeration form the previous section.
public void ChangeSectionFirstPageNumber(int? firstPageNumber)The new first page number value.
Implements:
Changes the bottom margin of the footer of the current section.
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)Footer bottom margin to be applied.
Implements:
Changes the value indicated whether the a 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 for footnotes for the current section.
public void ChangeSectionFootnotesFirstNumber(int firstNumber)The new start number.
Implements:
Changes the footnotes numbering format for the current section.
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)The new numbering format.
Implements:
Changes where footnote numbers will stop incrementing and will start from the first one for the current section.
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The new restart type.
Implements:
Changes the value indicated whether the a 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 top margin of the header of the current section.
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)Header top margin to be applied.
Implements:
Changes the line numberings for the selected sections.
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)The line numbering.
Implements:
Changes the page margin of the current section.
public void ChangeSectionPageMargin(Padding sectionMargin)The new margin to be applied.
Implements:
Changes the page orientation of the current section.
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)The new page orientation to be applied.
Implements:
Changes the page size of the current section.
public void ChangeSectionPageSize(Size size)The new page size to be applied.
Implements:
Changes the style of current run in the document.
public void ChangeSpanStyle(StyleDefinition styleInfo)The new style to be applied.
Implements:
Changes the strikethrough of the current run in the document.
public void ChangeStrikethrough(bool isStrikethrough)The new strikethrough value.
Implements:
Applies style with a given name to the selected elements in the document.
public void ChangeStyleName(string styleName)Name of the style.
Implements:
Changes the style name of the current run in the document.
Changes the borders of the current table.
public void ChangeTableBorders(TableBorders borders)The new table borders.
Implements:
Changes the back color of the current cell.
public void ChangeTableCellBackground(Color color)The new cell back color.
Implements:
Changes the borders style of the current cell.
public void ChangeTableCellBorders(Border border)The new borders style.
Implements:
Changes the cell border styles of the current table.
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)The new cell border styles.
Implements:
Changes the content alignment of the currently selected cells.
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)The new horizontal alignment.
verticalAlignmentRadVerticalAlignmentThe new vertical alignment.
Implements:
Changes the horizontal alignment of the currently selected cells.
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)The new horizontal alignment.
Implements:
Changes the cell padding for the currently selected cells.
public void ChangeTableCellPadding(Padding padding)The new padding.
Implements:
Changes the cell spacing of the current table.
public void ChangeTableCellSpacing(double cellSpacing)The new cell spacing.
Implements:
Changes the vertical alignment of the currently selected cells.
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)The new vertical alignment.
Implements:
Changes the default padding applied to cells of the current table.
public void ChangeTableDefaultCellPadding(Padding padding)The new padding.
Implements:
Changes the flow direction of the current table.
public void ChangeTableFlowDirection(FlowDirection flowDirection)The new flow direction.
Implements:
Changes the width of the column at the given index in the given table.
public void ChangeTableGridColumnWidth(Table table, int gridColumnIndex, TableWidthUnit width)The table containing the column.
gridColumnIndexintThe index of the column in the table.
widthTableWidthUnitThe new column width.
Implements:
Changhes the table horizontal alignment.
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)The new alignment.
Implements:
Changes the table indent.
Changes the layout mode of the given table.
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)The table to change the layout of.
tableLayoutModeTableLayoutModeThe new layout mode.
Implements:
Changes the visual appearance of the current table.
public void ChangeTableLook(TableLook tableLook)The new visual settings.
Implements:
Changes the preferred width for the current table.
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Implements:
ChangeTableRowRepeatOnEveryPage
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)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 current run in the document.
public void ChangeUnderlineColor(Color newColor)The new underline color to be applied.
Implements:
Changes the underline decoration of the current run in the document.
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)The new underline decoration provider to be applied.
Implements:
Clears all of the formatting of the current paragraph and run in the document.
public void ClearAllFormatting()Implements:
Clears the formatting of the current run in the document.
public void ClearFormatting()Implements:
Removes all tab stops from the currently selected paragraphs.
public void ClearTabStops()Implements:
Removes all paragraphs from the current list and continues the first possible list before that paragraph. The paragraph should be in list and should be first in the list, otherwise this method does nothing.
Copies 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:
Executes the Cut command.
public void Cut()Implements:
Decrements the font size of the current run in the document.
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 from the document respecting CaretPosition and Selection.
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 current document.
public void DeleteAllComments()Implements:
Deletes an annotation range.
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)The start of the range that is to 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 code range start 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 current read only range.
public void DeleteReadOnlyRange()Implements:
Deletes the read only range.
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)The read only range that is to be deleted.
Implements:
Deletes the current table.
public void DeleteTable()Implements:
Deletes the provided table from the document.
Deletes the current column.
public void DeleteTableColumn()Implements:
Deletes the current row from the table.
public void DeleteTableRow()Implements:
Removes the currently applied watermark.
public void DisableWatermark()protected virtual void DisposeDialogs()Releases managed resources by clearing the property store and disposing value animators to prevent memory leaks.
protected override void DisposeManagedResources()Overrides:
Releases any UNMANAGED resources used by this object. NOTE: If you declare some unmanaged resources in your class, you should override its finalizer and put disposing logic there also.
protected override void DisposeUnmanagedResources()Overrides:
Shows the dialog for editing list styles.
Closes current undo group.
public void EndUndoGroup()Implements:
Closes current undo group.
public void EndUndoGroup(string groupDisplayText)The display text which will be used for the undo group.
Implements:
Focuses the footer of the current page.
public void FocusFooter()Focuses the header of the current page.
public void FocusHeader()protected virtual Type GetDocumentEditorPresenterTypeForDocument(RadDocument document)Gets the component responsible for building the UI layers of the editor.
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()Increments the font size of the current run in the document.
public void IncrementFontSize()Implements:
Increments the left indent of the current paragraph.
public void IncrementParagraphLeftIndent()Implements:
Increments the list level the paragraph is currently in by 1.
public void IncrementParagraphListLevel()Inserts text into the document at the current caret position, applying the current formatting. This is the primary method for adding textual content to the document programmatically.
Inserts an annotation range.
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)The annotation range start.
rangeEndAnnotationRangeEndThe annotation range end.
Implements:
Inserts a bookmark at the current selection or caret position, which can be used for quick navigation within the document.
public void InsertBookmark(string bookmarkName)The unique name for the bookmark to be inserted.
Implements:
Inserts a caption.
public void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)The definition.
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 code block into the document at caret position. If caret position is in code block, replaces the current code block.
public void InsertCodeBlock(string code, CodeFormattingSettings settings)Implements:
Inserts a column break at the current caret position, forcing the following content to begin in the next column.
public void InsertColumnBreak()Implements:
Inserts a comment.
Inserts a Cross-Reference to a bookmark into the document at current caret position.
public void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)Implements:
Inserts a Cross-Reference to a caption into the document at current caret position.
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)Implements:
Inserts a Cross-Reference to a heading paragraph into the document at current caret position.
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)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 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 specified position.
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)The fragment to insert.
documentPositionDocumentPositionThe document position to insert the fragment at.
Implements:
Inserts a document fragment.
public void InsertFragment(DocumentFragment documentFragment)The document fragment to insert.
Implements:
Inserts a collection of inline elements as a hyperlink into the document at the current position.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)The hyperlink information containing URL, tooltip, and other link properties.
inlinesIEnumerable<Inline>The collection of inline elements to be displayed as the hyperlink text.
Implements:
Inserts a hyperlink with the specified text into the document at the current position.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)The hyperlink information containing URL, tooltip, and other link properties.
hyperlinkTextstringThe text to display for the hyperlink.
Creates a hyperlink from the current text selection, applying the provided link information.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)The hyperlink information containing URL, tooltip, and other link properties.
Implements:
Inserts an image as an inline element into the document at the current position.
Inserts inline element into the document.
public void InsertInline(Inline inline, DocumentPosition documentPosition)The inline element to insert.
documentPositionDocumentPositionThe document position to insert the inline at.
Implements:
Inserts inline element into the document.
public void InsertInline(Inline inline)The inline element to insert.
Implements:
Inserts text and adds new paragraph after it.
Inserts a line break at the current caret position, creating a new line without starting a new paragraph.
public void InsertLineBreak()Implements:
Inserts a non-breaking space into the document at the current caret position.
public void InsertNonBreakingSpace()Inserts a page break at the current caret position, forcing the following content to begin on a new page.
public void InsertPageBreak()Implements:
Inserts a new paragraph.
public void InsertParagraph()Implements:
Inserts a new permission range at the current selection, allowing control over who can edit specific parts of the document.
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)A collection of permission settings that define user access rights for the new range.
Implements:
Inserts a read only range.
public void InsertReadOnlyRange()Implements:
Inserts a section break at the current caret position, using the default NextPage section break type.
public void InsertSectionBreak()Implements:
Inserts a section break of the specified type at the current caret position, allowing independent formatting of different sections.
public void InsertSectionBreak(SectionBreakType sectionBreakType)The type of the section break to insert.
Implements:
Inserts a default structured document tag (Content Control) at the current selection. The default type is RichText.
public void InsertStructuredDocumentTag()Inserts a structured document tag (Content Control) with the specified properties at the current selection.
public void InsertStructuredDocumentTag(SdtProperties insertProperties)The properties to configure the structured document tag.
Inserts a structured document tag (Content Control) of the specified type at the current selection.
public void InsertStructuredDocumentTag(SdtType insertType)The type of structured document tag to insert.
Inserts a new table with the specified number of rows and columns at the current caret position.
Inserts the given table at the current caret position with an option to include a paragraph before it.
Inserts the given table at the current caret position with a paragraph before it. This is a convenience method that calls InsertTable(table, true).
Inserts a column to the right of the last table column.
public void InsertTableColumn()Implements:
Inserts a column to the left of the current column.
public void InsertTableColumnToTheLeft()Implements:
Inserts a column to the right of the current column.
public void InsertTableColumnToTheRight()Implements:
Inserts a row at the bottom of the table.
public void InsertTableRow()Implements:
Inserts a row above the current row in the table.
public void InsertTableRowAbove()Implements:
Inserts a row below the current row in the table.
public void InsertTableRowBelow()Implements:
Invalidates the active editor presenter layout, causing the editor to remeasure and rearrange its elements.
public void InvalidateEditorLayout()Clears the spell-checking state of words in the document and updates the UI to reflect the changes.
public void InvalidateProofingErrors(bool invalidateIncorrectWordsOnly)True to invalidate only words marked as incorrect, false to invalidate all words.
Produces a mail merge document for all the mail merge data records.
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)true if each record should start on a new page.
The document
Implements:
Produces a mail merge document for the current mail merge data record.
Measures the space required by the RadElement
Used by the layout system.
protected override SizeF MeasureOverride(SizeF availableSize)The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns:The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides:
In this method call to the Measure method of each child must be made.
Merges the currently selected cells.
public void MergeTableCells()Implements:
Moves current document selection to a specified position.
public void MoveSelection(DocumentPosition position, bool deleteSelection)The move position.
deleteSelectionboolIndicates whether the current selection should be deleted.
Implements:
Called when the template is applied to the control.
public override void OnApplyTemplate()Overrides:
Raises the BeforeOpenFile event before a file is opened.
protected virtual void OnBeforeOpenFile(OpenFileDialogEventArgs args)An OpenFileDialogEventArgs object that contains the event data.
This method is called to trigger the BeforeOpenFile event, allowing subscribers to perform actions before a file is opened. Override this method in a derived class to provide additional functionality when the event is raised.
Raises the BeforeSaveFile event before a file is saved.
protected virtual void OnBeforeSaveFile(SaveFileDialogEventArgs e)An SaveFileDialogEventArgs object that contains the event data.
This method is called to trigger the BeforeSaveFile event, allowing subscribers to perform actions before the file save operation occurs.
protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)Overrides:
Called when the bubble phase of a routed event occurs.
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)The element that originally raised the event.
argsRoutedEventArgsThe routed event arguments.
Overrides:
Raises the event.
protected virtual void OnCommandError(CommandErrorEventArgs args)The CommandErrorEventArgs instance containing the event data.
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.
Raises the event.
protected virtual void OnCurrentEditingStyleChanged()Raises the event.
protected virtual void OnCurrentParagraphStyleChanged()Raises the CurrentSpanStyleChanged event.
protected virtual void OnCurrentSpanStyleChanged()Raises the event.
protected virtual void OnCurrentVisiblePageChanged()Raises the DocumentArranged event.
protected virtual void OnDocumentArranged()Raises the DocumentChanged event.
protected virtual void OnDocumentChanged()Raises the DocumentChanging event.
protected virtual void OnDocumentChanging()Raises the DocumentContentChanged event.
protected virtual void OnDocumentContentChanged()Raises the DocumentLayoutModeChanged event.
protected virtual void OnDocumentLayoutModeChanged()Raises the DocumentPresentationChanged event.
protected virtual void OnDocumentPresentationChanged(PresentationChangedEventArgs e)The PresentationChangedEventArgs instance containing the event data.
Raises the event.
protected virtual void OnHyperlinkClicked(object sender, HyperlinkClickedEventArgs eventArgs)The sender of the event.
eventArgsHyperlinkClickedEventArgsThe HyperlinkClickedEventArgs instance containing the event data.
Called when the control is loaded.
protected override void OnLoaded()Overrides:
Raises the event.
protected virtual void OnMergeFieldToStringConverting(object sender, MergeFieldToStringConvertingEventArgs e)The sender of the event.
eMergeFieldToStringConvertingEventArgsThe MergeFieldToStringConvertingEventArgs instance containing the event data.
Raises the event.
protected virtual void OnNoteReferenceClicked(MouseButtonEventArgs args)The MouseButtonEventArgs instance containing the event data.
Raises the event.
protected virtual void OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs e)The PreviewEditorKeyEventArgs instance containing the event data.
Raises the event.
protected virtual void OnPrintCompleted(PrintCompletedEventArgs e)The PrintCompletedEventArgs instance containing the event data.
Called when a property value has changed, allowing for custom response to property changes.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)The property changed event arguments.
Overrides:
Raises the ProtectionStateChanged event.
protected virtual void OnProtectionStateChanged()protected virtual void OnProviderUILayerInitialized(ProviderUILayerBase layer, Canvas container, UILayerUpdateContext context)Raises the event.
protected virtual void OnScaleFactorChanged()Raises the event.
protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)The StreamFromUriResolvingEventArgs instance containing the event data.
Raises the event.
protected virtual void OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs e)The UntrackableCommandExecutingEventArgs instance containing the event data.
Raises the UserInfoChanged event.
protected virtual void OnUserInfoChanged()Opens the context menu next to the next spelling error in the document.
public void OpenContextMenuOnNextSpellingError()Pastes the content of the clipboard into the document.
public void Paste()Implements:
Pastes the content of the clipboard into the document using the specified paste option.
Pastes the currently copied formatting on the current selection.
public bool PasteFormatting()A value indicating whether the paste was successful.
Implements:
Previews the first mail merge data record.
Previews the last mail merge data record.
Previews the next mail merge data record.
Previews the previous mail merge data record.
Directly prints the RadRichTextEditor document to the default printer.
public virtual void Print()Directly prints the RadRichTextEditor document to the default printer or shows printer settings and then prints the RadRichTextEditor document.
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)Indicates whether printer settings dialog should be shown.
documentRadPrintDocumentAs instance of RadPrintDocument used to control the print process.
Directly prints the RadRichTextEditor document to the default printer or shows printer settings and then prints the RadRichTextEditor document.
public virtual void Print(bool showPrinterSettings)Indicates whether printer settings dialog should be shown.
Shows a RadPrintPreviewDialog for editing the RadRichTextEditor print settings.
public virtual void PrintPreview()Shows a RadPrintPreviewDialog for editing the RadRichTextEditor print settings.
public virtual void PrintPreview(RadPrintDocument document)As instance of RadPrintDocument used to control the print process.
Re-executes the last undone command group.
public void Redo()Implements:
Rejects all revisions in the current document.
public void RejectAllRevisions()Implements:
Rejects revision.
public void RejectRevision(Revision revision)The revision.
Implements:
Removes the hyperlink on the caret position.
public void RemoveHyperlink()Removes the given tab stop from the currently selected paragraphs.
public void RemoveTabStop(TabStop tabStop)The tab stop to be removed.
Implements:
Removes the enumeration of tab stops.
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)The tab stops to remove.
Implements:
protected virtual void ResetFormatPainter()Changes the width of the column at the specified index in the given table.
Creates a new list from the current paragraph. The paragraph should be in list, otherwise this method does nothing.
Scrolls the viewport so that a note becomes visible.
Sets the provided comment as selected.
public void SetSelectedComment(CommentRangeStart commentStart)The comment to select.
Sets the provided note as selected.
Sets a watermark with the provided settings.
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)The settings to apply to the watermark.
Implements:
Sets one of the predefined watermarks.
public void SetWatermark(PredefinedWatermarkType predefinedType)The predefined watermark to apply.
Implements:
Sets an image watermark with the provided settings.
public void SetWatermarkImage(WatermarkImageSettings settings)The settings to apply to the watermark.
Sets a text watermark with the provided settings.
public void SetWatermarkText(WatermarkTextSettings settings)The settings to apply to the watermark.
Gets a value indicating whether a child will be arranged during the ArrangeOverride(SizeF).
protected override bool ShouldArrangeChild(RadElement child)The child element to check.
Returns:Whether the child will be arranged in ArrangeOverride.
Overrides:
protected virtual bool ShouldCreateNewContextMenu(IContextMenu menu)Gets a value indicating, whether a child will be measured during the MeasureOverride.
protected override bool ShouldMeasureChild(RadElement child)The child.
Returns:Whether the child will be measured in MeasureOverride.
Overrides:
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()Opens the context menu at the specified document position.
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)The DocumentPosition where the context menu will be opened.
Opens the context menu at the specified document position.
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)A point where the context menu should appear without taking into account element obstruction.
positionDocumentPositionThe DocumentPosition for indicating the element for which the context menu is being shown.
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()Shows the section 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.
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)The start of the range that is to be split.
positionDocumentPositionThe position where the range is to be split.
Implements:
Splits an annotation range at the caret position.
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)The start of the range that is to be split.
Implements:
Suppress the line numbering for selected paragraphs.
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)Implements:
Toggles the bold state of the current run in the document.
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 between different first page header and footer and same header and footer for all pages.
public void ToggleDifferentFirstPageHeaderFooter()Toggles between different odd and eventpage header and footer and same header and footer for all pages.
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 italic state of the current run in the document.
public void ToggleItalic()Implements:
Toggles between highlighting and not highlighting Merge Fields.
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 last executed command group.
public void Undo()Implements:
Unmerges the currently selected cells.
public void UnmergeTableCells()Implements:
Updates all captions related to caption definition.
public void UpdateAllCaptions(CaptionDefinition captionDefinition)The caption definition.
Implements:
Updates all fields in the document.
public void UpdateAllFields()Implements:
Updates all fields and displays them in the specified display mode.
public void UpdateAllFields(FieldDisplayMode displayMode)The display mode.
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 before a file is opened, before the open file dialog is shown.
public event EventHandler<OpenFileDialogEventArgs> BeforeOpenFileSubscribe to this event to customize the OpenFileDialog properties (like Filter, InitialDirectory, etc.) before it is displayed to the user. Handlers can also cancel the open file operation by setting the Cancel property of the event arguments to true.
Occurs before the file is saved, before the save file dialog is shown.
public event EventHandler<SaveFileDialogEventArgs> BeforeSaveFileSubscribe to this event to customize the SaveFileDialog properties (like Filter, InitialDirectory, etc.) before it is displayed to the user. Handlers can also cancel the open file operation by setting the Cancel property of the event arguments to true.
Occurs 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 DocumentLayoutModeChangedOccurs when the presentation of the current document has changed.
public event EventHandler<PresentationChangedEventArgs> DocumentPresentationChangedOccurs when the users clicks on a hyperlink in the current document.
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClickedOccurs when going in or out of header/footer editing mode.
public event EventHandler IsInHeaderFooterEditModeChangedOccurs when IsReadOnly property changes.
public event EventHandler IsReadOnlyChangedOccurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it becames a result string value.
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConvertingOccurs when a key is pressed while and editor is focused.
public 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 child elements of an UI layer have been initialized and added to its container.
public event EventHandler<ProviderUILayerInitilizedEventArgs> ProviderUILayerInitializedOccurs 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 SelectionChangedOccurs when resolving a URI tfor a stram object.
public 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