Class

RadRichTextEditor

Declaration

public RadRichTextEditor()

The default namespace for the RadRichTextEditor control.

Declaration

public static readonly string DEFAULT_NAMESPACE

Field Value

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

Declaration

[Browsable(true)]
public bool AcceptsReturn { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool AcceptsTab { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool AllowScaling { get; set; }

Property Value

Gets or sets a value indicating whether hyperlinks should be automatically detected.

Declaration

[Browsable(true)]
public bool AutoInsertHyperlinks { get; set; }

Property Value

Gets or sets the color of the border.

Declaration

[Browsable(true)]
public Color BorderColor { get; set; }

Property Value

Gets a value indicating whether Input Method Editor (IME) can be enabled for this control.

Declaration

protected override bool CanEnableIme { get; }

Property Value

Overrides Control.CanEnableIme

Gets or sets the color of the caret.

Declaration

[Browsable(true)]
public Color CaretColor { get; set; }

Property Value

Gets or sets the width of the caret.

Declaration

[Browsable(false)]
public float CaretWidth { get; set; }

Property Value

Provides access to the commands that can be executed by this RadRichTextEditor.

Declaration

[Browsable(false)]
public RichTextBoxCommands Commands { get; set; }

Property Value

Gets or sets the minimum width of the comments pane.

Declaration

[Browsable(true)]
public double CommentPaneMinWidth { get; set; }

Property Value

Gets or sets the comment template content margin.

Declaration

[Browsable(true)]
public Padding CommentTemplateContentMargin { get; set; }

Property Value

Gets a value indicating the current editing style.

Declaration

[Browsable(false)]
public StyleDefinition CurrentEditingStyle { get; }

Property Value

Gets or sets information about the current user.

Declaration

[Browsable(false)]
public UserInfo CurrentUser { get; set; }

Property Value

Gets the currently visible page number.

Declaration

[Browsable(false)]
public int CurrentVisiblePage { get; }

Property Value

Gets the default size when the control is dragged onto the designer surface.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Declaration

public Dispatcher Dispatcher { get; }

Property Value

Gets or sets the currently active document in the editor.

Declaration

public RadDocument Document { get; set; }

Property Value

Gets the active document editor which provides methods for editing the document in an undo scope.

Declaration

public IDocumentEditor DocumentEditor { get; }

Property Value

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

Declaration

[Browsable(true)]
public bool DocumentInheritsDefaultStyleSettings { get; set; }

Property Value

Gets or sets the field shading type/

Declaration

[Browsable(true)]
public FieldShadingType FieldShadingMode { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Property Value

Gets or sets the hyperlink navigation mode.

Declaration

[Browsable(true)]
public HyperlinkNavigationMode HyperlinkNavigationMode { get; set; }

Property Value

Gets or sets the hyperlink tool text.

Declaration

[Browsable(false)]
public string HyperlinkToolTipFormatString { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public IIgnoredWordDictionary IgnoredWords { get; set; }

Property Value

Provides settings for the adorners of the selected images.

Declaration

[Browsable(true)]
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }

Property Value

Gets or sets the component which is responsible for handling the input of RadRichTextEditor.

Declaration

[Browsable(false)]
public RichTextEditorInputBehavior InputHandler { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool IsAdvancedSelectionEnabled { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool IsContextMenuEnabled { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public bool IsInHeaderFooterEditMode { get; set; }

Property Value

Gets or sets a value indicating whether the paste options pop-up is displayed on paste.

Declaration

[Browsable(true)]
public bool IsPasteOptionsPopupEnabled { get; set; }

Property Value

Gets or sets a value indicating whether the control is read-only.

Declaration

[Browsable(true)]
public bool IsReadOnly { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool IsSelectionEnabled { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool IsSelectionMiniToolBarEnabled { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool IsSpellCheckingEnabled { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool IsTrackChangesEnabled { get; set; }

Property Value

Gets or sets the document layout mode.

Declaration

[Browsable(true)]
public DocumentLayoutMode? LayoutMode { get; set; }

Property Value

Gets or sets the language which rules should be used for line breaking in the paragraphs.

Declaration

[Browsable(true)]
public LineBreakingRuleLanguage LineBreakingRuleLanguage { get; set; }

Property Value

Declaration

[Browsable(false)]
public IMentionBox MentionBox { get; set; }

Property Value

Declaration

[Browsable(false)]
public MentionContext MentionContext { get; set; }

Property Value

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

Declaration

public Color PageBackColor { get; set; }

Property Value

Gets the RadRichTextBox that is the main element in the control.

Declaration

public RadRichTextBox RichTextBoxElement { get; }

Property Value

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

Declaration

[Browsable(true)]
public SizeF ScaleFactor { get; set; }

Property Value

Gets or sets the currently selected comment.

Declaration

[Browsable(false)]
public Comment SelectedComment { get; set; }

Property Value

Gets or sets the currently selected note.

Declaration

[Browsable(false)]
public Note SelectedNote { get; set; }

Property Value

Gets or sets the fill of the selection rectangle.

Declaration

[Browsable(true)]
[TypeConverter(typeof(RadColorEditorConverter))]
public Color SelectionFill { get; set; }

Property Value

Gets or sets the border of the selection rectangle.

Declaration

[Browsable(true)]
[TypeConverter(typeof(RadColorEditorConverter))]
public Color SelectionStroke { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool ShowComments { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool ShowFormattingSymbols { get; set; }

Property Value

Gets or sets a value indicating whether merged fields should be highlighted.

Declaration

[Browsable(true)]
public bool ShowMergeFieldsHighlight { get; set; }

Property Value

Gets or sets the ISpellChecker implementation used when proofing.

Declaration

[Browsable(false)]
public ISpellChecker SpellChecker { get; set; }

Property Value

Declaration

public override string Text { get; set; }

Property Value

Overrides RadControl.Text

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

Declaration

[Browsable(false)]
public PermissionInfoCollection Users { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

Accepts all revisions in the current document.

Declaration

public void AcceptAllRevisions()

Accepts revision.

Declaration

public void AcceptRevision(Revision revision)

Parameters

Adds the provided TabStop at the current position of the document.

Declaration

public void AddTabStop(TabStop tabStop)

Parameters

Adds the provided TabStops at the current position of the document.

Declaration

public void AddTabStopRange(IEnumerable<TabStop> tabStops)

Parameters

Changes the display mode of all fields in the document.

Declaration

public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)

Parameters

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

Declaration

public void ChangeBaselineAlignment(BaselineAlignment newBaselineAlignment)

Parameters

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

Declaration

public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)

Parameters

Turns on or off the option to have a different header on the first page.

Declaration

public void ChangeDifferentFirstPageHeaderFooter(bool value)

Parameters

Turns on or off the option to have different headers and footers on odd and even pages.

Declaration

public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)

Parameters

Changes the width that a single Tab character takes.

Declaration

public void ChangeDocumentDefaultTabWidth(double tabWidth)

Parameters

Changes the Tag property of a specified DocumentElement.

Declaration

public void ChangeDocumentElementTag(DocumentElement element, string tag)

Parameters

Changes the starting number of the endnotes of the document.

Declaration

public void ChangeDocumentEndnotesFirstNumber(int firstNumber)

Parameters

Changes the list numbering format for the endnotes in the document.

Declaration

public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)

Parameters

Changes the mode in which endnotes numbers are reset to start from the first number.

Declaration

public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)

Parameters

Changes the location of the endnotes of the document.

Declaration

public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)

Parameters

Changes the starting number of the footnotes of the document.

Declaration

public void ChangeDocumentFootnotesFirstNumber(int firstNumber)

Parameters

Changes the list numbering format for the footnotes in the document.

Declaration

public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)

Parameters

Changes the mode in which footnotes numbers are reset to start from the first number.

Declaration

public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)

Parameters

Changes the location of the footnotes in the document.

Declaration

public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)

Parameters

Enables or disabled the Strict line breaking rule.

Declaration

public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)

Parameters

Applies the provided language to be used when calculating line breakings.

Declaration

public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)

Parameters

Applies the provided line breaking as no line breaking after rule.

Declaration

public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)

Parameters

Applies the provided line breaking rule as no line breaking before rule.

Declaration

public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)

