Class RadRichTextEditor

Inheritance
System.Object
RadControl
RadRichTextEditor
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

[TelerikToolboxCategory("RichTextEditor")]
public class RadRichTextEditor : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, IPrintable

Constructors

RadRichTextEditor()

Declaration
public RadRichTextEditor()

Fields

DEFAULT_NAMESPACE

Declaration
public static readonly string DEFAULT_NAMESPACE
Field Value
System.String

Properties

AcceptsReturn

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

Declaration
public bool AcceptsReturn { get; set; }
Property Value
System.Boolean

AcceptsTab

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

Declaration
public bool AcceptsTab { get; set; }
Property Value
System.Boolean

AllowScaling

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

Declaration
public bool AllowScaling { get; set; }
Property Value
System.Boolean

AutoSize

RadRichTextEditor does not support AutoSize. This property always returns False.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BackColor

RadRichTextEditor consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

BorderColor

Gets or sets the color of the border.

Declaration
public Color BorderColor { get; set; }
Property Value
System.Drawing.Color

CanEnableIme

Declaration
protected override bool CanEnableIme { get; }
Property Value
System.Boolean

CaretColor

Gets or sets the color of the caret.

Declaration
public Color CaretColor { get; set; }
Property Value
System.Drawing.Color

CaretWidth

Gets or sets the width of the caret.

Declaration
public float CaretWidth { get; set; }
Property Value
System.Single

The width of the caret.

Commands

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

Declaration
public RichTextBoxCommands Commands { get; set; }
Property Value
RichTextBoxCommands

CommentPaneMinWidth

Gets or sets the minimum width of the comments pane.

Declaration
public double CommentPaneMinWidth { get; set; }
Property Value
System.Double

CommentTemplateContentMargin

Gets or sets the comment template content margin.

Declaration
public Padding CommentTemplateContentMargin { get; set; }
Property Value
System.Windows.Forms.Padding

CurrentEditingStyle

Gets a value indicating the current editing style.

Declaration
public StyleDefinition CurrentEditingStyle { get; }
Property Value
StyleDefinition

CurrentUser

Gets or sets information about the current user.

Declaration
public UserInfo CurrentUser { get; set; }
Property Value
UserInfo

CurrentVisiblePage

Gets the currently visible page number.

Declaration
public int CurrentVisiblePage { get; }
Property Value
System.Int32

DefaultSize

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

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Dispatcher

Declaration
public Dispatcher Dispatcher { get; }
Property Value
Dispatcher

Document

Gets or sets the currently active document in the editor.

Declaration
public RadDocument Document { get; set; }
Property Value
RadDocument

DocumentEditor

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

Declaration
public IDocumentEditor DocumentEditor { get; }
Property Value
IDocumentEditor

DocumentInheritsDefaultStyleSettings

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
public bool DocumentInheritsDefaultStyleSettings { get; set; }
Property Value
System.Boolean

FieldShadingMode

Gets or sets the field shading type/

Declaration
public FieldShadingType FieldShadingMode { get; set; }
Property Value
FieldShadingType

Font

RadRichTextEditor consists of multiple visual elements and separate settings are provided to customize their appearance. Current Font property might be ignored.

Declaration
public override Font Font { get; set; }
Property Value
System.Drawing.Font

Overrides

ForeColor

RadRichTextEditor consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

HorizontalScrollBarVisibility

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

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
ScrollBarVisibility

HyperlinkNavigationMode

Gets or sets the hyperlink navigation mode.

Declaration
public HyperlinkNavigationMode HyperlinkNavigationMode { get; set; }
Property Value
HyperlinkNavigationMode

The hyperlink navigation mode.

HyperlinkToolTipFormatString

Gets or sets the hyperlink tool text.

Declaration
public string HyperlinkToolTipFormatString { get; set; }
Property Value
System.String

The hyperlink tool tip.

IgnoredWords

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

Declaration
public IIgnoredWordDictionary IgnoredWords { get; set; }
Property Value
IIgnoredWordDictionary

See Also

ImageSelectionAdornerSettings

Provides settings for the adorners of the selected images.

Declaration
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }
Property Value
ImageSelectionAdornerSettings

InputHandler

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

Declaration
public RichTextEditorInputBehavior InputHandler { get; set; }
Property Value
RichTextEditorInputBehavior

IsContextMenuEnabled

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

Declaration
public bool IsContextMenuEnabled { get; set; }
Property Value
System.Boolean

IsInHeaderFooterEditMode

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

Declaration
public bool IsInHeaderFooterEditMode { get; set; }
Property Value
System.Boolean

IsPasteOptionsPopupEnabled

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

Declaration
public bool IsPasteOptionsPopupEnabled { get; set; }
Property Value
System.Boolean

IsReadOnly

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

Declaration
public bool IsReadOnly { get; set; }
Property Value
System.Boolean

IsSelectionEnabled

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

Declaration
public bool IsSelectionEnabled { get; set; }
Property Value
System.Boolean

IsSelectionMiniToolBarEnabled

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

Declaration
public bool IsSelectionMiniToolBarEnabled { get; set; }
Property Value
System.Boolean

IsSpellCheckingEnabled

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

Declaration
public bool IsSpellCheckingEnabled { get; set; }
Property Value
System.Boolean

IsTrackChangesEnabled

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

Declaration
public bool IsTrackChangesEnabled { get; set; }
Property Value
System.Boolean

true if formatting symbols are shown; otherwise, false.

LayoutMode

Gets or sets the document layout mode.

Declaration
public DocumentLayoutMode? LayoutMode { get; set; }
Property Value
System.Nullable<DocumentLayoutMode>

The document layout mode.

LineBreakingRuleLanguage

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

Declaration
public LineBreakingRuleLanguage LineBreakingRuleLanguage { get; set; }
Property Value
LineBreakingRuleLanguage

The line breaking characters rule language.

PageBackColor

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

Declaration
public Color PageBackColor { get; set; }
Property Value
System.Drawing.Color

RichTextBoxElement

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

Declaration
public RadRichTextBox RichTextBoxElement { get; }
Property Value
RadRichTextBox

ScaleFactor

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

Declaration
public SizeF ScaleFactor { get; set; }
Property Value
System.Drawing.SizeF

SelectedComment

Gets or sets the currently selected comment.

Declaration
public Comment SelectedComment { get; set; }
Property Value
Comment

SelectedNote

Gets or sets the currently selected note.

Declaration
public Note SelectedNote { get; set; }
Property Value
Note

SelectionFill

Gets or sets the fill of the selection rectangle.

Declaration
public Color SelectionFill { get; set; }
Property Value
System.Drawing.Color

SelectionStroke

Gets or sets the border of the selection rectangle.

Declaration
public Color SelectionStroke { get; set; }
Property Value
System.Drawing.Color

ShowComments

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

Declaration
public bool ShowComments { get; set; }
Property Value
System.Boolean

ShowFormattingSymbols

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

Declaration
public bool ShowFormattingSymbols { get; set; }
Property Value
System.Boolean

true if formatting symbols are shown; otherwise, false.

ShowMergeFieldsHighlight

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

Declaration
public bool ShowMergeFieldsHighlight { get; set; }
Property Value
System.Boolean

