Class RadRichTextBox

Represents rich text box control, which can be used to visualize and edit RadDocument.

Inheritance
System.Object
RadRichTextBox
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Documents.dll

Syntax

[TelerikToolboxCategory("Documents")]
public class RadRichTextBox : Control, IDocumentEditorPresenterContainer, IDocumentEditor, ITextInputCommandsHandler

Constructors

RadRichTextBox()

Initializes a new instance of the RadRichTextBox class.

Declaration
public RadRichTextBox()

Fields

AcceptsReturnProperty

Declaration
public static readonly DependencyProperty AcceptsReturnProperty
Field Value
System.Windows.DependencyProperty

AcceptsTabProperty

Declaration
public static readonly DependencyProperty AcceptsTabProperty
Field Value
System.Windows.DependencyProperty

AllowScalingProperty

Declaration
public static readonly DependencyProperty AllowScalingProperty
Field Value
System.Windows.DependencyProperty

CaretColorProperty

Declaration
public static readonly DependencyProperty CaretColorProperty
Field Value
System.Windows.DependencyProperty

CommandsProperty

Declaration
public static readonly DependencyProperty CommandsProperty
Field Value
System.Windows.DependencyProperty

CommentTemplateContentMarginProperty

Declaration
public static readonly DependencyProperty CommentTemplateContentMarginProperty
Field Value
System.Windows.DependencyProperty

CurrentUserProperty

Declaration
public static readonly DependencyProperty CurrentUserProperty
Field Value
System.Windows.DependencyProperty

DocumentInheritsDefaultStyleSettingsProperty

Declaration
public static readonly DependencyProperty DocumentInheritsDefaultStyleSettingsProperty
Field Value
System.Windows.DependencyProperty

EnforcedPermissionRangeBrushProperty

Declaration
public static readonly DependencyProperty EnforcedPermissionRangeBrushProperty
Field Value
System.Windows.DependencyProperty

HorizontalScrollBarName

Declaration
public const string HorizontalScrollBarName = "HorizontalScrollBar"
Field Value
System.String

HorizontalScrollBarVisibilityProperty

Declaration
public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty
Field Value
System.Windows.DependencyProperty

HyperlinkNavigationModeProperty

Declaration
public static readonly DependencyProperty HyperlinkNavigationModeProperty
Field Value
System.Windows.DependencyProperty

HyperlinkToolTipFormatStringProperty

Declaration
public static readonly DependencyProperty HyperlinkToolTipFormatStringProperty
Field Value
System.Windows.DependencyProperty

IsAdvancedSelectionEnabledProperty

Declaration
public static readonly DependencyProperty IsAdvancedSelectionEnabledProperty
Field Value
System.Windows.DependencyProperty

IsContextMenuEnabledProperty

Declaration
public static readonly DependencyProperty IsContextMenuEnabledProperty
Field Value
System.Windows.DependencyProperty

IsFocusableProperty

Declaration
public static readonly DependencyProperty IsFocusableProperty
Field Value
System.Windows.DependencyProperty

IsImageMiniToolBarEnabledProperty

Declaration
public static readonly DependencyProperty IsImageMiniToolBarEnabledProperty
Field Value
System.Windows.DependencyProperty

IsPasteOptionsPopupEnabledProperty

Represents the IsPasteOptionsPopupEnabled dependency property.

Declaration
public static readonly DependencyProperty IsPasteOptionsPopupEnabledProperty
Field Value
System.Windows.DependencyProperty

IsReadOnlyProperty

Declaration
public static readonly DependencyProperty IsReadOnlyProperty
Field Value
System.Windows.DependencyProperty

IsSelectionEnabledProperty

Declaration
public static readonly DependencyProperty IsSelectionEnabledProperty
Field Value
System.Windows.DependencyProperty

IsSelectionMiniToolBarEnabledProperty

Declaration
public static readonly DependencyProperty IsSelectionMiniToolBarEnabledProperty
Field Value
System.Windows.DependencyProperty

IsSpellCheckingEnabledProperty

Declaration
public static readonly DependencyProperty IsSpellCheckingEnabledProperty
Field Value
System.Windows.DependencyProperty

IsTrackChangesEnabledProperty

Declaration
public static readonly DependencyProperty IsTrackChangesEnabledProperty
Field Value
System.Windows.DependencyProperty

LayoutModeProperty

Declaration
public static readonly DependencyProperty LayoutModeProperty
Field Value
System.Windows.DependencyProperty

LineBreakingRuleLanguageProperty

Declaration
public static readonly DependencyProperty LineBreakingRuleLanguageProperty
Field Value
System.Windows.DependencyProperty

MaxScaleFactor

Represents the maximum scale factor the control supports.

Declaration
public static readonly double MaxScaleFactor
Field Value
System.Double

MeasuringPanelName

Declaration
public const string MeasuringPanelName = "MeasuringPanel"
Field Value
System.String

MinScaleFactor

Represents the minimum scale factor the control supports.

Declaration
public static readonly double MinScaleFactor
Field Value
System.Double

MouseOverBorderThicknessProperty

Declaration
public static readonly DependencyProperty MouseOverBorderThicknessProperty
Field Value
System.Windows.DependencyProperty

PrintingScreenName

Declaration
public const string PrintingScreenName = "PrintingScreen"
Field Value
System.String

ProtectionAuthenticationProviderProperty

Declaration
public static readonly DependencyProperty ProtectionAuthenticationProviderProperty
Field Value
System.Windows.DependencyProperty

ScaleFactorProperty

Declaration
public static readonly DependencyProperty ScaleFactorProperty
Field Value
System.Windows.DependencyProperty

SelectionFillProperty

Declaration
public static readonly DependencyProperty SelectionFillProperty
Field Value
System.Windows.DependencyProperty

SelectionStrokeProperty

Declaration
public static readonly DependencyProperty SelectionStrokeProperty
Field Value
System.Windows.DependencyProperty

ShowCommentsProperty

Declaration
public static readonly DependencyProperty ShowCommentsProperty
Field Value
System.Windows.DependencyProperty

ShowFormattingSymbolsProperty

Declaration
public static readonly DependencyProperty ShowFormattingSymbolsProperty
Field Value
System.Windows.DependencyProperty

ShowMergeFieldsHighlightProperty

Declaration
public static readonly DependencyProperty ShowMergeFieldsHighlightProperty
Field Value
System.Windows.DependencyProperty

VerticalScrollBarName

Declaration
public const string VerticalScrollBarName = "VerticalScrollBar"
Field Value
System.String

VerticalScrollBarVisibilityProperty

Declaration
public static readonly DependencyProperty VerticalScrollBarVisibilityProperty
Field Value
System.Windows.DependencyProperty

ViewContentPresenter

Declaration
public const string ViewContentPresenter = "ViewPresenter"
Field Value
System.String

Properties

AcceptsReturn

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

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

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.

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

Implements

ActiveDocumentEditor

Declaration
public IDocumentEditor ActiveDocumentEditor { get; }
Property Value
IDocumentEditor

ActiveEditorPresenter

Gets or sets a value representing the active document presenter.

Declaration
public IDocumentEditorPresenter ActiveEditorPresenter { get; set; }
Property Value
IDocumentEditorPresenter

AddNewBibliographicSourceDialog

Gets or sets a value representing the current add new bibliographic reference dialog instance.

Declaration
public IAddNewBibliographicSourceDialog AddNewBibliographicSourceDialog { get; set; }
Property Value
IAddNewBibliographicSourceDialog

AllowScaling

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

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

Implements

CaretColor

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

Implements

CaretFactory

Declaration
public ICaretFactory CaretFactory { get; set; }
Property Value
ICaretFactory

Implements

ChangeEditingPermissionsDialog

Gets or sets a value representing the current dialog for changing document permissions.

Declaration
public IChangeEditingPermissionsDialog ChangeEditingPermissionsDialog { get; set; }
Property Value
IChangeEditingPermissionsDialog

ChangeFontFamilyCommand

Deprecated.

Declaration
public ChangeFontFamilyCommand ChangeFontFamilyCommand { get; }
Property Value
ChangeFontFamilyCommand

ChangeFontForeColorCommand

Deprecated.

Declaration
public ChangeFontForeColorCommand ChangeFontForeColorCommand { get; }
Property Value
ChangeFontForeColorCommand

ChangeFontHighlightColorCommand

Deprecated.

Declaration
public ChangeFontHighlightColorCommand ChangeFontHighlightColorCommand { get; }
Property Value
ChangeFontHighlightColorCommand

ChangeFontSizeCommand

Deprecated.

Declaration
public ChangeFontSizeCommand ChangeFontSizeCommand { get; }
Property Value
ChangeFontSizeCommand

ChangeLayoutModeCommand

Deprecated.

Declaration
public ChangeLayoutModeCommand ChangeLayoutModeCommand { get; }
Property Value
ChangeLayoutModeCommand

ChangePageMarginsCommand

Deprecated.

Declaration
public ChangePageMarginsTypeCommand ChangePageMarginsCommand { get; }
Property Value
ChangePageMarginsTypeCommand

ChangePaperTypeCommand

Deprecated.

Declaration
public ChangePaperTypeCommand ChangePaperTypeCommand { get; }
Property Value
ChangePaperTypeCommand

ChangeTextAlignmentCommand

Deprecated.

Declaration
public ChangeTextAlignmentCommand ChangeTextAlignmentCommand { get; }
Property Value
ChangeTextAlignmentCommand

ChangeUnderlineDecorationCommand

Deprecated.

Declaration
public ChangeUnderlineDecorationCommand ChangeUnderlineDecorationCommand { get; }
Property Value
ChangeUnderlineDecorationCommand

ClearFormattingCommand

Deprecated.

Declaration
public ClearFormattingCommand ClearFormattingCommand { get; }
Property Value
ClearFormattingCommand

CodeFormattingDialog

Gets or sets a value representing the current code formatting dialog instance.

Declaration
public ICodeFormattingDialog CodeFormattingDialog { get; set; }
Property Value
ICodeFormattingDialog

Commands

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

CommentPaneMinWidth

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

Implements

CommentTemplateContentMargin

Gets or sets the comment template content margin.

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

Implements

ContextMenu

Gets or sets a value representing the current context menu.

Declaration
public IContextMenu ContextMenu { get; set; }
Property Value
IContextMenu

CopyCommand

Deprecated.

Declaration
public CopyCommand CopyCommand { get; }
Property Value
CopyCommand

CurrentEditingContext

Declaration
public EditingContext CurrentEditingContext { get; }
Property Value
EditingContext

Implements

CurrentEditingStyle

Gets a value indicating the current editing style.

Declaration
public StyleDefinition CurrentEditingStyle { get; }
Property Value
StyleDefinition