Parameters

Changes the field display mode.

Declaration

public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)

Parameters

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

Declaration

public void ChangeFontFamily(FontFamily fontFamily)

Parameters

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

Declaration

public void ChangeFontSize(double newFontSize)

Parameters

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

Declaration

public void ChangeFontStyle(FontStyle fontStyle)

Parameters

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

Declaration

public void ChangeFontStyle(FontStyle fontStyle)

Parameters

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

Declaration

public void ChangeFontWeight(FontWeight fontWeight)

Parameters

Changes the image rotate angle.

Declaration

public void ChangeImageRotateAngle(ImageInline image, double angle)

Parameters

Changes the size of the image.

Declaration

public void ChangeImageSize(ImageInline image, Size size)

Parameters

Changes the layout mode.

Declaration

public void ChangeLayoutMode(DocumentLayoutMode layoutMode)

Parameters

Changes the ListStyle of the selected paragraphs in the document.

Declaration

public void ChangeListStyle(ListStyle style)

Parameters

Controls whether automatic spacing is applied after the current paragraph.

Declaration

public void ChangeParagraphAutomaticSpacingAfter(bool value)

Parameters

Controls whether automatic spacing is applied before the current paragraph.

Declaration

public void ChangeParagraphAutomaticSpacingBefore(bool value)

