ClassRadRichTextBox
A feature-rich text editing control that provides comprehensive text formatting, document navigation, mail merge, and printing functionality. Supports multiple document formats including DOCX, RTF, HTML, and PDF.
Definition
Namespace:Telerik.WinForms.RichTextEditor
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class RadRichTextBox : FrameworkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop, IDocumentEditorPresenterContainer, IDocumentEditor, IPrintableInheritance: objectDisposableObjectRadObjectRadElementVisualElementUIElementFrameworkElementRadRichTextBox
Implements:
Inherited Members
Constructors
RadRichTextBox()
Initializes a new instance of the RadRichTextBox class with default settings. Sets up document providers, input handling, default styles, and initializes the document.
Declaration
public RadRichTextBox()Fields
AcceptsReturnProperty
Declaration
public static readonly RadProperty AcceptsReturnPropertyField Value
AcceptsTabProperty
Declaration
public static readonly RadProperty AcceptsTabPropertyField Value
AllowScalingProperty
Declaration
public static readonly RadProperty AllowScalingPropertyField Value
BorderColorProperty
Declaration
public static readonly RadProperty BorderColorPropertyField Value
CaretColorProperty
Declaration
public static readonly RadProperty CaretColorPropertyField Value
CommandsProperty
Declaration
public static readonly RadProperty CommandsPropertyField Value
CommentTemplateContentMarginProperty
Declaration
public static readonly RadProperty CommentTemplateContentMarginPropertyField Value
CurrentUserProperty
Declaration
public static readonly RadProperty CurrentUserPropertyField Value
DocumentInheritsDefaultStyleSettingsProperty
Declaration
public static readonly RadProperty DocumentInheritsDefaultStyleSettingsPropertyField Value
EnforcedPermissionRangeBrushProperty
Declaration
public static readonly RadProperty EnforcedPermissionRangeBrushPropertyField Value
HorizontalScrollBarHeightProperty
Declaration
public static readonly RadProperty HorizontalScrollBarHeightPropertyField Value
HorizontalScrollBarName
Declaration
public const string HorizontalScrollBarName = "HorizontalScrollBar"Field Value
HorizontalScrollBarVisibilityProperty
Declaration
public static readonly RadProperty HorizontalScrollBarVisibilityPropertyField Value
HyperlinkNavigationModeProperty
Declaration
public static readonly RadProperty HyperlinkNavigationModePropertyField Value
HyperlinkToolTipFormatStringProperty
Declaration
public static readonly RadProperty HyperlinkToolTipFormatStringPropertyField Value
IsAdvancedSelectionEnabledProperty
Declaration
public static readonly RadProperty IsAdvancedSelectionEnabledPropertyField Value
IsContextMenuEnabledProperty
Declaration
public static readonly RadProperty IsContextMenuEnabledPropertyField Value
IsImageMiniToolBarEnabledProperty
Declaration
public static readonly RadProperty IsImageMiniToolBarEnabledPropertyField Value
IsPasteOptionsPopupEnabledProperty
Declaration
public static readonly RadProperty IsPasteOptionsPopupEnabledPropertyField Value
IsReadOnlyProperty
Declaration
public static readonly RadProperty IsReadOnlyPropertyField Value
IsSelectionEnabledProperty
Declaration
public static readonly RadProperty IsSelectionEnabledPropertyField Value
IsSelectionMiniToolBarEnabledProperty
Declaration
public static readonly RadProperty IsSelectionMiniToolBarEnabledPropertyField Value
IsSpellCheckingEnabledProperty
Declaration
public static readonly RadProperty IsSpellCheckingEnabledPropertyField Value
IsTrackChangesEnabledProperty
Declaration
public static readonly RadProperty IsTrackChangesEnabledPropertyField Value
LayoutModeProperty
Declaration
public static readonly RadProperty LayoutModePropertyField Value
LineBreakingRuleLanguageProperty
Declaration
public static readonly RadProperty LineBreakingRuleLanguagePropertyField Value
MaxScaleFactor
Represents the maximum scale factor the control supports for document zoom operations. The scale factor cannot be set above this value to maintain performance.
MeasuringPanelName
Declaration
public const string MeasuringPanelName = "MeasuringPanel"Field Value
MinScaleFactor
Represents the minimum scale factor the control supports for document zoom operations. The scale factor cannot be set below this value to maintain readability.
PrintingScreenName
Declaration
public const string PrintingScreenName = "PrintingScreen"Field Value
ProtectionAuthenticationProviderProperty
Declaration
public static readonly RadProperty ProtectionAuthenticationProviderPropertyField Value
ScaleFactorProperty
Declaration
public static readonly RadProperty ScaleFactorPropertyField Value
SelectionFillColorProperty
Declaration
public static readonly RadProperty SelectionFillColorPropertyField Value
SelectionFillProperty
Declaration
public static readonly RadProperty SelectionFillPropertyField Value
SelectionStrokeColorProperty
Declaration
public static readonly RadProperty SelectionStrokeColorPropertyField Value
SelectionStrokeProperty
Declaration
public static readonly RadProperty SelectionStrokePropertyField Value
ShowCommentsProperty
Declaration
public static readonly RadProperty ShowCommentsPropertyField Value
ShowFormattingSymbolsProperty
Declaration
public static readonly RadProperty ShowFormattingSymbolsPropertyField Value
ShowMergeFieldsHighlightProperty
Declaration
public static readonly RadProperty ShowMergeFieldsHighlightPropertyField Value
VerticalScrollBarName
Declaration
public const string VerticalScrollBarName = "VerticalScrollBar"Field Value
VerticalScrollBarVisibilityProperty
Declaration
public static readonly RadProperty VerticalScrollBarVisibilityPropertyField Value
VerticalScrollBarWidthProperty
Declaration
public static readonly RadProperty VerticalScrollBarWidthPropertyField Value
ViewContentPresenter
Declaration
public const string ViewContentPresenter = "ViewPresenter"Field Value
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
Implements
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.
ActiveDocumentEditor
Gets the currently active editor.
Declaration
public IDocumentEditor ActiveDocumentEditor { get; }Property Value
ActiveEditor
Gets the currently active editor instance when using master-detail document scenarios. This is typically used in more complex document editing scenarios where multiple editor instances work together.
Declaration
public RadRichTextBox ActiveEditor { get; }Property Value
ActiveEditorPresenter
Gets or sets a value representing the active document presenter.
Declaration
public IDocumentEditorPresenter ActiveEditorPresenter { get; set; }Property Value
AddNewBibliographicSourceDialog
Gets or sets the dialog for adding bibliographic sources.
Declaration
public IAddNewBibliographicSourceDialog AddNewBibliographicSourceDialog { get; set; }Property Value
AllowScaling
Gets or sets a value indicating whether the scaling is enabled.
AutoInsertHyperlinks
Gets or sets a value indicating whether hyperlinks should be automatically detected.
Declaration
public bool AutoInsertHyperlinks { get; set; }Property Value
Implements
BorderColor
Declaration
[VsbBrowsable(true)]
public Color BorderColor { get; set; }Property Value
CaretColor
Gets or sets the color of the caret.
CaretFactory
Gets or sets an instance implementing ICaretFactory
Declaration
public ICaretFactory CaretFactory { get; set; }Property Value
Implements
CaretWidth
Gets or sets the width of the caret.
ChangeEditingPermissionsDialog
Gets or sets the dialog for changing editing permissions of the document.
Declaration
public IChangeEditingPermissionsDialog ChangeEditingPermissionsDialog { get; set; }Property Value
CheckBoxPropertiesDialog
Gets or sets a value representing the current dialog for editing CheckBox content control properties.
Declaration
[Browsable(false)]
public ICheckBoxPropertiesDialog CheckBoxPropertiesDialog { get; set; }Property Value
CodeFormattingDialog
Gets or sets the dialog for formatting code blocks.
Declaration
public ICodeFormattingDialog CodeFormattingDialog { get; set; }Property Value
Commands
Gets or sets a collection of commands that can be executed.
Declaration
public RichTextBoxCommands Commands { get; set; }Property Value
CommentPaneMinWidth
Gets or sets the minimum width of the panel containing comments.
Declaration
public double CommentPaneMinWidth { get; set; }Property Value
Implements
CommentTemplateContentMargin
Gets or sets the comment template content margin.
Declaration
public Thickness CommentTemplateContentMargin { get; set; }Property Value
Implements
ContextMenu
Gets or sets the context menu.
Declaration
public IContextMenu ContextMenu { get; set; }Property Value
CurrentEditingContext
Gets the current editing context which provides information about the document's editing state and active operations like selection, search, or special editing modes.
Declaration
public EditingContext CurrentEditingContext { get; }Property Value
Implements
CurrentEditingStyle
Gets a value indicating the current editing style.
Declaration
public StyleDefinition CurrentEditingStyle { get; }Property Value
Implements
CurrentParagraphStyle
Gets a paragraph object containing the style settings of the current paragraph.
Declaration
public Paragraph CurrentParagraphStyle { get; }Property Value
CurrentSpanStyle
Gets a span object containing the style settings of the current span.
CurrentUser
Gets or sets the currently active user.
CurrentVisiblePage
Gets the index of the currently visible page.
DatePickerPropertiesDialog
Gets or sets a value representing the current dialog for editing DatePicker content control properties.
Declaration
[Browsable(false)]
public IDatePickerPropertiesDialog DatePickerPropertiesDialog { get; set; }Property Value
Document
Gets or sets the currently active document in the editor. This is the main document that contains all the content and formatting being edited. Changing this property will raise the DocumentChanging and DocumentChanged events.
Declaration
public RadDocument Document { get; set; }Property Value
The RadDocument instance that contains the document's content and formatting.
Implements
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
DropDownListPropertiesDialog
Gets or sets a value representing the current dialog for editing DropDownList content control properties.
Declaration
[Browsable(false)]
public IDropDownListPropertiesDialog DropDownListPropertiesDialog { get; set; }Property Value
EditCustomDictionaryDialog
Gets or sets the dialog for editing custom dictionaries.
Declaration
public IEditCustomDictionaryDialog EditCustomDictionaryDialog { get; set; }Property Value
EmailPattern
Gets or sets the pattern used for matching emails
Declaration
public string EmailPattern { get; set; }Property Value
Implements
EnforcedPermissionRangeBrush
Gets or sets the brush used to visually highlight text ranges with enforced permissions in the document.
Declaration
public Brush EnforcedPermissionRangeBrush { get; set; }Property Value
Implements
FieldShadingMode
Gets or sets the field shading type/
Declaration
public FieldShadingType FieldShadingMode { get; set; }Property Value
Implements
FindReplaceDialog
Gets or sets the find and replace dialog.
Declaration
public IFindReplaceDialog FindReplaceDialog { get; set; }Property Value
FloatingBlockPropertiesDialog
Gets or sets the dialog for editing floating block properties.
Declaration
public IFloatingBlockPropertiesDialog FloatingBlockPropertiesDialog { get; set; }Property Value
FlowDirection
Gets or sets the direction of flow of the elements.
Declaration
public override FlowDirection FlowDirection { get; }Property Value
Overrides
FontPropertiesDialog
Gets or sets the dialog for editing font properties.
Declaration
public IFontPropertiesDialog FontPropertiesDialog { get; set; }Property Value
HorizontalScrollBar
Gets the horizontal scroll bar of the RadRichTextBox
Declaration
public RadScrollBarElement HorizontalScrollBar { get; }Property Value
HorizontalScrollBarHeight
Gets or sets the height of the horizontal scroll bar.
HorizontalScrollBarVisibility
Gets or sets a value representing the horizontal scroll bar visibility.
Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }Property Value
HyperlinkNavigationMode
Gets or sets the hyperlink navigation mode.
Declaration
public HyperlinkNavigationMode HyperlinkNavigationMode { get; set; }Property Value
The hyperlink navigation mode.
HyperlinkPattern
Gets or sets the pattern used for matching hyperlinks
Declaration
public string HyperlinkPattern { get; set; }Property Value
Implements
HyperlinkToolTipFormatString
Gets or sets the hyperlink tool text.
Declaration
public string HyperlinkToolTipFormatString { get; set; }Property Value
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
Implements
ImageEditorDialog
Gets or sets the dialog for editing images.
Declaration
public IImageEditorDialog ImageEditorDialog { get; set; }Property Value
ImageMiniToolBar
Gets or sets the image mini toolbar.
Declaration
public IImageMiniToolBar ImageMiniToolBar { get; set; }Property Value
ImageSelectionAdornerSettings
Gets an object containing the options available for the Image selection adorner.
Declaration
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }Property Value
Implements
InputHandler
Gets or sets an instance of RichTextEditorInputBehavior that will handle user input.
Declaration
public RichTextEditorInputBehavior InputHandler { get; set; }Property Value
InsertCaptionDialog
Gets or sets the dialog for inserting captions.
Declaration
public IInsertCaptionDialog InsertCaptionDialog { get; set; }Property Value
InsertCrossReferenceWindow
Gets or sets the dialog for inserting cross-reference windows.
Declaration
public IInsertCrossReferenceWindow InsertCrossReferenceWindow { get; set; }Property Value
InsertDateTimeDialog
Gets or sets the dialog for inserting date time values.
Declaration
public IInsertDateTimeDialog InsertDateTimeDialog { get; set; }Property Value
InsertHyperlinkDialog
Gets or sets the dialog for inserting hyperlinks in the document.
Declaration
public IInsertHyperlinkDialog InsertHyperlinkDialog { get; set; }Property Value
InsertSymbolWindow
Gets or sets the dialog for inserting symbols in the document.
Declaration
public IInsertSymbolWindow InsertSymbolWindow { get; set; }Property Value
InsertTableDialog
Gets or sets the dialog for inserting tables in the document.
Declaration
public IInsertTableDialog InsertTableDialog { get; set; }Property Value
InsertTableOfContentsDialog
Gets or sets the dialog for inserting table of contents.
Declaration
public IInsertTableOfContentsDialog InsertTableOfContentsDialog { get; set; }Property Value
IsAdvancedSelectionEnabled
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
public bool IsAdvancedSelectionEnabled { get; set; }Property Value
IsContextMenuEnabled
Gets or sets a value indicating whether context menu is enabled.
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
Implements
IsPasteOptionsPopupEnabled
Gets or sets a value indicating whether the paste options popup is displayed on paste.
Declaration
public bool IsPasteOptionsPopupEnabled { get; set; }Property Value
true if this instance is paste options popup enabled; otherwise, false.
IsReadOnly
Gets or sets a value indicating whether the control is read-only. When true, users can still navigate through the document, copy content, and perform search operations, but editing operations are disabled. This property is useful for documents intended for display only.
Declaration
public bool IsReadOnly { get; set; }Property Value
True if the document is in read-only mode; otherwise, false.
Implements
IsSelectionEnabled
Gets or sets a value indicating whether selection can be made in the document.
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
IsSpellCheckingEnabled
Gets or sets a value indicating whether the spell checking is enabled for this document.
Declaration
public bool IsSpellCheckingEnabled { get; set; }Property Value
Implements
IsTrackChangesEnabled
Gets or sets a value indicating whether formatting symbols are shown in the document.
Declaration
public bool IsTrackChangesEnabled { get; set; }Property Value
true if formatting symbols are shown; otherwise, false.
LayoutMode
Gets or sets the document layout mode.
Declaration
public DocumentLayoutMode? LayoutMode { get; set; }Property Value
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
The line breaking characters rule language.
LineNumberingDialog
Gets or sets a value representing the current line numbering dialog.
Declaration
[Browsable(false)]
public ILineNumberingDialog LineNumberingDialog { get; set; }Property Value
ManageBibliographicSourcesDialog
Gets or sets the dialog for managing bibliographics sources.
Declaration
public IManageBibliographicSourcesDialog ManageBibliographicSourcesDialog { get; set; }Property Value
ManageBookmarksDialog
Gets or sets the dialog for managing bookmarks in the document.
Declaration
public IManageBookmarksDialog ManageBookmarksDialog { get; set; }Property Value
ManageStylesDialog
Gets or sets the dialog for managing styles.
Declaration
public IManageStylesDialog ManageStylesDialog { get; set; }Property Value
MentionBox
Declaration
public IMentionBox MentionBox { get; set; }Property Value
MentionContext
Declaration
public MentionContext MentionContext { get; set; }Property Value
NotesDialog
Gets or sets the dialog for editing footnotes and endnotes properties.
Declaration
public INotesDialog NotesDialog { get; set; }Property Value
PageBackColor
Gets or sets the back color that should be applied to all pages.
ParagraphPropertiesDialog
Gets or sets the dialog for editing paragraph properties.
Declaration
public IParagraphPropertiesDialog ParagraphPropertiesDialog { get; set; }Property Value
PasteOptionsPopup
Declaration
public IPasteOptionsPopup PasteOptionsPopup { get; set; }Property Value
PasteSettings
Gets the current PasteSettings associated with RadRichTextBox
Declaration
public PasteSettings PasteSettings { get; }Property Value
PicturePropertiesDialog
Gets or sets a value representing the current dialog for editing Picture content control properties.
Declaration
[Browsable(false)]
public IPicturePropertiesDialog PicturePropertiesDialog { get; set; }Property Value
PlainTextPropertiesDialog
Gets or sets a value representing the current dialog for editing PlainText content control properties.
Declaration
[Browsable(false)]
public IPlainTextPropertiesDialog PlainTextPropertiesDialog { get; set; }Property Value
ProtectDocumentDialog
Gets or sets the dialog for editing protection settings for the document.
Declaration
public IProtectDocumentDialog ProtectDocumentDialog { get; set; }Property Value
ProtectionAuthenticationProvider
Gets or sets the Protection Authentication Provider
Declaration
public IProtectionAuthenticationProvider ProtectionAuthenticationProvider { get; set; }Property Value
RepeatingSectionPropertiesDialog
Gets or sets a value representing the current dialog for editing RepeatingSection content control properties.
Declaration
[Browsable(false)]
public IRepeatingSectionPropertiesDialog RepeatingSectionPropertiesDialog { get; set; }Property Value
RichTextPropertiesDialog
Gets or sets a value representing the current dialog for editing RichText content control properties.
Declaration
[Browsable(false)]
public IRichTextPropertiesDialog RichTextPropertiesDialog { get; set; }Property Value
ScaleFactor
Gets or sets a value representing the current view scale factor.
SectionColumnsDialog
Gets or sets a value representing the current section columns dialog.
Declaration
public ISectionColumnsDialog SectionColumnsDialog { get; set; }Property Value
SelectedComment
Gets or sets the currently selected comment in the document. When a comment is selected, its content becomes visible in the comment area and can be edited if permissions allow. Setting this property will clear any current document selection.
Declaration
public Comment SelectedComment { get; set; }Property Value
The currently selected Comment instance, or null if no comment is selected.
Implements
SelectedNote
Gets or sets the currently selected note.
SelectionFill
Gets or sets the color of the selection rectangle.
Declaration
public Brush SelectionFill { get; set; }Property Value
Implements
SelectionMiniToolBar
Gets or sets the selection mini toolbar.
Declaration
public ISelectionMiniToolBar SelectionMiniToolBar { get; set; }Property Value
SelectionStroke
Gets or sets the brush for the selection rectangle border.
Declaration
public Brush SelectionStroke { get; set; }Property Value
Implements
SetNumberingValueDialog
Gets or sets the dialog for setting numbering values.
Declaration
public ISetNumberingValueDialog SetNumberingValueDialog { get; set; }Property Value
ShowComments
Gets or sets a value indicating whether the comments are shown.
ShowFormattingSymbols
Gets or sets a value indicating whether formatting symbols are shown in the document.
Declaration
public bool ShowFormattingSymbols { get; set; }Property Value
true if formatting symbols are shown; otherwise, false.
Implements
ShowMergeFieldsHighlight
Gets or sets a value indicating whether Merge Fields will be highlighted.
Declaration
public bool ShowMergeFieldsHighlight { get; set; }Property Value
SpellChecker
Gets or sets the ISpellChecker implementation used when proofing.
Declaration
public ISpellChecker SpellChecker { get; set; }Property Value
Implements
SpellCheckingDialog
Gets or sets the dialog for spell checking.
Declaration
public ISpellCheckingDialog SpellCheckingDialog { get; set; }Property Value
StyleFormattingPropertiesDialog
Gets or sets the dialog for editing style properties.
Declaration
public IStyleFormattingPropertiesDialog StyleFormattingPropertiesDialog { get; set; }Property Value
TabStopsPropertiesDialog
Gets or sets the dialog for editing tab stop properties.
Declaration
public ITabStopsPropertiesDialog TabStopsPropertiesDialog { get; set; }Property Value
TableBordersDialog
Gets or sets the dialog for editing table borders.
Declaration
public ITableBordersDialog TableBordersDialog { get; set; }Property Value
TablePropertiesDialog
Gets or sets the dialog for editing table properties.
Declaration
public ITablePropertiesDialog TablePropertiesDialog { get; set; }Property Value
TrackChangesOptions
Gets the object containing options available for Track changes.
Declaration
public TrackChangesOptions TrackChangesOptions { get; }Property Value
UILayersBuilder
Gets or sets an instance of UILayersBuilder.
Declaration
public UILayersBuilder UILayersBuilder { get; set; }Property Value
Implements
UnprotectDocumentDialog
Gets or sets the dialog for removing protection restrictions on the document.
Declaration
public IUnprotectDocumentDialog UnprotectDocumentDialog { get; set; }Property Value
Users
Gets or sets a collection containing the users' permissions on the current document.
Declaration
public PermissionInfoCollection Users { get; set; }Property Value
VerticalScrollBar
Gets the vertical scroll bar of the RadRichTextBox
Declaration
public RadScrollBarElement VerticalScrollBar { get; }Property Value
VerticalScrollBarVisibility
Gets or sets a value representing the vertical scroll bar visibility.
Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }Property Value
VerticalScrollBarWidth
Gets or sets the width of the vertical scroll bar.
WatermarkSettingsDialog
Gets or sets the dialog for editing watermark settings.
Declaration
public IWatermarkSettingsDialog WatermarkSettingsDialog { get; set; }Property Value
Methods
AcceptAllRevisions()
Accepts all revisions in the current document.
Declaration
public void AcceptAllRevisions()Implements
AcceptRevision(Revision)
Accepts revision.
Declaration
public void AcceptRevision(Revision revision)Parameters
revision
The revision.
Implements
AddTabStop(TabStop)
Adds a tab stop at the current position in the document.
Declaration
public void AddTabStop(TabStop tabStop)Parameters
tabStop
The tab stop to add.
Implements
AddTabStopRange(IEnumerable<TabStop>)
Adds the enumeration of tab stops.
Declaration
public void AddTabStopRange(IEnumerable<TabStop> tabStops)Parameters
tabStops
The tab stops to add.
Implements
ArrangeOverride(SizeF)
Arranges the RadElement to its final location. The element must call the Arrange method of each of its children.
Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)Parameters
finalSize
The size that is available for element.
Returns
The rectangle occupied by the element. Usually finalSize. Should you return different size, the Layout system will restart measuring and rearranging the items. That could lead to infinite recursion.
Overrides
Remarks
In this method call to the Arrange method of each child must be made.
BeginUndoGroup()
Begins new undo group.
Declaration
public void BeginUndoGroup()Implements
CanCopyFormatting()
Returns a value indicating whether the formatting can be copied according to the current selection.
Declaration
public bool CanCopyFormatting()Returns
The value indicating whether the formatting can be copied.
CancelUndoGroup()
Cancels current undo group.
Declaration
public void CancelUndoGroup()Implements
ChangeAllFieldsDisplayMode(FieldDisplayMode)
Changes the display mode of all fields in the document.
Declaration
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)Parameters
displayMode
The display mode.
Implements
ChangeBaselineAlignment(BaselineAlignment)
Changes the baseline alignment of the current run in the document.
Declaration
public void ChangeBaselineAlignment(BaselineAlignment newBaselineAlignment)Parameters
newBaselineAlignment
The new baseline alignment to be applied.
Implements
ChangeBibliographicStyle(BibliographicReferenceStyleBase)
Changes the bibliographic style of all bibliography related fields in the document.
Declaration
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)Parameters
newBibliographicStyle
BibliographicReferenceStyleBase
The new bibliographic style.
Implements
ChangeDifferentFirstPageHeaderFooter(bool)
Sets a value indicating whether the first page header and footer would be different than the rest of the pages.
Declaration
public void ChangeDifferentFirstPageHeaderFooter(bool value)Parameters
value
true if the header and footer will be different, otherwise false.
Implements
ChangeDifferentOddAndEvenPagesHeaderFooter(bool)
Sets a value indicating whether even and odd pages headers and footers would be different.
Declaration
public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)Parameters
value
true if the headers and footers will be different, otherwise false.
Implements
ChangeDocumentDefaultTabWidth(double)
Changes the space a single Tab (\t) character takes.
Declaration
public void ChangeDocumentDefaultTabWidth(double tabWidth)Parameters
tabWidth
The new width.
Implements
ChangeDocumentElementTag(DocumentElement, string)
Changes the Tag property of a specified DocumentElement.
Declaration
public void ChangeDocumentElementTag(DocumentElement element, string tag)Parameters
element
The DocumentElement.
tag
The new tag value.
Implements
ChangeDocumentEndnotesFirstNumber(int)
Changes the first number for endnotes for the entire document.
Declaration
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)Parameters
firstNumber
The new start number.
Implements
ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)
Changes the endnotes numbering format for the entire document.
Declaration
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
listNumberingFormat
The new numbering format.
Implements
ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)
Changes where endtnote numbers will stop incrementing and will start from the first one for the entire document.
Declaration
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The new restart type.
Implements
ChangeDocumentEndnotesPosition(EndnotesPosition)
Changes the position of the endnotes for the entire document.
Declaration
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)Parameters
endnotesPosition
Implements
ChangeDocumentFootnotesFirstNumber(int)
Changes the first number for footnotes for the entire document.
Declaration
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)Parameters
firstNumber
The new start number.
Implements
ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)
Changes the footnotes numbering format for the entire document.
Declaration
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
listNumberingFormat
The new numbering format.
Implements
ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)
Changes where footnote numbers will stop incrementing and will start from the first one for the entire document.
Declaration
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The new restart type.
Implements
ChangeDocumentFootnotesPosition(FootnotesPosition)
Changes the position of the footnoes for the entire document.
Declaration
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)Parameters
footnotesPosition
The new footnotes position.
Implements
ChangeDocumentIsStrictLineBreakingRuleEnabled(bool)
Sets a value indicating whether strict line brealing rule is enabled.
Declaration
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)Parameters
value
true if rule should be enabled otherwise false.
Implements
ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)
Changes the language for which line breaking rules are currently applied in the document.
Declaration
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)Parameters
lineBreakingRuleLanguage
The new language for which line breaking rules are applied.
Implements
ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)
Changes the characters after which a line break cannot be placed.
Declaration
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)Parameters
lineBreakingCharacterRule
The new rule for line breaks after a character.
Implements
ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)
Changes the characters before which a line break cannot be placed.
Declaration
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)Parameters
lineBreakingCharacterRule
The new rule for line breaks before a character.
Implements
ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)
Changes the field display mode.
Declaration
public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)Parameters
fieldStart
The field start.
displayMode
The new display mode.
Implements
ChangeFontFamily(FontFamily)
Changes the font family of the current run in the document.
Declaration
public void ChangeFontFamily(FontFamily fontFamily)Parameters
fontFamily
The new font family to be applied.
Implements
ChangeFontSize(double)
Changes the font size of the current run in the document.
Declaration
public void ChangeFontSize(double newFontSize)Parameters
newFontSize
The new font size to be applied.
Implements
ChangeFontStyle(FontStyle)
Changes the font style of the current run in the document.
Declaration
public void ChangeFontStyle(FontStyle fontStyle)Parameters
fontStyle
The new font style.
Implements
ChangeFontStyle(FontStyle)
Changes the font style of the current run in the document.
Declaration
public void ChangeFontStyle(FontStyle fontStyle)Parameters
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
The new font weight.
Implements
ChangeImageRotateAngle(ImageInline, double)
Changes the image rotate angle.
Declaration
public void ChangeImageRotateAngle(ImageInline image, double angle)Parameters
image
The ImageInline.
angle
The new angle.
Implements
ChangeImageSize(ImageInline, Size)
Changes the size of the image.
Declaration
public void ChangeImageSize(ImageInline image, Size size)Parameters
image
The ImageInline.
size
The new size.
Implements
ChangeLayoutMode(DocumentLayoutMode)
Changes the layout mode.
Declaration
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)Parameters
layoutMode
The new layout mode to be applied.
ChangeLineNumberingRestartType(LineNumberingRestartType)
Changes the restart type of line numberings for the selected sections.
Declaration
public void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)Parameters
restartType
The line numbering restart type.
Implements
ChangeListStyle(ListStyle)
Changes the paragraph style of the current paragraph.
Declaration
public void ChangeListStyle(ListStyle style)Parameters
style
The new style to be applied.
ChangeParagraphAutomaticSpacingAfter(bool)
Controls whether automatic spacing is applied after the current paragraph.
Declaration
public void ChangeParagraphAutomaticSpacingAfter(bool value)Parameters
value
True if automatic spacing should be applied, otherwise false.
Implements
ChangeParagraphAutomaticSpacingBefore(bool)
Controls whether automatic spacing is applied before the current paragraph.
Declaration
public void ChangeParagraphAutomaticSpacingBefore(bool value)Parameters
value
True if automatic spacing should be applied, otherwise false.
Implements
ChangeParagraphBackground(Color)
Changes the background color of the selected paragraphs in the document.
Declaration
public void ChangeParagraphBackground(Color color)Parameters
color
The new background color to be applied.
Implements
ChangeParagraphFirstLineIndent(double)
Changes the left indent of the current paragraph.
Declaration
public void ChangeParagraphFirstLineIndent(double firstLineIndent)Parameters
firstLineIndent
The new left indent to be applied.
Implements
ChangeParagraphFlowDirection(FlowDirection)
Changes the flow direction of the selected paragraphs in the document.
Declaration
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)Parameters
flowDirection
The new flow direction to be applied.
Implements
ChangeParagraphIsLineBreakingRuleEnabled(bool)
Sets a value indicating whether line brealing rules are enabled.
Declaration
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)Parameters
value
true if rules should be enabled otherwise false.
Implements
ChangeParagraphLeftIndent(double)
Changes the left indent of the current paragraph.
Declaration
public void ChangeParagraphLeftIndent(double leftIndent)Parameters
leftIndent
The new left indent to be applied.
Implements
ChangeParagraphLineSpacing(double)
Changes the lines spacing inside the current paragraph.
Declaration
public void ChangeParagraphLineSpacing(double lineSpacing)Parameters
lineSpacing
The new line spacing to be applied.
Implements
ChangeParagraphLineSpacing(double, LineSpacingType)
Changes the line spacing inside the current paragraph.
Declaration
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)Parameters
lineSpacing
The new line spacing to be applied.
lineSpacingType
The type of the line spacing to be applied.
Implements
ChangeParagraphLineSpacingType(LineSpacingType)
Changes the line spacing type inside the current paragraph.
Declaration
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)Parameters
lineSpacingType
The new line spacing type to be applied.
Implements
ChangeParagraphListLevel(int)
Changes the list level the paragraph is currently in.
Declaration
public void ChangeParagraphListLevel(int listLevel)Parameters
listLevel
The list level to be applied.
Implements
ChangeParagraphRightIndent(double)
Changes the right indent of the current paragraph.
Declaration
public void ChangeParagraphRightIndent(double rightIndent)Parameters
rightIndent
The new right indent to be applied.
Implements
ChangeParagraphSpacingAfter(double)
Changes the spacing after the current paragraph.
Declaration
public void ChangeParagraphSpacingAfter(double spacingAfter)Parameters
spacingAfter
The new spacing to be applied.
Implements
ChangeParagraphSpacingBefore(double)
Changes the spacing before the current paragraph.
Declaration
public void ChangeParagraphSpacingBefore(double spacingBefore)Parameters
spacingBefore
The new spacing to be applied.
Implements
ChangeParagraphStyle(StyleDefinition)
Changes the paragraph style of the current paragraph.
Declaration
public void ChangeParagraphStyle(StyleDefinition styleInfo)Parameters
styleInfo
The new style to be applied.
Implements
ChangeSectionActualPageMargin(Padding)
Changes the actual page margin (regarding the page orientation) of the section.
Declaration
public void ChangeSectionActualPageMargin(Padding sectionMargin)Parameters
sectionMargin
The section margin.
Implements
ChangeSectionColumns(SectionColumnCollection)
ChangeSectionColumns
Declaration
public void ChangeSectionColumns(SectionColumnCollection columnCollection)Parameters
columnCollection
columns
Implements
ChangeSectionColumns(SectionColumnsLayout)
ChangeSectionColumns
Declaration
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)Parameters
sectionColumnsLayout
Section Columns Layout
Implements
ChangeSectionEndnotesFirstNumber(int)
Changes the first number for endnotes for the current section.
Declaration
public void ChangeSectionEndnotesFirstNumber(int firstNumber)Parameters
firstNumber
The new start number.
Implements
ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)
Changes the endnotes numbering format for the current section.
Declaration
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
listNumberingFormat
The new numbering format.
Implements
ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)
Changes where endtnote numbers will stop incrementing and will start from the first one for the current section.
Declaration
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The new restart type.
Implements
ChangeSectionFirstPageNumber(int?)
Changes the first page number of the current section. Set null continue numeration form the previous section.
Declaration
public void ChangeSectionFirstPageNumber(int? firstPageNumber)Parameters
firstPageNumber
int?
The new first page number value.
Implements
ChangeSectionFooterBottomMargin(int)
Changes the bottom margin of the footer of the current section.
Declaration
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)Parameters
sectionFooterBottomMargin
Footer bottom margin to be applied.
Implements
ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, bool)
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
The section.
footerType
Type of the footer.
value
true if the footer should be linked.
Implements
ChangeSectionFootnotesFirstNumber(int)
Changes the first number for footnotes for the current section.
Declaration
public void ChangeSectionFootnotesFirstNumber(int firstNumber)Parameters
firstNumber
The new start number.
Implements
ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)
Changes the footnotes numbering format for the current section.
Declaration
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
listNumberingFormat
The new numbering format.
Implements
ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)
Changes where footnote numbers will stop incrementing and will start from the first one for the current section.
Declaration
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The new restart type.
Implements
ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, bool)
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
The section.
headerType
Type of the header.
value
true if the header should be linked.
Implements
ChangeSectionHeaderTopMargin(int)
Changes the top margin of the header of the current section.
Declaration
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)Parameters
sectionHeaderTopMargin
Header top margin to be applied.
Implements
ChangeSectionLineNumbering(LineNumbering)
Changes the line numberings for the selected sections.
Declaration
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)Parameters
lineNumbering
The line numbering.
Implements
ChangeSectionPageMargin(Padding)
Changes the page margin of the current section.
Declaration
public void ChangeSectionPageMargin(Padding sectionMargin)Parameters
sectionMargin
The new margin to be applied.
Implements
ChangeSectionPageOrientation(PageOrientation)
Changes the page orientation of the current section.
Declaration
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)Parameters
sectionPageOrientation
The new page orientation to be applied.
Implements
ChangeSectionPageSize(Size)
Changes the page size of the current section.
Declaration
public void ChangeSectionPageSize(Size size)Parameters
size
The new page size to be applied.
Implements
ChangeSpanStyle(StyleDefinition)
Changes the style of current run in the document.
Declaration
public void ChangeSpanStyle(StyleDefinition styleInfo)Parameters
styleInfo
The new style to be applied.
Implements
ChangeStrikethrough(bool)
Changes the strikethrough of the current run in the document.
Declaration
public void ChangeStrikethrough(bool isStrikethrough)Parameters
isStrikethrough
The new strikethrough value.
Implements
ChangeStyleName(string)
Applies style with a given name to the selected elements in the document.
Declaration
public void ChangeStyleName(string styleName)Parameters
styleName
Name of the style.
Implements
ChangeStyleName(string, bool)
Applies style with a given name to the selected elements in the document.
ChangeStyleNameToActiveEditor(string)
Changes the style name of the current run in the document.
Declaration
public void ChangeStyleNameToActiveEditor(string newStyleName)Parameters
newStyleName
ChangeTableBorders(TableBorders)
Changes the borders of the current table.
Declaration
public void ChangeTableBorders(TableBorders borders)Parameters
borders
The new table borders.
Implements
ChangeTableCellBackground(Color)
Changes the back color of the current cell.
Declaration
public void ChangeTableCellBackground(Color color)Parameters
color
The new cell back color.
Implements
ChangeTableCellBorders(Border)
Changes the borders style of the current cell.
Declaration
public void ChangeTableCellBorders(Border border)Parameters
border
The new borders style.
Implements
ChangeTableCellBorders(TableCellBorders)
Changes the cell border styles of the current table.
Declaration
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)Parameters
tableCellBorders
The new cell border styles.
Implements
ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)
Changes the content alignment of the currently selected cells.
Declaration
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)Parameters
textAlignment
The new horizontal alignment.
verticalAlignment
The new vertical alignment.
Implements
ChangeTableCellHorizontalContentAlignment(RadTextAlignment)
Changes the horizontal alignment of the currently selected cells.
Declaration
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)Parameters
textAlignment
The new horizontal alignment.
Implements
ChangeTableCellPadding(Padding)
Changes the cell padding for the currently selected cells.
Declaration
public void ChangeTableCellPadding(Padding padding)Parameters
padding
The new padding.
Implements
ChangeTableCellSpacing(double)
Changes the cell spacing of the current table.
Declaration
public void ChangeTableCellSpacing(double cellSpacing)Parameters
cellSpacing
The new cell spacing.
Implements
ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)
Changes the vertical alignment of the currently selected cells.
Declaration
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)Parameters
verticalAlignment
The new vertical alignment.
Implements
ChangeTableDefaultCellPadding(Padding)
Changes the default padding applied to cells of the current table.
Declaration
public void ChangeTableDefaultCellPadding(Padding padding)Parameters
padding
The new padding.
Implements
ChangeTableFlowDirection(FlowDirection)
Changes the flow direction of the current table.
Declaration
public void ChangeTableFlowDirection(FlowDirection flowDirection)Parameters
flowDirection
The new flow direction.
Implements
ChangeTableGridColumnWidth(Table, int, TableWidthUnit)
Changes the width of the column at the given index in the given table.
Declaration
public void ChangeTableGridColumnWidth(Table table, int gridColumnIndex, TableWidthUnit width)Parameters
table
The table containing the column.
gridColumnIndex
The index of the column in the table.
width
The new column width.
Implements
ChangeTableHorizontalAlignment(RadHorizontalAlignment)
Changhes the table horizontal alignment.
Declaration
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)Parameters
alignment
The new alignment.
Implements
ChangeTableIndent(double)
Changes the table indent.
Declaration
public void ChangeTableIndent(double indent)Parameters
indent
The new indent.
Implements
ChangeTableLayoutMode(Table, TableLayoutMode)
Changes the layout mode of the given table.
Declaration
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)Parameters
table
The table to change the layout of.
tableLayoutMode
The new layout mode.
Implements
ChangeTableLook(TableLook)
Changes the visual appearance of the current table.
Declaration
public void ChangeTableLook(TableLook tableLook)Parameters
tableLook
The new visual settings.
Implements
ChangeTablePreferredWidth(TableWidthUnit)
Changes the preferred width for the current table.
Declaration
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Parameters
tableWidth
Implements
ChangeTableRowHeight(TableRow, double)
Changes the height of the given table row.
ChangeTableRowRepeatOnEveryPage(TableRow)
ChangeTableRowRepeatOnEveryPage
Declaration
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)Parameters
tableRow
Implements
ChangeTextAlignment(RadTextAlignment)
Changes the text alignment of the current run in the document.
Declaration
public void ChangeTextAlignment(RadTextAlignment alignment)Parameters
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
newColor
The new foreground color to be applied.
ChangeTextHighlightColor(Color)
Changes the text highligh color of the current run in the document.
Declaration
public void ChangeTextHighlightColor(Color newColor)Parameters
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
newColor
The new underline color to be applied.
Implements
ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)
Changes the underline decoration of the current run in the document.
Declaration
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)Parameters
decoration
IUnderlineUIDecorationProvider
The new underline decoration provider to be applied.
Implements
ClearAllFormatting()
Clears all of the formatting of the current paragraph and run in the document.
Declaration
public void ClearAllFormatting()Implements
ClearFormatting()
Clears the formatting of the current run in the document.
Declaration
public void ClearFormatting()Implements
ClearTabStops()
Removes all tab stops from the currently selected paragraphs.
Declaration
public void ClearTabStops()Implements
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.
Copy()
Copies currently selected document elements into the clipboard
Declaration
public void Copy()Implements
CopyFormatting()
Copies the formatting of the current selection.
Declaration
public bool CopyFormatting()Returns
A value indicating whether the copy was successful.
Implements
CreatePrintDocument()
Declaration
protected virtual RadPrintDocument CreatePrintDocument()Returns
DecrementFontSize()
Decrements the font size of the current run in the document.
Declaration
public void DecrementFontSize()Implements
DecrementParagraphLeftIndent()
Decrements the left indent of the current paragraph.
Declaration
public void DecrementParagraphLeftIndent()Implements
DecrementParagraphListLevel()
Decrements the list level the paragraph is currently in by 1.
Declaration
public void DecrementParagraphListLevel()Delete(bool)
Deletes from the document respecting CaretPosition and Selection.
Declaration
public void Delete(bool deletePrevious)Parameters
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()Implements
DeleteAnnotationRange(AnnotationRangeStart)
Deletes an annotation range.
Declaration
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)Parameters
rangeStart
The start of the range that is to be deleted.
Implements
DeleteBookmark(BookmarkRangeStart)
Deletes a bookmark.
Declaration
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)Parameters
bookmarkRangeStart
The bookmark range start.
Implements
DeleteBookmark(string)
Deletes a bookmark.
Declaration
public void DeleteBookmark(string bookmarkName)Parameters
bookmarkName
Name of the bookmark.
Implements
DeleteCodeBlock(CodeAnnotationRangeStart)
Deletes a code block.
Declaration
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)Parameters
rangeStart
The code range start of the block to delete.
Implements
DeleteComment()
Deletes the current comment.
Declaration
public void DeleteComment()Implements
DeleteComment(CommentRangeStart)
Deletes a comment.
Declaration
public void DeleteComment(CommentRangeStart commentRangeStart)Parameters
commentRangeStart
The comment range start.
Implements
DeletePermissionRange(PermissionRangeStart)
Deletes a permission range.
Declaration
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)Parameters
permissionRangeStart
The permission range start.
Implements
DeleteReadOnlyRange()
Deletes the current read only range.
Declaration
public void DeleteReadOnlyRange()Implements
DeleteReadOnlyRange(ReadOnlyRangeStart)
Deletes the read only range.
Declaration
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)Parameters
readOnlyRangeStart
The read only range that is to be deleted.
Implements
DeleteTable()
Deletes the current table.
Declaration
public void DeleteTable()Implements
DeleteTable(Table)
Deletes the provided table from the document.
Declaration
public void DeleteTable(Table table)Parameters
table
The table to delete.
Implements
DeleteTableColumn()
Deletes the current column.
Declaration
public void DeleteTableColumn()Implements
DeleteTableRow()
Deletes the current row from the table.
Declaration
public void DeleteTableRow()Implements
DeleteTableRow(TableRow)
Deletes the given row from the table.
DisableWatermark()
Removes the currently applied watermark.
Declaration
public void DisableWatermark()DisposeDialogs()
Declaration
protected virtual void DisposeDialogs()DisposeManagedResources()
Releases managed resources by clearing the property store and disposing value animators to prevent memory leaks.
Declaration
protected override void DisposeManagedResources()Overrides
DisposeUnmanagedResources()
Releases any UNMANAGED resources used by this object. NOTE: If you declare some unmanaged resources in your class, you should override its finalizer and put disposing logic there also.
Declaration
protected override void DisposeUnmanagedResources()Overrides
EditListStyleInDialog(ListStyle)
Shows the dialog for editing list styles.
Declaration
public void EditListStyleInDialog(ListStyle listStyle)Parameters
listStyle
EndUndoGroup()
Closes current undo group.
Declaration
public void EndUndoGroup()Implements
EndUndoGroup(string)
Closes current undo group.
Declaration
public void EndUndoGroup(string groupDisplayText)Parameters
groupDisplayText
The display text which will be used for the undo group.
Implements
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 an object containing the appearance settings for the given comment.
Declaration
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)Parameters
comment
The Comment to get the settings for.
Returns
Implements
GetContent(string)
Gets the content in various formats.
GetDocumentEditorPresenterTypeForDocument(RadDocument)
Declaration
protected virtual Type GetDocumentEditorPresenterTypeForDocument(RadDocument document)Parameters
document
Returns
GetLayersBuilder()
Gets the component responsible for building the UI layers of the editor.
Declaration
protected virtual UILayersBuilder GetLayersBuilder()Returns
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()Implements
IncrementParagraphLeftIndent()
Increments the left indent of the current paragraph.
Declaration
public void IncrementParagraphLeftIndent()Implements
IncrementParagraphListLevel()
Increments the list level the paragraph is currently in by 1.
Declaration
public void IncrementParagraphListLevel()Insert(string)
Inserts text into the document at the current caret position, applying the current formatting. This is the primary method for adding textual content to the document programmatically.
Declaration
public void Insert(string text)Parameters
text
The text to insert into the document.
InsertAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)
Inserts an annotation range.
Declaration
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)Parameters
rangeStart
The annotation range start.
rangeEnd
The annotation range end.
Implements
InsertBookmark(string)
Inserts a bookmark at the current selection or caret position, which can be used for quick navigation within the document.
Declaration
public void InsertBookmark(string bookmarkName)Parameters
bookmarkName
The unique name for the bookmark to be inserted.
Implements
InsertCaption(CaptionDefinition, string, bool, bool)
Inserts a caption.
Declaration
public void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)Parameters
definition
The definition.
caption
The caption text to be used.
includeLabel
if set to true the label is included in the caption.
insertBelow
if set to true the caption is inserted after the current selection.
Implements
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
code
settings
Implements
InsertColumnBreak()
Inserts a column break at the current caret position, forcing the following content to begin in the next column.
Declaration
public void InsertColumnBreak()Implements
InsertComment(Comment)
Inserts a comment.
Declaration
public void InsertComment(Comment comment)Parameters
comment
The comment.
Implements
InsertCrossReferenceToBookmark(string, ReferenceContentType, bool)
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
bookmarkName
contentType
insertAsHyperlink
Implements
InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, bool)
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
captionParagraph
contentType
insertAsHyperlink
Implements
InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, bool)
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
headingParagraph
contentType
insertAsHyperlink
Implements
InsertEndnote()
Inserts endnote at the current position.
Declaration
public void InsertEndnote()Implements
InsertEndnote(Note)
Inserts the endnote at the current position.
Declaration
public void InsertEndnote(Note endnote)Parameters
endnote
The endnote.
Implements
InsertField(Field)
Inserts a field into the document at current caret position.
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
The field.
displayMode
The display mode.
Returns
True if the operation completed successfully
Implements
InsertFootnote()
Inserts footnote at the current position.
Declaration
public void InsertFootnote()Implements
InsertFootnote(Note)
Inserts the footnote at the current position.
Declaration
public void InsertFootnote(Note footnote)Parameters
footnote
The footnote.
Implements
InsertFragment(DocumentFragment)
Inserts a document fragment.
Declaration
public void InsertFragment(DocumentFragment documentFragment)Parameters
documentFragment
The document fragment to insert.
Implements
InsertFragment(DocumentFragment, DocumentPosition)
Inserts a fragment at specified position.
Declaration
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)Parameters
documentFragment
The fragment to insert.
documentPosition
The document position to insert the fragment at.
Implements
InsertHyperlink(HyperlinkInfo)
Creates a hyperlink from the current text selection, applying the provided link information.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)Parameters
hyperlinkInfo
The hyperlink information containing URL, tooltip, and other link properties.
Implements
InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)
Inserts a collection of inline elements as a hyperlink into the document at the current position.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)Parameters
hyperlinkInfo
The hyperlink information containing URL, tooltip, and other link properties.
inlines
The collection of inline elements to be displayed as the hyperlink text.
Implements
InsertHyperlink(HyperlinkInfo, string)
Inserts a hyperlink with the specified text into the document at the current position.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)Parameters
hyperlinkInfo
The hyperlink information containing URL, tooltip, and other link properties.
hyperlinkText
The text to display for the hyperlink.
InsertImage(Stream, string)
Inserts an image as an inline element into the document at the current position.
InsertInline(Inline)
Inserts inline element into the document.
Declaration
public void InsertInline(Inline inline)Parameters
inline
The inline element to insert.
Implements
InsertInline(Inline, DocumentPosition)
Inserts inline element into the document.
Declaration
public void InsertInline(Inline inline, DocumentPosition documentPosition)Parameters
inline
The inline element to insert.
documentPosition
The document position to insert the inline at.
Implements
InsertLine(string)
Inserts text and adds new paragraph after it.
Declaration
public void InsertLine(string text)Parameters
text
The text.
Implements
InsertLineBreak()
Inserts a line break at the current caret position, creating a new line without starting a new paragraph.
Declaration
public void InsertLineBreak()Implements
InsertNonBreakingSpace()
Inserts a non-breaking space into the document at the current caret position.
Declaration
public void InsertNonBreakingSpace()InsertPageBreak()
Inserts a page break at the current caret position, forcing the following content to begin on a new page.
Declaration
public void InsertPageBreak()Implements
InsertParagraph()
Inserts a new paragraph.
Declaration
public void InsertParagraph()Implements
InsertPermissionRange(IEnumerable<PermissionRangeInfo>)
Inserts a new permission range at the current selection, allowing control over who can edit specific parts of the document.
Declaration
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)Parameters
permissionInfos
IEnumerable<PermissionRangeInfo>
A collection of permission settings that define user access rights for the new range.
Implements
InsertReadOnlyRange()
Inserts a read only range.
Declaration
public void InsertReadOnlyRange()Implements
InsertSectionBreak()
Inserts a section break at the current caret position, using the default NextPage section break type.
Declaration
public void InsertSectionBreak()Implements
InsertSectionBreak(SectionBreakType)
Inserts a section break of the specified type at the current caret position, allowing independent formatting of different sections.
Declaration
public void InsertSectionBreak(SectionBreakType sectionBreakType)Parameters
sectionBreakType
The type of the section break to insert.
Implements
InsertStructuredDocumentTag()
Inserts a default structured document tag (Content Control) at the current selection. The default type is RichText.
Declaration
public void InsertStructuredDocumentTag()InsertStructuredDocumentTag(SdtProperties)
Inserts a structured document tag (Content Control) with the specified properties at the current selection.
Declaration
public void InsertStructuredDocumentTag(SdtProperties insertProperties)Parameters
insertProperties
The properties to configure the structured document tag.
InsertStructuredDocumentTag(SdtType)
Inserts a structured document tag (Content Control) of the specified type at the current selection.
Declaration
public void InsertStructuredDocumentTag(SdtType insertType)Parameters
insertType
The type of structured document tag to insert.
InsertTable(Table)
Inserts the given table at the current caret position with a paragraph before it. This is a convenience method that calls InsertTable(table, true).
Declaration
public void InsertTable(Table table)Parameters
table
The table to insert.
Implements
InsertTable(Table, bool)
Inserts the given table at the current caret position with an option to include a paragraph before it.
Declaration
public void InsertTable(Table table, bool shouldInsertParagraphBeforeTable)Parameters
table
The table to insert.
shouldInsertParagraphBeforeTable
Indicates whether a new paragraph should be inserted before the table.
Remarks
The Table instance inserted in the document is a cloning of the one passed for the table parameter. Making subsequent changes to the Table is not possible.
InsertTable(int, int)
Inserts a new table with the specified number of rows and columns at the current caret position.
InsertTable(int, int, bool)
Inserts a new table with the specified number of rows and columns at the current caret position.
InsertTableColumn()
Inserts a column to the right of the last table column.
Declaration
public void InsertTableColumn()Implements
InsertTableColumnToTheLeft()
Inserts a column to the left of the current column.
Declaration
public void InsertTableColumnToTheLeft()Implements
InsertTableColumnToTheRight()
Inserts a column to the right of the current column.
Declaration
public void InsertTableColumnToTheRight()Implements
InsertTableRow()
Inserts a row at the bottom of the table.
Declaration
public void InsertTableRow()Implements
InsertTableRowAbove()
Inserts a row above the current row in the table.
Declaration
public void InsertTableRowAbove()Implements
InsertTableRowBelow()
Inserts a row below the current row in the table.
Declaration
public void InsertTableRowBelow()Implements
InvalidateEditorLayout()
Invalidates the active editor presenter layout, causing the editor to remeasure and rearrange its elements.
Declaration
public void InvalidateEditorLayout()InvalidateProofingErrors(bool)
Clears the spell-checking state of words in the document and updates the UI to reflect the changes.
Declaration
public void InvalidateProofingErrors(bool invalidateIncorrectWordsOnly)Parameters
invalidateIncorrectWordsOnly
True to invalidate only words marked as incorrect, false to invalidate all words.
MailMerge(bool)
Produces a mail merge document for all the mail merge data records.
Declaration
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)Parameters
startEachRecordOnNewPage
true if each record should start on a new page.
Returns
The document
Implements
MailMergeCurrentRecord()
Produces a mail merge document for the current mail merge data record.
Declaration
public RadDocument MailMergeCurrentRecord()Returns
The document
Implements
MeasureOverride(SizeF)
Measures the space required by the RadElement
Used by the layout system.
Declaration
protected override SizeF MeasureOverride(SizeF availableSize)Parameters
availableSize
The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides
Remarks
In this method call to the Measure method of each child must be made.
MergeTableCells()
Merges the currently selected cells.
Declaration
public void MergeTableCells()Implements
MoveSelection(DocumentPosition, bool)
Moves current document selection to a specified position.
Declaration
public void MoveSelection(DocumentPosition position, bool deleteSelection)Parameters
position
The move position.
deleteSelection
Indicates whether the current selection should be deleted.
Implements
OnApplyTemplate()
Called when the template is applied to the control.
Declaration
public override void OnApplyTemplate()Overrides
OnBeforeOpenFile(OpenFileDialogEventArgs)
Raises the BeforeOpenFile event before a file is opened.
Declaration
protected virtual void OnBeforeOpenFile(OpenFileDialogEventArgs args)Parameters
args
An OpenFileDialogEventArgs object that contains the event data.
Remarks
This method is called to trigger the BeforeOpenFile event, allowing subscribers to perform actions before a file is opened. Override this method in a derived class to provide additional functionality when the event is raised.
OnBeforeSaveFile(SaveFileDialogEventArgs)
Raises the BeforeSaveFile event before a file is saved.
Declaration
protected virtual void OnBeforeSaveFile(SaveFileDialogEventArgs e)Parameters
e
An SaveFileDialogEventArgs object that contains the event data.
Remarks
This method is called to trigger the BeforeSaveFile event, allowing subscribers to perform actions before the file save operation occurs.
OnBoundsChanged(RadPropertyChangedEventArgs)
Declaration
protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)Parameters
e
Overrides
OnBubbleEvent(RadElement, RoutedEventArgs)
Called when the bubble phase of a routed event occurs.
Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)Parameters
sender
The element that originally raised the event.
args
The routed event arguments.
Overrides
OnCommandError(CommandErrorEventArgs)
Raises the event.
Declaration
protected virtual void OnCommandError(CommandErrorEventArgs args)Parameters
args
The CommandErrorEventArgs instance containing the event data.
OnCommandExecuted(CommandExecutedEventArgs)
Raises the event.
Declaration
protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)Parameters
e
The CommandExecutedEventArgs instance containing the event data.
OnCommandExecuting(CommandExecutingEventArgs)
Raises the event.
Declaration
protected virtual void OnCommandExecuting(CommandExecutingEventArgs e)Parameters
e
The CommandExecutingEventArgs instance containing the event data.
OnCommentShowing(CommentShowingEventArgs)
Raises the event.
Declaration
protected virtual void OnCommentShowing(CommentShowingEventArgs e)Parameters
e
The CommentShowingEventArgs instance containing the event data.
OnCurrentEditingStyleChanged()
Raises the event.
Declaration
protected virtual void OnCurrentEditingStyleChanged()OnCurrentParagraphStyleChanged()
Raises the event.
Declaration
protected virtual void OnCurrentParagraphStyleChanged()OnCurrentSpanStyleChanged()
Raises the CurrentSpanStyleChanged event.
Declaration
protected virtual void OnCurrentSpanStyleChanged()OnCurrentVisiblePageChanged()
Raises the event.
Declaration
protected virtual void OnCurrentVisiblePageChanged()OnDocumentArranged()
Raises the DocumentArranged event.
Declaration
protected virtual void OnDocumentArranged()OnDocumentChanged()
Raises the DocumentChanged event.
Declaration
protected virtual void OnDocumentChanged()OnDocumentChanging()
Raises the DocumentChanging event.
Declaration
protected virtual void OnDocumentChanging()OnDocumentContentChanged()
Raises the DocumentContentChanged event.
Declaration
protected virtual void OnDocumentContentChanged()OnDocumentLayoutModeChanged()
Raises the DocumentLayoutModeChanged event.
Declaration
protected virtual void OnDocumentLayoutModeChanged()OnDocumentPresentationChanged(PresentationChangedEventArgs)
Raises the DocumentPresentationChanged event.
Declaration
protected virtual void OnDocumentPresentationChanged(PresentationChangedEventArgs e)Parameters
e
The PresentationChangedEventArgs instance containing the event data.
OnGotFocus(EventArgs)
Declaration
protected override void OnGotFocus(EventArgs e)Parameters
e
Overrides
OnHyperlinkClicked(object, HyperlinkClickedEventArgs)
Raises the event.
Declaration
protected virtual void OnHyperlinkClicked(object sender, HyperlinkClickedEventArgs eventArgs)Parameters
sender
The sender of the event.
eventArgs
The HyperlinkClickedEventArgs instance containing the event data.
OnIsReadOnlyChanged(EventArgs)
Raises the event.
OnLoaded()
Called when the control is loaded.
Declaration
protected override void OnLoaded()Overrides
OnLostFocus(EventArgs)
Declaration
protected override void OnLostFocus(EventArgs e)Parameters
e
Overrides
OnMergeFieldToStringConverting(object, MergeFieldToStringConvertingEventArgs)
Raises the event.
Declaration
protected virtual void OnMergeFieldToStringConverting(object sender, MergeFieldToStringConvertingEventArgs e)Parameters
sender
The sender of the event.
e
MergeFieldToStringConvertingEventArgs
The MergeFieldToStringConvertingEventArgs instance containing the event data.
OnNoteReferenceClicked(MouseButtonEventArgs)
Raises the event.
Declaration
protected virtual void OnNoteReferenceClicked(MouseButtonEventArgs args)Parameters
args
The MouseButtonEventArgs instance containing the event data.
OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs)
Raises the event.
Declaration
protected virtual void OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs e)Parameters
e
The PreviewEditorKeyEventArgs instance containing the event data.
OnPrintCompleted(PrintCompletedEventArgs)
Raises the event.
Declaration
protected virtual void OnPrintCompleted(PrintCompletedEventArgs e)Parameters
e
The PrintCompletedEventArgs instance containing the event data.
OnPrintStarted(EventArgs)
Raises the event.
OnPropertyChanged(RadPropertyChangedEventArgs)
Called when a property value has changed, allowing for custom response to property changes.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Parameters
e
The property changed event arguments.
Overrides
OnProtectionStateChanged()
Raises the ProtectionStateChanged event.
Declaration
protected virtual void OnProtectionStateChanged()OnProviderUILayerInitialized(ProviderUILayerBase, Canvas, UILayerUpdateContext)
Declaration
protected virtual void OnProviderUILayerInitialized(ProviderUILayerBase layer, Canvas container, UILayerUpdateContext context)Parameters
layer
container
context
OnScaleFactorChanged()
Raises the event.
Declaration
protected virtual void OnScaleFactorChanged()OnSelectionChanged(EventArgs)
Raises the event.
OnStreamFromUriResolving(StreamFromUriResolvingEventArgs)
Raises the event.
Declaration
protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)Parameters
e
StreamFromUriResolvingEventArgs
The StreamFromUriResolvingEventArgs instance containing the event data.
OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs)
Raises the event.
Declaration
protected virtual void OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs e)Parameters
e
UntrackableCommandExecutingEventArgs
The UntrackableCommandExecutingEventArgs instance containing the event data.
OnUserInfoChanged()
Raises the UserInfoChanged event.
Declaration
protected virtual void OnUserInfoChanged()OpenContextMenuOnNextSpellingError()
Opens the context menu next to the next spelling error in the document.
Declaration
public void OpenContextMenuOnNextSpellingError()Paste()
Pastes the content of the clipboard into the document.
Declaration
public void Paste()Implements
Paste(PasteOption)
Pastes the content of the clipboard into the document using the specified paste option.
Declaration
public void Paste(PasteOption pasteOption)Parameters
pasteOption
Implements
PasteFormatting()
Pastes the currently copied formatting on the current selection.
Declaration
public bool PasteFormatting()Returns
A value indicating whether the paste was successful.
Implements
PreviewFirstMailMergeDataRecord()
Previews the first mail merge data record.
PreviewLastMailMergeDataRecord()
Previews the last mail merge data record.
PreviewMailMergeDataRecordAtIndex(int)
Previews the the mail merge data record at a specified index.
PreviewNextMailMergeDataRecord()
Previews the next mail merge data record.
PreviewPreviousMailMergeDataRecord()
Previews the previous mail merge data record.
Declaration
public bool PreviewPreviousMailMergeDataRecord()Returns
Implements
Print()
Directly prints the RadRichTextEditor document to the default printer.
Declaration
public virtual void Print()Print(bool)
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
showPrinterSettings
Indicates whether printer settings dialog should be shown.
Print(bool, 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
showPrinterSettings
Indicates whether printer settings dialog should be shown.
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
document
As instance of RadPrintDocument used to control the print process.
Redo()
Re-executes the last undone command group.
Declaration
public void Redo()Implements
RejectAllRevisions()
Rejects all revisions in the current document.
Declaration
public void RejectAllRevisions()Implements
RejectRevision(Revision)
Rejects revision.
Declaration
public void RejectRevision(Revision revision)Parameters
revision
The revision.
Implements
RemoveHyperlink()
Removes the hyperlink on the caret position.
Declaration
public void RemoveHyperlink()RemoveTabStop(TabStop)
Removes the given tab stop from the currently selected paragraphs.
Declaration
public void RemoveTabStop(TabStop tabStop)Parameters
tabStop
The tab stop to be removed.
Implements
RemoveTabStopRange(IEnumerable<TabStop>)
Removes the enumeration of tab stops.
Declaration
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)Parameters
tabStops
The tab stops to remove.
Implements
ReplaceTabStop(TabStop, TabStop)
Replaces the old tab stop with the new one in the currently selected paragraphs.
ResetFormatPainter()
Declaration
protected virtual void ResetFormatPainter()ResizeTableColumn(Table, int, double)
Changes the width of the column at the specified index in the given table.
RestartListNumbering()
Creates a new list from the current paragraph. The paragraph should be in list, otherwise this method does nothing.
ScrollToNote(Note)
Scrolls the viewport so that a note becomes visible.
Declaration
public void ScrollToNote(Note note)Parameters
note
The note.
Implements
SetSelectedComment(CommentRangeStart)
Sets the provided comment as selected.
Declaration
public void SetSelectedComment(CommentRangeStart commentStart)Parameters
commentStart
The comment to select.
SetSelectedNote(Note)
Sets the provided note as selected.
Declaration
public void SetSelectedNote(Note note)Parameters
note
The note to select.
SetWatermark(DocumentWatermarkSettings)
Sets a watermark with the provided settings.
Declaration
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)Parameters
watermarkSettings
The settings to apply to the watermark.
Implements
SetWatermark(PredefinedWatermarkType)
Sets one of the predefined watermarks.
Declaration
public void SetWatermark(PredefinedWatermarkType predefinedType)Parameters
predefinedType
The predefined watermark to apply.
Implements
SetWatermarkImage(WatermarkImageSettings)
Sets an image watermark with the provided settings.
Declaration
public void SetWatermarkImage(WatermarkImageSettings settings)Parameters
settings
The settings to apply to the watermark.
SetWatermarkText(WatermarkTextSettings)
Sets a text watermark with the provided settings.
Declaration
public void SetWatermarkText(WatermarkTextSettings settings)Parameters
settings
The settings to apply to the watermark.
ShouldArrangeChild(RadElement)
Gets a value indicating whether a child will be arranged during the ArrangeOverride(SizeF).
Declaration
protected override bool ShouldArrangeChild(RadElement child)Parameters
child
The child element to check.
Returns
Whether the child will be arranged in ArrangeOverride.
Overrides
ShouldCreateNewContextMenu(IContextMenu)
Declaration
protected virtual bool ShouldCreateNewContextMenu(IContextMenu menu)Parameters
menu
Returns
ShouldMeasureChild(RadElement)
Gets a value indicating, whether a child will be measured during the MeasureOverride.
Declaration
protected override bool ShouldMeasureChild(RadElement child)Parameters
child
The child.
Returns
Whether the child will be measured in MeasureOverride.
Overrides
ShowAddNewBibliographicSourceDialog(string, bool, Action<BibliographicSource>)
Shows the Add New Bibliographic Source Dialog.
Declaration
public void ShowAddNewBibliographicSourceDialog(string sourceName = null, bool insertFieldOnClose = true, Action<BibliographicSource> callBackOnClosed = null)Parameters
sourceName
insertFieldOnClose
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(DocumentPosition)
Opens the context menu at the specified document position.
Declaration
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)Parameters
position
The DocumentPosition where the context menu will be opened.
ShowContextMenuAtDocumentPosition(Point, DocumentPosition)
Opens the context menu at the specified document position.
Declaration
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)Parameters
proposedLocation
A point where the context menu should appear without taking into account element obstruction.
position
The DocumentPosition for indicating the element for which the context menu is being shown.
ShowDefineNewListStyleDialog()
Shows dialog for creating new list style.
Declaration
public void ShowDefineNewListStyleDialog()ShowEditCustomDictionaryDialog()
Shows the dialog for editing custom spellchecking 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
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()ShowLineNumberingDialog()
Show the line numbers dialog.
Declaration
public void ShowLineNumberingDialog()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()ShowParagraphPropertiesDialog()
Shows the paragraph properties dialog.
Declaration
public void ShowParagraphPropertiesDialog()ShowProtectDocumentDialog()
Shows the dialog for enforcing document protection.
Declaration
public void ShowProtectDocumentDialog()ShowSectionColumnsDialog()
Shows the section columns dialog.
Declaration
public void ShowSectionColumnsDialog()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
ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings)
Shows the style formatting properties dialog.
Declaration
public void ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings settings)Parameters
settings
StyleFormattingPropertiesDialogSettings
The settings.
ShowTabStopsPropertiesDialog()
Shows the dialog for editing tab stops.
Declaration
public void ShowTabStopsPropertiesDialog()ShowTableBordersDialog()
Shows the table borders dialog.
Declaration
public void ShowTableBordersDialog()ShowTablePropertiesDialog()
Shows the table properties dialog.
Declaration
public void ShowTablePropertiesDialog()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
rangeStart
The start of the range that is to be split.
Implements
SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)
Splits an annotation range at the specified position.
Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)Parameters
rangeStart
The start of the range that is to be split.
position
The position where the range is to be split.
Implements
SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph>)
Suppress the line numbering for selected paragraphs.
Declaration
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)Parameters
paragraphs
Implements
ToggleBold()
Toggles the bold state of the current run in the document.
Declaration
public void ToggleBold()Implements
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()
Toggles between different first page header and footer and same header and footer for all pages.
Declaration
public void ToggleDifferentFirstPageHeaderFooter()ToggleDifferentOddAndEvenPagesHeaderFooter()
Toggles between different odd and eventpage header and footer and same header and footer for all pages.
Declaration
public void ToggleDifferentOddAndEvenPagesHeaderFooter()ToggleFieldCodes(FieldRangeStart)
Toggles the display mode of a field.
Declaration
public void ToggleFieldCodes(FieldRangeStart fieldStart)Parameters
fieldStart
The field start.
Implements
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()Implements
ToggleMergeFieldsHighlight()
Toggles between highlighting and not highlighting Merge Fields.
Declaration
public void ToggleMergeFieldsHighlight()ToggleStrikethrough()
Toggles the subscript state of the current run in the document.
Declaration
public void ToggleStrikethrough()Implements
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()Implements
UnmergeTableCells()
Unmerges the currently selected cells.
Declaration
public void UnmergeTableCells()Implements
UpdateAllCaptions(CaptionDefinition)
Updates all captions related to caption definition.
Declaration
public void UpdateAllCaptions(CaptionDefinition captionDefinition)Parameters
captionDefinition
The caption definition.
Implements
UpdateAllFields()
Updates all fields in the document.
Declaration
public void UpdateAllFields()Implements
UpdateAllFields(FieldDisplayMode)
Updates all fields and displays them in the specified display mode.
Declaration
public void UpdateAllFields(FieldDisplayMode displayMode)Parameters
displayMode
The display mode.
Implements
UpdateEditorLayout()
Forces the control to update its layout and UI;
Declaration
public void UpdateEditorLayout()Implements
UpdateEditorLayout(bool)
Forces the control to update its layout and UI.
Declaration
public void UpdateEditorLayout(bool async)Parameters
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
fieldStart
The field start.
Implements
UpdateFooter(Section, HeaderFooterType, Footer)
Updates the footer for a section.
Declaration
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)Parameters
section
The section of the footer.
footerType
Type of the 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
The section of the header.
headerType
Type of the header.
header
The header.
Events
ActiveDocumentEditorChanged
Occurs when active document editor changes.
Declaration
public event EventHandler<ActiveDocumentEditorChangedEventArgs> ActiveDocumentEditorChangedEvent Value
BeforeOpenFile
Occurs before a file is opened, before the open file dialog is shown.
Declaration
public event EventHandler<OpenFileDialogEventArgs> BeforeOpenFileEvent Value
Remarks
Subscribe to this event to customize the OpenFileDialog properties (like Filter, InitialDirectory, etc.) before it is displayed to the user. Handlers can also cancel the open file operation by setting the Cancel property of the event arguments to true.
BeforeSaveFile
Occurs before the file is saved, before the save file dialog is shown.
Declaration
public event EventHandler<SaveFileDialogEventArgs> BeforeSaveFileEvent Value
Remarks
Subscribe to this event to customize the SaveFileDialog properties (like Filter, InitialDirectory, etc.) before it is displayed to the user. Handlers can also cancel the open file operation by setting the Cancel property of the event arguments to true.
CommandError
Occurs on error while executing command.
Declaration
public event EventHandler<CommandErrorEventArgs> CommandErrorEvent Value
CommandExecuted
Occurs after the execution of RichTextBoxCommandBase.
Declaration
public event EventHandler<CommandExecutedEventArgs> CommandExecutedEvent Value
CommandExecuting
Occurs before the execution of RichTextBoxCommandBase.
Declaration
public event EventHandler<CommandExecutingEventArgs> CommandExecutingEvent Value
CommentShowing
Occurs when showing comment.
Declaration
public event EventHandler<CommentShowingEventArgs> CommentShowingEvent Value
CurrentEditingStyleChanged
Occurs when the current editing style has changed.
Declaration
public event EventHandler CurrentEditingStyleChangedEvent Value
CurrentParagraphStyleChanged
Occurs when the current paragraph's style has changed.
Declaration
public event EventHandler CurrentParagraphStyleChangedEvent Value
CurrentSpanStyleChanged
Occurs when the current span's style has changed.
Declaration
public event EventHandler CurrentSpanStyleChangedEvent Value
CurrentVisiblePageChanged
Occurs when the CurrentPage property value has changed.
Declaration
public event EventHandler CurrentVisiblePageChangedEvent Value
DocumentArranged
Occurs when the current document has been arranged.
DocumentChanged
Occurs when the current document has changed.
DocumentChanging
Occurs when the current document is changing.
DocumentContentChanged
Occurs when the content of the current document has changed.
Declaration
public event EventHandler DocumentContentChangedEvent Value
DocumentLayoutModeChanged
Occurs when the layout mode of the current document has changed.
Declaration
public event EventHandler DocumentLayoutModeChangedEvent Value
DocumentPresentationChanged
Occurs when the presentation of the current document has changed.
Declaration
public event EventHandler<PresentationChangedEventArgs> DocumentPresentationChangedEvent Value
HyperlinkClicked
Occurs when the users clicks on a hyperlink in the current document.
Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClickedEvent Value
IsInHeaderFooterEditModeChanged
Occurs when going in or out of header/footer editing mode.
Declaration
public event EventHandler IsInHeaderFooterEditModeChangedEvent Value
IsReadOnlyChanged
Occurs when IsReadOnly property changes.
MergeFieldToStringConverting
Occurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it becames a result string value.
Declaration
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConvertingEvent Value
PreviewEditorKeyDown
Occurs when a key is pressed while and editor is focused.
Declaration
public event PreviewEditorKeyEventHandler PreviewEditorKeyDownEvent Value
PrintCompleted
Occurs when print is completed.
Declaration
public event EventHandler<PrintCompletedEventArgs> PrintCompletedEvent Value
PrintStarted
Occurs when printing has started.
ProtectionStateChanged
Occurs when the current protection state has changed.
Declaration
public event EventHandler ProtectionStateChangedEvent Value
Implements
ProviderUILayerInitialized
Occurs when the child elements of an UI layer have been initialized and added to its container.
Declaration
public event EventHandler<ProviderUILayerInitilizedEventArgs> ProviderUILayerInitializedEvent Value
ScaleFactorChanged
Occurs when the ScaleFactor property value has changed.
Declaration
public event EventHandler ScaleFactorChangedEvent Value
Implements
SelectedLayoutBoxChanged
Occurs when currently selected layout box has changed.
Declaration
public event EventHandler<SelectedLayoutBoxChangedEventArgs> SelectedLayoutBoxChangedEvent Value
SelectionChanged
Occurs when selection is changed.
StreamFromUriResolving
Occurs when resolving a URI tfor a stram object.
Declaration
public event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolvingEvent Value
UntrackableCommandExecuting
Occurs when executing command that does not support track changes and track changes are enabled.
Declaration
public event EventHandler<UntrackableCommandExecutingEventArgs> UntrackableCommandExecutingEvent Value
UserInfoChanged
Occurs when the current user info has changed.