SpellChecker

Gets or sets the ISpellChecker implementation used when proofing.

Declaration
public ISpellChecker SpellChecker { get; set; }
Property Value
ISpellChecker

Text

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Users

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

Declaration
public PermissionInfoCollection Users { get; set; }
Property Value
PermissionInfoCollection

VerticalScrollBarVisibility

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

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
ScrollBarVisibility

Methods

AcceptAllRevisions()

Accepts all revisions in the current document.

Declaration
public void AcceptAllRevisions()

AcceptRevision(Revision)

Accepts revision.

Declaration
public void AcceptRevision(Revision revision)
Parameters
Revision revision

The revision.

AddTabStop(TabStop)

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

Declaration
public void AddTabStop(TabStop tabStop)
Parameters
TabStop tabStop

AddTabStopRange(IEnumerable<TabStop>)

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

Declaration
public void AddTabStopRange(IEnumerable<TabStop> tabStops)
Parameters
System.Collections.Generic.IEnumerable<TabStop> tabStops

ChangeAllFieldsDisplayMode(FieldDisplayMode)

Changes the display mode of all fields in the document.

Declaration
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

The display mode.

ChangeBaselineAlignment(BaselineAlignment)

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

Declaration
public void ChangeBaselineAlignment(BaselineAlignment newBaselineAlignment)
Parameters
BaselineAlignment newBaselineAlignment

The new baseline alignment to be applied.

ChangeBibliographicStyle(BibliographicReferenceStyleBase)

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

Declaration
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)
Parameters
BibliographicReferenceStyleBase newBibliographicStyle

The new bibliographic style.

ChangeDifferentFirstPageHeaderFooter(Boolean)

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

Declaration
public void ChangeDifferentFirstPageHeaderFooter(bool value)
Parameters
System.Boolean value

ChangeDifferentOddAndEvenPagesHeaderFooter(Boolean)

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

Declaration
public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)
Parameters
System.Boolean value

ChangeDocumentDefaultTabWidth(Double)

Changes the width that a single Tab character takes.

Declaration
public void ChangeDocumentDefaultTabWidth(double tabWidth)
Parameters
System.Double tabWidth

ChangeDocumentElementTag(DocumentElement, String)

Changes the Tag property of a specified DocumentElement.

Declaration
public void ChangeDocumentElementTag(DocumentElement element, string tag)
Parameters
DocumentElement element

The DocumentElement.
System.String tag

The new tag value.

ChangeDocumentEndnotesFirstNumber(Int32)

Changes the starting number of the endnotes of the document.

Declaration
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)

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

Declaration
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)

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

Declaration
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

ChangeDocumentEndnotesPosition(EndnotesPosition)

Changes the location of the endnotes of the document.

Declaration
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)
Parameters
EndnotesPosition endnotesPosition

ChangeDocumentFootnotesFirstNumber(Int32)

Changes the starting number of the footnotes of the document.

Declaration
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)

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

Declaration
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)

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

Declaration
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

ChangeDocumentFootnotesPosition(FootnotesPosition)

Changes the location of the footnotes in the document.

Declaration
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)
Parameters
FootnotesPosition footnotesPosition

ChangeDocumentIsStrictLineBreakingRuleEnabled(Boolean)

Enables or disabled the Strict line breaking rule.

Declaration
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)
Parameters
System.Boolean value

ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)

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

Declaration
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)
Parameters
LineBreakingRuleLanguage lineBreakingRuleLanguage

ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)

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

Declaration
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)

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

Declaration
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)

Changes the field display mode.

Declaration
public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)
Parameters
FieldRangeStart fieldStart

The field start.
FieldDisplayMode displayMode

The new display mode.

ChangeFontFamily(FontFamily)

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

Declaration
public void ChangeFontFamily(FontFamily fontFamily)
Parameters
FontFamily fontFamily

The new font family to be applied.

ChangeFontSize(Double)

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

Declaration
public void ChangeFontSize(double newFontSize)
Parameters
System.Double newFontSize

The new font size to be applied.

ChangeFontStyle(FontStyle)

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

Declaration
public void ChangeFontStyle(FontStyle fontStyle)
Parameters
FontStyle fontStyle

The new font style.

ChangeFontWeight(FontWeight)

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

Declaration
public void ChangeFontWeight(FontWeight fontWeight)
Parameters
FontWeight fontWeight

The new font weight.

ChangeImageRotateAngle(ImageInline, Double)

Changes the image rotate angle.

Declaration
public void ChangeImageRotateAngle(ImageInline image, double angle)
Parameters
ImageInline image

The ImageInline.
System.Double angle

The new angle.

ChangeImageSize(ImageInline, Size)

Changes the size of the image.

Declaration
public void ChangeImageSize(ImageInline image, Size size)
Parameters
ImageInline image

The ImageInline.
Size size

The new size.

ChangeLayoutMode(DocumentLayoutMode)

Changes the layout mode.

Declaration
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)
Parameters
DocumentLayoutMode layoutMode

The new layout mode to be applied.

ChangeListStyle(ListStyle)

Changes the ListStyle of the selected paragraphs in the document.

Declaration
public void ChangeListStyle(ListStyle style)
Parameters
ListStyle style

The style to apply

ChangeParagraphAutomaticSpacingAfter(Boolean)

Controls whether automatic spacing is applied after the current paragraph.

Declaration
public void ChangeParagraphAutomaticSpacingAfter(bool value)
Parameters
System.Boolean value

True if automatic spacing should be applied, otherwise false.

ChangeParagraphAutomaticSpacingBefore(Boolean)

Controls whether automatic spacing is applied before the current paragraph.

Declaration
public void ChangeParagraphAutomaticSpacingBefore(bool value)
Parameters
System.Boolean value

True if automatic spacing should be applied, otherwise false.

ChangeParagraphBackground(Color)

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

Declaration
public void ChangeParagraphBackground(Color color)
Parameters
Color color

The new background color to be applied.

ChangeParagraphFirstLineIndent(Double)

Changes the left indent of the current paragraph.

Declaration
public void ChangeParagraphFirstLineIndent(double firstLineIndent)
Parameters
System.Double firstLineIndent

The new left indent to be applied.

ChangeParagraphFlowDirection(FlowDirection)

Changes the FlowDirection of the selected paragraphs in the document.

Declaration
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)
Parameters
FlowDirection flowDirection

ChangeParagraphIsLineBreakingRuleEnabled(Boolean)

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

Declaration
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)
Parameters
System.Boolean value

True if the rule will be enabled otherwise false.

ChangeParagraphLeftIndent(Double)

Changes the left indent of the current paragraph.

Declaration
public void ChangeParagraphLeftIndent(double leftIndent)
Parameters
System.Double leftIndent

The new left indent to be applied.

ChangeParagraphLineSpacing(Double)

Changes the lines spacing inside the current paragraph.

Declaration
public void ChangeParagraphLineSpacing(double lineSpacing)
Parameters
System.Double lineSpacing

The new line spacing to be applied.

ChangeParagraphLineSpacing(Double, LineSpacingType)

Changes the line spacing inside the current paragraph.