Implements

CurrentUser

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

CurrentVisiblePage

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

CutCommand

Deprecated.

Declaration
public CutCommand CutCommand { get; }
Property Value
CutCommand

DecrementFontSizeCommand

Deprecated.

Declaration
public DecrementFontSizeCommand DecrementFontSizeCommand { get; }
Property Value
DecrementFontSizeCommand

DecrementPageWidthCommand

Deprecated.

Declaration
public DecrementPageWidthCommand DecrementPageWidthCommand { get; }
Property Value
DecrementPageWidthCommand

DecrementParagraphLeftIndentCommand

Deprecated.

Declaration
public DecrementParagraphLeftIndentCommand DecrementParagraphLeftIndentCommand { get; }
Property Value
DecrementParagraphLeftIndentCommand

DefaultInputBindings

Declaration
public static InputBindingCollection DefaultInputBindings { get; }
Property Value
InputBindingCollection

DefaultStyleSettings

Gets a StyleDefinition instance that stores default values for span and paragraph properties. If DocumentInheritsDefaultStyleSettings is set to true, these properties are used as default style properties for the document elements in Document.

Declaration
public StyleDefinition DefaultStyleSettings { get; }
Property Value
StyleDefinition

See Also

Document

Gets or sets the current document.

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

Implements

DocumentInheritsDefaultStyleSettings

Gets or sets a value indicating whether FontFamily, FontSize, Foreground, FontWeight and FontStyle properties of this instance, or the properties from DefaultStyleSettings, should be used as default style properties for the document elements in Document.

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

See Also

EditCustomDictionaryDialog

Gets or sets a value representing the current instance of the dialog for editing custom dictionaries.

Declaration
public IEditCustomDictionaryDialog EditCustomDictionaryDialog { get; set; }
Property Value
IEditCustomDictionaryDialog

EmailPattern

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

Implements

EnforcedPermissionRangeBrush

Declaration
public Brush EnforcedPermissionRangeBrush { get; set; }
Property Value
System.Windows.Media.Brush

Implements

FieldShadingMode

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

Implements

FindReplaceDialog

Gets or sets a value representing the current find/replace dialog instance.

Declaration
public IFindReplaceDialog FindReplaceDialog { get; set; }
Property Value
IFindReplaceDialog

FloatingBlockPropertiesDialog

Gets or sets a value representing the current floating block properties dialog instance.

Declaration
public IFloatingBlockPropertiesDialog FloatingBlockPropertiesDialog { get; set; }
Property Value
IFloatingBlockPropertiesDialog

FontPropertiesDialog

Gets or sets a value representing the current font properties dialog instance.

Declaration
public IFontPropertiesDialog FontPropertiesDialog { get; set; }
Property Value
IFontPropertiesDialog

HorizontalOffset

Gets the horizontal scroll position.

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

HorizontalScrollBar

Gets the horizontal scroll bar instance of the control.

Declaration
public virtual ScrollBar HorizontalScrollBar { get; }
Property Value
System.Windows.Controls.Primitives.ScrollBar

HorizontalScrollBarVisibility

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

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
System.Windows.Controls.ScrollBarVisibility

HyperlinkNavigationMode

Gets or sets the hyperlink navigation mode.

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

The hyperlink navigation mode.

HyperlinkPattern

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

Implements

HyperlinkToolTipFormatString

Gets or sets the hyperlink tool tip text.

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

The hyperlink tool tip.

IgnoredWords

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

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

Implements
See Also

ImageEditorDialog

Gets or sets the image editor dialog.

Declaration
public IImageEditorDialog ImageEditorDialog { get; set; }
Property Value
IImageEditorDialog

The image editor dialog.

ImageMiniToolBar

Gets or sets the image mini toolbar.

Declaration
public IImageMiniToolBar ImageMiniToolBar { get; set; }
Property Value
IImageMiniToolBar

The image mini toolbar.

ImageSelectionAdornerSettings

Declaration
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }
Property Value
ImageSelectionAdornerSettings

Implements

IncrementFontSizeCommand

Deprecated.

Declaration
public IncrementFontSizeCommand IncrementFontSizeCommand { get; }
Property Value
IncrementFontSizeCommand

IncrementPageWidthCommand

Deprecated.

Declaration
public IncrementPageWidthCommand IncrementPageWidthCommand { get; }
Property Value
IncrementPageWidthCommand

IncrementParagraphLeftIndentCommand

Deprecated.

Declaration
public IncrementParagraphLeftIndentCommand IncrementParagraphLeftIndentCommand { get; }
Property Value
IncrementParagraphLeftIndentCommand

InputHandler

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

InsertCaptionDialog

Gets or sets a value representing the current Insert Caption dialog instance.

Declaration
public IInsertCaptionDialog InsertCaptionDialog { get; set; }
Property Value
IInsertCaptionDialog

InsertCrossReferenceWindow

Gets or sets a value representing the current insert cross-reference window instance.

Declaration
public IInsertCrossReferenceWindow InsertCrossReferenceWindow { get; set; }
Property Value
IInsertCrossReferenceWindow

InsertDateTimeDialog

Gets or sets a value representing the current spell checking dialog instance.

Declaration
public IInsertDateTimeDialog InsertDateTimeDialog { get; set; }
Property Value
IInsertDateTimeDialog

InsertHyperlinkDialog

Gets or sets a value representing the current insert-hyperlink dialog instance.

Declaration
public IInsertHyperlinkDialog InsertHyperlinkDialog { get; set; }
Property Value
IInsertHyperlinkDialog

InsertPageBreakCommand

Deprecated.

Declaration
public InsertPageBreakCommand InsertPageBreakCommand { get; }
Property Value
InsertPageBreakCommand

InsertPictureCommand

Deprecated.

Declaration
public InsertPictureCommand InsertPictureCommand { get; }
Property Value
InsertPictureCommand

InsertSymbolWindow

Gets or sets a value representing the current insert symbol window.

Declaration
public IInsertSymbolWindow InsertSymbolWindow { get; set; }
Property Value
IInsertSymbolWindow

InsertTableDialog

Gets or sets a value representing the current insert table dialog instance.

Declaration
public IInsertTableDialog InsertTableDialog { get; set; }
Property Value
IInsertTableDialog

InsertTableOfContentsDialog

Gets or sets a value representing the current insert Table of Contents window instance.

Declaration
public IInsertTableOfContentsDialog InsertTableOfContentsDialog { get; set; }
Property Value
IInsertTableOfContentsDialog

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
System.Boolean

IsContextMenuEnabled

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

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

IsFocusable

Gets or sets a value that indicates whether a control is included in tab navigation.

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

Implements

IsImageMiniToolBarEnabled

Gets or sets value indicating whether image mini toolBar is enabled.

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

IsInHeaderFooterEditMode

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

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
System.Boolean

true if this instance is paste options popup enabled; otherwise, false.

IsReadOnly

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

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

Implements

IsSelectionEnabled

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

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

IsSelectionMiniToolBarEnabled

Gets or sets value indicating whether selection mini toolBar is enabled.

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

IsSpellCheckingEnabled

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

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

Implements

IsTouchEnabled

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

IsTrackChangesEnabled

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

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

true if formatting symbols are shown; otherwise, false.

LayoutMode

Gets or sets the document layout mode.

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

The document layout mode.

LineBreakingRuleLanguage

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

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

The line breaking characters rule language.

ManageBibliographicSourcesDialog

Gets or sets a value representing the current Manage Bibliographic Sources reference dialog instance.

Declaration
public IManageBibliographicSourcesDialog ManageBibliographicSourcesDialog { get; set; }
Property Value
IManageBibliographicSourcesDialog

ManageBookmarksDialog

Gets or sets a value representing the current manage bookmark dialog instance.

Declaration
public IManageBookmarksDialog ManageBookmarksDialog { get; set; }
Property Value
IManageBookmarksDialog

ManageStylesDialog

Gets or sets a value representing the current manage styles dialog instance.

Declaration
public IManageStylesDialog ManageStylesDialog { get; set; }
Property Value
IManageStylesDialog

MouseOverBorderThickness

Declaration
public Thickness MouseOverBorderThickness { get; set; }
Property Value
System.Windows.Thickness

NewDocumentCommand

Deprecated.

Declaration
public NewDocumentCommand NewDocumentCommand { get; }
Property Value
NewDocumentCommand

NotesDialog

Gets or sets a value representing the current Notes dialog instance.

Declaration
public INotesDialog NotesDialog { get; set; }
Property Value
INotesDialog

OpenDocumentCommand

Deprecated.

Declaration
public OpenDocumentCommand OpenDocumentCommand { get; }
Property Value
OpenDocumentCommand

ParagraphPropertiesDialog

Gets or sets a value representing the current paragraph properties dialog.

Declaration
public IParagraphPropertiesDialog ParagraphPropertiesDialog { get; set; }
Property Value
IParagraphPropertiesDialog

PasteCommand

Deprecated.

Declaration
public PasteCommand PasteCommand { get; }
Property Value
PasteCommand

PrintCommand

Deprecated.

Declaration
public PrintCommand PrintCommand { get; }
Property Value
PrintCommand

ProtectDocumentDialog

Gets or sets a value representing the current dialog for enforcing document protection.

Declaration
public IProtectDocumentDialog ProtectDocumentDialog { get; set; }
Property Value
IProtectDocumentDialog

ProtectionAuthenticationProvider

Declaration
public IProtectionAuthenticationProvider ProtectionAuthenticationProvider { get; set; }
Property Value
IProtectionAuthenticationProvider

RedoCommand

Deprecated.

Declaration
public RedoCommand RedoCommand { get; }
Property Value
RedoCommand

SaveCommand

Deprecated.

Declaration
public SaveCommand SaveCommand { get; }
Property Value
SaveCommand

ScaleFactor

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

Declaration
public Size ScaleFactor { get; set; }
Property Value
System.Windows.Size

Implements

ScrollableHeight

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

ScrollableWidth

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

SectionColumnsDialog

Gets or sets a value representing the current section columns dialog.

Declaration
public ISectionColumnsDialog SectionColumnsDialog { get; set; }
Property Value
ISectionColumnsDialog

SelectedComment

Gets or sets the currently focused comment in the document

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

Implements

SelectedNote

Gets or sets the currently focused note

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

Implements

SelectionFill

Declaration
public Brush SelectionFill { get; set; }
Property Value
System.Windows.Media.Brush

Implements

SelectionMiniToolBar

Gets or sets a value representing the current selection mini toolbar.

Declaration
public ISelectionMiniToolBar SelectionMiniToolBar { get; set; }
Property Value
ISelectionMiniToolBar

SelectionStroke