Parameters

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

Declaration

public void ChangeParagraphBackground(Color color)

Parameters

Changes the left indent of the current paragraph.

Declaration

public void ChangeParagraphFirstLineIndent(double firstLineIndent)

Parameters

Changes the FlowDirection of the selected paragraphs in the document.

Declaration

public void ChangeParagraphFlowDirection(FlowDirection flowDirection)

Parameters

Changes a value indicating whether the line breaking rule is enabled.

Declaration

public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)

Parameters

Changes the left indent of the current paragraph.

Declaration

public void ChangeParagraphLeftIndent(double leftIndent)

Parameters

Changes the lines spacing inside the current paragraph.

Declaration

public void ChangeParagraphLineSpacing(double lineSpacing)

Parameters

Changes the line spacing inside the current paragraph.

Declaration

public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)

Parameters

Changes the line spacing type inside the current paragraph.

Declaration

public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)

Parameters

Changes the list level the paragraph is currently in.

Declaration

public void ChangeParagraphListLevel(int listLevel)

Parameters

Changes the right indent of the current paragraph.

Declaration

public void ChangeParagraphRightIndent(double rightIndent)

Parameters

Changes the spacing after the current paragraph.

Declaration

public void ChangeParagraphSpacingAfter(double spacingAfter)

Parameters

Changes the spacing before the current paragraph.

Declaration

public void ChangeParagraphSpacingBefore(double spacingBefore)

Parameters

Changes the paragraph style of the current paragraph.

Declaration

public void ChangeParagraphStyle(StyleDefinition styleInfo)

Parameters

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

Declaration

public void ChangeSectionActualPageMargin(Padding sectionMargin)

Parameters

Changes the starting number of the endnotes of the current section.

Declaration

public void ChangeSectionEndnotesFirstNumber(int firstNumber)

Parameters

Changes the list numbering format for the endnotes in the current section.

Declaration

public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)

Parameters

Changes the mode in which endnotes numbers are reset to start from the first number in the current section.

Declaration

public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)

Parameters

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

Declaration

public void ChangeSectionFirstPageNumber(int? firstPageNumber)

Parameters

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

Declaration

public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)

Parameters

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

Declaration

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

Parameters

Changes the starting number of the footnotes of the current section.

Declaration

public void ChangeSectionFootnotesFirstNumber(int firstNumber)

Parameters

Changes the list numbering format for the footnotes in the current section.

Declaration

public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)

Parameters

Changes the mode in which footnotes numbers are reset to start from the first number in the current section.

Declaration

public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)

Parameters

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

Declaration

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