Declaration
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)
Parameters
System.Double lineSpacing

The new line spacing to be applied.
LineSpacingType lineSpacingType

The type of the line spacing to be applied.

ChangeParagraphLineSpacingType(LineSpacingType)

Changes the line spacing type inside the current paragraph.

Declaration
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)
Parameters
LineSpacingType lineSpacingType

The new line spacing type to be applied.

ChangeParagraphListLevel(Int32)

Changes the list level the paragraph is currently in.

Declaration
public void ChangeParagraphListLevel(int listLevel)
Parameters
System.Int32 listLevel

The list level to be applied.

ChangeParagraphRightIndent(Double)

Changes the right indent of the current paragraph.

Declaration
public void ChangeParagraphRightIndent(double rightIndent)
Parameters
System.Double rightIndent

The new right indent to be applied.

ChangeParagraphSpacingAfter(Double)

Changes the spacing after the current paragraph.

Declaration
public void ChangeParagraphSpacingAfter(double spacingAfter)
Parameters
System.Double spacingAfter

The new spacing to be applied.

ChangeParagraphSpacingBefore(Double)

Changes the spacing before the current paragraph.

Declaration
public void ChangeParagraphSpacingBefore(double spacingBefore)
Parameters
System.Double spacingBefore

The new spacing to be applied.

ChangeParagraphStyle(StyleDefinition)

Changes the paragraph style of the current paragraph.

Declaration
public void ChangeParagraphStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The new style to be applied.

ChangeSectionActualPageMargin(Padding)

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

Declaration
public void ChangeSectionActualPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The section margin.

ChangeSectionEndnotesFirstNumber(Int32)

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

Declaration
public void ChangeSectionEndnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)

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

Declaration
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)

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
NumberingRestartType numberingRestartType

ChangeSectionFirstPageNumber(Nullable<Int32>)

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

Declaration
public void ChangeSectionFirstPageNumber(int? firstPageNumber)
Parameters
System.Nullable<System.Int32> firstPageNumber

The new first page number value.

ChangeSectionFooterBottomMargin(Int32)

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

Declaration
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)
Parameters
System.Int32 sectionFooterBottomMargin

Footer bottom margin to be applied.

ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, Boolean)

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
Section section

The section.
HeaderFooterType footerType

Type of the footer.
System.Boolean value

true if the footer should be linked.

ChangeSectionFootnotesFirstNumber(Int32)

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

Declaration
public void ChangeSectionFootnotesFirstNumber(int firstNumber)
Parameters
System.Int32 firstNumber

ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)

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

Declaration
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)
Parameters
ListNumberingFormat listNumberingFormat

ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)

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
NumberingRestartType numberingRestartType

ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, Boolean)

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)
Parameters
Section section

The section.
HeaderFooterType headerType

Type of the header.
System.Boolean value

true if the header should be linked.

ChangeSectionHeaderTopMargin(Int32)

Changes the top margin of the header of the current section.

Declaration
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)
Parameters
System.Int32 sectionHeaderTopMargin

Header top margin to be applied.

ChangeSectionPageMargin(Padding)

Changes the page margin of the current section.

Declaration
public void ChangeSectionPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The new margin to be applied.

ChangeSectionPageOrientation(PageOrientation)

Changes the page orientation of the current section.

Declaration
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)
Parameters
PageOrientation sectionPageOrientation

The new page orientation to be applied.

ChangeSectionPageSize(Size)

Changes the page size of the current section.

Declaration
public void ChangeSectionPageSize(Size size)
Parameters
Size size

The new page size to be applied.

ChangeSpanStyle(StyleDefinition)

Changes the style of current run in the document.

Declaration
public void ChangeSpanStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The new style to be applied.

ChangeStrikethrough(Boolean)

Changes the strikethrough of the current run in the document.

Declaration
public void ChangeStrikethrough(bool isStrikethrough)
Parameters
System.Boolean isStrikethrough

The new strikethrough value.

ChangeTableBorders(TableBorders)

Applies the border to the selected tables.

Declaration
public void ChangeTableBorders(TableBorders borders)
Parameters
TableBorders borders

ChangeTableCellBackground(Color)

Changes the back color of the currently selected cells.

Declaration
public void ChangeTableCellBackground(Color color)
Parameters
Color color

ChangeTableCellBorders(Border)

Applies the border to the currently selected cells.

Declaration
public void ChangeTableCellBorders(Border border)
Parameters
Border border

ChangeTableCellBorders(TableCellBorders)

Applies the borders to the currently selected cells.

Declaration
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)
Parameters
TableCellBorders tableCellBorders

ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)

Applies the content alignment settings to the selected cells.

Declaration
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)
Parameters
RadTextAlignment textAlignment

RadVerticalAlignment verticalAlignment

ChangeTableCellHorizontalContentAlignment(RadTextAlignment)

Applies the horizontal alignment to the selected cells.

Declaration
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)
Parameters
RadTextAlignment textAlignment

ChangeTableCellPadding(Padding)

Applies the padding to the currently selected cells.

Declaration
public void ChangeTableCellPadding(Padding padding)
Parameters
Padding padding

ChangeTableCellSpacing(Double)

Applies the cell spacing to the currently selected tables.

Declaration
public void ChangeTableCellSpacing(double cellSpacing)
Parameters
System.Double cellSpacing

ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)

Applies the vertical alignment to the selected cells.

Declaration
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)
Parameters
RadVerticalAlignment verticalAlignment

ChangeTableDefaultCellPadding(Padding)

Changes the default cell padding of the currently selected tables.

Declaration
public void ChangeTableDefaultCellPadding(Padding padding)
Parameters
Padding padding

ChangeTableFlowDirection(FlowDirection)

Changes the flow direction of the current table to the flow direction.

Declaration
public void ChangeTableFlowDirection(FlowDirection flowDirection)
Parameters
FlowDirection flowDirection

ChangeTableGridColumnWidth(Table, Int32, TableWidthUnit)

Changes the width of the column at the given index.

Declaration
public void ChangeTableGridColumnWidth(Table table, int gridColumnIndex, TableWidthUnit width)
Parameters
Table table

System.Int32 gridColumnIndex

TableWidthUnit width

ChangeTableHorizontalAlignment(RadHorizontalAlignment)

Changes the horizontal alignment of the current table.

Declaration
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)
Parameters
RadHorizontalAlignment alignment

ChangeTableIndent(Double)

Changes the table indentation.

Declaration
public void ChangeTableIndent(double indent)
Parameters
System.Double indent

ChangeTableLayoutMode(Table, TableLayoutMode)

Changes the layout mode of the table.

Declaration
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)
Parameters
Table table

TableLayoutMode tableLayoutMode

ChangeTableLook(TableLook)

Applies the table look to the selected tables.

Declaration
public void ChangeTableLook(TableLook tableLook)
Parameters
TableLook tableLook

ChangeTablePreferredWidth(TableWidthUnit)

Changes the preferred table width to the provided one.

Declaration
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)
Parameters
TableWidthUnit tableWidth

ChangeTableRowHeight(TableRow, Double)

Changes the height of the table row.

Declaration
public void ChangeTableRowHeight(TableRow tableRow, double height)
Parameters
TableRow tableRow