Declaration
public Brush SelectionStroke { get; set; }
Property Value
System.Windows.Media.Brush

Implements

SetNumberingValueDialog

Gets or sets a value representing the current Set Numbering Value reference dialog instance.

Declaration
public ISetNumberingValueDialog SetNumberingValueDialog { get; set; }
Property Value
ISetNumberingValueDialog

ShowComments

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

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

Implements

ShowFormattingSymbols

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

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

true if formatting symbols are shown; otherwise, false.
Implements

ShowInsertHyperlinkDialogCommand

Deprecated.

Declaration
public ShowInsertHyperlinkDialogCommand ShowInsertHyperlinkDialogCommand { get; }
Property Value
ShowInsertHyperlinkDialogCommand

ShowInsertSymbolWindowCommand

Deprecated.

Declaration
public ShowInsertSymbolWindowCommand ShowInsertSymbolWindowCommand { get; }
Property Value
ShowInsertSymbolWindowCommand

ShowMergeFieldsHighlight

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

ShowParagraphPropertiesDialogCommand

Deprecated.

Declaration
public ShowParagraphPropertiesDialogCommand ShowParagraphPropertiesDialogCommand { get; }
Property Value
ShowParagraphPropertiesDialogCommand

SpellChecker

Gets or sets the ISpellChecker implementation used when proofing.

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

Implements

SpellCheckingDialog

Gets or sets a value representing the current spell checking dialog instance.

Declaration
public ISpellCheckingDialog SpellCheckingDialog { get; set; }
Property Value
ISpellCheckingDialog

StyleFormattingPropertiesDialog

Gets or sets a value representing the current style formatting properties dialog instance.

Declaration
public IStyleFormattingPropertiesDialog StyleFormattingPropertiesDialog { get; set; }
Property Value
IStyleFormattingPropertiesDialog

TableBordersDialog

Gets or sets a value representing the current table borders dialog instance.

Declaration
public ITableBordersDialog TableBordersDialog { get; set; }
Property Value
ITableBordersDialog

TablePropertiesDialog

Gets or sets a value representing the current table properties dialog instance.

Declaration
public ITablePropertiesDialog TablePropertiesDialog { get; set; }
Property Value
ITablePropertiesDialog

TabStopsPropertiesDialog

Gets or sets a value representing the current tab stops properties dialog instance.

Declaration
public ITabStopsPropertiesDialog TabStopsPropertiesDialog { get; set; }
Property Value
ITabStopsPropertiesDialog

ToggleBoldCommand

Deprecated.

Declaration
public ToggleBoldCommand ToggleBoldCommand { get; }
Property Value
ToggleBoldCommand

ToggleBulletsCommand

Deprecated.

Declaration
public ToggleBulletsCommand ToggleBulletsCommand { get; }
Property Value
ToggleBulletsCommand

ToggleFormattingSymbolsCommand

Deprecated.

Declaration
public ToggleFormattingSymbolsCommand ToggleFormattingSymbolsCommand { get; }
Property Value
ToggleFormattingSymbolsCommand

ToggleItalicCommand

Deprecated.

Declaration
public ToggleItalicCommand ToggleItalicCommand { get; }
Property Value
ToggleItalicCommand

ToggleNumberedCommand

Deprecated.

Declaration
public ToggleNumberedCommand ToggleNumberedCommand { get; }
Property Value
ToggleNumberedCommand

ToggleStrikethroughCommand

Deprecated.

Declaration
public ToggleStrikethroughCommand ToggleStrikethroughCommand { get; }
Property Value
ToggleStrikethroughCommand

ToggleSubscriptCommand

Deprecated.

Declaration
public ToggleSubscriptCommand ToggleSubscriptCommand { get; }
Property Value
ToggleSubscriptCommand

ToggleSuperscriptCommand

Deprecated.

Declaration
public ToggleSuperscriptCommand ToggleSuperscriptCommand { get; }
Property Value
ToggleSuperscriptCommand

ToggleUnderlineCommand

Deprecated.

Declaration
public ToggleUnderlineCommand ToggleUnderlineCommand { get; }
Property Value
ToggleUnderlineCommand

TrackChangesOptions

Declaration
public TrackChangesOptions TrackChangesOptions { get; }
Property Value
TrackChangesOptions

UILayersBuilder

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

Implements

UndoCommand

Deprecated.

Declaration
public UndoCommand UndoCommand { get; }
Property Value
UndoCommand

UnprotectDocumentDialog

Gets or sets a value representing the current dialog for removing document protection.

Declaration
public IUnprotectDocumentDialog UnprotectDocumentDialog { get; set; }
Property Value
IUnprotectDocumentDialog

Users

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

ValidationErrors

Gets or sets(private) an instance of ValidationError that provides an error set by DataProviderBase.

Declaration
public ReadOnlyObservableCollection<ValidationError> ValidationErrors { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyObservableCollection<System.Windows.Controls.ValidationError>

VerticalOffset

Gets the vertical scroll position.

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

VerticalScrollBar

Gets the vertical scroll bar instance of the control.

Declaration
public virtual ScrollBar VerticalScrollBar { get; }
Property Value
System.Windows.Controls.Primitives.ScrollBar

VerticalScrollBarVisibility

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

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
System.Windows.Controls.ScrollBarVisibility

ViewportHeight

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

ViewportWidth

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

WatermarkSettingsDialog

Gets or sets a value representing the current Watermark Settings dialog instance.

Declaration
public IWatermarkSettingsDialog WatermarkSettingsDialog { get; set; }
Property Value
IWatermarkSettingsDialog

Methods

AcceptAllRevisions()

Accepts all revisions in the document.

Declaration
public void AcceptAllRevisions()
Implements

AcceptRevision(Revision)

Accepts a revision.

Declaration
public void AcceptRevision(Revision revision)
Parameters
Revision revision

The revision.
Implements

add_PreviewEditorKeyDown(PreviewEditorKeyEventHandler)

Declaration
public void add_PreviewEditorKeyDown(PreviewEditorKeyEventHandler value)
Parameters
PreviewEditorKeyEventHandler value

AddOrReplaceTabStop(TabStop, TabStop)

Deprecated.

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

TabStop newTabStop

AddTabStop(TabStop)

Adds a tab stop to the current paragraph.

Declaration
public void AddTabStop(TabStop tabStop)
Parameters
TabStop tabStop

The tab stop.
Implements

AddTabStopRange(IEnumerable<TabStop>)

Adds a tab stop range to the current paragraph.

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

The tab stop collection.
Implements

BeginUndoGroup()

Begins a new group of actions which will appear as a single item in the document history.

Declaration
public void BeginUndoGroup()
Implements

CancelUndoGroup()

Cancels the currently started undo-able group, started with BeginUndoGroup() and undoes the actions executed since the starting of the group.

If an undo group is not started, an System.InvalidOperationException is thrown.

Declaration
public void CancelUndoGroup()
Implements

CanCopyFormatting()

Returns a value indicating whether the formatting can be copied according to the current selection.

Declaration
public bool CanCopyFormatting()
Returns
System.Boolean

The value indicating whether the formatting can be copied.

ChangeAllFieldsDisplayMode(FieldDisplayMode)

Changes the display mode of all fields in the document.

Declaration
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

The display mode which will be used for the fields.
Implements

ChangeBaselineAlignment(BaselineAlignment)

Changes the baseline alignment of the selected content.

Declaration
public void ChangeBaselineAlignment(BaselineAlignment baselineAlignment)
Parameters
BaselineAlignment baselineAlignment

The 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
BibliographicReferenceStyleBase newBibliographicStyle

The new bibliographic style.
Implements

ChangeDifferentFirstPageHeaderFooter(Boolean)

Sets a value determining whether the headers and footers of the first page in the selected sections are different than the ones of the other pages.

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

If set to true, the header and footer of the first page will be different than the rest of the pages in the section.
Implements

ChangeDifferentOddAndEvenPagesHeaderFooter(Boolean)

Changes the value determining whether the sections should have different odd and even pages header/footer.

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

true, if the even and odd page header/footer should differ.
Implements

ChangeDocumentDefaultTabWidth(Double)

Changes default tab stop width for the document.

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

Width of the tab.
Implements

ChangeDocumentElementTag(DocumentElement, String)

Changes the Tag property of a specified DocumentElement.

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

The DocumentElement.
System.String tag

The new tag value.
Implements

ChangeDocumentEndnotesFirstNumber(Int32)

Changes the first number of the endnotes in the document.

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

The first number.
Implements

ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)

Changes the numbering format of the endnotes in the document.

Declaration
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)

Changes the type of numbering restart of the endnotes in the document.

Declaration
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeDocumentEndnotesPosition(EndnotesPosition)

Changes the position of the endnotes in the document.

Declaration
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)
Parameters
EndnotesPosition endnotesPosition

The position.
Implements

ChangeDocumentFootnotesFirstNumber(Int32)

Changes the first number of the footnotes in the document.

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

The first number.
Implements

ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)

Changes the numbering format of the footnotes in the document.

Declaration
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)

Changes the type of numbering restart of the endnotes in the document.

Declaration
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeDocumentFootnotesPosition(FootnotesPosition)

Changes the position of the footnotes in the document.

Declaration
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)
Parameters
FootnotesPosition footnotesPosition

The footnotes position.
Implements

ChangeDocumentIsStrictLineBreakingRuleEnabled(Boolean)

Sets a value determining whether the strict line breaking rule will be applied to Japanese text in this document.

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

if set to true, the strict line breaking rule will be applied.
Implements

ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)

Sets the language whose rules should be used for line breaking in the paragraphs.

Declaration
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)
Parameters
LineBreakingRuleLanguage lineBreakingRuleLanguage

The line breaking rule language.
Implements

ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)

Sets a rule determining which characters cannot end a line in East-Asian languages.

Declaration
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

The line breaking character rule.
Implements

ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)

Sets a rule determining which characters cannot start a line in East-Asian languages.

Declaration
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

The rule.
Implements

ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)

Changes the display mode of a field.

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

The field start.
FieldDisplayMode displayMode

The new display mode.
Implements

ChangeFontFamily(FontFamily)

Changes the font family of the selected content.

Declaration
public void ChangeFontFamily(FontFamily fontFamily)
Parameters
System.Windows.Media.FontFamily fontFamily

The font family to be applied.
Implements

ChangeFontSize(Double)

Changes the size of the font of the selected content.

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

Size of the font.
Implements

ChangeFontStyle(FontStyle)

Changes the font style of the selected content.

Declaration
public void ChangeFontStyle(FontStyle fontStyle)
Parameters
System.Windows.FontStyle fontStyle

The font style.
Implements

ChangeFontWeight(FontWeight)

Changes the font weight of the selected content. If selection is not present, the current editing style is updated.

