Class RadRichTextBox
Inheritance
Inherited Members
Namespace: Telerik.WinForms.RichTextEditor
Assembly: Telerik.WinControls.RichTextEditor.dll
Syntax
public class RadRichTextBox : FrameworkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop, IDocumentEditorPresenterContainer, IDocumentEditor, ITextInputCommandsHandler, IPrintableConstructors
RadRichTextBox()
Declaration
public RadRichTextBox()Fields
AcceptsReturnProperty
AcceptsTabProperty
AllowScalingProperty
BorderColorProperty
CaretColorProperty
CommandsProperty
CommentTemplateContentMarginProperty
Declaration
public static readonly RadProperty CommentTemplateContentMarginPropertyField Value
CurrentUserProperty
DocumentInheritsDefaultStyleSettingsProperty
Declaration
public static readonly RadProperty DocumentInheritsDefaultStyleSettingsPropertyField Value
EnforcedPermissionRangeBrushProperty
Declaration
public static readonly RadProperty EnforcedPermissionRangeBrushPropertyField Value
HorizontalScrollBarHeightProperty
Declaration
public static readonly RadProperty HorizontalScrollBarHeightPropertyField Value
HorizontalScrollBarName
Declaration
public const string HorizontalScrollBarName = "HorizontalScrollBar"Field Value
|
System.
|
HorizontalScrollBarVisibilityProperty
Declaration
public static readonly RadProperty HorizontalScrollBarVisibilityPropertyField Value
HyperlinkNavigationModeProperty
HyperlinkToolTipFormatStringProperty
Declaration
public static readonly RadProperty HyperlinkToolTipFormatStringPropertyField Value
IsAdvancedSelectionEnabledProperty
Declaration
public static readonly RadProperty IsAdvancedSelectionEnabledPropertyField Value
IsContextMenuEnabledProperty
IsImageMiniToolBarEnabledProperty
Declaration
public static readonly RadProperty IsImageMiniToolBarEnabledPropertyField Value
IsPasteOptionsPopupEnabledProperty
Declaration
public static readonly RadProperty IsPasteOptionsPopupEnabledPropertyField Value
IsReadOnlyProperty
IsSelectionEnabledProperty
IsSelectionMiniToolBarEnabledProperty
Declaration
public static readonly RadProperty IsSelectionMiniToolBarEnabledPropertyField Value
IsSpellCheckingEnabledProperty
Declaration
public static readonly RadProperty IsSpellCheckingEnabledPropertyField Value
IsTrackChangesEnabledProperty
Declaration
public static readonly RadProperty IsTrackChangesEnabledPropertyField Value
LayoutModeProperty
LineBreakingRuleLanguageProperty
Declaration
public static readonly RadProperty LineBreakingRuleLanguagePropertyField Value
MaxScaleFactor
Represents the maximum scale factor the control supports.
Declaration
public static readonly double MaxScaleFactorField Value
|
System.
|
MeasuringPanelName
Declaration
public const string MeasuringPanelName = "MeasuringPanel"Field Value
|
System.
|
MinScaleFactor
Represents the minimum scale factor the control supports.
Declaration
public static readonly double MinScaleFactorField Value
|
System.
|
PrintingScreenName
Declaration
public const string PrintingScreenName = "PrintingScreen"Field Value
|
System.
|
ProtectionAuthenticationProviderProperty
Declaration
public static readonly RadProperty ProtectionAuthenticationProviderPropertyField Value
ScaleFactorProperty
SelectionFillColorProperty
SelectionFillProperty
SelectionStrokeColorProperty
SelectionStrokeProperty
ShowCommentsProperty
ShowFormattingSymbolsProperty
Declaration
public static readonly RadProperty ShowFormattingSymbolsPropertyField Value
ShowMergeFieldsHighlightProperty
Declaration
public static readonly RadProperty ShowMergeFieldsHighlightPropertyField Value
VerticalScrollBarName
Declaration
public const string VerticalScrollBarName = "VerticalScrollBar"Field Value
|
System.
|
VerticalScrollBarVisibilityProperty
Declaration
public static readonly RadProperty VerticalScrollBarVisibilityPropertyField Value
VerticalScrollBarWidthProperty
Declaration
public static readonly RadProperty VerticalScrollBarWidthPropertyField Value
ViewContentPresenter
Declaration
public const string ViewContentPresenter = "ViewPresenter"Field Value
|
System.
|
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.
|
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.
|
Implements
ActiveDocumentEditor
Gets the currently active editor.
Declaration
public IDocumentEditor ActiveDocumentEditor { get; }Property Value
ActiveEditor
Gets the currently active editor.
Declaration
public RadRichTextBox ActiveEditor { get; }Property Value
ActiveEditorPresenter
Gets or sets a value representing the active document presenter.
Declaration
public IDocumentEditorPresenter ActiveEditorPresenter { get; set; }Property Value
AddNewBibliographicSourceDialog
Gets or sets the dialog for adding bibliographic sources.
Declaration
public IAddNewBibliographicSourceDialog AddNewBibliographicSourceDialog { get; set; }Property Value
AllowScaling
Gets or sets a value indicating whether the scaling is enabled.
Declaration
public bool AllowScaling { get; set; }Property Value
|
System.
|
Implements
AutoInsertHyperlinks
Gets or sets a value indicating whether hyperlinks should be automatically detected.
Declaration
public bool AutoInsertHyperlinks { get; set; }Property Value
|
System.
|
Implements
BorderColor
Declaration
[VsbBrowsable(true)]
public Color BorderColor { get; set; }Property Value
|
System.
|
CaretColor
Gets or sets the color of the caret.
Declaration
public Color CaretColor { get; set; }Property Value
Implements
CaretFactory
Gets or sets an instance implementing ICaret
Declaration
public ICaretFactory CaretFactory { get; set; }Property Value
Implements
CaretWidth
Gets or sets the width of the caret.
Declaration
public float CaretWidth { get; set; }Property Value
|
System.
|
ChangeEditingPermissionsDialog
Gets or sets the dialog for changing editing permissions of the document.
Declaration
public IChangeEditingPermissionsDialog ChangeEditingPermissionsDialog { get; set; }Property Value
CheckBoxPropertiesDialog
Gets or sets a value representing the current dialog for editing CheckBox content control properties.
Declaration
public ICheckBoxPropertiesDialog CheckBoxPropertiesDialog { get; set; }Property Value
CodeFormattingDialog
Gets or sets the dialog for formatting code blocks.
Declaration
public ICodeFormattingDialog CodeFormattingDialog { get; set; }Property Value
Commands
Gets or sets a collection of commands that can be executed.
Declaration
public RichTextBoxCommands Commands { get; set; }Property Value
CommentPaneMinWidth
Gets or sets the minimum width of the panel containing comments.
Declaration
public double CommentPaneMinWidth { get; set; }Property Value
|
System.
|
Implements
CommentTemplateContentMargin
Gets or sets the comment template content margin.
Declaration
public Thickness CommentTemplateContentMargin { get; set; }Property Value
Implements
ContextMenu
Gets or sets the context menu.
Declaration
public IContextMenu ContextMenu { get; set; }Property Value
CurrentEditingContext
Gets the current editing context.
Declaration
public EditingContext CurrentEditingContext { get; }Property Value
Implements
CurrentEditingStyle
Gets a value indicating the current editing style.
Declaration
public StyleDefinition CurrentEditingStyle { get; }Property Value
Implements
CurrentParagraphStyle
Gets a paragraph object containing the style settings of the current paragraph.
Declaration
public Paragraph CurrentParagraphStyle { get; }Property Value
CurrentSpanStyle
Gets a span object containing the style settings of the current span.
Declaration
public Span CurrentSpanStyle { get; }Property Value
CurrentUser
Gets or sets the currently active user.
Declaration
public UserInfo CurrentUser { get; set; }Property Value
CurrentVisiblePage
Gets the index of the currently visible page.
Declaration
public int CurrentVisiblePage { get; }Property Value
|
System.
|
DatePickerPropertiesDialog
Gets or sets a value representing the current dialog for editing DatePicker content control properties.
Declaration
public IDatePickerPropertiesDialog DatePickerPropertiesDialog { get; set; }Property Value
DefaultTextRenderingMode
Declaration
public static TextBlockRenderingMode DefaultTextRenderingMode { get; set; }Property Value
Document
Gets or sets the currently active document in the editor.
Declaration
public RadDocument Document { get; set; }Property Value
Implements
DocumentInheritsDefaultStyleSettings
Gets or sets value indicating whether the edited Document instance should use by default the FontFamily, FontSize, ForeColor and other style properties applied to this RadRichTextBox using the DefaultStyleSettings.
Declaration
public bool DocumentInheritsDefaultStyleSettings { get; set; }Property Value
|
System.
|
DropDownListPropertiesDialog
Gets or sets a value representing the current dialog for editing DropDownList content control properties.
Declaration
public IDropDownListPropertiesDialog DropDownListPropertiesDialog { get; set; }Property Value
EditCustomDictionaryDialog
Gets or sets the dialog for editing custom dictionaries.
Declaration
public IEditCustomDictionaryDialog EditCustomDictionaryDialog { get; set; }Property Value
EmailPattern
Gets or sets the pattern used for matching emails
Declaration
public string EmailPattern { get; set; }Property Value
|
System.
|
Implements
EnforcedPermissionRangeBrush
Declaration
public Brush EnforcedPermissionRangeBrush { get; set; }Property Value
|
System.
|
Implements
FieldShadingMode
Gets or sets the field shading type/
Declaration
public FieldShadingType FieldShadingMode { get; set; }Property Value
Implements
FindReplaceDialog
Gets or sets the find and replace dialog.
Declaration
public IFindReplaceDialog FindReplaceDialog { get; set; }Property Value
FloatingBlockPropertiesDialog
Gets or sets the dialog for editing floating block properties.
Declaration
public IFloatingBlockPropertiesDialog FloatingBlockPropertiesDialog { get; set; }Property Value
FlowDirection
Gets or sets the direction of flow of the elements.
Declaration
public override FlowDirection FlowDirection { get; }Property Value
Overrides
FontPropertiesDialog
Gets or sets the dialog for editing font properties.
Declaration
public IFontPropertiesDialog FontPropertiesDialog { get; set; }Property Value
HorizontalScrollBar
Gets the horizontal scroll bar of the Rad
Declaration
public RadScrollBarElement HorizontalScrollBar { get; }Property Value
HorizontalScrollBarHeight
Gets or sets the height of the horizontal scroll bar.
Declaration
public int HorizontalScrollBarHeight { get; set; }Property Value
|
System.
|
HorizontalScrollBarVisibility
Gets or sets a value representing the horizontal scroll bar visibility.
Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }Property Value
HyperlinkNavigationMode
HyperlinkPattern
Gets or sets the pattern used for matching hyperlinks
Declaration
public string HyperlinkPattern { get; set; }Property Value
|
System.
|
Implements
HyperlinkToolTipFormatString
Gets or sets the hyperlink tool text.
Declaration
public string HyperlinkToolTipFormatString { get; set; }Property Value
|
System. The hyperlink tool tip. |
IgnoredWords
Gets or sets an instance of IIgnoredWordDictionary that provides a list of words that would be ignored by spell checker.
Declaration
public IIgnoredWordDictionary IgnoredWords { get; set; }Property Value
Implements
See Also
ImageEditorDialog
Gets or sets the dialog for editing images.
Declaration
public IImageEditorDialog ImageEditorDialog { get; set; }Property Value
ImageMiniToolBar
Gets or sets the image mini toolbar.
Declaration
public IImageMiniToolBar ImageMiniToolBar { get; set; }Property Value
ImageSelectionAdornerSettings
Gets an object containing the options available for the Image selection adorner.
Declaration
public ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }Property Value
Implements
InputHandler
Gets or sets an instance of Rich
Declaration
public RichTextEditorInputBehavior InputHandler { get; set; }Property Value
InsertCaptionDialog
Gets or sets the dialog for inserting captions.
Declaration
public IInsertCaptionDialog InsertCaptionDialog { get; set; }Property Value
InsertCrossReferenceWindow
Gets or sets the dialog for inserting cross-reference windows.
Declaration
public IInsertCrossReferenceWindow InsertCrossReferenceWindow { get; set; }Property Value
InsertDateTimeDialog
Gets or sets the dialog for inserting date time values.
Declaration
public IInsertDateTimeDialog InsertDateTimeDialog { get; set; }Property Value
InsertHyperlinkDialog
Gets or sets the dialog for inserting hyperlinks in the document.
Declaration
public IInsertHyperlinkDialog InsertHyperlinkDialog { get; set; }Property Value
InsertSymbolWindow
Gets or sets the dialog for inserting symbols in the document.
Declaration
public IInsertSymbolWindow InsertSymbolWindow { get; set; }Property Value
InsertTableDialog
Gets or sets the dialog for inserting tables in the document.
Declaration
public IInsertTableDialog InsertTableDialog { get; set; }Property Value
InsertTableOfContentsDialog
Gets or sets the dialog for inserting table of contents.
Declaration
public IInsertTableOfContentsDialog InsertTableOfContentsDialog { get; set; }Property Value
IsAdvancedSelectionEnabled
Gets or sets a value that indicates whether a the advanced selection mode is enabled. If so, when the cursor leaves the initial word the selection continues by expanding with a whole word every time until the cursor moves in the opposite direction. When the cursor returns to the initial word the selection continues to expand one character at a time. More about this behavior can be learned in the documentation.
Declaration
public bool IsAdvancedSelectionEnabled { get; set; }Property Value
|
System.
|
IsContextMenuEnabled
Gets or sets a value indicating whether context menu is enabled.
Declaration
public bool IsContextMenuEnabled { get; set; }Property Value
|
System.
|
IsImageMiniToolBarEnabled
Gets or sets a value indicating whether the mini toolbar that appears when an image is selected is enabled. NOTE: not supported for WinForms
Declaration
public bool IsImageMiniToolBarEnabled { get; set; }Property Value
|
System.
|
IsInHeaderFooterEditMode
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.
|
IsReadOnly
Gets or sets a value indicating whether the control is read-only.
Declaration
public bool IsReadOnly { get; set; }Property Value
|
System.
|
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.
|
IsSelectionMiniToolBarEnabled
Gets or sets a value indicating whether the mini toolbar that appears after a selection is enabled.
Declaration
public bool IsSelectionMiniToolBarEnabled { get; set; }Property Value
|
System.
|
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.
|
Implements
IsTrackChangesEnabled
Gets or sets a value indicating whether formatting symbols are shown in the document.
Declaration
public bool IsTrackChangesEnabled { get; set; }Property Value
|
System.
|
LayoutMode
Gets or sets the document layout mode.
Declaration
public DocumentLayoutMode? LayoutMode { get; set; }Property Value
|
System. 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
|
Line The line breaking characters rule language. |
LineNumberingDialog
Gets or sets a value representing the current line numbering dialog.
Declaration
public ILineNumberingDialog LineNumberingDialog { get; set; }Property Value
ManageBibliographicSourcesDialog
Gets or sets the dialog for managing bibliographics sources.
Declaration
public IManageBibliographicSourcesDialog ManageBibliographicSourcesDialog { get; set; }Property Value
ManageBookmarksDialog
Gets or sets the dialog for managing bookmarks in the document.
Declaration
public IManageBookmarksDialog ManageBookmarksDialog { get; set; }Property Value
ManageStylesDialog
Gets or sets the dialog for managing styles.
Declaration
public IManageStylesDialog ManageStylesDialog { get; set; }Property Value
MeasuringPanel
MentionBox
MentionContext
NotesDialog
Gets or sets the dialog for editing footnotes and endnotes properties.
Declaration
public INotesDialog NotesDialog { get; set; }Property Value
PageBackColor
Gets or sets the back color that should be applied to all pages.
Declaration
public Color PageBackColor { get; set; }Property Value
|
System.
|
ParagraphPropertiesDialog
Gets or sets the dialog for editing paragraph properties.
Declaration
public IParagraphPropertiesDialog ParagraphPropertiesDialog { get; set; }Property Value
PasteOptionsPopup
Declaration
public IPasteOptionsPopup PasteOptionsPopup { get; set; }Property Value
PasteSettings
Gets the current PasteSettings associated with RadRichTextBox
Declaration
public PasteSettings PasteSettings { get; }Property Value
PicturePropertiesDialog
Gets or sets a value representing the current dialog for editing Picture content control properties.
Declaration
public IPicturePropertiesDialog PicturePropertiesDialog { get; set; }Property Value
PlainTextPropertiesDialog
Gets or sets a value representing the current dialog for editing PlainText content control properties.
Declaration
public IPlainTextPropertiesDialog PlainTextPropertiesDialog { get; set; }Property Value
ProtectDocumentDialog
Gets or sets the dialog for editing protection settings for the document.
Declaration
public IProtectDocumentDialog ProtectDocumentDialog { get; set; }Property Value
ProtectionAuthenticationProvider
Gets or sets the Protection Authentication Provider
Declaration
public IProtectionAuthenticationProvider ProtectionAuthenticationProvider { get; set; }Property Value
RepeatingSectionPropertiesDialog
Gets or sets a value representing the current dialog for editing RepeatingSection content control properties.
Declaration
public IRepeatingSectionPropertiesDialog RepeatingSectionPropertiesDialog { get; set; }Property Value
RichTextPropertiesDialog
Gets or sets a value representing the current dialog for editing RichText content control properties.
Declaration
public IRichTextPropertiesDialog RichTextPropertiesDialog { get; set; }Property Value
ScaleFactor
Gets or sets a value representing the current view scale factor.
Declaration
public Size ScaleFactor { get; set; }Property Value
Implements
SectionColumnsDialog
Gets or sets a value representing the current section columns dialog.
Declaration
public ISectionColumnsDialog SectionColumnsDialog { get; set; }Property Value
SelectedComment
Gets or sets the currently selected comment.
Declaration
public Comment SelectedComment { get; set; }Property Value
Implements
SelectedNote
Gets or sets the currently selected note.
Declaration
public Note SelectedNote { get; set; }Property Value
Implements
SelectionFill
Gets or sets the color of the selection rectangle.
Declaration
public Brush SelectionFill { get; set; }Property Value
|
System.
|
Implements
SelectionFillColor
Declaration
[VsbBrowsable(true)]
public Color SelectionFillColor { get; set; }Property Value
|
System.
|
SelectionMiniToolBar
Gets or sets the selection mini toolbar.
Declaration
public ISelectionMiniToolBar SelectionMiniToolBar { get; set; }Property Value
SelectionStroke
Gets or sets the brush for the selection rectangle border.
Declaration
public Brush SelectionStroke { get; set; }Property Value
|
System.
|
Implements
SelectionStrokeColor
Declaration
[VsbBrowsable(true)]
public Color SelectionStrokeColor { get; set; }Property Value
|
System.
|
SetNumberingValueDialog
Gets or sets the dialog for setting numbering values.
Declaration
public ISetNumberingValueDialog SetNumberingValueDialog { get; set; }Property Value
ShouldChangeIconsOnThemeChange
Declaration
public virtual bool ShouldChangeIconsOnThemeChange { get; set; }Property Value
|
System.
|
ShowComments
Gets or sets a value indicating whether the comments are shown.
Declaration
public bool ShowComments { get; set; }Property Value
|
System.
|
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.
|
Implements
ShowMergeFieldsHighlight
Gets or sets a value indicating whether Merge Fields will be highlighted.
Declaration
public bool ShowMergeFieldsHighlight { get; set; }Property Value
|
System.
|
SpellChecker
Gets or sets the ISpellChecker implementation used when proofing.
Declaration
public ISpellChecker SpellChecker { get; set; }Property Value
Implements
SpellCheckingDialog
Gets or sets the dialog for spell checking.
Declaration
public ISpellCheckingDialog SpellCheckingDialog { get; set; }Property Value
StyleFormattingPropertiesDialog
Gets or sets the dialog for editing style properties.
Declaration
public IStyleFormattingPropertiesDialog StyleFormattingPropertiesDialog { get; set; }Property Value
TableBordersDialog
Gets or sets the dialog for editing table borders.
Declaration
public ITableBordersDialog TableBordersDialog { get; set; }Property Value
TablePropertiesDialog
Gets or sets the dialog for editing table properties.
Declaration
public ITablePropertiesDialog TablePropertiesDialog { get; set; }Property Value
TabStopsPropertiesDialog
Gets or sets the dialog for editing tab stop properties.
Declaration
public ITabStopsPropertiesDialog TabStopsPropertiesDialog { get; set; }Property Value
TrackChangesOptions
Gets the object containing options available for Track changes.
Declaration
public TrackChangesOptions TrackChangesOptions { get; }Property Value
UILayersBuilder
Gets or sets an instance of UILayers
Declaration
public UILayersBuilder UILayersBuilder { get; set; }Property Value
Implements
UnprotectDocumentDialog
Gets or sets the dialog for removing protection restrictions on the document.
Declaration
public IUnprotectDocumentDialog UnprotectDocumentDialog { get; set; }Property Value
Users
Gets or sets a collection containing the users' permissions on the current document.
Declaration
public PermissionInfoCollection Users { get; set; }Property Value
VerticalScrollBar
Gets the vertical scroll bar of the Rad
Declaration
public RadScrollBarElement VerticalScrollBar { get; }Property Value
VerticalScrollBarVisibility
Gets or sets a value representing the vertical scroll bar visibility.
Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }Property Value
VerticalScrollBarWidth
Gets or sets the width of the vertical scroll bar.
Declaration
public int VerticalScrollBarWidth { get; set; }Property Value
|
System.
|
WatermarkSettingsDialog
Gets or sets the dialog for editing watermark settings.
Declaration
public IWatermarkSettingsDialog WatermarkSettingsDialog { get; set; }Property Value
Methods
AcceptAllRevisions()
Accepts all revisions in the current document.
Declaration
public void AcceptAllRevisions()Implements
AcceptRevision(Revision)
Accepts revision.
Declaration
public void AcceptRevision(Revision revision)Parameters
|
Revision
revision
The revision. |
Implements
AddTabStop(TabStop)
Adds a tab stop at the current position in the document.
Declaration
public void AddTabStop(TabStop tabStop)Parameters
|
Tab The tab stop to add. |
Implements
AddTabStopRange(IEnumerable<TabStop>)
Adds the enumeration of tab stops.
Declaration
public void AddTabStopRange(IEnumerable<TabStop> tabStops)Parameters
|
System. The tab stops to add. |
Implements
ArrangeOverride(SizeF)
Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)Parameters
|
System.
|
Returns
|
System.
|
Overrides
BeginUndoGroup()
Begins new undo group.
Declaration
public void BeginUndoGroup()Implements
CancelUndoGroup()
Cancels current undo group.
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. 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
|
Field The display mode. |
Implements
ChangeBaselineAlignment(BaselineAlignment)
Changes the baseline alignment of the current run in the document.
Declaration
public void ChangeBaselineAlignment(BaselineAlignment newBaselineAlignment)Parameters
|
Baseline The new baseline alignment to be applied. |
Implements
ChangeBibliographicStyle(BibliographicReferenceStyleBase)
Changes the bibliographic style of all bibliography related fields in the document.
Declaration
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)Parameters
|
Bibliographic The new bibliographic style. |
Implements
ChangeDifferentFirstPageHeaderFooter(Boolean)
ChangeDifferentOddAndEvenPagesHeaderFooter(Boolean)
ChangeDocumentDefaultTabWidth(Double)
Changes the space a single Tab (\t) character takes.
Declaration
public void ChangeDocumentDefaultTabWidth(double tabWidth)Parameters
|
System. The new width. |
Implements
ChangeDocumentElementTag(DocumentElement, String)
Changes the Tag property of a specified DocumentElement.
Declaration
public void ChangeDocumentElementTag(DocumentElement element, string tag)Parameters
|
Document The DocumentElement. |
|
System. The new tag value. |
Implements
ChangeDocumentEndnotesFirstNumber(Int32)
Changes the first number for endnotes for the entire document.
Declaration
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)Parameters
|
System. The new start number. |
Implements
ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)
Changes the endnotes numbering format for the entire document.
Declaration
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
|
List The new numbering format. |
Implements
ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)
Changes where endtnote numbers will stop incrementing and will start from the first one for the entire document.
Declaration
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The new restart type. |
Implements
ChangeDocumentEndnotesPosition(EndnotesPosition)
Changes the position of the endnotes for the entire document.
Declaration
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)Parameters
|
Endnotes
|
Implements
ChangeDocumentFootnotesFirstNumber(Int32)
Changes the first number for footnotes for the entire document.
Declaration
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)Parameters
|
System. The new start number. |
Implements
ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)
Changes the footnotes numbering format for the entire document.
Declaration
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
|
List The new numbering format. |
Implements
ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)
Changes where footnote numbers will stop incrementing and will start from the first one for the entire document.
Declaration
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The new restart type. |
Implements
ChangeDocumentFootnotesPosition(FootnotesPosition)
Changes the position of the footnoes for the entire document.
Declaration
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)Parameters
|
Footnotes The new footnotes position. |
Implements
ChangeDocumentIsStrictLineBreakingRuleEnabled(Boolean)
Sets a value indicating whether strict line brealing rule is enabled.
Declaration
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)Parameters
|
System. true if rule should be enabled otherwise false. |
Implements
ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)
Changes the language for which line breaking rules are currently applied in the document.
Declaration
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)Parameters
|
Line The new language for which line breaking rules are applied. |
Implements
ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)
Changes the characters after which a line break cannot be placed.
Declaration
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)Parameters
|
Line The new rule for line breaks after a character. |
Implements
ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)
Changes the characters before which a line break cannot be placed.
Declaration
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)Parameters
|
Line The new rule for line breaks before a character. |
Implements
ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)
Changes the field display mode.
Declaration
public void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)Parameters
|
Field The field start. |
|
Field The new display mode. |
Implements
ChangeFontFamily(FontFamily)
Changes the font family of the current run in the document.
Declaration
public void ChangeFontFamily(FontFamily fontFamily)Parameters
|
Font The new font family to be applied. |
Implements
ChangeFontSize(Double)
Changes the font size of the current run in the document.
Declaration
public void ChangeFontSize(double newFontSize)Parameters
|
System. The new font size to be applied. |
Implements
ChangeFontStyle(FontStyle)
Changes the font style of the current run in the document.
Declaration
public void ChangeFontStyle(FontStyle fontStyle)Parameters
|
System. The new font style. |
ChangeFontStyle(FontStyle)
Changes the font style of the current run in the document.
Declaration
public void ChangeFontStyle(FontStyle fontStyle)Parameters
|
Font The new font style. |
Implements
ChangeFontWeight(FontWeight)
Changes the font weight of the current run in the document.
Declaration
public void ChangeFontWeight(FontWeight fontWeight)Parameters
|
Font The new font weight. |
Implements
ChangeImageRotateAngle(ImageInline, Double)
Changes the image rotate angle.
Declaration
public void ChangeImageRotateAngle(ImageInline image, double angle)Parameters
|
Image The ImageInline. |
|
System. The new angle. |
Implements
ChangeImageSize(ImageInline, Size)
Changes the size of the image.
Declaration
public void ChangeImageSize(ImageInline image, Size size)Parameters
|
Image The ImageInline. |
|
Size
size
The new size. |
Implements
ChangeLayoutMode(DocumentLayoutMode)
Changes the layout mode.
Declaration
public void ChangeLayoutMode(DocumentLayoutMode layoutMode)Parameters
|
Document The new layout mode to be applied. |
ChangeLineNumberingRestartType(LineNumberingRestartType)
Changes the restart type of line numberings for the selected sections.
Declaration
public void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)Parameters
|
Line The line numbering restart type. |
Implements
ChangeListStyle(ListStyle)
Changes the paragraph style of the current paragraph.
Declaration
public void ChangeListStyle(ListStyle style)Parameters
|
List The new style to be applied. |
ChangeParagraphAutomaticSpacingAfter(Boolean)
Controls whether automatic spacing is applied after the current paragraph.
Declaration
public void ChangeParagraphAutomaticSpacingAfter(bool value)Parameters
|
System. True if automatic spacing should be applied, otherwise false. |
Implements
ChangeParagraphAutomaticSpacingBefore(Boolean)
Controls whether automatic spacing is applied before the current paragraph.
Declaration
public void ChangeParagraphAutomaticSpacingBefore(bool value)Parameters
|
System. True if automatic spacing should be applied, otherwise false. |
Implements
ChangeParagraphBackground(Color)
Changes the background color of the selected paragraphs in the document.
Declaration
public void ChangeParagraphBackground(Color color)Parameters
|
Color
color
The new background color to be applied. |
Implements
ChangeParagraphFirstLineIndent(Double)
Changes the left indent of the current paragraph.
Declaration
public void ChangeParagraphFirstLineIndent(double firstLineIndent)Parameters
|
System. The new left indent to be applied. |
Implements
ChangeParagraphFlowDirection(FlowDirection)
Changes the flow direction of the selected paragraphs in the document.
Declaration
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)Parameters
|
Flow The new flow direction to be applied. |
Implements
ChangeParagraphIsLineBreakingRuleEnabled(Boolean)
Sets a value indicating whether line brealing rules are enabled.
Declaration
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)Parameters
|
System. true if rules should be enabled otherwise false. |
Implements
ChangeParagraphLeftIndent(Double)
Changes the left indent of the current paragraph.
Declaration
public void ChangeParagraphLeftIndent(double leftIndent)Parameters
|
System. The new left indent to be applied. |
Implements
ChangeParagraphLineSpacing(Double)
Changes the lines spacing inside the current paragraph.
Declaration
public void ChangeParagraphLineSpacing(double lineSpacing)Parameters
|
System. The new line spacing to be applied. |
Implements
ChangeParagraphLineSpacing(Double, LineSpacingType)
Changes the line spacing inside the current paragraph.
Declaration
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)Parameters
|
System. The new line spacing to be applied. |
|
Line The type of the line spacing to be applied. |
Implements
ChangeParagraphLineSpacingType(LineSpacingType)
Changes the line spacing type inside the current paragraph.
Declaration
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)Parameters
|
Line The new line spacing type to be applied. |
Implements
ChangeParagraphListLevel(Int32)
Changes the list level the paragraph is currently in.
Declaration
public void ChangeParagraphListLevel(int listLevel)Parameters
|
System. The list level to be applied. |
Implements
ChangeParagraphRightIndent(Double)
Changes the right indent of the current paragraph.
Declaration
public void ChangeParagraphRightIndent(double rightIndent)Parameters
|
System. The new right indent to be applied. |
Implements
ChangeParagraphSpacingAfter(Double)
Changes the spacing after the current paragraph.
Declaration
public void ChangeParagraphSpacingAfter(double spacingAfter)Parameters
|
System. The new spacing to be applied. |
Implements
ChangeParagraphSpacingBefore(Double)
Changes the spacing before the current paragraph.
Declaration
public void ChangeParagraphSpacingBefore(double spacingBefore)Parameters
|
System. The new spacing to be applied. |
Implements
ChangeParagraphStyle(StyleDefinition)
Changes the paragraph style of the current paragraph.
Declaration
public void ChangeParagraphStyle(StyleDefinition styleInfo)Parameters
|
Style The new style to be applied. |
Implements
ChangeSectionActualPageMargin(Padding)
Changes the actual page margin (regarding the page orientation) of the section.
Declaration
public void ChangeSectionActualPageMargin(Padding sectionMargin)Parameters
|
Padding
sectionMargin
The section margin. |
Implements
ChangeSectionColumns(SectionColumnCollection)
ChangeSectionColumns
Declaration
public void ChangeSectionColumns(SectionColumnCollection columnCollection)Parameters
|
Section columns |
Implements
ChangeSectionColumns(SectionColumnsLayout)
ChangeSectionColumns
Declaration
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)Parameters
|
Section Section Columns Layout |
Implements
ChangeSectionEndnotesFirstNumber(Int32)
Changes the first number for endnotes for the current section.
Declaration
public void ChangeSectionEndnotesFirstNumber(int firstNumber)Parameters
|
System. The new start number. |
Implements
ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)
Changes the endnotes numbering format for the current section.
Declaration
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
|
List The new numbering format. |
Implements
ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)
Changes where endtnote numbers will stop incrementing and will start from the first one for the current section.
Declaration
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The new restart type. |
Implements
ChangeSectionFirstPageNumber(Nullable<Int32>)
Changes the first page number of the current section. Set null continue numeration form the previous section.
Declaration
public void ChangeSectionFirstPageNumber(int? firstPageNumber)Parameters
|
System. The new first page number value. |
Implements
ChangeSectionFooterBottomMargin(Int32)
ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, Boolean)
ChangeSectionFootnotesFirstNumber(Int32)
Changes the first number for footnotes for the current section.
Declaration
public void ChangeSectionFootnotesFirstNumber(int firstNumber)Parameters
|
System. The new start number. |
Implements
ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)
Changes the footnotes numbering format for the current section.
Declaration
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat listNumberingFormat)Parameters
|
List The new numbering format. |
Implements
ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)
Changes where footnote numbers will stop incrementing and will start from the first one for the current section.
Declaration
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The new restart type. |
Implements
ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, Boolean)
ChangeSectionHeaderTopMargin(Int32)
Changes the top margin of the header of the current section.
Declaration
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)Parameters
|
System. Header top margin to be applied. |
Implements
ChangeSectionLineNumbering(LineNumbering)
Changes the line numberings for the selected sections.
Declaration
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)Parameters
|
Line The line numbering. |
Implements
ChangeSectionPageMargin(Padding)
Changes the page margin of the current section.
Declaration
public void ChangeSectionPageMargin(Padding sectionMargin)Parameters
|
Padding
sectionMargin
The new margin to be applied. |
Implements
ChangeSectionPageOrientation(PageOrientation)
Changes the page orientation of the current section.
Declaration
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)Parameters
|
Page The new page orientation to be applied. |
Implements
ChangeSectionPageSize(Size)
Changes the page size of the current section.
Declaration
public void ChangeSectionPageSize(Size size)Parameters
|
Size
size
The new page size to be applied. |
Implements
ChangeSpanStyle(StyleDefinition)
Changes the style of current run in the document.
Declaration
public void ChangeSpanStyle(StyleDefinition styleInfo)Parameters
|
Style The new style to be applied. |
Implements
ChangeStrikethrough(Boolean)
Changes the strikethrough of the current run in the document.
Declaration
public void ChangeStrikethrough(bool isStrikethrough)Parameters
|
System. The new strikethrough value. |
Implements
ChangeStyleName(String)
Applies style with a given name to the selected elements in the document.
Declaration
public void ChangeStyleName(string styleName)Parameters
|
System. Name of the style. |
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. Name of the style. |
|
System. If true, the linked style may be used depending on the selection. |
Implements
ChangeStyleNameToActiveEditor(String)
Changes the style name of the current run in the document.
Declaration
public void ChangeStyleNameToActiveEditor(string newStyleName)Parameters
|
System.
|
ChangeTableBorders(TableBorders)
Changes the borders of the current table.
Declaration
public void ChangeTableBorders(TableBorders borders)Parameters
|
Table The new table borders. |
Implements
ChangeTableCellBackground(Color)
Changes the back color of the current cell.
Declaration
public void ChangeTableCellBackground(Color color)Parameters
|
Color
color
The new cell back color. |
Implements
ChangeTableCellBorders(Border)
Changes the borders style of the current cell.
Declaration
public void ChangeTableCellBorders(Border border)Parameters
|
Border
border
The new borders style. |
Implements
ChangeTableCellBorders(TableCellBorders)
Changes the cell border styles of the current table.
Declaration
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)Parameters
|
Table The new cell border styles. |
Implements
ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)
Changes the content alignment of the currently selected cells.
Declaration
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)Parameters
|
Rad The new horizontal alignment. |
|
Rad The new vertical alignment. |
Implements
ChangeTableCellHorizontalContentAlignment(RadTextAlignment)
Changes the horizontal alignment of the currently selected cells.
Declaration
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)Parameters
|
Rad The new horizontal alignment. |
Implements
ChangeTableCellPadding(Padding)
Changes the cell padding for the currently selected cells.
Declaration
public void ChangeTableCellPadding(Padding padding)Parameters
|
Padding
padding
The new padding. |
Implements
ChangeTableCellSpacing(Double)
Changes the cell spacing of the current table.
Declaration
public void ChangeTableCellSpacing(double cellSpacing)Parameters
|
System. The new cell spacing. |
Implements
ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)
Changes the vertical alignment of the currently selected cells.
Declaration
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)Parameters
|
Rad The new vertical alignment. |
Implements
ChangeTableDefaultCellPadding(Padding)
Changes the default padding applied to cells of the current table.
Declaration
public void ChangeTableDefaultCellPadding(Padding padding)Parameters
|
Padding
padding
The new padding. |
Implements
ChangeTableFlowDirection(FlowDirection)
Changes the flow direction of the current table.
Declaration
public void ChangeTableFlowDirection(FlowDirection flowDirection)Parameters
|
Flow The new flow direction. |
Implements
ChangeTableGridColumnWidth(Table, Int32, TableWidthUnit)
Changes the width of the column at the given index in the given table.
Declaration
public void ChangeTableGridColumnWidth(Table table, int gridColumnIndex, TableWidthUnit width)Parameters
|
Table
table
The table containing the column. |
|
System. The index of the column in the table. |
|
Table The new column width. |
Implements
ChangeTableHorizontalAlignment(RadHorizontalAlignment)
Changhes the table horizontal alignment.
Declaration
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)Parameters
|
Rad The new alignment. |
Implements
ChangeTableIndent(Double)
Changes the table indent.
Declaration
public void ChangeTableIndent(double indent)Parameters
|
System. The new indent. |
Implements
ChangeTableLayoutMode(Table, TableLayoutMode)
Changes the layout mode of the given table.
Declaration
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)Parameters
|
Table
table
The table to change the layout of. |
|
Table The new layout mode. |
Implements
ChangeTableLook(TableLook)
Changes the visual appearance of the current table.
Declaration
public void ChangeTableLook(TableLook tableLook)Parameters
|
Table The new visual settings. |
Implements
ChangeTablePreferredWidth(TableWidthUnit)
Changes the preferred width for the current table.
Declaration
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Parameters
|
Table
|
Implements
ChangeTableRowHeight(TableRow, Double)
Changes the height of the given table row.
Declaration
public void ChangeTableRowHeight(TableRow tableRow, double height)Parameters
|
Table The row to change the height of. |
|
System. The new height. |
Implements
ChangeTableRowRepeatOnEveryPage(TableRow)
ChangeTableRowRepeatOnEveryPage
Declaration
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)Parameters
|
Table
|
Implements
ChangeTextAlignment(RadTextAlignment)
Changes the text alignment of the current run in the document.
Declaration
public void ChangeTextAlignment(RadTextAlignment alignment)Parameters
|
Rad The new text alignment to be applied. |
ChangeTextForeColor(Color)
Changes the text foreground color of the current run in the document.
Declaration
public void ChangeTextForeColor(Color newColor)Parameters
|
Color
newColor
The new foreground color to be applied. |
ChangeTextHighlightColor(Color)
Changes the text highligh color of the current run in the document.
Declaration
public void ChangeTextHighlightColor(Color newColor)Parameters
|
Color
newColor
The new highlight color to be applied. |
ChangeUnderlineColor(Color)
Changes the underline color of the current run in the document.
Declaration
public void ChangeUnderlineColor(Color newColor)Parameters
|
Color
newColor
The new underline color to be applied. |
Implements
ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)
Changes the underline decoration of the current run in the document.
Declaration
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)Parameters
|
IUnderline The new underline decoration provider to be applied. |
Implements
ClearAllFormatting()
Clears all of the formatting of the current paragraph and run in the document.
Declaration
public void ClearAllFormatting()Implements
ClearFormatting()
Clears the formatting of the current run in the document.
Declaration
public void ClearFormatting()Implements
ClearTabStops()
Removes all tab stops from the currently selected paragraphs.
Declaration
public void ClearTabStops()Implements
ContinueListNumbering()
Removes all paragraphs from the current list and continues the first possible list before that paragraph. The paragraph should be in list and should be first in the list, otherwise this method does nothing.
Declaration
public bool ContinueListNumbering()Returns
|
System.
|
Implements
Copy()
Copies currently selected document elements into the clipboard
Declaration
public void Copy()Implements
CopyFormatting()
Copies the formatting of the current selection.
Declaration
public bool CopyFormatting()Returns
|
System. A value indicating whether the copy was successful. |
Implements
CreatePrintDocument()
Cut()
DecrementFontSize()
Decrements the font size of the current run in the document.
Declaration
public void DecrementFontSize()Implements
DecrementParagraphLeftIndent()
Decrements the left indent of the current paragraph.
Declaration
public void DecrementParagraphLeftIndent()Implements
DecrementParagraphListLevel()
Decrements the list level the paragraph is currently in by 1.
Declaration
public void DecrementParagraphListLevel()Delete(Boolean)
Deletes from the document respecting CaretPosition and Selection.
Declaration
public void Delete(bool deletePrevious)Parameters
|
System. If the selection is empty, indicates whether to delete the character before or after the caret. |
DeleteAllComments()
Deletes all comments in the current document.
Declaration
public void DeleteAllComments()Implements
DeleteAnnotationRange(AnnotationRangeStart)
Deletes an annotation range.
Declaration
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)Parameters
|
Annotation The start of the range that is to be deleted. |
Implements
DeleteBookmark(String)
Deletes a bookmark.
Declaration
public void DeleteBookmark(string bookmarkName)Parameters
|
System. Name of the bookmark. |
Implements
DeleteBookmark(BookmarkRangeStart)
Deletes a bookmark.
Declaration
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)Parameters
|
Bookmark The bookmark range start. |
Implements
DeleteCodeBlock(CodeAnnotationRangeStart)
Deletes a code block.
Declaration
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)Parameters
|
Code The code range start of the block to delete. |
Implements
DeleteComment()
Deletes the current comment.
Declaration
public void DeleteComment()Implements
DeleteComment(CommentRangeStart)
Deletes a comment.
Declaration
public void DeleteComment(CommentRangeStart commentRangeStart)Parameters
|
Comment The comment range start. |
Implements
DeletePermissionRange(PermissionRangeStart)
Deletes a permission range.
Declaration
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)Parameters
|
Permission The permission range start. |
Implements
DeleteReadOnlyRange()
Deletes the current read only range.
Declaration
public void DeleteReadOnlyRange()Implements
DeleteReadOnlyRange(ReadOnlyRangeStart)
Deletes the read only range.
Declaration
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)Parameters
|
Read The read only range that is to be deleted. |
Implements
DeleteTable()
Deletes the current table.
Declaration
public void DeleteTable()Implements
DeleteTable(Table)
Deletes the provided table from the document.
Declaration
public void DeleteTable(Table table)Parameters
|
Table
table
The table to delete. |
Implements
DeleteTableColumn()
Deletes the current column.
Declaration
public void DeleteTableColumn()Implements
DeleteTableRow()
Deletes the current row from the table.
Declaration
public void DeleteTableRow()Implements
DeleteTableRow(TableRow)
Deletes the given row from the table.
Declaration
public void DeleteTableRow(TableRow row)Parameters
Implements
DisableWatermark()
Removes the currently applied watermark.
Declaration
public void DisableWatermark()DisposeDialogs()
Declaration
protected virtual void DisposeDialogs()DisposeManagedResources()
Declaration
protected override void DisposeManagedResources()Overrides
DisposeUnmanagedResources()
Declaration
protected override void DisposeUnmanagedResources()Overrides
EditListStyleInDialog(ListStyle)
Shows the dialog for editing list styles.
Declaration
public void EditListStyleInDialog(ListStyle listStyle)Parameters
|
List
|
EndUndoGroup()
Closes current undo group.
Declaration
public void EndUndoGroup()Implements
EndUndoGroup(String)
Closes current undo group.
Declaration
public void EndUndoGroup(string groupDisplayText)Parameters
|
System. The display text which will be used for the undo group. |
Implements
FocusFooter()
FocusHeader()
Focuses the header of the current page.
Declaration
public void FocusHeader()GetApperanceSettingsForComment(Comment)
Gets an object containing the appearance settings for the given comment.
Declaration
public CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)Parameters
Returns
Implements
GetContent(String)
Gets the content in various formats.
Declaration
public string GetContent(string format)Parameters
|
System. The format to export into. |
Returns
|
System. String representation of the content. |
GetDocumentEditorPresenterTypeForDocument(RadDocument)
Declaration
protected virtual Type GetDocumentEditorPresenterTypeForDocument(RadDocument document)Parameters
|
Rad
|
Returns
|
System.
|
GetLayersBuilder()
Gets the component responsible for building the UI layers of the editor.
Declaration
protected virtual UILayersBuilder GetLayersBuilder()Returns
GoToNextComment()
Moves current position to the next comment.
Declaration
public void GoToNextComment()GoToNextEndnote()
Moves current position to the next endnote.
Declaration
public void GoToNextEndnote()GoToNextFootnote()
Moves current position to the next footnote.
Declaration
public void GoToNextFootnote()GoToNextRevision()
Moves current position to the next revision.
Declaration
public void GoToNextRevision()GoToPreviousComment()
Moves current position to the previous comment.
Declaration
public void GoToPreviousComment()GoToPreviousEndnote()
Moves current position to the previous endnote.
Declaration
public void GoToPreviousEndnote()GoToPreviousFootnote()
Moves current position to the previous footnote.
Declaration
public void GoToPreviousFootnote()GoToPreviousRevision()
Moves current position to the previous revision.
Declaration
public void GoToPreviousRevision()IncrementFontSize()
Increments the font size of the current run in the document.
Declaration
public void IncrementFontSize()Implements
IncrementParagraphLeftIndent()
Increments the left indent of the current paragraph.
Declaration
public void IncrementParagraphLeftIndent()Implements
IncrementParagraphListLevel()
Increments the list level the paragraph is currently in by 1.
Declaration
public void IncrementParagraphListLevel()Insert(String)
Inserts text into the document at current caret position.
Declaration
public void Insert(string text)Parameters
|
System. 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. The text to insert. |
|
Document The position where the text will be inserted. |
InsertAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)
Inserts an annotation range.
Declaration
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)Parameters
|
Annotation The annotation range start. |
|
Annotation The annotation range end. |
Implements
InsertBookmark(String)
Inserts a bookmark.
Declaration
public void InsertBookmark(string bookmarkName)Parameters
|
System. Name of the bookmark. |
Implements
InsertCaption(CaptionDefinition, String, Boolean, Boolean)
Inserts a caption.
Declaration
public void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)Parameters
|
Caption The definition. |
|
System. The caption text to be used. |
|
System. if set to |
|
System. if set to |
Implements
InsertCodeBlock(String, CodeFormattingSettings)
Inserts code block into the document at caret position. If caret position is in code block, replaces the current code block.
Declaration
public void InsertCodeBlock(string code, CodeFormattingSettings settings)Parameters
|
System.
|
|
Code
|
Implements
InsertColumnBreak()
Inserts Column break into the document at current caret position.
Declaration
public void InsertColumnBreak()Implements
InsertComment(Comment)
Inserts a comment.
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 current caret position.
Declaration
public void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)Parameters
|
System.
|
|
Reference
|
|
System.
|
Implements
InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, Boolean)
Inserts a Cross-Reference to a caption into the document at current caret position.
Declaration
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)Parameters
|
Paragraph
captionParagraph
|
|
Reference
|
|
System.
|
Implements
InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, Boolean)
Inserts a Cross-Reference to a heading paragraph into the document at current caret position.
Declaration
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)Parameters
|
Paragraph
headingParagraph
|
|
Reference
|
|
System.
|
Implements
InsertEndnote()
Inserts endnote at the current position.
Declaration
public void InsertEndnote()Implements
InsertEndnote(Note)
Inserts the endnote at the current position.
Declaration
public void InsertEndnote(Note endnote)Parameters
|
Note
endnote
The endnote. |
Implements
InsertField(Field)
Inserts a field into the document at current caret position.
Declaration
public bool InsertField(Field field)Parameters
|
Field
field
The field. |
Returns
|
System. True if the operation completed successfully |
Implements
InsertField(Field, FieldDisplayMode)
Inserts a field into the document at current caret position in a specified display mode.
Declaration
public bool InsertField(Field field, FieldDisplayMode displayMode)Parameters
|
Field
field
The field. |
|
Field The display mode. |
Returns
|
System. 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 document fragment.
Declaration
public void InsertFragment(DocumentFragment documentFragment)Parameters
|
Document The document fragment to insert. |
Implements
InsertFragment(DocumentFragment, DocumentPosition)
Inserts a fragment at specified position.
Declaration
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)Parameters
|
Document The fragment to insert. |
|
Document The document position to insert the fragment at. |
Implements
InsertHyperlink(HyperlinkInfo)
Creates hyperlink form the current selection.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)Parameters
|
Hyperlink 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
|
Hyperlink The hyperlink info. |
|
System. The inlines. |
Implements
InsertHyperlink(HyperlinkInfo, String)
Inserts hyperlink into the document.
Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)Parameters
|
Hyperlink The hyperlink info. |
|
System. The hyperlink text. |
InsertImage(Stream, String)
Inserts image inline into the document.
Declaration
public void InsertImage(Stream imageStream, string extension)Parameters
|
System. The stream to the image's contents. |
|
System. The extension specifying the image format. |
Implements
InsertInline(Inline)
Inserts inline element into the document.
Declaration
public void InsertInline(Inline inline)Parameters
|
Inline
inline
The inline element to insert. |
Implements
InsertInline(Inline, DocumentPosition)
Inserts inline element into the document.
Declaration
public void InsertInline(Inline inline, DocumentPosition documentPosition)Parameters
|
Inline
inline
The inline element to insert. |
|
Document The document position to insert the inline at. |
Implements
InsertLine(String)
Inserts text and adds new paragraph after it.
Declaration
public void InsertLine(string text)Parameters
|
System. The text. |
Implements
InsertLineBreak()
Inserts LineBreak into the document at current caret position.
Declaration
public void InsertLineBreak()Implements
InsertNonBreakingSpace()
Declaration
public void InsertNonBreakingSpace()InsertPageBreak()
Inserts PageBreak into the document at current caret position.
Declaration
public void InsertPageBreak()Implements
InsertParagraph()
Inserts a new paragraph.
Declaration
public void InsertParagraph()Implements
InsertPermissionRange(IEnumerable<PermissionRangeInfo>)
Inserts new permission range.
Declaration
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)Parameters
|
System. The permissions for the new range. |
Implements
InsertReadOnlyRange()
Inserts a read only range.
Declaration
public void InsertReadOnlyRange()Implements
InsertSectionBreak()
Inserts SectionBreak into the document at current caret position.
Declaration
public void InsertSectionBreak()Implements
InsertSectionBreak(SectionBreakType)
Inserts SectionBreak of the specified type into the document at current caret position.
Declaration
public void InsertSectionBreak(SectionBreakType sectionBreakType)Parameters
|
Section The type of the section break. |
Implements
InsertStructuredDocumentTag()
Inserts a default structured document tag (Content Control). The default type is RichText.
Declaration
public void InsertStructuredDocumentTag()InsertStructuredDocumentTag(SdtProperties)
Inserts a structured document tag (Content Control) based on the provided properties.
Declaration
public void InsertStructuredDocumentTag(SdtProperties insertProperties)Parameters
|
Sdt
|
InsertStructuredDocumentTag(SdtType)
Inserts a structured document tag (Content Control) of the given type.
Declaration
public void InsertStructuredDocumentTag(SdtType insertType)Parameters
|
Sdt
|
InsertTable(Int32, Int32)
Inserts a new table with the specified number of rows and columns at the current caret position.
Declaration
public void InsertTable(int rows, int columns)Parameters
|
System. The number of rows. |
|
System. The number of columns. |
Implements
InsertTable(Int32, Int32, Boolean)
Inserts a new table with the specified number of rows and columns at the current caret position.
Declaration
public void InsertTable(int rows, int columns, bool shouldInsertParagraphBeforeTable)Parameters
|
System. The number of rows. |
|
System. The number of columns. |
|
System. Indicate whether a new paragraph should be inserted before the table. |
InsertTable(Table)
Inserts the given column at the current caret position.
Declaration
public void InsertTable(Table table)Parameters
|
Table
table
The table to insert. |
Implements
InsertTable(Table, Boolean)
Inserts the given column at the current caret position.
Declaration
public void InsertTable(Table table, bool shouldInsertParagraphBeforeTable)Parameters
|
Table
table
|
|
System. Indicate whether a new paragraph should be inserted before the table. |
Remarks
InsertTableColumn()
Inserts a column to the right of the last table column.
Declaration
public void InsertTableColumn()Implements
InsertTableColumnToTheLeft()
Inserts a column to the left of the current column.
Declaration
public void InsertTableColumnToTheLeft()Implements
InsertTableColumnToTheRight()
Inserts a column to the right of the current column.
Declaration
public void InsertTableColumnToTheRight()Implements
InsertTableRow()
Inserts a row at the bottom of the table.
Declaration
public void InsertTableRow()Implements
InsertTableRowAbove()
Inserts a row above the current row in the table.
Declaration
public void InsertTableRowAbove()Implements
InsertTableRowBelow()
Inserts a row below the current row in the table.
Declaration
public void InsertTableRowBelow()Implements
InvalidateEditorLayout()
Invalidates the active editor presenter layout.
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. True to invalidate incorrect word only. |
MailMerge(Boolean)
Produces a mail merge document for all the mail merge data records.
Declaration
public RadDocument MailMerge(bool startEachRecordOnNewPage = true)Parameters
|
System.
|
Returns
|
Rad The document |
Implements
MailMergeCurrentRecord()
Produces a mail merge document for the current mail merge data record.
Declaration
public RadDocument MailMergeCurrentRecord()Returns
|
Rad The document |
Implements
MeasureOverride(SizeF)
Declaration
protected override SizeF MeasureOverride(SizeF availableSize)Parameters
|
System.
|
Returns
|
System.
|
Overrides
MergeTableCells()
Merges the currently selected cells.
Declaration
public void MergeTableCells()Implements
MoveSelection(DocumentPosition, Boolean)
Moves current document selection to a specified position.
Declaration
public void MoveSelection(DocumentPosition position, bool deleteSelection)Parameters
|
Document The move position. |
|
System. Indicates whether the current selection should be deleted. |
Implements
OnApplyTemplate()
OnBoundsChanged(RadPropertyChangedEventArgs)
Declaration
protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)Parameters
Overrides
OnBubbleEvent(RadElement, RoutedEventArgs)
Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)Parameters
|
Rad
|
|
Routed
|
Overrides
OnCommandError(CommandErrorEventArgs)
Raises the Command
Declaration
protected virtual void OnCommandError(CommandErrorEventArgs args)Parameters
|
Command The Command |
OnCommandExecuted(CommandExecutedEventArgs)
Raises the Command
Declaration
protected virtual void OnCommandExecuted(CommandExecutedEventArgs e)Parameters
|
Command The Command |
OnCommandExecuting(CommandExecutingEventArgs)
Raises the Command
Declaration
protected virtual void OnCommandExecuting(CommandExecutingEventArgs e)Parameters
|
Command The Command |
OnCommentShowing(CommentShowingEventArgs)
Raises the Comment
Declaration
protected virtual void OnCommentShowing(CommentShowingEventArgs e)Parameters
|
Comment The Comment |
OnCurrentEditingStyleChanged()
Raises the Current
Declaration
protected virtual void OnCurrentEditingStyleChanged()OnCurrentParagraphStyleChanged()
Raises the Current
Declaration
protected virtual void OnCurrentParagraphStyleChanged()OnCurrentSpanStyleChanged()
Raises the Current
Declaration
protected virtual void OnCurrentSpanStyleChanged()OnCurrentVisiblePageChanged()
Raises the Current
Declaration
protected virtual void OnCurrentVisiblePageChanged()OnDocumentArranged()
Raises the Document
Declaration
protected virtual void OnDocumentArranged()OnDocumentChanged()
Raises the Document
Declaration
protected virtual void OnDocumentChanged()OnDocumentChanging()
Raises the Document
Declaration
protected virtual void OnDocumentChanging()OnDocumentContentChanged()
Raises the Document
Declaration
protected virtual void OnDocumentContentChanged()OnDocumentLayoutModeChanged()
Raises the Document
Declaration
protected virtual void OnDocumentLayoutModeChanged()OnDocumentPresentationChanged(PresentationChangedEventArgs)
Raises the Document
Declaration
protected virtual void OnDocumentPresentationChanged(PresentationChangedEventArgs e)Parameters
|
Presentation The Presentation |
OnGotFocus(EventArgs)
Declaration
protected override void OnGotFocus(EventArgs e)Parameters
|
System.
|
Overrides
OnHyperlinkClicked(Object, HyperlinkClickedEventArgs)
Raises the Hyperlink
Declaration
protected virtual void OnHyperlinkClicked(object sender, HyperlinkClickedEventArgs eventArgs)Parameters
|
System. The sender of the event. |
|
Hyperlink The Hyperlink |
OnIsReadOnlyChanged(EventArgs)
Raises the Is
Declaration
protected virtual void OnIsReadOnlyChanged(EventArgs e)Parameters
|
System. The System. |
OnLoaded()
OnLostFocus(EventArgs)
Declaration
protected override void OnLostFocus(EventArgs e)Parameters
|
System.
|
Overrides
OnMergeFieldToStringConverting(Object, MergeFieldToStringConvertingEventArgs)
Raises the Merge
Declaration
protected virtual void OnMergeFieldToStringConverting(object sender, MergeFieldToStringConvertingEventArgs e)Parameters
|
System. The sender of the event. |
|
Merge The Merge |
OnNoteReferenceClicked(MouseButtonEventArgs)
Raises the Note
Declaration
protected virtual void OnNoteReferenceClicked(MouseButtonEventArgs args)Parameters
|
Mouse The MouseButtonEventArgs instance containing the event data. |
OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs)
Raises the Preview
Declaration
protected virtual void OnPreviewEditorKeyDown(PreviewEditorKeyEventArgs e)Parameters
|
Preview The Preview |
OnPrintCompleted(PrintCompletedEventArgs)
Raises the Print
Declaration
protected virtual void OnPrintCompleted(PrintCompletedEventArgs e)Parameters
|
Print The Print |
OnPrintStarted(EventArgs)
Raises the Print
Declaration
protected virtual void OnPrintStarted(EventArgs e)Parameters
|
System. The System. |
OnPropertyChanged(RadPropertyChangedEventArgs)
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Parameters
Overrides
OnProtectionStateChanged()
Raises the Protection
Declaration
protected virtual void OnProtectionStateChanged()OnProviderUILayerInitialized(ProviderUILayerBase, Canvas, UILayerUpdateContext)
Declaration
protected virtual void OnProviderUILayerInitialized(ProviderUILayerBase layer, Canvas container, UILayerUpdateContext context)Parameters
|
Provider
|
|
Canvas
container
|
|
UILayer
|
OnScaleFactorChanged()
Raises the Scale
Declaration
protected virtual void OnScaleFactorChanged()OnSelectionChanged(EventArgs)
Raises the Selection
Declaration
protected virtual void OnSelectionChanged(EventArgs e)Parameters
|
System. The System. |
OnStreamFromUriResolving(StreamFromUriResolvingEventArgs)
Raises the Stream
Declaration
protected virtual void OnStreamFromUriResolving(StreamFromUriResolvingEventArgs e)Parameters
|
Stream The Stream |
OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs)
Raises the Untrackable
Declaration
protected virtual void OnUntrackableCommandExecuting(UntrackableCommandExecutingEventArgs e)Parameters
|
Untrackable The Untrackable |
OnUserInfoChanged()
Raises the User
Declaration
protected virtual void OnUserInfoChanged()OpenContextMenuOnNextSpellingError()
Opens the context menu next to the next spelling error in the document.
Declaration
public void OpenContextMenuOnNextSpellingError()Paste()
Pastes the content of the clipboard into the document.
Declaration
public void Paste()Implements
Paste(PasteOption)
Pastes the content of the clipboard into the document using the specified paste option.
Declaration
public void Paste(PasteOption pasteOption)Parameters
|
Paste
|
Implements
PasteFormatting()
Pastes the currently copied formatting on the current selection.
Declaration
public bool PasteFormatting()Returns
|
System. A value indicating whether the paste was successful. |
Implements
PreviewFirstMailMergeDataRecord()
Previews the first mail merge data record.
Declaration
public bool PreviewFirstMailMergeDataRecord()Returns
|
System.
|
Implements
PreviewLastMailMergeDataRecord()
Previews the last mail merge data record.
Declaration
public bool PreviewLastMailMergeDataRecord()Returns
|
System.
|
Implements
PreviewMailMergeDataRecordAtIndex(Int32)
Previews the the mail merge data record at a specified index.
Declaration
public bool PreviewMailMergeDataRecordAtIndex(int index)Parameters
|
System. The index of the record to be shown. |
Returns
|
System.
|
Implements
PreviewNextMailMergeDataRecord()
Previews the next mail merge data record.
Declaration
public bool PreviewNextMailMergeDataRecord()Returns
|
System.
|
Implements
PreviewPreviousMailMergeDataRecord()
Previews the previous mail merge data record.
Declaration
public bool PreviewPreviousMailMergeDataRecord()Returns
|
System.
|
Implements
Print()
Directly prints the Rad
Declaration
public virtual void Print()Print(Boolean)
Directly prints the Rad
Declaration
public virtual void Print(bool showPrinterSettings)Parameters
|
System. Indicates whether printer settings dialog should be shown. |
Print(Boolean, RadPrintDocument)
Directly prints the Rad
Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)Parameters
|
System. Indicates whether printer settings dialog should be shown. |
|
Rad As instance of Rad |
PrintPreview()
Shows a Rad
Declaration
public virtual void PrintPreview()PrintPreview(RadPrintDocument)
Shows a Rad
Declaration
public virtual void PrintPreview(RadPrintDocument document)Parameters
|
Rad As instance of Rad |
Redo()
Re-executes the last undone command group.
Declaration
public void Redo()Implements
RejectAllRevisions()
Rejects all revisions in the current document.
Declaration
public void RejectAllRevisions()Implements
RejectRevision(Revision)
Rejects revision.
Declaration
public void RejectRevision(Revision revision)Parameters
|
Revision
revision
The revision. |
Implements
RemoveHyperlink()
Removes the hyperlink on the caret position.
Declaration
public void RemoveHyperlink()RemoveTabStop(TabStop)
Removes the given tab stop from the currently selected paragraphs.
Declaration
public void RemoveTabStop(TabStop tabStop)Parameters
|
Tab The tab stop to be removed. |
Implements
RemoveTabStopRange(IEnumerable<TabStop>)
Removes the enumeration of tab stops.
Declaration
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)Parameters
|
System. The tab stops to remove. |
Implements
ReplaceTabStop(TabStop, TabStop)
Replaces the old tab stop with the new one in the currently selected paragraphs.
Declaration
public void ReplaceTabStop(TabStop oldTabStop, TabStop newTabStop)Parameters
Implements
ResetFormatPainter()
Declaration
protected virtual void ResetFormatPainter()ResizeTableColumn(Table, Int32, Double)
Changes the width of the column at the specified index in the given table.
Declaration
public void ResizeTableColumn(Table table, int columnIndex, double columnWidth)Parameters
|
Table
table
The table containing the column. |
|
System. The index of the column in the table. |
|
System. The new column width. |
Implements
RestartListNumbering()
Creates a new list from the current paragraph. The paragraph should be in list, otherwise this method does nothing.
Declaration
public bool RestartListNumbering()Returns
|
System.
|
Implements
ResumeUpdateLayout(Boolean)
This method supports control infrastructure and is not intended for use directly from your code.
Resumes layout updates suspended by calls to Suspend
Declaration
public void ResumeUpdateLayout(bool updateLayout = true)Parameters
|
System. True to call UpdateEditorLayout once all "resume" calls are equal to the "suspend" calls. |
ScrollToNote(Note)
Scrolls the viewport so that a note becomes visible.
Declaration
public void ScrollToNote(Note note)Parameters
|
Note
note
The note. |
Implements
SetSelectedComment(CommentRangeStart)
Sets the provided comment as selected.
Declaration
public void SetSelectedComment(CommentRangeStart commentStart)Parameters
|
Comment The comment to select. |
SetSelectedNote(Note)
Sets the provided note as selected.
Declaration
public void SetSelectedNote(Note note)Parameters
|
Note
note
The note to select. |
SetWatermark(DocumentWatermarkSettings)
Sets a watermark with the provided settings.
Declaration
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)Parameters
|
Document The settings to apply to the watermark. |
Implements
SetWatermark(PredefinedWatermarkType)
Sets one of the predefined watermarks.
Declaration
public void SetWatermark(PredefinedWatermarkType predefinedType)Parameters
|
Predefined The predefined watermark to apply. |
Implements
SetWatermarkImage(WatermarkImageSettings)
Sets an image watermark with the provided settings.
Declaration
public void SetWatermarkImage(WatermarkImageSettings settings)Parameters
|
Watermark The settings to apply to the watermark. |
SetWatermarkText(WatermarkTextSettings)
Sets a text watermark with the provided settings.
Declaration
public void SetWatermarkText(WatermarkTextSettings settings)Parameters
|
Watermark The settings to apply to the watermark. |
ShouldArrangeChild(RadElement)
Declaration
protected override bool ShouldArrangeChild(RadElement child)Parameters
|
Rad
|
Returns
|
System.
|
Overrides
ShouldCreateNewContextMenu(IContextMenu)
Declaration
protected virtual bool ShouldCreateNewContextMenu(IContextMenu menu)Parameters
|
IContext
|
Returns
|
System.
|
ShouldMeasureChild(RadElement)
Declaration
protected override bool ShouldMeasureChild(RadElement child)Parameters
|
Rad
|
Returns
|
System.
|
Overrides
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.
|
|
System.
|
|
System.
|
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)
Opens the context menu at the specified document position.
Declaration
public void ShowContextMenuAtDocumentPosition(Point proposedLocation, DocumentPosition position)Parameters
|
Point
proposedLocation
A point where the context menu should appear without taking into account element obstruction. |
|
Document The Document |
ShowContextMenuAtDocumentPosition(DocumentPosition)
Opens the context menu at the specified document position.
Declaration
public void ShowContextMenuAtDocumentPosition(DocumentPosition position)Parameters
|
Document The Document |
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. Name of the tool to execute when the dialog is opened. |
ShowInsertCaptionDialog()
Shows the insert caption dialog.
Declaration
public void ShowInsertCaptionDialog()ShowInsertCrossReferenceWindow()
Shows the insert cross reference window.
Declaration
public void ShowInsertCrossReferenceWindow()ShowInsertDateTimeDialog()
Shows the insert date field dialog.
Declaration
public void ShowInsertDateTimeDialog()ShowInsertHyperlinkDialog()
Shows the insert hyperlink dialog.
Declaration
public void ShowInsertHyperlinkDialog()ShowInsertSymbolWindow()
Show the insert symbol dialog.
Declaration
public void ShowInsertSymbolWindow()ShowInsertTableDialog()
Shows the insert table dialog.
Declaration
public void ShowInsertTableDialog()ShowInsertTableOfContentsDialog()
Shows the insert Table of Contents window.
Declaration
public void ShowInsertTableOfContentsDialog()ShowLineNumberingDialog()
Show the line numbers dialog.
Declaration
public void ShowLineNumberingDialog()ShowManageBibliographicSourcesDialog()
Shows the Manage Bibliographic Sources Dialog.
Declaration
public void ShowManageBibliographicSourcesDialog()ShowManageBookmarksDialog()
Shows the dialog for managing bookmarks.
Declaration
public void ShowManageBookmarksDialog()ShowManageStylesDialog()
Shows the dialog for managing styles.
Declaration
public void ShowManageStylesDialog()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()
Shows the section columns dialog.
Declaration
public void ShowSectionColumnsDialog()ShowSetNumberingValueDialog()
Shows the Set Numbering Value Dialog.
Declaration
public void ShowSetNumberingValueDialog()ShowSpellCheckingDialog()
Shows the spell checking dialog.
Declaration
public void ShowSpellCheckingDialog()ShowStyleFormattingPropertiesDialog()
Shows the dialog for adding new style.
Declaration
public void ShowStyleFormattingPropertiesDialog()ShowStyleFormattingPropertiesDialog(StyleDefinition)
Shows the dialog for modifying style formatting.
Declaration
public void ShowStyleFormattingPropertiesDialog(StyleDefinition styleDefinition)Parameters
|
Style
|
ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings)
Shows the style formatting properties dialog.
Declaration
public void ShowStyleFormattingPropertiesDialog(StyleFormattingPropertiesDialogSettings settings)Parameters
|
Style The settings. |
ShowTableBordersDialog()
Shows the table borders dialog.
Declaration
public void ShowTableBordersDialog()ShowTablePropertiesDialog()
Shows the table properties dialog.
Declaration
public void ShowTablePropertiesDialog()ShowTabStopsPropertiesDialog()
Shows the dialog for editing tab stops.
Declaration
public void ShowTabStopsPropertiesDialog()ShowUnprotectDocumentDialog()
Shows the dialog for removing document protection.
Declaration
public void ShowUnprotectDocumentDialog()ShowWatermarkSettingsDialog()
Shows the watermark settings dialog.
Declaration
public void ShowWatermarkSettingsDialog()SplitAnnotationRange(AnnotationRangeStart)
Splits an annotation range at the caret position.
Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)Parameters
|
Annotation The start of the range that is to be split. |
Implements
SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)
Splits an annotation range at the specified position.
Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)Parameters
|
Annotation The start of the range that is to be split. |
|
Document The position where the range is to be split. |
Implements
SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph>)
Suppress the line numbering for selected paragraphs.
Declaration
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)Parameters
|
System.
|
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 Resume
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 bold state of the current run in the document.
Declaration
public void ToggleBold()Implements
ToggleBookmarks()
Toggles the visibility of the bookmarks in the document.
Declaration
public void ToggleBookmarks()ToggleComments()
Toggles the visibility of the comments in the document.
Declaration
public void ToggleComments()ToggleDifferentFirstPageHeaderFooter()
ToggleDifferentOddAndEvenPagesHeaderFooter()
ToggleFieldCodes(FieldRangeStart)
Toggles the display mode of a field.
Declaration
public void ToggleFieldCodes(FieldRangeStart fieldStart)Parameters
|
Field The field start. |
Implements
ToggleFormattingSymbols()
Toggles the visibility of the formatting symbols in the document.
Declaration
public void ToggleFormattingSymbols()ToggleHeaderFooterEditingMode()
ToggleItalic()
Toggles the italic state of the current run in the document.
Declaration
public void ToggleItalic()Implements
ToggleMergeFieldsHighlight()
Toggles between highlighting and not highlighting Merge Fields.
Declaration
public void ToggleMergeFieldsHighlight()ToggleStrikethrough()
Toggles the subscript state of the current run in the document.
Declaration
public void ToggleStrikethrough()Implements
ToggleSubscript()
Toggles the subscript state of the current run in the document.
Declaration
public void ToggleSubscript()ToggleSuperscript()
Changes the superscript state of the current run in the document.
Declaration
public void ToggleSuperscript()ToggleUnderline()
Toggles the underline state of the current run in the document.
Declaration
public void ToggleUnderline()Undo()
Reverts last executed command group.
Declaration
public void Undo()Implements
UnmergeTableCells()
Unmerges the currently selected cells.
Declaration
public void UnmergeTableCells()Implements
UpdateAllCaptions(CaptionDefinition)
Updates all captions related to caption definition.
Declaration
public void UpdateAllCaptions(CaptionDefinition captionDefinition)Parameters
|
Caption The caption definition. |
Implements
UpdateAllFields()
Updates all fields in the document.
Declaration
public void UpdateAllFields()Implements
UpdateAllFields(FieldDisplayMode)
Updates all fields and displays them in the specified display mode.
Declaration
public void UpdateAllFields(FieldDisplayMode displayMode)Parameters
|
Field The display mode. |
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. 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
|
Field The field start. |
Implements
UpdateFooter(Section, HeaderFooterType, Footer)
UpdateHeader(Section, HeaderFooterType, Header)
Events
ActiveDocumentEditorChanged
Occurs when active document editor changes.
Declaration
public event EventHandler<ActiveDocumentEditorChangedEventArgs> ActiveDocumentEditorChangedEvent Type
|
System.
|
CommandError
Occurs on error while executing command.
Declaration
public event EventHandler<CommandErrorEventArgs> CommandErrorEvent Type
|
System.
|
CommandExecuted
Occurs after the execution of Rich
Declaration
public event EventHandler<CommandExecutedEventArgs> CommandExecutedEvent Type
|
System.
|
CommandExecuting
Occurs before the execution of Rich
Declaration
public event EventHandler<CommandExecutingEventArgs> CommandExecutingEvent Type
|
System.
|
CommentShowing
Occurs when showing comment.
Declaration
public event EventHandler<CommentShowingEventArgs> CommentShowingEvent Type
|
System.
|
CurrentEditingStyleChanged
Occurs when the current editing style has changed.
Declaration
public event EventHandler CurrentEditingStyleChangedEvent Type
|
System.
|
CurrentParagraphStyleChanged
Occurs when the current paragraph's style has changed.
Declaration
public event EventHandler CurrentParagraphStyleChangedEvent Type
|
System.
|
CurrentSpanStyleChanged
Occurs when the current span's style has changed.
Declaration
public event EventHandler CurrentSpanStyleChangedEvent Type
|
System.
|
CurrentVisiblePageChanged
Occurs when the CurrentPage property value has changed.
Declaration
public event EventHandler CurrentVisiblePageChangedEvent Type
|
System.
|
DocumentArranged
Occurs when the current document has been arranged.
Declaration
public event EventHandler DocumentArrangedEvent Type
|
System.
|
DocumentChanged
Occurs when the current document has changed.
Declaration
public event EventHandler DocumentChangedEvent Type
|
System.
|
DocumentChanging
Occurs when the current document is changing.
Declaration
public event EventHandler DocumentChangingEvent Type
|
System.
|
DocumentContentChanged
Occurs when the content of the current document has changed.
Declaration
public event EventHandler DocumentContentChangedEvent Type
|
System.
|
DocumentLayoutModeChanged
Occurs when the layout mode of the current document has changed.
Declaration
public event EventHandler DocumentLayoutModeChangedEvent Type
|
System.
|
DocumentPresentationChanged
Occurs when the presentation of the current document has changed.
Declaration
public event EventHandler<PresentationChangedEventArgs> DocumentPresentationChangedEvent Type
|
System.
|
HyperlinkClicked
Occurs when the users clicks on a hyperlink in the current document.
Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClickedEvent Type
|
System.
|
IsInHeaderFooterEditModeChanged
IsReadOnlyChanged
Occurs when IsReadOnly property changes.
Declaration
public event EventHandler IsReadOnlyChangedEvent Type
|
System.
|
MergeFieldToStringConverting
Occurs when MergeField is going to calculate its value. If MergeFieldToStringConvertingEventArgs.ConvertedValue is set it becames a result string value.
Declaration
public event EventHandler<MergeFieldToStringConvertingEventArgs> MergeFieldToStringConvertingEvent Type
|
System.
|
PreviewEditorKeyDown
Occurs when a key is pressed while and editor is focused.
Declaration
public event PreviewEditorKeyEventHandler PreviewEditorKeyDownEvent Type
PrintCompleted
Occurs when print is completed.
Declaration
public event EventHandler<PrintCompletedEventArgs> PrintCompletedEvent Type
|
System.
|
PrintStarted
Occurs when printing has started.
Declaration
public event EventHandler PrintStartedEvent Type
|
System.
|
ProtectionStateChanged
Occurs when the current protection state has changed.
Declaration
public event EventHandler ProtectionStateChangedEvent Type
|
System.
|
Implements
ProviderUILayerInitialized
Occurs when the child elements of an UI layer have been initialized and added to its container.
Declaration
public event EventHandler<ProviderUILayerInitilizedEventArgs> ProviderUILayerInitializedEvent Type
|
System.
|
ScaleFactorChanged
Occurs when the ScaleFactor property value has changed.
Declaration
public event EventHandler ScaleFactorChangedEvent Type
|
System.
|
Implements
SelectedLayoutBoxChanged
Occurs when currently selected layout box has changed.
Declaration
public event EventHandler<SelectedLayoutBoxChangedEventArgs> SelectedLayoutBoxChangedEvent Type
|
System.
|
SelectionChanged
Occurs when selection is changed.
Declaration
public event EventHandler SelectionChangedEvent Type
|
System.
|
StreamFromUriResolving
Occurs when resolving a URI tfor a stram object.
Declaration
public event EventHandler<StreamFromUriResolvingEventArgs> StreamFromUriResolvingEvent Type
|
System.
|
UntrackableCommandExecuting
Occurs when executing command that does not support track changes and track changes are enabled.
Declaration
public event EventHandler<UntrackableCommandExecutingEventArgs> UntrackableCommandExecutingEvent Type
|
System.
|
UserInfoChanged
Occurs when the current user info has changed.
Declaration
public event EventHandler UserInfoChangedEvent Type
|
System.
|
Explicit Interface Implementations
IPrintable.BeginPrint(RadPrintDocument, PrintEventArgs)
Declaration
int IPrintable.BeginPrint(RadPrintDocument sender, PrintEventArgs args)Parameters
|
Rad
|
|
System.
|
Returns
|
System.
|
Implements
IPrintable.EndPrint(RadPrintDocument, PrintEventArgs)
Declaration
bool IPrintable.EndPrint(RadPrintDocument sender, PrintEventArgs args)Parameters
|
Rad
|
|
System.
|
Returns
|
System.
|
Implements
IPrintable.GetSettingsDialog(RadPrintDocument)
Declaration
Form IPrintable.GetSettingsDialog(RadPrintDocument document)Parameters
|
Rad
|
Returns
|
System.
|
Implements
IPrintable.PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)
Declaration
bool IPrintable.PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)Parameters
|
System.
|
|
Rad
|
|
System.
|
Returns
|
System.
|
Implements
IDocumentEditor.ChangeForeColor(Color)
Declaration
void IDocumentEditor.ChangeForeColor(Color newColor)Parameters
|
Color
newColor
|
Implements
IDocumentEditor.ChangeHighlightColor(Color)
Declaration
void IDocumentEditor.ChangeHighlightColor(Color newColor)Parameters
|
Color
newColor
|
Implements
IDocumentEditor.ChangeParagraphListStyle(ListStyle)
Declaration
void IDocumentEditor.ChangeParagraphListStyle(ListStyle style)Parameters
|
List
|
Implements
IDocumentEditor.ChangeParagraphTextAlignment(RadTextAlignment)
Declaration
void IDocumentEditor.ChangeParagraphTextAlignment(RadTextAlignment alignment)Parameters
|
Rad
|
Implements
IDocumentEditor.ChangeSectionFooter(Section, HeaderFooterType, Footer)
IDocumentEditor.ChangeSectionHeader(Section, HeaderFooterType, Header)
IDocumentEditor.Delete(Boolean)
Deletes from the document respecting CaretPosition and Selection.
Declaration
bool IDocumentEditor.Delete(bool deletePrevious)Parameters
|
System. If the selection is empty, indicates whether to delete the character before or after the caret. |
Returns
|
System. True if the command was executed successfully. |
Implements
IDocumentEditor.DeleteHyperlink()
IDocumentEditor.DeleteHyperlink(HyperlinkRangeStart)
Declaration
void IDocumentEditor.DeleteHyperlink(HyperlinkRangeStart rangeStart)Parameters
|
Hyperlink
|
Implements
IDocumentEditor.Insert(String)
Inserts text into the document at current caret position.
Declaration
bool IDocumentEditor.Insert(string text)Parameters
|
System. The text to insert. |
Returns
|
System. True if the command was executed successfully. |
Implements
IDocumentEditor.SetListNumbering(Int32)
Declaration
bool IDocumentEditor.SetListNumbering(int numbersToSkip)Parameters
|
System.
|
Returns
|
System.
|
Implements
IDocumentEditor.UpdatePermissionRanges(IEnumerable<PermissionRangeInfo>, IEnumerable<PermissionRangeInfo>)
Declaration
void IDocumentEditor.UpdatePermissionRanges(IEnumerable<PermissionRangeInfo> permissionsToAdd, IEnumerable<PermissionRangeInfo> permissionsToRemove)Parameters
|
System.
|
|
System.
|
Implements
IDocumentEditorPresenterContainer.CallOnNoteReferenceClicked(MouseButtonEventArgs)
Declaration
void IDocumentEditorPresenterContainer.CallOnNoteReferenceClicked(MouseButtonEventArgs args)Parameters
|
Mouse
|
Implements
IDocumentEditorPresenterContainer.DocumentEditor
Declaration
IDocumentEditor IDocumentEditorPresenterContainer.DocumentEditor { get; }Returns
Implements
IDocumentEditorPresenterContainer.GetUIProviderRegistry()
Declaration
UIProviderRegistry IDocumentEditorPresenterContainer.GetUIProviderRegistry()Returns
Implements
IDocumentEditorPresenterContainer.HeaderFooterUIContext
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
|
IDocument
|
|
Document
|
Implements
IDocumentEditorPresenterContainer.ShouldShowSelectionMarkers
Declaration
bool IDocumentEditorPresenterContainer.ShouldShowSelectionMarkers { get; }Returns
|
System.
|
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.
|