System.Double height

ChangeTextAlignment(RadTextAlignment)

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

Declaration
public void ChangeTextAlignment(RadTextAlignment alignment)
Parameters
RadTextAlignment alignment

The new text alignment to be applied.

ChangeTextForeColor(Color)

Changes the text foreground color of the current run in the document.

Declaration
public void ChangeTextForeColor(Color newColor)
Parameters
Color newColor

The new foreground color to be applied.

ChangeTextHighlightColor(Color)

Changes the text highlight color of the current run in the document.

Declaration
public void ChangeTextHighlightColor(Color newColor)
Parameters
Color newColor

The new highlight color to be applied.

ChangeUnderlineColor(Color)

Changes the underline color of the current run in the document.

Declaration
public void ChangeUnderlineColor(Color newColor)
Parameters
Color newColor

The new underline color to be applied.

ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)

Changes the underline decoration of the current run in the document.

Declaration
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)
Parameters
IUnderlineUIDecorationProvider decoration

The new underline decoration provider to be applied.

ClearAllFormatting()

Clears all of the formatting of the current paragraph and run in the document.

Declaration
public void ClearAllFormatting()

ClearFormatting()

Clears the formatting of the current run in the document.

Declaration
public void ClearFormatting()

ClearTabStops()

Removes all TabStops from the document.

Declaration
public void ClearTabStops()

ContinueListNumbering()

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.

Declaration
public bool ContinueListNumbering()
Returns
System.Boolean

Copy()

Copies currently selected document elements into the clipboard

Declaration
public void Copy()

CreateBehavior()

Declaration
protected override ComponentInputBehavior CreateBehavior()
Returns
ComponentInputBehavior

Overrides

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

Cut()

Executes the Cut command.

Declaration
public void Cut()

DecrementFontSize()

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

Declaration
public void DecrementFontSize()

DecrementParagraphLeftIndent()

Decrements the left indent of the current paragraph.

Declaration
public void DecrementParagraphLeftIndent()

DecrementParagraphListLevel()

Decrements the list level the paragraph is currently in by 1.

Declaration
public void DecrementParagraphListLevel()

Delete(Boolean)

Deletes from the document respecting CaretPosition and Selection.

Declaration
public void Delete(bool deletePrevious)
Parameters
System.Boolean deletePrevious

If the selection is empty, indicates whether to delete the character before or after the caret.

DeleteAllComments()

Deletes all comments in the current document.

Declaration
public void DeleteAllComments()

DeleteAnnotationRange(AnnotationRangeStart)

Deletes an annotation range.

Declaration
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The start of the range that is to be deleted.

DeleteBookmark(String)

Deletes a bookmark.

Declaration
public void DeleteBookmark(string bookmarkName)
Parameters
System.String bookmarkName

Name of the bookmark.

DeleteBookmark(BookmarkRangeStart)

Deletes a bookmark.

Declaration
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)
Parameters
BookmarkRangeStart bookmarkRangeStart

The bookmark range start.

DeleteCodeBlock(CodeAnnotationRangeStart)

Deletes a code block.

Declaration
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)
Parameters
CodeAnnotationRangeStart rangeStart

The code range start of the block to delete.

DeleteComment()

Deletes the current comment.

Declaration
public void DeleteComment()

DeleteComment(CommentRangeStart)

Deletes a comment.

Declaration
public void DeleteComment(CommentRangeStart commentRangeStart)
Parameters
CommentRangeStart commentRangeStart

The comment range start.

DeletePermissionRange(PermissionRangeStart)

Deletes a permission range.

Declaration
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)
Parameters
PermissionRangeStart permissionRangeStart

The permission range start.

DeleteReadOnlyRange()

Deletes the current read only range.

Declaration
public void DeleteReadOnlyRange()

DeleteReadOnlyRange(ReadOnlyRangeStart)

Deletes the read only range.

Declaration
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)
Parameters
ReadOnlyRangeStart readOnlyRangeStart

The read only range that is to be deleted.

DeleteTable()

Deletes the table currently containing the caret.

Declaration
public void DeleteTable()

DeleteTable(Table)

Deletes the table from the document.

Declaration
public void DeleteTable(Table table)
Parameters
Table table

DeleteTableColumn()

Deletes the current column.

Declaration
public void DeleteTableColumn()

DeleteTableRow()

Deletes the current row from the table.

Declaration
public void DeleteTableRow()

DeleteTableRow(TableRow)

Deletes the row from the table.

Declaration
public void DeleteTableRow(TableRow row)
Parameters
TableRow row

DisableWatermark()

Removes the currently applied watermark.

Declaration
public void DisableWatermark()

EditListStyleInDialog(ListStyle)

Shows the dialog for editing styles.

Declaration
public void EditListStyleInDialog(ListStyle listStyle)
Parameters
ListStyle listStyle

EndInit()

Declaration
public override void EndInit()
Overrides

FocusFooter()

Focuses the footer of the current page.

Declaration
public void FocusFooter()

FocusHeader()

Focuses the header of the current page.

Declaration
public void FocusHeader()

GetApperanceSettingsForComment(Comment)

Gets the visual settings for the given comment.

Declaration
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)
Parameters
Comment comment

The comment to get visual settings for.
Returns
CommentAppearanceSettings

GetContent(String)

Gets the content in various formats.

Declaration
public string GetContent(string format)
Parameters
System.String format

The format to export into.
Returns
System.String

String representation of the content.

GoToNextComment()

Moves current position to the next comment.

Declaration
public void GoToNextComment()

GoToNextEndnote()

Moves current position to the next endnote.

Declaration
public void GoToNextEndnote()

GoToNextFootnote()

Moves current position to the next footnote.

Declaration
public void GoToNextFootnote()

GoToNextRevision()

Moves current position to the next revision.

Declaration
public void GoToNextRevision()

GoToPreviousComment()

Moves current position to the previous comment.

Declaration
public void GoToPreviousComment()

GoToPreviousEndnote()

Moves current position to the previous endnote.

Declaration
public void GoToPreviousEndnote()

GoToPreviousFootnote()

Moves current position to the previous footnote.

Declaration
public void GoToPreviousFootnote()

GoToPreviousRevision()

Moves current position to the previous revision.

Declaration
public void GoToPreviousRevision()

IncrementFontSize()

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

Declaration
public void IncrementFontSize()

IncrementParagraphLeftIndent()

Increments the left indent of the current paragraph.

Declaration
public void IncrementParagraphLeftIndent()

IncrementParagraphListLevel()

Increments the list level the paragraph is currently in by 1.

Declaration
public void IncrementParagraphListLevel()

Insert(String)

Inserts text into the document at current caret position.

Declaration
public void Insert(string text)
Parameters
System.String text

The text to insert.

Insert(String, DocumentPosition)

Inserts text into the document at the specified position.

Declaration
public void Insert(string text, DocumentPosition insertionPosition)
Parameters
System.String text

The text to insert.
DocumentPosition insertionPosition

The position where the text will be inserted.

InsertAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)

Inserts an annotation range.

Declaration
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)
Parameters
AnnotationRangeStart rangeStart

The annotation range start.
AnnotationRangeEnd rangeEnd