Declaration
public void ChangeFontWeight(FontWeight fontWeight)
Parameters
System.Windows.FontWeight fontWeight

The font weight.
Implements

ChangeImageRotateAngle(ImageInline, Double)

Changes the rotate angle of an image.

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

The ImageInline.
System.Double angle

The new angle.
Implements

ChangeImageSize(ImageInline, Size)

Changes the size of an image.

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

The ImageInline whose size should be changed.
System.Windows.Size size

The new size.
Implements

ChangeLayoutMode(DocumentLayoutMode)

Changes the layout mode.

Declaration
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)
Parameters
DocumentLayoutMode layoutMode

The new layout mode to be applied.

ChangeListStyle(ListStyle)

Declaration
public void ChangeListStyle(ListStyle style)
Parameters
ListStyle style

ChangeListType(ListType)

Changes the list type of the current paragraph.

Declaration
public void ChangeListType(ListType listType)
Parameters
ListType listType

The new list type to be applied.

ChangePageSize(Size)

Deprecated.

Declaration
public void ChangePageSize(Size newSize)
Parameters
System.Windows.Size newSize

ChangePageSize(SizeF)

Deprecated.

Declaration
public void ChangePageSize(SizeF newSize)
Parameters
SizeF newSize

ChangeParagraphAutomaticSpacingAfter(Boolean)

Changes the automatic spacing after of the selected paragraphs.

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

If set to true, the automatic spacing after will be enabled.
Implements

ChangeParagraphAutomaticSpacingBefore(Boolean)

Changes the automatic spacing before of the selected paragraphs.

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

If set to true, the automatic spacing before will be enabled.
Implements

ChangeParagraphBackground(Color)

Changes the background of the selected paragraphs.

Declaration
public void ChangeParagraphBackground(Color color)
Parameters
System.Windows.Media.Color color

The color.
Implements

ChangeParagraphFirstLineIndent(Double)

Changes the first line indent of the selected paragraphs.

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

The first line indent.
Implements

ChangeParagraphFlowDirection(FlowDirection)

Changes the flow direction of the selected paragraphs.

Declaration
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)
Parameters
System.Windows.FlowDirection flowDirection

The flow direction.
Implements

ChangeParagraphIsLineBreakingRuleEnabled(Boolean)

Changes the IsLineBreakingRuleEnabled property. This property indicates whether East Asian typography rules will be applied to determine which characters may begin and end each line.

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

If set to true, East Asian typography rules will be applied to determine which characters may begin and end each line.
Implements

ChangeParagraphLeftIndent(Double)

Changes the left indent of the selected paragraphs.

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

The left indent.
Implements

ChangeParagraphLineSpacing(Double)

Changes the line spacing of the selected paragraphs.

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

The line spacing.
Implements

ChangeParagraphLineSpacing(Double, LineSpacingType)

Changes the line spacing of the selected paragraphs.

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

The line spacing.
LineSpacingType lineSpacingType

Type of the line spacing.
Implements

ChangeParagraphLineSpacingType(LineSpacingType)

Changes the type of the line spacing of the selected paragraphs.

Declaration
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)
Parameters
LineSpacingType lineSpacingType

Type of the line spacing.
Implements

ChangeParagraphListLevel(Int32)

Changes the list level of the selected paragraphs.

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

The list level.
Implements

ChangeParagraphRightIndent(Double)

Changes the right indent of the selected paragraphs.

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

The right indent.
Implements

ChangeParagraphSpacingAfter(Double)

Changes the spacing after of the selected paragraphs.

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

The spacing after.
Implements

ChangeParagraphSpacingBefore(Double)

Changes the spacing before of the selected paragraphs.

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

The spacing before.
Implements

ChangeParagraphStyle(StyleDefinition)

Changes the paragraph style of the selected content.

Declaration
public void ChangeParagraphStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The style information.
Implements

ChangeSectionActualPageMargin(Padding)

Changes the page margin of the selected sections respecting their current orientation.

Declaration
public void ChangeSectionActualPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The margin.
Implements

ChangeSectionColumns(SectionColumnCollection)

Changes the section columns for the selected sections.

Declaration
public void ChangeSectionColumns(SectionColumnCollection sectionColumns)
Parameters
SectionColumnCollection sectionColumns

The section columns.
Implements

ChangeSectionColumns(SectionColumnsLayout)

Changes the section columns for a given collection of Section elements.

Declaration
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)
Parameters
SectionColumnsLayout sectionColumnsLayout

The section columns layout.
Implements

ChangeSectionEndnotesFirstNumber(Int32)

Changes the first number of the endnotes in the selected sections.

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

The first number.
Implements

ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)

Changes the numbering format of the endnotes in the selected sections.

Declaration
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)

Changes the type of numbering restart of the endnotes in the selected sections.

Declaration
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeSectionFirstPageNumber(Nullable<Int32>)

Changes the first page number of the selected sections.

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

The first page number.
Implements

ChangeSectionFooterBottomMargin(Int32)

Changes the footer bottom margin of the selected sections.

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

The section footer bottom margin.
Implements

ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, Boolean)

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

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

The section.
HeaderFooterType footerType

Type of the footer.
System.Boolean value

true if the footer should be linked.
Implements

ChangeSectionFootnotesFirstNumber(Int32)

Changes the first number of the footnotes in the selected sections.

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

The first number.
Implements

ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)

Changes the numbering format of the footnotes in the selected sections.

Declaration
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)

Changes the type of numbering restart of the footnotes in the selected sections.

Declaration
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, Boolean)

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

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

The section.
HeaderFooterType headerType

Type of the header.
System.Boolean value

true if the header should be linked.
Implements

ChangeSectionHeaderTopMargin(Int32)

Changes the header top margin of the selected sections.

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

The section header top margin.
Implements

ChangeSectionMagin(Padding)

Deprecated.

Declaration
public void ChangeSectionMagin(Padding newSectionMargin)
Parameters
Padding newSectionMargin

ChangeSectionMargin(Padding)

Deprecated.

Declaration
public void ChangeSectionMargin(Padding newSectionMargin)
Parameters
Padding newSectionMargin

ChangeSectionPageMargin(Padding)

Changes the page margin of the selected sections.

Declaration
public void ChangeSectionPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The margin.
Implements

ChangeSectionPageOrientation(PageOrientation)

Changes the page orientation of the selected sections.

Declaration
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)
Parameters
Telerik.Windows.Documents.Model.PageOrientation sectionPageOrientation

The page orientation.
Implements

ChangeSectionPageSize(Size)

Changes the page size of the selected sections.

Declaration
public void ChangeSectionPageSize(Size newSize)
Parameters
System.Windows.Size newSize

The new size. You can use the Telerik.Windows.Documents.Model.PaperTypes enumeration to get the desired size from the predefined values.
Implements

ChangeSpanStyle(StyleDefinition)

Changes the span style of the selected content.

Declaration
public void ChangeSpanStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The style information.
Implements

ChangeStrikethrough(Boolean)

Changes the strike-through of the selected content.

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

If set to true, a strike-through will be applied to the selected content.
Implements

ChangeStyleName(String)

Applies style with a given name to the selected elements in the document.

Declaration
public void ChangeStyleName(string styleName)
Parameters
System.String styleName

Name of the style to be applied.
Implements

ChangeStyleName(String, Boolean)

Applies style with a given name to the selected elements in the document.

Declaration
public void ChangeStyleName(string styleName, bool useLinkedStyle)
Parameters
System.String styleName

Name of the style.
System.Boolean useLinkedStyle

If true, the linked style may be used depending on the selection.
Implements

ChangeTableBorders(TableBorders)

Changes the borders of the selected tables.

Declaration
public void ChangeTableBorders(TableBorders tableBorders)
Parameters
TableBorders tableBorders

The table borders.
Implements

ChangeTableCellBackground(Color)

Changes the background of the selected table cells.

Declaration
public void ChangeTableCellBackground(Color color)
Parameters
System.Windows.Media.Color color

The color.
Implements

ChangeTableCellBorders(Border)

Changes the borders of the selected table cells.

Declaration
public void ChangeTableCellBorders(Border tableCellBorders)
Parameters
Border tableCellBorders

The border which will be used for all table cell borders.
Implements

ChangeTableCellBorders(TableCellBorders)

Changes the borders of the selected table cells.

Declaration
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)
Parameters
TableCellBorders tableCellBorders

The table cell borders.
Implements

ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)

Changes the content alignment of the selected table cells.

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

The text alignment.
RadVerticalAlignment verticalAlignment

The vertical alignment.
Implements

ChangeTableCellHorizontalContentAlignment(RadTextAlignment)

Changes the horizontal content alignment of the selected table cells.

Declaration
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)
Parameters
RadTextAlignment textAlignment

The alignment.
Implements

ChangeTableCellPadding(Padding)

Changes the padding of the selected table cells.

Declaration
public void ChangeTableCellPadding(Padding padding)
Parameters
Padding padding

The padding.
Implements

ChangeTableCellSpacing(Double)

Changes the cell spacing of the selected tables.

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

The cell spacing.
Implements

ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)

Changes the vertical content alignment of the selected table cells.

Declaration
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)
Parameters
RadVerticalAlignment verticalAlignment

The alignment.
Implements

ChangeTableColumnsLayoutMode(Table, TableLayoutMode)

Deprecated.

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

TableLayoutMode tableLayoutMode

ChangeTableDefaultCellPadding(Padding)

Changes the default cell padding of the selected tables.

Declaration
public void ChangeTableDefaultCellPadding(Padding padding)
Parameters
Padding padding

The padding which will be used as a default value.
Implements

ChangeTableFlowDirection(FlowDirection)

Changes the flow direction of the selected tables.

Declaration
public void ChangeTableFlowDirection(FlowDirection flowDirection)
Parameters
System.Windows.FlowDirection flowDirection

The flow direction.
Implements

ChangeTableGridColumnWidth(Table, Int32, TableWidthUnit)

Changes the width of a table column.

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

The table.
System.Int32 columnIndex

The index of the column.
TableWidthUnit width

The new value for the column width. If the type of the width is not specified, Fixed will be used.
Implements

ChangeTableHorizontalAlignment(RadHorizontalAlignment)

Changes the horizontal alignment of the selected tables.

Declaration
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)
Parameters
RadHorizontalAlignment alignment

The alignment.
Implements

ChangeTableIndent(Double)

Changes the indent of the selected tables.

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

The indent.
Implements

ChangeTableLayoutMode(Table, TableLayoutMode)

Changes the layout mode of the selected tables.

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

The table.

TableLayoutMode tableLayoutMode

The table layout mode.

Implements

ChangeTableLook(TableLook)

Changes the look of the selected tables.

