RadRichTextEditor
RadRichTextEditor is a control that allows you to create, view, modify and format rich text content including sections, paragraphs, spans, tables, etc. It offers a full set of formatting options and various ways to access them.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
[TelerikToolboxCategory("RichTextEditor")]
[Docking(DockingBehavior.Ask)]
public class RadRichTextEditor : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, IPrintableInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadRichTextEditor...
Implements:
Inherited Members
Constructors
public RadRichTextEditor()Fields
The default namespace for the RadRichTextEditor control.
public static readonly string DEFAULT_NAMESPACEProperties
Gets or sets a value indicating whether pressing the RETURN key types a RETURN character in the control.
[Browsable(true)]
public bool AcceptsReturn { get; set; }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.
[Browsable(true)]
public bool AcceptsTab { get; set; }Gets or sets a value indicating whether the scaling is enabled.
[Browsable(true)]
public bool AllowScaling { get; set; }Gets or sets a value indicating whether hyperlinks should be automatically detected.
[Browsable(true)]
public bool AutoInsertHyperlinks { get; set; }Gets or sets the color of the border.
[Browsable(true)]
public Color BorderColor { get; set; }Gets a value indicating whether Input Method Editor (IME) can be enabled for this control.
protected override bool CanEnableIme { get; }Always returns true to enable IME input for text editing.
Overrides:
Gets or sets the color of the caret.
[Browsable(true)]
public Color CaretColor { get; set; }Gets or sets the width of the caret.
[Browsable(false)]
public float CaretWidth { get; set; }The width of the caret.
Provides access to the commands that can be executed by this RadRichTextEditor.
[Browsable(false)]
public RichTextBoxCommands Commands { get; set; }Gets or sets the minimum width of the comments pane.
[Browsable(true)]
public double CommentPaneMinWidth { get; set; }Gets or sets the comment template content margin.
[Browsable(true)]
public Padding CommentTemplateContentMargin { get; set; }Gets a value indicating the current editing style.
[Browsable(false)]
public StyleDefinition CurrentEditingStyle { get; }Gets or sets information about the current user.
[Browsable(false)]
public UserInfo CurrentUser { get; set; }Gets the currently visible page number.
[Browsable(false)]
public int CurrentVisiblePage { get; }Gets the default size when the control is dragged onto the designer surface.
protected override Size DefaultSize { get; }Overrides:
public Dispatcher Dispatcher { get; }Gets or sets the currently active document in the editor.
public RadDocument Document { get; set; }Gets the active document editor which provides methods for editing the document in an undo scope.
public IDocumentEditor DocumentEditor { get; }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.
[Browsable(true)]
public bool DocumentInheritsDefaultStyleSettings { get; set; }Gets or sets the field shading type/
[Browsable(true)]
public FieldShadingType FieldShadingMode { get; set; }Gets or sets a value representing the horizontal scroll bar visibility.
[Browsable(true)]
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }Gets or sets the hyperlink navigation mode.
[Browsable(true)]
public HyperlinkNavigationMode HyperlinkNavigationMode { get; set; }The hyperlink navigation mode.
Gets or sets the hyperlink tool text.
[Browsable(false)]
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.
[Browsable(false)]
public IIgnoredWordDictionary IgnoredWords { get; set; }Provides settings for the adorners of the selected images.
[Browsable(true)]
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }Gets or sets the component which is responsible for handling the input of RadRichTextEditor.
[Browsable(false)]
public RichTextEditorInputBehavior InputHandler { 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.
[Browsable(true)]
public bool IsAdvancedSelectionEnabled { get; set; }Gets or sets a value indicating whether context menu is enabled.
[Browsable(true)]
public bool IsContextMenuEnabled { get; set; }Gets or sets a value indicating whether the editor is currently in Header/Footer edit mode.
[Browsable(false)]
public bool IsInHeaderFooterEditMode { get; set; }Gets or sets a value indicating whether the paste options pop-up is displayed on paste.
[Browsable(true)]
public bool IsPasteOptionsPopupEnabled { get; set; }Gets or sets a value indicating whether the control is read-only.
[Browsable(true)]
public bool IsReadOnly { get; set; }Gets or sets a value indicating whether selection can be made in the document.
[Browsable(true)]
public bool IsSelectionEnabled { get; set; }Gets or sets a value indicating whether the mini toolbar that appears after a selection is enabled.
[Browsable(true)]
public bool IsSelectionMiniToolBarEnabled { get; set; }Gets or sets a value indicating whether the spell checking is enabled for this document.
[Browsable(true)]
public bool IsSpellCheckingEnabled { get; set; }Gets or sets a value indicating whether formatting symbols are shown in the document.
[Browsable(true)]
public bool IsTrackChangesEnabled { get; set; }true if formatting symbols are shown; otherwise, false.
Gets or sets the document layout mode.
[Browsable(true)]
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.
[Browsable(true)]
public LineBreakingRuleLanguage LineBreakingRuleLanguage { get; set; }The line breaking characters rule language.
[Browsable(false)]
public IMentionBox MentionBox { get; set; }[Browsable(false)]
public MentionContext MentionContext { get; set; }Gets or sets the back color that should be applied to all pages.
public Color PageBackColor { get; set; }Gets the RadRichTextBox that is the main element in the control.
public RadRichTextBox RichTextBoxElement { get; }Gets or sets a value representing the current view scale factor.
[Browsable(true)]
public SizeF ScaleFactor { get; set; }Gets or sets the currently selected comment.
[Browsable(false)]
public Comment SelectedComment { get; set; }Gets or sets the currently selected note.
[Browsable(false)]
public Note SelectedNote { get; set; }Gets or sets the fill of the selection rectangle.
[Browsable(true)]
[TypeConverter(typeof(RadColorEditorConverter))]
public Color SelectionFill { get; set; }Gets or sets the border of the selection rectangle.
[Browsable(true)]
[TypeConverter(typeof(RadColorEditorConverter))]
public Color SelectionStroke { get; set; }Gets or sets a value indicating whether the comments are shown.
[Browsable(true)]
public bool ShowComments { get; set; }Gets or sets a value indicating whether formatting symbols are shown in the document.
[Browsable(true)]
public bool ShowFormattingSymbols { get; set; }true if formatting symbols are shown; otherwise, false.
Gets or sets a value indicating whether merged fields should be highlighted.
[Browsable(true)]
public bool ShowMergeFieldsHighlight { get; set; }Gets or sets the ISpellChecker implementation used when proofing.
[Browsable(false)]
public ISpellChecker SpellChecker { get; set; }Gets or sets a collection containing the users' permissions on the current document.
[Browsable(false)]
public PermissionInfoCollection Users { get; set; }Gets or sets a value representing the vertical scroll bar visibility.
[Browsable(true)]
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }Methods
Accepts all revisions in the current document.
public void AcceptAllRevisions()Accepts revision.
Changes the display mode of all fields in the document.
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)The display mode.
Changes the baseline alignment of the current run in the document.
public void ChangeBaselineAlignment(BaselineAlignment newBaselineAlignment)The new baseline alignment to be applied.
Changes the bibliographic style of all bibliography related fields in the document.
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)The new bibliographic style.
Turns on or off the option to have a different header on the first page.
Turns on or off the option to have different headers and footers on odd and even pages.
Changes the width that a single Tab character takes.
Changes the Tag property of a specified DocumentElement.
public void ChangeDocumentElementTag(DocumentElement element, string tag)The DocumentElement.
tagstringThe new tag value.
Changes the starting number of the endnotes of the document.
Changes the list numbering format for the endnotes in the document.
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Changes the mode in which endnotes numbers are reset to start from the first number.
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Changes the location of the endnotes of the document.
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)Changes the starting number of the footnotes of the document.
Changes the list numbering format for the footnotes in the document.
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Changes the mode in which footnotes numbers are reset to start from the first number.
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Changes the location of the footnotes in the document.
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)Enables or disabled the Strict line breaking rule.
Applies the provided language to be used when calculating line breakings.
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)Applies the provided line breaking as no line breaking after rule.
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)Applies the provided line breaking rule as no line breaking before rule.
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)Changes the field display mode.
public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)The field start.
displayModeFieldDisplayModeThe new display mode.
Changes the font family of the current run in the document.
public void ChangeFontFamily(FontFamily fontFamily)The new font family to be applied.
Changes the font size of the current run in the document.
public void ChangeFontSize(double newFontSize)The new font size to be applied.
Changes the font style of the current run in the document.
public void ChangeFontStyle(FontStyle fontStyle)The new font style.
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.
Changes the image rotate angle.
public void ChangeImageRotateAngle(ImageInline image, double angle)The ImageInline.
angledoubleThe new angle.
Changes the size of the image.
public void ChangeImageSize(ImageInline image, Size size)The ImageInline.
sizeSizeThe new size.
Changes the layout mode.
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)The new layout mode 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.
Controls whether automatic spacing is applied before the current paragraph.
public void ChangeParagraphAutomaticSpacingBefore(bool value)True if automatic spacing should be applied, otherwise false.
Changes the background color of the selected paragraphs in the document.
public void ChangeParagraphBackground(Color color)The new background color to be applied.
Changes the left indent of the current paragraph.
public void ChangeParagraphFirstLineIndent(double firstLineIndent)The new left indent to be applied.
Changes the FlowDirection of the selected paragraphs in the document.
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)Changes a value indicating whether the line breaking rule is enabled.
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)True if the rule will be enabled otherwise false.
Changes the left indent of the current paragraph.
public void ChangeParagraphLeftIndent(double leftIndent)The new left indent to be applied.
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.
Changes the lines spacing inside the current paragraph.
public void ChangeParagraphLineSpacing(double lineSpacing)The new line spacing to be applied.
Changes the line spacing type inside the current paragraph.
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)The new line spacing type to be applied.
Changes the list level the paragraph is currently in.
public void ChangeParagraphListLevel(int listLevel)The list level to be applied.
Changes the right indent of the current paragraph.
public void ChangeParagraphRightIndent(double rightIndent)The new right indent to be applied.
Changes the spacing after the current paragraph.
public void ChangeParagraphSpacingAfter(double spacingAfter)The new spacing to be applied.
Changes the spacing before the current paragraph.
public void ChangeParagraphSpacingBefore(double spacingBefore)The new spacing to be applied.
Changes the paragraph style of the current paragraph.
public void ChangeParagraphStyle(StyleDefinition styleInfo)The new style to be applied.
Changes the actual page margin (regarding the page orientation) of the section.
public void ChangeSectionActualPageMargin(Padding sectionMargin)The section margin.
Changes the starting number of the endnotes of the current section.
Changes the list numbering format for the endnotes in the current section.
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Changes the mode in which endnotes numbers are reset to start from the first number in the current section.
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)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.
Changes the bottom margin of the footer of the current section.
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)Footer bottom margin to be applied.
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.
Changes the starting number of the footnotes of the current section.
Changes the list numbering format for the footnotes in the current section.
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Changes the mode in which footnotes numbers are reset to start from the first number in the current section.
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)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.
Changes the top margin of the header of the current section.
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)Header top margin to be applied.
Changes the page margin of the current section.
public void ChangeSectionPageMargin(Padding sectionMargin)The new margin to be applied.
Changes the page orientation of the current section.
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)The new page orientation to be applied.
Changes the page size of the current section.
Changes the style of current run in the document.
public void ChangeSpanStyle(StyleDefinition styleInfo)The new style to be applied.
Changes the strikethrough of the current run in the document.
public void ChangeStrikethrough(bool isStrikethrough)The new strikethrough value.
Applies the border to the selected tables.
Changes the back color of the currently selected cells.
Applies the border to the currently selected cells.
Applies the borders to the currently selected cells.
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)Applies the content alignment settings to the selected cells.
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)Applies the horizontal alignment to the selected cells.
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)Applies the padding to the currently selected cells.
Applies the cell spacing to the currently selected tables.
Applies the vertical alignment to the selected cells.
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)Changes the default cell padding of the currently selected tables.
Changes the flow direction of the current table to the flow direction.
public void ChangeTableFlowDirection(FlowDirection flowDirection)Changes the width of the column at the given index.
public void ChangeTableGridColumnWidth(Table table, int gridColumnIndex, TableWidthUnit width)Changes the horizontal alignment of the current table.
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)Changes the table indentation.
Changes the layout mode of the table.
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)Applies the table look to the selected tables.
Changes the preferred table width to the provided one.
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)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 highlight 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.
Changes the underline decoration of the current run in the document.
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)The new underline decoration provider to be applied.
Clears all of the formatting of the current paragraph and run in the document.
public void ClearAllFormatting()Clears the formatting of the current run in the document.
public void ClearFormatting()Removes all TabStops from the document.
public void ClearTabStops()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()Creates and returns the input behavior for the RadRichTextEditor control.
protected override ComponentInputBehavior CreateBehavior()A new instance of RadRichTextEditorComponentInputBehavior.
Overrides:
Creates the child items for the RadRichTextEditor control.
protected override void CreateChildItems(RadElement parent)The parent RadElement to which child items will be added.
Overrides:
Executes the Cut command.
public void Cut()Decrements the font size of the current run in the document.
public void DecrementFontSize()Decrements the left indent of the current paragraph.
public void DecrementParagraphLeftIndent()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()Deletes an annotation range.
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)The start of the range that is to be deleted.
Deletes a bookmark.
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)The bookmark range start.
Deletes a bookmark.
public void DeleteBookmark(string bookmarkName)Name of the bookmark.
Deletes a code block.
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)The code range start of the block to delete.
Deletes the current comment.
public void DeleteComment()Deletes a comment.
public void DeleteComment(CommentRangeStart commentRangeStart)The comment range start.
Deletes a permission range.
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)The permission range start.
Deletes the current read only range.
public void DeleteReadOnlyRange()Deletes the read only range.
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)The read only range that is to be deleted.
Deletes the table currently containing the caret.
public void DeleteTable()Deletes the table from the document.
Deletes the current column.
public void DeleteTableColumn()Deletes the current row from the table.
public void DeleteTableRow()Deletes the row from the table.
Removes the currently applied watermark.
public void DisableWatermark()Shows the dialog for editing styles.
Resumes layout.
public override void EndInit()Overrides:
Focuses the footer of the current page.
public void FocusFooter()Focuses the header of the current page.
public void FocusHeader()Gets the visual settings for the given comment.
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)The comment to get visual settings for.
Returns: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()Increments the left indent of the current paragraph.
public void IncrementParagraphLeftIndent()Increments the list level the paragraph is currently in by 1.
public void IncrementParagraphListLevel()Inserts text into the document at the specified position.
public void Insert(string text, DocumentPosition insertionPosition)The text to insert.
insertionPositionDocumentPositionThe position where the text will be inserted.
Inserts text into the document at current caret position.
Inserts an annotation range.
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)The annotation range start.
rangeEndAnnotationRangeEndThe annotation range end.
Inserts a bookmark.
public void InsertBookmark(string bookmarkName)Name of the bookmark.
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.
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)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)Inserts a Cross-Reference to a caption into the document at current caret position.
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)Inserts a Cross-Reference to a heading paragraph into the document at current caret position.
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)Inserts endnote at the current position.
public void InsertEndnote()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
Inserts footnote at the current position.
public void InsertFootnote()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.
Inserts a document fragment.
public void InsertFragment(DocumentFragment documentFragment)The document fragment to insert.
Inserts collection of inlines as hyperlink into the document.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)The hyperlink info.
inlinesIEnumerable<Inline>The inlines.
Inserts hyperlink into the document.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)The hyperlink info.
hyperlinkTextstringThe hyperlink text.
Creates hyperlink form the current selection.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)The hyperlink info.
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.
Inserts inline element into the document.
Inserts text and adds new paragraph after it.
Inserts LineBreak into the document at current caret position.
public void InsertLineBreak()Inserts PageBreak into the document at current caret position.
public void InsertPageBreak()Inserts a new paragraph.
public void InsertParagraph()Inserts new permission range.
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)The permissions for the new range.
Inserts a read only range.
public void InsertReadOnlyRange()Inserts SectionBreak into the document at current caret position.
public void InsertSectionBreak()Inserts SectionBreak of the specified type into the document at current caret position.
public void InsertSectionBreak(SectionBreakType sectionBreakType)The type of the section break.
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 the table at the current caret position.
Adds a column to the table.
public void InsertTableColumn()Adds a column to the left of the current one.
public void InsertTableColumnToTheLeft()Adds a column to the right of the current one.
public void InsertTableColumnToTheRight()Adds a new row at the bottom of the current table.
public void InsertTableRow()Inserts a row above the current row in the table.
public void InsertTableRowAbove()Inserts a row below the current row in the table.
public void InsertTableRowBelow()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
Produces a mail merge document for the current mail merge data record.
Merges the currently selected cells.
public void MergeTableCells()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.
Raises the GotFocus event when the control receives focus.
protected override void OnGotFocus(EventArgs e)An EventArgs that contains the event data.
Overrides:
Raises the HandleCreated event to initialize IME support.
protected override void OnHandleCreated(EventArgs e)An EventArgs that contains the event data.
Overrides:
Raises the KeyPress event to handle character input.
protected override void OnKeyPress(KeyPressEventArgs e)A KeyPressEventArgs that contains the event data.
Overrides:
Raises the KeyUp event to handle key release events.
protected override void OnKeyUp(KeyEventArgs e)A KeyEventArgs that contains the event data.
Overrides:
Raises the Load event and initializes the control.
protected override void OnLoad(Size desiredSize)The desired size of the control.
Overrides:
Opens the context menu on the next word that has a spelling error.
public void OpenContextMenuOnNextSpellingError()Pastes from clipboard into the document respecting CaretPosition and Selection
public void Paste()Pastes the content of the clipboard into the document using the specified paste option.
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()Rejects all revisions in the current document.
public void RejectAllRevisions()Rejects revision.
Removes the hyperlink on the caret position.
public void RemoveHyperlink()Creates a new list from the current paragraph. The paragraph should be in list, otherwise this method does nothing.
Scales the control according to the specified scaling factor.
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)The scaling factor to apply.
specifiedBoundsSpecifiedA BoundsSpecified value that specifies which bounds of the control to update.
Overrides:
Scrolls the viewport so that a note becomes visible.
Sets the currently selected comment.
public void SetSelectedComment(CommentRangeStart commentStart)Applies the watermark settings to the document.
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)Applies one of the predefined watermarks.
public void SetWatermark(PredefinedWatermarkType predefinedType)Applies the image settings watermark to the document.
public void SetWatermarkImage(WatermarkImageSettings settings)Applies the text settings watermark to the document.
public void SetWatermarkText(WatermarkTextSettings settings)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 RichTextEditor context menu at the given position
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)The position of the context menu.
Shows the context menu and adjusts the position it needed.
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)The original location where the context menu will open.
positionDocumentPositionThe position in the document that would help adjust the precise location of the menu.
Shows dialog for creating new list style.
public void ShowDefineNewListStyleDialog()Shows the dialog for editing custom spell-checking 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()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 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.
Splits an annotation range at the caret position.
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)The start of the range that is to be split.
Toggles the bold state of the current run in the document.
public void ToggleBold()Toggles the visibility of the bookmarks in the document.
public void ToggleBookmarks()Toggles the visibility of the comments in the document.
public void ToggleComments()Turns on or off the option to have a different header on the first page.
public void ToggleDifferentFirstPageHeaderFooter()Turns on or off the option to have different headers and footers on odd and even pages.
public void ToggleDifferentOddAndEvenPagesHeaderFooter()Toggles the display mode of a field.
public void ToggleFieldCodes(FieldRangeStart fieldStart)The field start.
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()Turns on or off the highlighting of merge fields.
public void ToggleMergeFieldsHighlight()Toggles the subscript state of the current run in the document.
public void ToggleStrikethrough()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()Unmerges the currently selected cells.
public void UnmergeTableCells()Updates all captions related to caption definition.
public void UpdateAllCaptions(CaptionDefinition captionDefinition)The caption definition.
Updates all fields in the document.
public void UpdateAllFields()Updates all fields and displays them in the specified display mode.
public void UpdateAllFields(FieldDisplayMode displayMode)The display mode.
Forces the control to update its layout and UI;
public void UpdateEditorLayout()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.
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.
Processes Windows messages, handling IME character input specially.
protected override void WndProc(ref Message m)The Windows Message to process.
Overrides:
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 document presentation is changed.
public event EventHandler<PresentationChangedEventArgs> DocumentPresentationChangedOccurs when the users clicks on a hyperlink in the current document.
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClickedOccurs when IsReadOnly property changes.
public event EventHandler IsReadOnlyChangedOccurs when the control is loaded and fully initialized.
public event EventHandler LoadedOccurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it becomes a result string value.
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConvertingOccurs when the current protection state has changed.
public event EventHandler ProtectionStateChangedOccurs 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 ScaleFactorChangedOccurs when currently selected layout box has changed.
public event EventHandler<SelectedLayoutBoxChangedEventArgs> SelectedLayoutBoxChangedOccurs when selection is changed.
public event EventHandler SelectionChangedOccurs when resolving a stream from a URI reference.
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