The annotation range end.

InsertBookmark(String)

Inserts a bookmark.

Declaration
public void InsertBookmark(string bookmarkName)
Parameters
System.String bookmarkName

Name of the bookmark.

InsertCaption(CaptionDefinition, String, Boolean, Boolean)

Inserts a caption.

Declaration
public void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)
Parameters
CaptionDefinition definition

The definition.
System.String caption

The caption text to be used.
System.Boolean includeLabel

if set to true the label is included in the caption.
System.Boolean insertBelow

if set to true the caption is inserted after the current selection.

InsertCodeBlock(String, CodeFormattingSettings)

Inserts code block into the document at caret position. If caret position is in code block, replaces the current code block.

Declaration
public void InsertCodeBlock(string code, CodeFormattingSettings settings)
Parameters
System.String code

CodeFormattingSettings settings

InsertComment(Comment)

Inserts a comment.

Declaration
public void InsertComment(Comment comment)
Parameters
Comment comment

The comment.

InsertCrossReferenceToBookmark(String, ReferenceContentType, Boolean)

Inserts a Cross-Reference to a bookmark into the document at current caret position.

Declaration
public void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
System.String bookmarkName

ReferenceContentType contentType

System.Boolean insertAsHyperlink

InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, Boolean)

Inserts a Cross-Reference to a caption into the document at current caret position.

Declaration
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
Paragraph captionParagraph

ReferenceContentType contentType

System.Boolean insertAsHyperlink

InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, Boolean)

Inserts a Cross-Reference to a heading paragraph into the document at current caret position.

Declaration
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)
Parameters
Paragraph headingParagraph

ReferenceContentType contentType

System.Boolean insertAsHyperlink

InsertEndnote()

Inserts endnote at the current position.

Declaration
public void InsertEndnote()

InsertEndnote(Note)

Inserts the endnote at the current position.

Declaration
public void InsertEndnote(Note endnote)
Parameters
Note endnote

The endnote.

InsertField(Field)

Inserts a field into the document at current caret position.

Declaration
public bool InsertField(Field field)
Parameters
Field field

The field.
Returns
System.Boolean

True if the operation completed successfully

InsertField(Field, FieldDisplayMode)

Inserts a field into the document at current caret position in a specified display mode.

Declaration
public bool InsertField(Field field, FieldDisplayMode displayMode)
Parameters
Field field

The field.
FieldDisplayMode displayMode

The display mode.
Returns
System.Boolean

True if the operation completed successfully

InsertFootnote()

Inserts footnote at the current position.

Declaration
public void InsertFootnote()

InsertFootnote(Note)

Inserts the footnote at the current position.

Declaration
public void InsertFootnote(Note footnote)
Parameters
Note footnote

The footnote.

InsertFragment(DocumentFragment)

Inserts a document fragment.

Declaration
public void InsertFragment(DocumentFragment documentFragment)
Parameters
DocumentFragment documentFragment

The document fragment to insert.

InsertFragment(DocumentFragment, DocumentPosition)

Inserts a fragment at specified position.

Declaration
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)
Parameters
DocumentFragment documentFragment

The fragment to insert.
DocumentPosition documentPosition

The document position to insert the fragment at.

InsertHyperlink(HyperlinkInfo)

Creates hyperlink form the current selection.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.

InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)

Inserts collection of inlines as hyperlink into the document.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.
System.Collections.Generic.IEnumerable<Inline> inlines

The inlines.

InsertHyperlink(HyperlinkInfo, String)

Inserts hyperlink into the document.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.
System.String hyperlinkText

The hyperlink text.

InsertHyperlink(HyperlinkInfo, String, StyleDefinition)

Inserts hyperlink into the document.

Declaration
[Obsolete("The parameter hyperlinkStyle is not used. The document hyperlink style will be used instead")]
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText, StyleDefinition hyperlinkStyle)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.
System.String hyperlinkText

The hyperlink text.
StyleDefinition hyperlinkStyle

The hyperlink style.

InsertHyperlink(HyperlinkInfo, StyleDefinition)

Creates hyperlink form the current selection.

Declaration
[Obsolete("The parameter hyperlinkStyle is not used. The document hyperlink style will be used instead")]
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, StyleDefinition hyperlinkStyle)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.
StyleDefinition hyperlinkStyle

The hyperlink style.

InsertImage(Stream, String)

Inserts image inline into the document.

Declaration
public void InsertImage(Stream imageStream, string extension)
Parameters
System.IO.Stream imageStream

The stream to the image's contents.
System.String extension

The extension specifying the image format.

InsertInline(Inline)

Inserts inline element into the document.

Declaration
public void InsertInline(Inline inline)
Parameters
Inline inline

The inline element to insert.

InsertInline(Inline, DocumentPosition)

Inserts inline element into the document.

Declaration
public void InsertInline(Inline inline, DocumentPosition documentPosition)
Parameters
Inline inline

The inline element to insert.
DocumentPosition documentPosition

The document position to insert the inline at.

InsertLine(String)

Inserts text and adds new paragraph after it.

Declaration
public void InsertLine(string text)
Parameters
System.String text

The text.

InsertLineBreak()

Inserts LineBreak into the document at current caret position.

Declaration
public void InsertLineBreak()

InsertPageBreak()

Inserts PageBreak into the document at current caret position.

Declaration
public void InsertPageBreak()

InsertParagraph()

Inserts a new paragraph.

Declaration
public void InsertParagraph()

InsertPermissionRange(IEnumerable<PermissionRangeInfo>)

Inserts new permission range.

Declaration
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)
Parameters
System.Collections.Generic.IEnumerable<PermissionRangeInfo> permissionInfos

The permissions for the new range.

InsertReadOnlyRange()

Inserts a read only range.

Declaration
public void InsertReadOnlyRange()

InsertSectionBreak()

Inserts SectionBreak into the document at current caret position.

Declaration
public void InsertSectionBreak()

InsertSectionBreak(SectionBreakType)

Inserts SectionBreak of the specified type into the document at current caret position.

Declaration
public void InsertSectionBreak(SectionBreakType sectionBreakType)
Parameters
SectionBreakType sectionBreakType

The type of the section break.

InsertTable(Int32, Int32)

Inserts a table with the given number or rows and columns.

Declaration
public void InsertTable(int rows, int columns)
Parameters
System.Int32 rows

System.Int32 columns

InsertTable(Table)

Inserts the table at the current caret position.

Declaration
public void InsertTable(Table table)
Parameters
Table table

InsertTableColumn()

Adds a column to the table.

Declaration
public void InsertTableColumn()

InsertTableColumnToTheLeft()

Adds a column to the left of the current one.

Declaration
public void InsertTableColumnToTheLeft()

InsertTableColumnToTheRight()

Adds a column to the right of the current one.

Declaration
public void InsertTableColumnToTheRight()

InsertTableRow()

Adds a new row at the bottom of the current table.

Declaration
public void InsertTableRow()

InsertTableRowAbove()

Inserts a row above the current row in the table.

Declaration
public void InsertTableRowAbove()

InsertTableRowBelow()

Inserts a row below the current row in the table.

Declaration
public void InsertTableRowBelow()