The look of a table defines the components of the conditional formatting which will be applied to it.

Declaration
public void ChangeTableLook(TableLook tableLook)
Parameters
TableLook tableLook

The table look.
Implements

ChangeTablePreferredWidth(TableWidthUnit)

Changes the preferred width of the selected tables.

Declaration
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)
Parameters
TableWidthUnit tableWidth

Width of the table.
Implements

ChangeTableRowHeight(TableRow, Double)

Changes the height of a table row.

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

The table row.
System.Double height

The height.
Implements

ChangeTableRowRepeatOnEveryPage(TableRow)

Depending on the current value, enables or disables the repetition of a table row on every page.

Declaration
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)
Parameters
TableRow tableRow

The table row.
Implements

ChangeTextAlignment(RadTextAlignment)

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

Declaration
public void ChangeTextAlignment(RadTextAlignment alignment)
Parameters
RadTextAlignment alignment

The new text alignment to be applied.

ChangeTextForeColor(Color)

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

Declaration
public void ChangeTextForeColor(Color newColor)
Parameters
System.Windows.Media.Color 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
System.Windows.Media.Color newColor

The new highlight color to be applied.

ChangeUnderlineColor(Color)

Changes the underline color of the selected content.

Declaration
public void ChangeUnderlineColor(Color newColor)
Parameters
System.Windows.Media.Color newColor

The color.
Implements

ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)

Changes the underline decoration of the selected content.

Declaration
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)
Parameters
IUnderlineUIDecorationProvider decoration

The value.
Implements

ClearAllFormatting()

Clears all the formatting (character and paragraph) from the selected content.

Declaration
public void ClearAllFormatting()
Implements

ClearFormatting()

Clears the character formatting of the selected content.

Declaration
public void ClearFormatting()
Implements

ClearTabStops()

Clears the tab stops inside the 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 must be in a list and should be first in the list, otherwise this method does nothing.

Declaration
public bool ContinueListNumbering()
Returns
System.Boolean

A boolean value indicating whether the operation completed successfully.
Implements

ContinueNumbering()

Deprecated

Declaration
public void ContinueNumbering()

Copy()

Copies the 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
System.Boolean

A value indicating whether the copy was successful.
Implements

Cut()

Cuts the currently selected document elements into the clipboard.

Declaration
public void Cut()
Implements

DecrementFontSize()

Decrements the size of the font of the selected content with 2 points.

Declaration
public void DecrementFontSize()
Implements

DecrementPageWidth()

Deprecated.

Declaration
public void DecrementPageWidth()

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(Boolean)

Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the CaretPosition.

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

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

DeleteAllComments()

Deletes all comments in the document.

Declaration
public void DeleteAllComments()
Implements

DeleteAnnotationRange(AnnotationRangeStart)

Deletes an annotation range.

Declaration
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The start of the range that will be deleted.
Implements

DeleteBookmark(String)

Deletes a bookmark.

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

Name of the bookmark.
Implements

DeleteBookmark(BookmarkRangeStart)

Deletes a bookmark.

Declaration
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)
Parameters
BookmarkRangeStart bookmarkRangeStart

The bookmark range start.
Implements

DeleteCodeBlock(CodeAnnotationRangeStart)

Deletes a code block.

Declaration
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)
Parameters
CodeAnnotationRangeStart rangeStart

The CodeAnnotationRangeStart 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 commentRangeStart

The comment range start.
Implements

DeletePermissionRange(PermissionRangeStart)

Deletes a permission range.

Declaration
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)
Parameters
PermissionRangeStart permissionRangeStart

The permission range start.
Implements

DeleteReadOnlyRange()

Deletes the read only range at the current caret position or inside the current selection.

Declaration
public void DeleteReadOnlyRange()
Implements

DeleteReadOnlyRange(ReadOnlyRangeStart)

Deletes read only range.

Declaration
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)
Parameters
ReadOnlyRangeStart readOnlyRangeStart

The read only range that is to be deleted.
Implements

DeleteTable()

Deletes the table the current caret position is in.

Declaration
public void DeleteTable()
Implements

DeleteTable(Table)

Deletes a table.

Declaration
public void DeleteTable(Table table)
Parameters
Table table

The Table to delete.
Implements

DeleteTableColumn()

Deletes the current table column which is under the caret position.

Declaration
public void DeleteTableColumn()
Implements

DeleteTableRow()

Deletes the table row under the caret position.

Declaration
public void DeleteTableRow()
Implements

DeleteTableRow(TableRow)

Deletes a table row.

Declaration
public void DeleteTableRow(TableRow row)
Parameters
TableRow row

The TableRow to delete.
Implements

DisableWatermark()

Declaration
public void DisableWatermark()

EditListStyleInDialog(ListStyle)

Declaration
public void EditListStyleInDialog(ListStyle listStyle)
Parameters
ListStyle listStyle

EndUndoGroup()

Closes current undo group.

Declaration
public void EndUndoGroup()
Implements

EndUndoGroup(String)

Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.

Declaration
public void EndUndoGroup(string groupDisplayText)
Parameters
System.String groupDisplayText

Implements

EnsureActiveEditorPresenter()

Ensures control template is applied and ensures ActiveEditorPresenter is initialized to its default value.

Declaration
public bool EnsureActiveEditorPresenter()
Returns
System.Boolean

Whether the ActiveEditorPresenter has been created as a result of this method call.

Focus()

Declaration
public void Focus()

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)

Declaration
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)
Parameters
Comment comment

Returns
CommentAppearanceSettings

Implements

GetContent(String)

Gets the content in various formats.

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

The format to export into.
Returns
System.String

String representation of the content.

GetDocumentEditorPresenterTypeForDocument(RadDocument)

Declaration
protected virtual Type GetDocumentEditorPresenterTypeForDocument(RadDocument document)
Parameters
RadDocument document

Returns
System.Type

GetStatisticsInfo()

Declaration
public DocumentStatisticsInfo GetStatisticsInfo()
Returns
DocumentStatisticsInfo

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 size of the font of the selected content with 2 points.

Declaration
public void IncrementFontSize()
Implements

IncrementPageWidth()

Deprecated.

Declaration
public void IncrementPageWidth()

IncrementParagraphLeftIndent()

Increments the left indent of the current paragraph.

Declaration
public void IncrementParagraphLeftIndent()
Implements

IncrementParagraphListLevel()

Increments the paragraph list level of the selected paragraphs.

Declaration
public void IncrementParagraphListLevel()

Insert(String)

Inserts text into the document at the current caret position.

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

The text to insert.

Insert(String, DocumentPosition)

Inserts text into the document at the specified position.

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

The text to insert.
DocumentPosition insertionPosition

InsertAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)

Inserts an annotation range.

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

The annotation range start.
AnnotationRangeEnd rangeEnd

The annotation range end.
Implements

InsertBookmark(String)

Inserts a bookmark around the current selection. If the selection is empty, the bookmark is inserted at the caret position.

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

Name of the bookmark.
Implements

InsertCaption(CaptionDefinition, String, Boolean, Boolean)

Inserts a caption around the current selection. If the selection is empty, the caption is inserted at the current caret position.

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

The definition of the caption.
System.String caption

The caption text to be used.
System.Boolean includeLabel

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

If set to true, the caption is inserted after the current selection.
Implements

InsertCodeBlock(String, CodeFormattingSettings)

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

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

The code to insert.
CodeFormattingSettings settings

The settings which will be used for the code block.
Implements

InsertColumnBreak()

Inserts a column break into the document at the current caret position.

Declaration
public void InsertColumnBreak()
Implements

InsertComment(Comment)

Inserts a comment around the current selection. If the selection is empty, the comment is inserted at the caret position.

Declaration
public void InsertComment(Comment comment)
Parameters
Comment comment

The comment.
Implements

InsertCrossReferenceToBookmark(String, ReferenceContentType, Boolean)

Inserts a cross-reference to a bookmark into the document at the current caret position.

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

Name of the bookmark.
ReferenceContentType contentType

Type of the content.
System.Boolean insertAsHyperlink

If set to true, the cross-reference is inserted as a hyperlink.
Implements

InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, Boolean)

Inserts a cross-reference to a caption into the document at the current caret position.

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

The paragraph containing the caption sequence field.
ReferenceContentType contentType

The reference content type. If the paragraph doesn't have applied a Caption style, the method will not be executed.
System.Boolean insertAsHyperlink

A parameter indicating whether the cross-reference field should be a hyperlink.
Implements

InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, Boolean)

Inserts a cross-reference to a paragraph with Heading style into the document at the current caret position.

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

The paragraph. If the paragraph doesn't have applied a Heading style, the method will not be executed.
ReferenceContentType contentType

Type of the content.
System.Boolean insertAsHyperlink

If set to true, the cross-reference is inserted as a hyperlink.
Implements

InsertCustomAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)

Deprecated.

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

AnnotationRangeEnd rangeEnd

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
Note endnote

The endnote.
Implements

InsertField(Field)

Inserts a field into the document at the current caret position.

Declaration
public bool InsertField(Field field)
Parameters
Field field

The field.
Returns
System.Boolean

True, if the operation completed successfully.
Implements

InsertField(Field, FieldDisplayMode)

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

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

The field.
FieldDisplayMode displayMode

The display mode.
Returns
System.Boolean

True, if the operation completed successfully.
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
Note footnote

The footnote.
Implements

InsertFragment(DocumentFragment)

Inserts a fragment at the current caret position.

Declaration
public void InsertFragment(DocumentFragment documentFragment)
Parameters
DocumentFragment documentFragment

The fragment to insert.
Implements
Exceptions
System.ArgumentNullException

Thrown when documentFragment is null.

InsertFragment(DocumentFragment, DocumentPosition)

Inserts a fragment at a specified position. Document selection should be cleared in advance.

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

The fragment to insert.
DocumentPosition documentPosition

The document position to insert the fragment at.
Implements
Remarks

Document selection should be cleared before calling this method, otherwise exception may be thrown.

Exceptions
System.InvalidOperationException

Thrown when there is selection in the document.
System.ArgumentNullException

Thrown when documentFragment or documentPosition is null.

InsertHyperlink(HyperlinkInfo)

Inserts a hyperlink in the document. The hyperlink will be created around the current selection.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.
Implements

InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)

Inserts collection of inlines as hyperlink into the document.

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

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

The inlines.
Implements

InsertHyperlink(HyperlinkInfo, String)

Inserts a hyperlink in the document.

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

The hyperlink info.
System.String hyperlinkText

The hyperlink text.
Implements

InsertHyperlink(HyperlinkInfo, String, StyleDefinition)

Inserts hyperlink into the document.

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

The hyperlink info.
System.String hyperlinkText