IsInputKey(Keys)

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

Overrides

MailMerge(Boolean)

Produces a mail merge document for all the mail merge data records.

Declaration
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)
Parameters
System.Boolean startEachRecordOnNewPage

true if each record should start on a new page.
Returns
RadDocument

The document

MailMergeCurrentRecord()

Produces a mail merge document for the current mail merge data record.

Declaration
public RadDocument MailMergeCurrentRecord()
Returns
RadDocument

The document

MergeTableCells()

Merges the currently selected cells.

Declaration
public void MergeTableCells()

MoveSelection(DocumentPosition, Boolean)

Moves current document selection to a specified position.

Declaration
public void MoveSelection(DocumentPosition position, bool deleteSelection)
Parameters
DocumentPosition position

The move position.
System.Boolean deleteSelection

Indicates whether the current selection should be deleted.

OnGotFocus(EventArgs)

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnHandleCreated(EventArgs)

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
System.EventArgs e

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnKeyPress(KeyPressEventArgs)

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

Overrides

OnKeyUp(KeyEventArgs)

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnLoad(Size)

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OpenContextMenuOnNextSpellingError()

Opens the context menu on the next word that has a spelling error.

Declaration
public void OpenContextMenuOnNextSpellingError()

Paste()

Pastes from clipboard into the document respecting CaretPosition and Selection

Declaration
public void Paste()

Paste(PasteOption)

Pastes the content of the clipboard into the document using the specified paste option.

Declaration
public void Paste(PasteOption pasteOption)
Parameters
PasteOption pasteOption

PreviewFirstMailMergeDataRecord()

Previews the first mail merge data record.

Declaration
public bool PreviewFirstMailMergeDataRecord()
Returns
System.Boolean

PreviewLastMailMergeDataRecord()

Previews the last mail merge data record.

Declaration
public bool PreviewLastMailMergeDataRecord()
Returns
System.Boolean

PreviewMailMergeDataRecordAtIndex(Int32)

Previews the mail merge data record at a specified index.

Declaration
public bool PreviewMailMergeDataRecordAtIndex(int index)
Parameters
System.Int32 index

The index of the record to be shown.
Returns
System.Boolean

PreviewNextMailMergeDataRecord()

Previews the next mail merge data record.

Declaration
public bool PreviewNextMailMergeDataRecord()
Returns
System.Boolean

PreviewPreviousMailMergeDataRecord()

Previews the previous mail merge data record.

Declaration
public bool PreviewPreviousMailMergeDataRecord()
Returns
System.Boolean

Print()

Directly prints the RadRichTextEditor document to the default printer.

Declaration
public virtual void Print()

Print(Boolean)

Directly prints the RadRichTextEditor document to the default printer or shows printer settings and then prints the RadRichTextEditor document.

Declaration
public virtual void Print(bool showPrinterSettings)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.

Print(Boolean, RadPrintDocument)

Directly prints the RadRichTextEditor document to the default printer or shows printer settings and then prints the RadRichTextEditor document.

Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

PrintPreview()

Shows a RadPrintPreviewDialog for editing the RadRichTextEditor print settings.

Declaration
public virtual void PrintPreview()

PrintPreview(RadPrintDocument)

Shows a RadPrintPreviewDialog for editing the RadRichTextEditor print settings.

Declaration
public virtual void PrintPreview(RadPrintDocument document)
Parameters
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

ProcessDialogChar(Char)

Declaration
protected override bool ProcessDialogChar(char charCode)
Parameters
System.Char charCode

Returns
System.Boolean

ProcessDialogKey(Keys)

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

ProcessMnemonic(Char)

Declaration
protected override bool ProcessMnemonic(char charCode)
Parameters
System.Char charCode

Returns
System.Boolean

Overrides

Redo()

Re-executes the last undone command group.

Declaration
public void Redo()

RejectAllRevisions()

Rejects all revisions in the current document.

Declaration
public void RejectAllRevisions()

RejectRevision(Revision)

Rejects revision.

Declaration
public void RejectRevision(Revision revision)
Parameters
Revision revision

The revision.

RemoveTabStop(TabStop)

Removes the provided TabStop from the document.

Declaration
public void RemoveTabStop(TabStop tabStop)
Parameters
TabStop tabStop

RemoveTabStopRange(IEnumerable<TabStop>)

Removes the provided TabStops from the document.

Declaration
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)
Parameters
System.Collections.Generic.IEnumerable<TabStop> tabStops

ReplaceTabStop(TabStop, TabStop)

Replaces the provided tab stop with a new one.

Declaration
public void ReplaceTabStop(TabStop oldTabStop, TabStop newTabStop)
Parameters
TabStop oldTabStop

TabStop newTabStop

ResizeTableColumn(Table, Int32, Double)

Changes the size of the column in the table to the new width.

Declaration
public void ResizeTableColumn(Table table, int columnIndex, double columnWidth)
Parameters
Table table

System.Int32 columnIndex

System.Double columnWidth

RestartListNumbering()

Creates a new list from the current paragraph. The paragraph should be in list, otherwise this method does nothing.

Declaration
public bool RestartListNumbering()
Returns
System.Boolean

ScaleControl(SizeF, BoundsSpecified)

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

System.Windows.Forms.BoundsSpecified specified

Overrides

ScrollToNote(Note)

Scrolls the viewport so that a note becomes visible.

Declaration
public void ScrollToNote(Note note)
Parameters
Note note

The note.

SetSelectedComment(CommentRangeStart)

Sets the currently selected comment.

Declaration
public void SetSelectedComment(CommentRangeStart commentStart)
Parameters
CommentRangeStart commentStart

SetSelectedNote(Note)

Declaration
public void SetSelectedNote(Note note)
Parameters
Note note

SetWatermark(DocumentWatermarkSettings)

Applies the watermark settings to the document.

Declaration
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)
Parameters
DocumentWatermarkSettings watermarkSettings

SetWatermark(PredefinedWatermarkType)

Applies one of the predefined watermarks.

Declaration
public void SetWatermark(PredefinedWatermarkType predefinedType)
Parameters
PredefinedWatermarkType predefinedType

SetWatermarkImage(WatermarkImageSettings)

Applies the image settings watermark to the document.

Declaration
public void SetWatermarkImage(WatermarkImageSettings settings)
Parameters
WatermarkImageSettings settings

SetWatermarkText(WatermarkTextSettings)

Applies the text settings watermark to the document.

Declaration
public void SetWatermarkText(WatermarkTextSettings settings)
Parameters
WatermarkTextSettings settings

ShowAddNewBibliographicSourceDialog(String, Boolean, Action<BibliographicSource>)

Shows the Add New Bibliographic Source Dialog.

Declaration
public void ShowAddNewBibliographicSourceDialog(string sourceName = null, bool insertFieldOnClose = true, Action<BibliographicSource> callBackOnClosed = null)
Parameters
System.String sourceName

System.Boolean insertFieldOnClose

System.Action<BibliographicSource> callBackOnClosed

ShowChangeEditingPermissionsDialog()

Shows the dialog for changing editing permissions.

Declaration
public void ShowChangeEditingPermissionsDialog()