The hyperlink text.
StyleDefinition hyperlinkStyle

The hyperlink style.
Implements

InsertHyperlink(HyperlinkInfo, StyleDefinition)

Creates hyperlink form the current selection.

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, StyleDefinition hyperlinkStyle)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.
StyleDefinition hyperlinkStyle

The hyperlink style.
Implements

InsertImage(Stream, String)

Inserts an inline image into the document at the current caret position.

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

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

The extension specifying the image format.
Implements

InsertInline(Inline)

Inserts inline element into the document at the current caret position.

Declaration
public void InsertInline(Inline inline)
Parameters
Inline inline

The inline element to insert.
Implements
Exceptions
System.ArgumentNullException

Thrown when inline is null.

InsertInline(Inline, DocumentPosition)

Inserts inline element into the document at a specified caret position. Document selection should be cleared in advance.

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

The inline element to insert.
DocumentPosition documentPosition

The document position to insert the inline at.
Implements
Remarks

Document selection should be cleared before calling this method, otherwise exception may be thrown.

Exceptions
System.InvalidOperationException

Thrown when there is selection in the document.
System.ArgumentNullException

Thrown when inline or documentPosition is null.

InsertLine(String)

Inserts text at the current caret position and adds a new paragraph after it.

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

The text.
Implements

InsertLineBreak()

Inserts a line break into the document at the current caret position.

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 into the document at the current caret position.

Declaration
public void InsertPageBreak()
Implements

InsertParagraph()

Inserts a new paragraph at the current caret position.

Declaration
public void InsertParagraph()
Implements

InsertPermissionRange(IEnumerable<PermissionRangeInfo>)

Inserts a new permission range over the current selection. If the selection is empty, the permission range is inserted at the caret position.

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

The permissions for the new range.
Implements

InsertReadOnlyRange()

Inserts a read only range over the current selection. If the selection is empty, the range is inserted at the caret position.

Declaration
public void InsertReadOnlyRange()
Implements

InsertSectionBreak()

Inserts a section break into the document at the current caret position.

Declaration
public void InsertSectionBreak()
Implements

InsertSectionBreak(SectionBreakType)

Inserts a section break of the specified type into the document at the current caret position.

Declaration
public void InsertSectionBreak(SectionBreakType sectionBreakType)
Parameters
SectionBreakType sectionBreakType

The type of the section break.
Implements

InsertTable(Int32, Int32)

Inserts a new table in the document.

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

Number of the rows in the table.
System.Int32 columns

Number of the columns in the table.
Implements

InsertTable(Int32, Int32, Boolean)

Inserts a new table in the document.

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

Number of the rows in the table.
System.Int32 columns

Number of the columns in the table.
System.Boolean shouldInsertParagraphBeforeTable

if set to true, an additional empty paragraph is inserted before the table.

InsertTable(Table)

Inserts a table in the document.

Note: 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 using the same object.

Declaration
public void InsertTable(Table table)
Parameters
Table table

The table.
Implements

InsertTable(Table, Boolean)

Inserts the table.

Declaration
public void InsertTable(Table table, bool shouldInsertParagraphBeforeTable)
Parameters
Table table

The table.
System.Boolean shouldInsertParagraphBeforeTable

if set to true, an additional empty paragraph is 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.

InsertTableColumn()

Inserts a table column in the table which is under the caret position.

Declaration
public void InsertTableColumn()
Implements

InsertTableColumnToTheLeft()

Inserts a table column to the left in the table which is under the caret position.

Declaration
public void InsertTableColumnToTheLeft()
Implements

InsertTableColumnToTheRight()

Inserts a table column to the right in the table which is under the caret position.

Declaration
public void InsertTableColumnToTheRight()
Implements

InsertTableRow()

Inserts a new table row in the table under the caret position.

Declaration
public void InsertTableRow()
Implements

InsertTableRowAbove()

Inserts a table row above the one under the caret position.

Declaration
public void InsertTableRowAbove()
Implements

InsertTableRowBelow()

Inserts a table row below the one under the caret position.

Declaration
public void InsertTableRowBelow()
Implements

InvalidateEditorLayout()

Forces the control to invalidate the layout of its child elements.

Declaration
public void InvalidateEditorLayout()

InvalidateProofingErrors(Boolean)

Clears the spell-checking state of all words in the document and updates the UI.

Declaration
public void InvalidateProofingErrors(bool invalidateIncorrectWordsOnly)
Parameters
System.Boolean invalidateIncorrectWordsOnly

True to invalidate incorrect word only.

MailMerge(Boolean)

Produces a mail merged document containing the results for all data records.

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

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

The document containing the result of the operation.
Implements

MailMergeCurrentRecord()

Creates a new RadDocument containing the result of merging the template with the values of the current data record.

Declaration
public RadDocument MailMergeCurrentRecord()
Returns
RadDocument

The document.
Implements

MergeTableCells()

Merges the currently selected table cells into one.

Declaration
public void MergeTableCells()
Implements

MoveSelection(DocumentPosition, Boolean)

Moves the current selection along with the selected document elements to a specified position.

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

The start position where the selection should be moved to.
System.Boolean deleteSelection

true, if the current selection and contained elements should be deleted on the original position.
Implements

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnCommandError(CommandErrorEventArgs)

Declaration
protected virtual void OnCommandError(CommandErrorEventArgs args)
Parameters
CommandErrorEventArgs args

OnCommandExecuted(CommandExecutedEventArgs)

Raises the CommandExecuted event.

Declaration
protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)
Parameters
CommandExecutedEventArgs e

The CommandExecutedEventArgs instance containing the event data.

OnCommandExecuting(CommandExecutingEventArgs)

Raises the CommandExecuting event.

Declaration
protected virtual void OnCommandExecuting(CommandExecutingEventArgs e)
Parameters
CommandExecutingEventArgs e

The CommandExecutingEventArgs instance containing the event data.

OnCommentShowing(CommentShowingEventArgs)

Raises the CommentShowing event.

Declaration
protected virtual void OnCommentShowing(CommentShowingEventArgs e)
Parameters
CommentShowingEventArgs e

The CommentShowingEventArgs instance containing the event data.

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF)/Silverlight infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnCurrentEditingStyleChanged()

Declaration
protected virtual void OnCurrentEditingStyleChanged()

OnCurrentParagraphStyleChanged()

Declaration
protected virtual void OnCurrentParagraphStyleChanged()

OnCurrentSpanStyleChanged()

Declaration
protected virtual void OnCurrentSpanStyleChanged()

OnCurrentVisiblePageChanged()

Declaration
protected virtual void OnCurrentVisiblePageChanged()

OnDocumentArranged()

Declaration
protected virtual void OnDocumentArranged()

OnDocumentChanged()

Declaration
protected virtual void OnDocumentChanged()

OnDocumentChanging()

Declaration
protected virtual void OnDocumentChanging()

OnDocumentContentChanged()

Declaration
protected virtual void OnDocumentContentChanged()

OnDocumentLayoutModeChanged()

Declaration
protected virtual void OnDocumentLayoutModeChanged()

OnDocumentPresentationChanged(PresentationChangedEventArgs)

Declaration
protected virtual void OnDocumentPresentationChanged(PresentationChangedEventArgs e)
Parameters
PresentationChangedEventArgs e

OnGotFocus(RoutedEventArgs)

Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

OnHyperlinkClicked(Object, HyperlinkClickedEventArgs)

Declaration
protected virtual void OnHyperlinkClicked(object sender, HyperlinkClickedEventArgs eventArgs)
Parameters
System.Object sender

HyperlinkClickedEventArgs eventArgs

OnIsReadOnlyChanged(EventArgs)

Raises the IsReadOnlyChanged event.

Declaration
protected virtual void OnIsReadOnlyChanged(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnLostFocus(RoutedEventArgs)

Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

OnMergeFieldToStringConverting(Object, MergeFieldToStringConvertingEventArgs)

Declaration
protected virtual void OnMergeFieldToStringConverting(object sender, MergeFieldToStringConvertingEventArgs e)
Parameters
System.Object sender

MergeFieldToStringConvertingEventArgs e

OnNoteReferenceClicked(MouseButtonEventArgs)

Raises the NoteReferenceClicked event.

Declaration
protected virtual void OnNoteReferenceClicked(MouseButtonEventArgs args)
Parameters
MouseButtonEventArgs args

The MouseButtonEventArgs instance containing the event data.

OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs)

Declaration
protected virtual void OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs e)
Parameters
PreviewEditorKeyEventArgs e

OnPrintCompleted(PrintCompletedEventArgs)

Raises the PrintCompleted event.

Declaration
protected virtual void OnPrintCompleted(PrintCompletedEventArgs e)
Parameters
PrintCompletedEventArgs e

The PrintCompletedEventArgs instance containing the event data.

OnPrintStarted(EventArgs)

Raises the PrintStarted event.

Declaration
protected virtual void OnPrintStarted(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnProtectionStateChanged()

Declaration
protected virtual void OnProtectionStateChanged()

OnScaleFactorChanged()

Declaration
protected virtual void OnScaleFactorChanged()

OnSelectionChanged(EventArgs)

Raises the SelectionChanged event.

Declaration
protected virtual void OnSelectionChanged(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnStreamFromUriResolving(StreamFromUriResolvingEventArgs)

Declaration
protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)
Parameters
StreamFromUriResolvingEventArgs e

OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs)

Raises the UntrackableCommandExecuting event.

Declaration
protected virtual void OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs e)
Parameters
UntrackableCommandExecutingEventArgs e

The UntrackableCommandExecutingEventArgs instance containing the event data.

OnUserInfoChanged()

Declaration
protected virtual void OnUserInfoChanged()

OnValidationError(Object, ValidationErrorEventArgs)

Declaration
public void OnValidationError(object sender, ValidationErrorEventArgs e)
Parameters
System.Object sender

System.Windows.Controls.ValidationErrorEventArgs e

OpenContextMenuOnNextSpellingError()

Declaration
public void OpenContextMenuOnNextSpellingError()

Paste()

Pastes the content of the clipboard into the document.

Declaration
public void Paste()
Implements

PasteFormatting()

Pastes the currently copied formatting on the current selection.

Declaration
public bool PasteFormatting()
Returns
System.Boolean

A value indicating whether the paste was successful.
Implements

PreviewFirstMailMergeDataRecord()

Updates all fields in the document with the values evaluated using the first data record.

Declaration
public bool PreviewFirstMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

PreviewLastMailMergeDataRecord()

Updates all fields in the document with the values evaluated using the last data record.

Declaration
public bool PreviewLastMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

PreviewMailMergeDataRecordAtIndex(Int32)

Updates all fields in the document with the values evaluated using a specified data record.

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

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

True, if the operation completed successfully.
Implements

PreviewNextMailMergeDataRecord()

Updates all fields in the document with the values evaluated using the next data record.

Declaration
public bool PreviewNextMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

PreviewPreviousMailMergeDataRecord()

Updates all fields in the document with the values evaluated using the previous data record.

Declaration
public bool PreviewPreviousMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

Print(String, PrintMode)

Initializes printing of the current document.

Declaration
public void Print(string documentName, PrintMode mode)
Parameters
System.String documentName

The name of the document to print.
PrintMode mode

The printing mode.

Print(PrintSettings)

Declaration
public void Print(PrintSettings printSettings)
Parameters
PrintSettings printSettings

PrintPreview()

Initializing print preview of the current document.

Declaration
public void PrintPreview()

Redo()

Re-executes the last undone command group.

Declaration
public void Redo()
Implements

RegisterCommand(RoutedCommand, Key, ModifierKeys, Object)

Declaration
public static void RegisterCommand(RoutedCommand command, Key key, ModifierKeys modifierKeys, object commandParameter = null)
Parameters
RoutedCommand command

System.Windows.Input.Key key

System.Windows.Input.ModifierKeys modifierKeys

System.Object commandParameter

RejectAllRevisions()

Rejects all revisions in the document.

Declaration
public void RejectAllRevisions()
Implements

RejectRevision(Revision)

Rejects a revision.

Declaration
public void RejectRevision(Revision revision)
Parameters
Revision revision

The revision.
Implements

remove_PreviewEditorKeyDown(PreviewEditorKeyEventHandler)

Declaration
public void remove_PreviewEditorKeyDown(PreviewEditorKeyEventHandler value)
Parameters
PreviewEditorKeyEventHandler value

RemoveTabStop(TabStop)

Removes a tab stop from the selected paragraphs.

Declaration
public void RemoveTabStop(TabStop tabStop)
Parameters
TabStop tabStop

The tab stop.
Implements

RemoveTabStopRange(IEnumerable<TabStop>)

Removes a collection of tab stops in the selected paragraphs.

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

The tab stops.
Implements

ReplaceTabStop(TabStop, TabStop)

Replaces a tab stop inside the selected paragraphs.

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

The old tab stop.
TabStop newTabStop

The new tab stop.
Implements

ResizeColumn(Table, Int32, Double)

Deprecated.

Declaration
public void ResizeColumn(Table table, int columnIndex, double columnNewWidth)
Parameters
Table table

System.Int32 columnIndex

System.Double columnNewWidth

ResizeTableColumn(Table, Int32, Double)

Changes the width of a table column. The specified width value will be applied with width type Fixed. You could specify different width type through the ChangeTableGridColumnWidth(Table, Int32, TableWidthUnit) method.

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

The table.
System.Int32 columnIndex

The index of the column.
System.Double columnWidth

The new value for the column width.
Implements

RestartListNumbering()

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

Declaration
public bool RestartListNumbering()
Returns
System.Boolean

A boolean value determining whether the operation completed successfully.
Implements

RestartNumbering()

Deprecated

Declaration
public void RestartNumbering()

ResumeUpdateLayout(Boolean)

This method supports control infrastructure and is not intended for use directly from your code. Resumes layout updates suspended by calls to SuspendUpdateLayout() method.

Declaration
public void ResumeUpdateLayout(bool updateLayout = true)
Parameters
System.Boolean updateLayout

True to call UpdateEditorLayout once all "resume" calls are equal to the "suspend" calls.

SatisfyImports()

Loads extensible UI components through MEF.

Declaration
public void SatisfyImports()

ScrollToHorizontalOffset(Double)

Scrolls the contents of RadRichTextBox to the specified horizontal offset.

Declaration
public void ScrollToHorizontalOffset(double offset)
Parameters
System.Double offset

ScrollToNote(Note)

Scrolls the viewport so that a note becomes visible.

Declaration
public void ScrollToNote(Note note)
Parameters
Note note

The note.
Implements

ScrollToVerticalOffset(Double)

Scrolls the contents of RadRichTextBox to the specified vertical offset.

Declaration
public void ScrollToVerticalOffset(double offset)
Parameters
System.Double offset

SetNumberingValue(SetNumberingValueOption, Int32)

Deprecated.

Declaration
public void SetNumberingValue(SetNumberingValueOption option, int skipWith = 1)
Parameters
SetNumberingValueOption option

System.Int32 skipWith

SetSelectedComment(CommentRangeStart)

Declaration
public void SetSelectedComment(CommentRangeStart commentStart)
Parameters
CommentRangeStart commentStart

SetSelectedNote(Note)

Declaration
public void SetSelectedNote(Note note)
Parameters
Note note

SetWatermark(DocumentWatermarkSettings)

Sets a watermark to the selected sections.

Declaration
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)
Parameters
DocumentWatermarkSettings watermarkSettings

The watermark settings describing the watermark that will be applied.
Implements

SetWatermark(PredefinedWatermarkType)

Sets a predefined watermark to the selected sections.

Declaration
public void SetWatermark(PredefinedWatermarkType predefinedType)
Parameters
PredefinedWatermarkType predefinedType

Type of the predefined watermark.
Implements

SetWatermarkImage(WatermarkImageSettings)

Declaration
public void SetWatermarkImage(WatermarkImageSettings settings)
Parameters
WatermarkImageSettings settings

SetWatermarkText(WatermarkTextSettings)

Declaration
public void SetWatermarkText(WatermarkTextSettings settings)
Parameters
WatermarkTextSettings settings

ShowAddNewBibliographicSourceDialog(String, Boolean, Action<BibliographicSource>)

Shows the Add New Bibliographic Source Dialog.

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

System.Boolean insertFieldOnClose

System.Action<BibliographicSource> callBackOnClosed

ShowChangeEditingPermissionsDialog()

Shows the dialog for changing editing permissions.

Declaration
public void ShowChangeEditingPermissionsDialog()

ShowCodeFormattingDialog()

Shows the dialog for code formatting.

Declaration
public void ShowCodeFormattingDialog()

ShowContextMenuAtDocumentPosition(Point, DocumentPosition)

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

DocumentPosition position

ShowContextMenuAtDocumentPosition(DocumentPosition)

Declaration
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)
Parameters
DocumentPosition position

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
System.String executeToolName

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

ShowInsertCaptionDialog()

Shows the insert caption dialog.

Declaration
public void ShowInsertCaptionDialog()

ShowInsertCrossReferenceWindow()

Shows the insert cross reference window.

Declaration
public void ShowInsertCrossReferenceWindow()

ShowInsertDateTimeDialog()

Shows the insert date field dialog.

Declaration
public void ShowInsertDateTimeDialog()

ShowInsertHyperlinkDialog()

Shows the insert hyperlink dialog.

Declaration
public void ShowInsertHyperlinkDialog()

ShowInsertSymbolWindow()

Show the insert symbol dialog.

Declaration
public void ShowInsertSymbolWindow()

ShowInsertTableDialog()

Shows the insert table dialog.

Declaration
public void ShowInsertTableDialog()

ShowInsertTableOfContentsDialog()

Shows the insert Table of Contents window.

Declaration
public void ShowInsertTableOfContentsDialog()

ShowManageBibliographicSourcesDialog()

Shows the Manage Bibliographic Sources Dialog.

Declaration
public void ShowManageBibliographicSourcesDialog()

ShowManageBookmarksDialog()

Shows the dialog for managing bookmarks.

Declaration
public void ShowManageBookmarksDialog()

ShowManageStylesDialog()

Shows the dialog for managing styles.

Declaration
public void ShowManageStylesDialog()

ShowNotesDialog()

Shows the notes dialog.

Declaration
public void ShowNotesDialog()

ShowParagraphPropertiesDialog()

Shows the paragraph properties dialog.

Declaration
public void ShowParagraphPropertiesDialog()

ShowProtectDocumentDialog()

Shows the dialog for enforcing document protection.

Declaration
public void ShowProtectDocumentDialog()

ShowSectionColumnsDialog()

Show the sections 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 styleDefinition

ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings)

Shows the style formatting properties dialog.

Declaration
public void ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings settings)
Parameters
StyleFormattingPropertiesDialogSettings settings

The settings.

ShowTableBordersDialog()

Shows the table borders dialog.

Declaration
public void ShowTableBordersDialog()

ShowTablePropertiesDialog()

Shows the table properties dialog.

Declaration
public void ShowTablePropertiesDialog()

ShowTabStopsPropertiesDialog()

Shows the dialog for editing tab stops.

Declaration
public void ShowTabStopsPropertiesDialog()

ShowUnprotectDocumentDialog()

Shows the dialog for removing document protection.

Declaration
public void ShowUnprotectDocumentDialog()

ShowWatermarkSettingsDialog()

Shows the watermark settings dialog.

Declaration
public void ShowWatermarkSettingsDialog()

SplitAnnotationRange(AnnotationRangeStart)

Splits an annotation range at the caret position, resulting in two new ranges.

Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The annotation range start to be split.
Implements

SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)

Splits an annotation range at the specified position, resulting in two new ranges.

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

The annotation range start to be split.
DocumentPosition position

The position where the range start should be split.
Implements

SuspendUpdateLayout()

This method supports control infrastructure and is not intended for use directly from your code. Suspends layout updates forced by document editing operations (e.g. multiple insert/delete operations). Each call to to this method should be followed by a call to ResumeUpdateLayout(Boolean) method.

Declaration
public void SuspendUpdateLayout()
Remarks

Use this method when you have to do sequence of updates to the document, to improve performance and avoid unnecessary layout and UI updates.

ToggleBold()

Toggles the font weight of the selected content between System.Windows.FontWeights.Bold and System.Windows.FontWeights.Normal.

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()

Declaration
public void ToggleDifferentFirstPageHeaderFooter()

ToggleDifferentOddAndEvenPagesHeaderFooter()

Declaration
public void ToggleDifferentOddAndEvenPagesHeaderFooter()

ToggleFieldCodes(FieldRangeStart)

Toggles the display mode of a field.