ShowCodeFormattingDialog()

Shows the dialog for code formatting.

Declaration
public void ShowCodeFormattingDialog()

ShowContextMenuAtDocumentPosition(Point, DocumentPosition)

Shows the context menu and adjusts the position it needed.

Declaration
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)
Parameters
Point proposedLocation

The original location where the context menu will open.
DocumentPosition position

The position in the document that would help adjust the precise location of the menu.

ShowContextMenuAtDocumentPosition(DocumentPosition)

Opens the RichTextEditor context menu at the given position

Declaration
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)
Parameters
DocumentPosition position

The position of the context menu.

ShowDefineNewListStyleDialog()

Shows dialog for creating new list style.

Declaration
public void ShowDefineNewListStyleDialog()

ShowEditCustomDictionaryDialog()

Shows the dialog for editing custom spell-checking dictionaries.

Declaration
public void ShowEditCustomDictionaryDialog()

ShowFindReplaceDialog()

Shows the find replace dialog.

Declaration
public virtual void ShowFindReplaceDialog()

ShowFloatingBlockPropertiesDialog()

Shows the floating block properties dialog.

Declaration
public void ShowFloatingBlockPropertiesDialog()

ShowFontPropertiesDialog()

Shows the font properties dialog.

Declaration
public void ShowFontPropertiesDialog()

ShowImageEditorDialog()

Shows the image editor dialog.

Declaration
public void ShowImageEditorDialog()

ShowImageEditorDialog(String)

Shows the image editor dialog.

Declaration
public void ShowImageEditorDialog(string executeToolName)
Parameters
System.String executeToolName

Name of the tool to execute when the dialog is opened.

ShowInsertCaptionDialog()

Shows the insert caption dialog.

Declaration
public void ShowInsertCaptionDialog()

ShowInsertCrossReferenceWindow()

Shows the insert cross reference window.

Declaration
public void ShowInsertCrossReferenceWindow()

ShowInsertDateTimeDialog()

Shows the insert date field dialog.

Declaration
public void ShowInsertDateTimeDialog()

ShowInsertHyperlinkDialog()

Shows the insert hyperlink dialog.

Declaration
public void ShowInsertHyperlinkDialog()

ShowInsertSymbolWindow()

Show the insert symbol dialog.

Declaration
public void ShowInsertSymbolWindow()

ShowInsertTableDialog()

Shows the insert table dialog.

Declaration
public void ShowInsertTableDialog()

ShowInsertTableOfContentsDialog()

Shows the insert Table of Contents window.

Declaration
public void ShowInsertTableOfContentsDialog()

ShowManageBibliographicSourcesDialog()

Shows the Manage Bibliographic Sources Dialog.

Declaration
public void ShowManageBibliographicSourcesDialog()

ShowManageBookmarksDialog()

Shows the dialog for managing bookmarks.

Declaration
public void ShowManageBookmarksDialog()

ShowManageStylesDialog()

Shows the dialog for managing styles.

Declaration
public void ShowManageStylesDialog()

ShowNotesDialog()

Shows the notes dialog.

Declaration
public void ShowNotesDialog()

ShowParagraphPropertiesDialog()

Shows the paragraph properties dialog.

Declaration
public void ShowParagraphPropertiesDialog()

ShowProtectDocumentDialog()

Shows the dialog for enforcing document protection.

Declaration
public void ShowProtectDocumentDialog()

ShowSetNumberingValueDialog()

Shows the Set Numbering Value Dialog.

Declaration
public void ShowSetNumberingValueDialog()

ShowSpellCheckingDialog()

Shows the spell checking dialog.

Declaration
public void ShowSpellCheckingDialog()

ShowStyleFormattingPropertiesDialog()

Shows the dialog for adding new style.

Declaration
public void ShowStyleFormattingPropertiesDialog()

ShowStyleFormattingPropertiesDialog(StyleDefinition)

Shows the dialog for modifying style formatting.

Declaration
public void ShowStyleFormattingPropertiesDialog(StyleDefinition styleDefinition)
Parameters
StyleDefinition styleDefinition

ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings)

Shows the style formatting properties dialog.

Declaration
public void ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings settings)
Parameters
StyleFormattingPropertiesDialogSettings settings

The settings.

ShowTableBordersDialog()

Shows the table borders dialog.

Declaration
public void ShowTableBordersDialog()

ShowTablePropertiesDialog()

Shows the table properties dialog.

Declaration
public void ShowTablePropertiesDialog()

ShowTabStopsPropertiesDialog()

Shows the dialog for editing tab stops.

Declaration
public void ShowTabStopsPropertiesDialog()

ShowUnprotectDocumentDialog()

Shows the dialog for removing document protection.

Declaration
public void ShowUnprotectDocumentDialog()

ShowWatermarkSettingsDialog()

Shows the watermark settings dialog.

Declaration
public void ShowWatermarkSettingsDialog()

SplitAnnotationRange(AnnotationRangeStart)

Splits an annotation range at the caret position.

Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The start of the range that is to be split.

SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)

Splits an annotation range at the specified position.

Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)
Parameters
AnnotationRangeStart rangeStart

The start of the range that is to be split.
DocumentPosition position

The position where the range is to be split.

ToggleBold()

Toggles the bold state of the current run in the document.

Declaration
public void ToggleBold()

ToggleBookmarks()

Toggles the visibility of the bookmarks in the document.

Declaration
public void ToggleBookmarks()

ToggleComments()

Toggles the visibility of the comments in the document.

Declaration
public void ToggleComments()

ToggleDifferentFirstPageHeaderFooter()

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

Declaration
public void ToggleDifferentFirstPageHeaderFooter()

ToggleDifferentOddAndEvenPagesHeaderFooter()

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

Declaration
public void ToggleDifferentOddAndEvenPagesHeaderFooter()

ToggleFieldCodes(FieldRangeStart)

Toggles the display mode of a field.