Declaration
public void ToggleFieldCodes(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.
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 font style of the selected content between System.Windows.FontStyles.Italic and System.Windows.FontStyles.Normal.

Declaration
public void ToggleItalic()
Implements

ToggleList(Boolean, DocumentList)

Deprecated.

Declaration
public void ToggleList(bool shouldAddToList, DocumentList defaultList)
Parameters
System.Boolean shouldAddToList

DocumentList defaultList

ToggleMergeFieldsHighlight()

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 the last executed command group.

Declaration
public void Undo()
Implements

UnmergeTableCells()

Splits the currently selected table cell.

Declaration
public void UnmergeTableCells()
Implements

UpdateAllCaptions(CaptionDefinition)

Updates all captions in the document related to a caption definition.

Declaration
public void UpdateAllCaptions(CaptionDefinition captionDefinition)
Parameters
CaptionDefinition captionDefinition

The caption definition.
Implements

UpdateAllFields()

Updates all fields in the document.

Declaration
public void UpdateAllFields()
Implements

UpdateAllFields(FieldDisplayMode)

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

Declaration
public void UpdateAllFields(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

The display mode which will be used for the fields.
Implements

UpdateEditorLayout()

Forces the control to update its layout and UI;

Declaration
public void UpdateEditorLayout()
Implements

UpdateEditorLayout(Boolean)

Forces the control to update its layout and UI.

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

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

UpdateField(FieldRangeStart)

Updates a field.

Declaration
public void UpdateField(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.
Implements

UpdateFooter(Section, HeaderFooterType, Footer)

Updates the footer for a section.

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

The section of the footer.
HeaderFooterType footerType

Type of the footer.
Footer footer

The footer.

UpdateHeader(Section, HeaderFooterType, Header)

Updates the header for a section.

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

The section of the header.
HeaderFooterType headerType

Type of the header.
Header header

The header.

Events

ActiveDocumentEditorChanged

Occurs when active document editor changes.

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

CommandError

Occurs on error while executing command.

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

CommandExecuted

Occurs after the execution of RichTextBoxCommandBase.

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

CommandExecuting

Occurs before the execution of RichTextBoxCommandBase.

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

CommentShowing

Occurs when showing comment.

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

CurrentEditingStyleChanged

Occurs when the current editing style has changed.

Declaration
public event EventHandler CurrentEditingStyleChanged
Event Type
System.EventHandler

CurrentParagraphStyleChanged

Occurs when the current paragraph's style has changed.

Declaration
public event EventHandler CurrentParagraphStyleChanged
Event Type
System.EventHandler

CurrentSpanStyleChanged

Occurs when the current span's style has changed.

Declaration
public event EventHandler CurrentSpanStyleChanged
Event Type
System.EventHandler

CurrentVisiblePageChanged

Occurs when the CurrentPage property value has changed.

Declaration
public event EventHandler CurrentVisiblePageChanged
Event Type
System.EventHandler

DocumentArranged

Occurs when the current document has been arranged.

Declaration
public event EventHandler DocumentArranged
Event Type
System.EventHandler

DocumentChanged

Occurs when the current document has changed.

Declaration
public event EventHandler DocumentChanged
Event Type
System.EventHandler

DocumentChanging

Occurs when the current document is changing.

Declaration
public event EventHandler DocumentChanging
Event Type
System.EventHandler

DocumentContentChanged

Occurs when the content of the current document has changed.

Declaration
public event EventHandler DocumentContentChanged
Event Type
System.EventHandler

DocumentLayoutModeChanged

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

Declaration
public event EventHandler DocumentLayoutModeChanged
Event Type
System.EventHandler

DocumentPresentationChanged

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

HyperlinkClicked

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

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

IsReadOnlyChanged

Occurs when IsReadOnly property changes.

Declaration
public event EventHandler IsReadOnlyChanged
Event Type
System.EventHandler

MergeFieldToStringConverting

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

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

PreviewEditorKeyDown

Declaration
public event PreviewEditorKeyEventHandler PreviewEditorKeyDown
Event Type
PreviewEditorKeyEventHandler

PrintCompleted

Occurs when print is completed.

Declaration
public event EventHandler<PrintCompletedEventArgs> PrintCompleted
Event Type
System.EventHandler<PrintCompletedEventArgs>

PrintStarted

Occurs when printing has started.

Declaration
public event EventHandler PrintStarted
Event Type
System.EventHandler

ProtectionStateChanged

Occurs when the current protection state has changed.

Declaration
public event EventHandler ProtectionStateChanged
Event Type
System.EventHandler

Implements

ScaleFactorChanged

Occurs when the ScaleFactor property value has changed.

Declaration
public event EventHandler ScaleFactorChanged
Event Type
System.EventHandler

Implements

SelectedLayoutBoxChanged

Occurs when currently selected layout box has changed.

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

SelectionChanged

Occurs when selection is changed.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

StreamFromUriResolving

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

UntrackableCommandExecuting

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

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

UserInfoChanged

Occurs when the current user info has changed.

Declaration
public event EventHandler UserInfoChanged
Event Type
System.EventHandler

Explicit Interface Implementations

IDocumentEditor.ChangeForeColor(Color)

Changes the fore color of the selected content.

Declaration
void IDocumentEditor.ChangeForeColor(Color newColor)
Parameters
System.Windows.Media.Color newColor

The color.
Implements

IDocumentEditor.ChangeHighlightColor(Color)

Changes the highlight color of the selected content.

Declaration
void IDocumentEditor.ChangeHighlightColor(Color newColor)
Parameters
System.Windows.Media.Color newColor

The color.
Implements

IDocumentEditor.ChangeParagraphListStyle(ListStyle)

Changes the paragraph list style of the selected paragraphs.

Declaration
void IDocumentEditor.ChangeParagraphListStyle(ListStyle style)
Parameters
ListStyle style

The style.
Implements

IDocumentEditor.ChangeParagraphTextAlignment(RadTextAlignment)

Changes the text alignment of the selected paragraphs.

Declaration
void IDocumentEditor.ChangeParagraphTextAlignment(RadTextAlignment alignment)
Parameters
RadTextAlignment alignment

The alignment.
Implements

IDocumentEditor.ChangeSectionFooter(Section, HeaderFooterType, Footer)

Changes the section footer.

Declaration
void IDocumentEditor.ChangeSectionFooter(Section section, HeaderFooterType footerType, Footer footer)
Parameters
Section section

The section.
HeaderFooterType footerType

Type of the footer.
Footer footer

The footer.
Implements

IDocumentEditor.ChangeSectionHeader(Section, HeaderFooterType, Header)

Changes the section header.

Declaration
void IDocumentEditor.ChangeSectionHeader(Section section, HeaderFooterType headerType, Header header)
Parameters
Section section

The section.
HeaderFooterType headerType

Type of the header.
Header header

The header.
Implements

IDocumentEditor.Delete(Boolean)

Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the CaretPosition.

Declaration
bool IDocumentEditor.Delete(bool deletePrevious)
Parameters
System.Boolean deletePrevious

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

Implements

IDocumentEditor.DeleteHyperlink(HyperlinkRangeStart)

Deletes a hyperlink.

Declaration
void IDocumentEditor.DeleteHyperlink(HyperlinkRangeStart hyperlinkRangeStart)
Parameters
HyperlinkRangeStart hyperlinkRangeStart

The hyperlink range start.
Implements

IDocumentEditor.Insert(String)

Inserts text into the document at the current caret position.

Declaration
bool IDocumentEditor.Insert(string text)
Parameters
System.String text

The text to insert.
Returns
System.Boolean

Implements

IDocumentEditor.SetListNumbering(Int32)

Skips numbers and starts the counting of the current list from the specified value.

Declaration
bool IDocumentEditor.SetListNumbering(int numbersToSkip)
Parameters
System.Int32 numbersToSkip

The numbers to skip.
Returns
System.Boolean

A boolean value indicating whether the operation completed successfully.
Implements

IDocumentEditor.UpdatePermissionRanges(IEnumerable<PermissionRangeInfo>, IEnumerable<PermissionRangeInfo>)

Updates the permissions inside the current selection.

Declaration
void IDocumentEditor.UpdatePermissionRanges(IEnumerable<PermissionRangeInfo> permissionsToAdd, IEnumerable<PermissionRangeInfo> permissionsToRemove)
Parameters
System.Collections.Generic.IEnumerable<PermissionRangeInfo> permissionsToAdd

Permissions to add.
System.Collections.Generic.IEnumerable<PermissionRangeInfo> permissionsToRemove

Permissions to remove.
Implements

IDocumentEditorPresenterContainer.CallOnNoteReferenceClicked(MouseButtonEventArgs)

Declaration
void IDocumentEditorPresenterContainer.CallOnNoteReferenceClicked(MouseButtonEventArgs args)
Parameters
MouseButtonEventArgs args

Implements

IDocumentEditorPresenterContainer.DocumentEditor

Declaration
IDocumentEditor IDocumentEditorPresenterContainer.DocumentEditor { get; }
Returns
IDocumentEditor

Implements

IDocumentEditorPresenterContainer.GetUIProviderRegistry()

Declaration
UIProviderRegistry IDocumentEditorPresenterContainer.GetUIProviderRegistry()
Returns
UIProviderRegistry

Implements

IDocumentEditorPresenterContainer.HeaderFooterUIContext

Declaration
HeaderFooterUIContext IDocumentEditorPresenterContainer.HeaderFooterUIContext { get; }
Returns
HeaderFooterUIContext

Implements

IDocumentEditorPresenterContainer.HideSelectionMarkers()

Declaration
void IDocumentEditorPresenterContainer.HideSelectionMarkers()
Implements

IDocumentEditorPresenterContainer.InvalidateEditorArrange()

Declaration
void IDocumentEditorPresenterContainer.InvalidateEditorArrange()
Implements

IDocumentEditorPresenterContainer.InvalidateEditorMeasure()

Declaration
void IDocumentEditorPresenterContainer.InvalidateEditorMeasure()
Implements

IDocumentEditorPresenterContainer.SetActiveDocumentEditor(IDocumentEditor, DocumentEditorType)

Declaration
void IDocumentEditorPresenterContainer.SetActiveDocumentEditor(IDocumentEditor documentEditor, DocumentEditorType documentEditorType)
Parameters
IDocumentEditor documentEditor

DocumentEditorType documentEditorType

Implements

IDocumentEditorPresenterContainer.ShouldShowSelectionMarkers

Declaration
bool IDocumentEditorPresenterContainer.ShouldShowSelectionMarkers { get; }
Returns
System.Boolean

Implements

IDocumentEditorPresenterContainer.ShowSelectionMarkers()

Declaration
void IDocumentEditorPresenterContainer.ShowSelectionMarkers()
Implements

IDocumentEditorPresenterContainer.TrackCurrentEditingStyles()

Declaration
void IDocumentEditorPresenterContainer.TrackCurrentEditingStyles()
Implements

IDocumentEditorPresenterContainer.UpdateCurrentEditingStyle()

Declaration
void IDocumentEditorPresenterContainer.UpdateCurrentEditingStyle()
Implements

IDocumentEditorPresenterContainer.UpdateCurrentVisiblePage(Int32)

Declaration
void IDocumentEditorPresenterContainer.UpdateCurrentVisiblePage(int newValue)
Parameters
System.Int32 newValue

Implements

Extension Methods