Declaration
public void ToggleFieldCodes(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.

ToggleFormattingSymbols()

Toggles the visibility of the formatting symbols in the document.

Declaration
public void ToggleFormattingSymbols()

ToggleHeaderFooterEditingMode()

Toggles the headers/footers editing mode.

Declaration
public void ToggleHeaderFooterEditingMode()

ToggleItalic()

Toggles the italic state of the current run in the document.

Declaration
public void ToggleItalic()

ToggleMergeFieldsHighlight()

Turns on or off the highlighting of merge fields.

Declaration
public void ToggleMergeFieldsHighlight()

ToggleStrikethrough()

Toggles the subscript state of the current run in the document.

Declaration
public void ToggleStrikethrough()

ToggleSubscript()

Toggles the subscript state of the current run in the document.

Declaration
public void ToggleSubscript()

ToggleSuperscript()

Changes the superscript state of the current run in the document.

Declaration
public void ToggleSuperscript()

ToggleUnderline()

Toggles the underline state of the current run in the document.

Declaration
public void ToggleUnderline()

Undo()

Reverts last executed command group.

Declaration
public void Undo()

UnmergeTableCells()

Unmerges the currently selected cells.

Declaration
public void UnmergeTableCells()

UpdateAllCaptions(CaptionDefinition)

Updates all captions related to caption definition.

Declaration
public void UpdateAllCaptions(CaptionDefinition captionDefinition)
Parameters
CaptionDefinition captionDefinition

The caption definition.

UpdateAllFields()

Updates all fields in the document.

Declaration
public void UpdateAllFields()

UpdateAllFields(FieldDisplayMode)

Updates all fields and displays them in the specified display mode.

Declaration
public void UpdateAllFields(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

The display mode.

UpdateEditorLayout()

Forces the control to update its layout and UI;

Declaration
public void UpdateEditorLayout()

UpdateEditorLayout(Boolean)

Forces the control to update its layout and UI.

Declaration
public void UpdateEditorLayout(bool async)
Parameters
System.Boolean async

False to execute the update immediately. Otherwise it will be executed with slight delay using Dispatcher Timer for performance reasons.

UpdateField(FieldRangeStart)

Updates a field.

Declaration
public void UpdateField(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.

UpdateFooter(Section, HeaderFooterType, Footer)

Updates the footer for a section.

Declaration
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)
Parameters
Section section

The section of the footer.
HeaderFooterType footerType

Type of the footer.
Footer footer

The footer.

UpdateHeader(Section, HeaderFooterType, Header)

Updates the header for a section.

Declaration
public void UpdateHeader(Section section, HeaderFooterType headerType, Header header)
Parameters
Section section

The section of the header.
HeaderFooterType headerType

Type of the header.
Header header

The header.

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

Overrides

Events

ActiveDocumentEditorChanged

Occurs when active document editor changes.

Declaration
public event EventHandler<ActiveDocumentEditorChangedEventArgs> ActiveDocumentEditorChanged
Event Type
System.EventHandler<ActiveDocumentEditorChangedEventArgs>

CommandError

Occurs on error while executing command.

Declaration
public event EventHandler<CommandErrorEventArgs> CommandError
Event Type
System.EventHandler<CommandErrorEventArgs>

CommandExecuted

Occurs after the execution of RichTextBoxCommandBase.

Declaration
public event EventHandler<CommandExecutedEventArgs> CommandExecuted
Event Type
System.EventHandler<CommandExecutedEventArgs>

CommandExecuting

Occurs before the execution of RichTextBoxCommandBase.

Declaration
public event EventHandler<CommandExecutingEventArgs> CommandExecuting
Event Type
System.EventHandler<CommandExecutingEventArgs>

CommentShowing

Occurs when showing comment.

Declaration
public event EventHandler<CommentShowingEventArgs> CommentShowing
Event Type
System.EventHandler<CommentShowingEventArgs>

CurrentEditingStyleChanged

Occurs when the current editing style has changed.

Declaration
public event EventHandler CurrentEditingStyleChanged
Event Type
System.EventHandler

CurrentParagraphStyleChanged

Occurs when the current paragraph's style has changed.

Declaration
public event EventHandler CurrentParagraphStyleChanged
Event Type
System.EventHandler

CurrentSpanStyleChanged

Occurs when the current span's style has changed.

Declaration
public event EventHandler CurrentSpanStyleChanged
Event Type
System.EventHandler

CurrentVisiblePageChanged

Occurs when the CurrentPage property value has changed.

Declaration
public event EventHandler CurrentVisiblePageChanged
Event Type
System.EventHandler

DocumentArranged

Occurs when the current document has been arranged.

Declaration
public event EventHandler DocumentArranged
Event Type
System.EventHandler

DocumentChanged

Occurs when the current document has changed.

Declaration
public event EventHandler DocumentChanged
Event Type
System.EventHandler

DocumentChanging

Occurs when the current document is changing.

Declaration
public event EventHandler DocumentChanging
Event Type
System.EventHandler

DocumentContentChanged

Occurs when the content of the current document has changed.

Declaration
public event EventHandler DocumentContentChanged
Event Type
System.EventHandler

DocumentLayoutModeChanged

Occurs when the layout mode of the current document has changed.

Declaration
public event EventHandler DocumentLayoutModeChanged
Event Type
System.EventHandler

DocumentPresentationChanged

Occurs when document presentation is changed.

Declaration
public event EventHandler<PresentationChangedEventArgs> DocumentPresentationChanged
Event Type
System.EventHandler<PresentationChangedEventArgs>

HyperlinkClicked

Occurs when the users clicks on a hyperlink in the current document.

Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked
Event Type
System.EventHandler<HyperlinkClickedEventArgs>

IsReadOnlyChanged

Occurs when IsReadOnly property changes.

Declaration
public event EventHandler IsReadOnlyChanged
Event Type
System.EventHandler

Loaded

Occurs when the control is loaded.

Declaration
public event EventHandler Loaded
Event Type
System.EventHandler

MergeFieldToStringConverting

Occurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it becomes a result string value.

Declaration
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConverting
Event Type
System.EventHandler<MergeFieldToStringConvertingEventArgs>

ProtectionStateChanged

Occurs when the current protection state has changed.

Declaration
public event EventHandler ProtectionStateChanged
Event Type
System.EventHandler

ProviderUILayerInitialized

Occurs when the child elements of an UI layer have been initialized and added to its container.

Declaration
public event EventHandler<ProviderUILayerInitilizedEventArgs> ProviderUILayerInitialized
Event Type
System.EventHandler<ProviderUILayerInitilizedEventArgs>

ScaleFactorChanged

Occurs when the ScaleFactor property value has changed.

Declaration
public event EventHandler ScaleFactorChanged
Event Type
System.EventHandler

SelectedLayoutBoxChanged

Occurs when currently selected layout box has changed.

Declaration
public event EventHandler<SelectedLayoutBoxChangedEventArgs> SelectedLayoutBoxChanged
Event Type
System.EventHandler<SelectedLayoutBoxChangedEventArgs>

SelectionChanged

Occurs when selection is changed.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

StreamFromUriResolving

Declaration
public event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolving
Event Type
System.EventHandler<StreamFromUriResolvingEventArgs>

UntrackableCommandExecuting

Occurs when executing command that does not support track changes and track changes are enabled.

Declaration
public event EventHandler<UntrackableCommandExecutingEventArgs> UntrackableCommandExecuting
Event Type
System.EventHandler<UntrackableCommandExecutingEventArgs>

UserInfoChanged

Occurs when the current user info has changed.

Declaration
public event EventHandler UserInfoChanged
Event Type
System.EventHandler

Explicit Interface Implementations

IPrintable.BeginPrint(RadPrintDocument, PrintEventArgs)

Declaration
int IPrintable.BeginPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Int32

Implements

IPrintable.EndPrint(RadPrintDocument, PrintEventArgs)

Declaration
bool IPrintable.EndPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Boolean

Implements

IPrintable.GetSettingsDialog(RadPrintDocument)

Declaration
Form IPrintable.GetSettingsDialog(RadPrintDocument document)
Parameters
RadPrintDocument document

Returns
System.Windows.Forms.Form

Implements

IPrintable.PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)

Declaration
bool IPrintable.PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)
Parameters
System.Int32 pageNumber

RadPrintDocument sender

System.Drawing.Printing.PrintPageEventArgs args

Returns
System.Boolean

Implements

Extension Methods