RadDocumentEditor
Represents a non-visual editor for RadDocument, which supports history and preserves the validity of the underlying document model.
Definition
Namespace:Telerik.WinForms.Documents.Model
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class RadDocumentEditor : IDocumentEditorInheritance: objectRadDocumentEditor
Implements:
Constructors
Initializes a new instance of the RadDocumentEditor class.
public RadDocumentEditor(RadDocument document)The RadDocument instance which will be edited.
Properties
Gets or sets a value indicating whether the editing operations can insert new paragraphs if needed.
public bool AcceptsReturn { get; set; }Gets the document that is to be edited.
public RadDocument Document { get; }Implements:
Gets or sets a value that indicates whether protection ranges should be respected when editing.
public bool RespectDocumentProtection { get; set; }true if the protection ranges should be respected; otherwise, false.
Gets or sets a value indicating whether non-deletable ranges should be respected when editing.
public bool RespectNonDeletableRanges { get; set; }true if the non-deletable ranges should be respected; otherwise, false.
Gets or sets a value indicating whether read-only ranges should be respected when editing.
public bool RespectReadOnlyRanges { get; set; }true if the read-only ranges should be respected; otherwise, false.
Methods
Accepts all revisions in the document.
public void AcceptAllRevisions()Implements:
Accepts a revision.
public void AcceptRevision(Revision revision)The revision.
Implements:
Adds a tab stop to the current paragraph.
Adds a tab stop range to the current paragraph.
public void AddTabStopRange(IEnumerable<TabStop> tabStops)The tab stop collection.
Implements:
Begins a new group of actions which will appear as a single item in the document history.
public void BeginUndoGroup()Implements:
Cancels the currently started undo-able group, started with BeginUndoGroup() and undoes the actions executed since the starting of the group.
If an undo group is not started, an InvalidOperationException is thrown.
public void CancelUndoGroup()Implements:
Changes the display mode of all fields in the document.
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)The display mode which will be used for the fields.
Implements:
Changes the baseline alignment of the selected content.
public void ChangeBaselineAlignment(BaselineAlignment baselineAlignment)The baseline alignment to be applied.
Implements:
Changes the bibliographic style of all bibliography related fields in the document.
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)The new bibliographic style.
Implements:
Sets a value determining whether the headers and footers of the first page in the selected sections are different than the ones of the other pages.
public void ChangeDifferentFirstPageHeaderFooter(bool value)If set to true, the header and footer of the first page will be different than the rest of the pages in the section.
Implements:
Changes the value determining whether the sections should have different odd and even pages header/footer.
public void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)true, if the even and odd page header/footer should differ.
Implements:
Changes default tab stop width for the document.
public void ChangeDocumentDefaultTabWidth(double tabWidth)Width of the tab.
Implements:
Changes the Tag property of a specified DocumentElement.
public void ChangeDocumentElementTag(DocumentElement element, string tag)The DocumentElement.
tagstringThe new tag value.
Implements:
Changes the first number of the endnotes in the document.
public void ChangeDocumentEndnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the endnotes in the document.
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the endnotes in the document.
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the position of the endnotes in the document.
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)The position.
Implements:
Changes the first number of the footnotes in the document.
public void ChangeDocumentFootnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the footnotes in the document.
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the endnotes in the document.
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the position of the footnotes in the document.
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)The footnotes position.
Implements:
Sets a value determining whether the strict line breaking rule will be applied to Japanese text in this document.
public void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)if set to true, the strict line breaking rule will be applied.
Implements:
Sets the language whose rules should be used for line breaking in the paragraphs.
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)The line breaking rule language.
Implements:
Sets a rule determining which characters cannot end a line in East-Asian languages.
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)The line breaking character rule.
Implements:
Sets a rule determining which characters cannot start a line in East-Asian languages.
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)The rule.
Implements:
Changes the display mode of a field.
public void ChangeFieldDisplayMode(FieldRangeStart fieldRangeStart, FieldDisplayMode displayMode)The field start.
displayModeFieldDisplayModeThe new display mode.
Implements:
Changes the font family of the selected content.
public void ChangeFontFamily(FontFamily fontFamily)The font family to be applied.
Implements:
Changes the size of the font of the selected content.
public void ChangeFontSize(double fontSize)Size of the font.
Implements:
Changes the font style of the selected content.
public void ChangeFontStyle(FontStyle fontStyle)The font style.
Implements:
Changes the font weight of the selected content. If selection is not present, the current editing style is updated.
public void ChangeFontWeight(FontWeight fontWeight)The font weight.
Implements:
Changes the fore color of the selected content.
Changes the highlight color of the selected content.
Changes the rotate angle of an image.
public void ChangeImageRotateAngle(ImageInline image, double angle)The ImageInline.
angledoubleThe new angle.
Implements:
Changes the size of an image.
public void ChangeImageSize(ImageInline image, Size size)The ImageInline whose size should be changed.
sizeSizeThe new size.
Implements:
Changes the restart type of line numberings for the selected sections.
public void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)The line numbering restart type.
Implements:
Changes the automatic spacing after of the selected paragraphs.
public void ChangeParagraphAutomaticSpacingAfter(bool value)If set to true, the automatic spacing after will be enabled.
Implements:
Changes the automatic spacing before of the selected paragraphs.
public void ChangeParagraphAutomaticSpacingBefore(bool value)If set to true, the automatic spacing before will be enabled.
Implements:
Changes the background of the selected paragraphs.
Changes the first line indent of the selected paragraphs.
public void ChangeParagraphFirstLineIndent(double firstLineIndent)The first line indent.
Implements:
Changes the flow direction of the selected paragraphs.
public void ChangeParagraphFlowDirection(FlowDirection flowDirection)The flow direction.
Implements:
Changes the IsLineBreakingRuleEnabled property. This property indicates whether East Asian typography rules will be applied to determine which characters may begin and end each line.
public void ChangeParagraphIsLineBreakingRuleEnabled(bool value)If set to true, East Asian typography rules will be applied to determine which characters may begin and end each line.
Implements:
Changes the left indent of the selected paragraphs.
public void ChangeParagraphLeftIndent(double leftIndent)The left indent.
Implements:
Changes the line spacing of the selected paragraphs.
public void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)The line spacing.
lineSpacingTypeLineSpacingTypeType of the line spacing.
Implements:
Changes the line spacing of the selected paragraphs.
public void ChangeParagraphLineSpacing(double lineSpacing)The line spacing.
Implements:
Changes the type of the line spacing of the selected paragraphs.
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)Type of the line spacing.
Implements:
Changes the list level of the selected paragraphs.
public void ChangeParagraphListLevel(int listLevel)The list level.
Implements:
Changes the paragraph list style of the selected paragraphs.
public void ChangeParagraphListStyle(ListStyle style)The style.
Implements:
Changes the right indent of the selected paragraphs.
public void ChangeParagraphRightIndent(double rightIndent)The right indent.
Implements:
Changes the spacing after of the selected paragraphs.
public void ChangeParagraphSpacingAfter(double spacingAfter)The spacing after.
Implements:
Changes the spacing before of the selected paragraphs.
public void ChangeParagraphSpacingBefore(double spacingBefore)The spacing before.
Implements:
Changes the paragraph style of the selected content.
public void ChangeParagraphStyle(StyleDefinition styleInfo)The style information.
Implements:
Changes the text alignment of the selected paragraphs.
public void ChangeParagraphTextAlignment(RadTextAlignment alignment)The alignment.
Implements:
Changes the page margin of the selected sections respecting their current orientation.
public void ChangeSectionActualPageMargin(Padding sectionMargin)The margin.
Implements:
Changes the section columns for the selected sections.
public void ChangeSectionColumns(SectionColumnCollection sectionColumns)The section columns.
Implements:
Changes the section columns for a given collection of Section elements.
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)The section columns layout.
Implements:
Changes the first number of the endnotes in the selected sections.
public void ChangeSectionEndnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the endnotes in the selected sections.
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the endnotes in the selected sections.
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the first page number of the selected sections.
public void ChangeSectionFirstPageNumber(int? firstPageNumber)The first page number.
Implements:
Changes the section footer.
public void ChangeSectionFooter(Section section, HeaderFooterType footerType, Footer footer)The section.
footerTypeHeaderFooterTypeType of the footer.
footerFooterThe footer.
Implements:
Changes the footer bottom margin of the selected sections.
public void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)The section footer bottom margin.
Implements:
Changes the value indicating whether the section footer should be linked to the footer of the previous section.
public void ChangeSectionFooterLinkToPrevious(Section section, HeaderFooterType footerType, bool value)The section.
footerTypeHeaderFooterTypeType of the footer.
valuebooltrue if the footer should be linked.
Implements:
Changes the first number of the footnotes in the selected sections.
public void ChangeSectionFootnotesFirstNumber(int firstNumber)The first number.
Implements:
Changes the numbering format of the footnotes in the selected sections.
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Implements:
Changes the type of numbering restart of the footnotes in the selected sections.
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Implements:
Changes the section header.
public void ChangeSectionHeader(Section section, HeaderFooterType headerType, Header header)The section.
headerTypeHeaderFooterTypeType of the header.
headerHeaderThe header.
Implements:
Changes the value indicating whether the section header should be linked to the header of the previous section.
public void ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value)The section.
headerTypeHeaderFooterTypeType of the header.
valuebooltrue if the header should be linked.
Implements:
Changes the header top margin of the selected sections.
public void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)The section header top margin.
Implements:
Changes the line numbering for a given collection of Section elements.
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)The line numbering.
Implements:
Changes the page margin of the selected sections.
public void ChangeSectionPageMargin(Padding sectionMargin)The margin.
Implements:
Changes the page orientation of the selected sections.
public void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)The page orientation.
Implements:
Changes the page size of the selected sections.
public void ChangeSectionPageSize(Size newSize)The new size. You can use the PaperTypes enumeration to get the desired size from the predefined values.
Implements:
Changes the span style of the selected content.
public void ChangeSpanStyle(StyleDefinition styleInfo)The style information.
Implements:
Changes the strike-through of the selected content.
public void ChangeStrikethrough(bool isStriketrough)If set to true, a strike-through will be applied to the selected content.
Implements:
Applies style with a given name to the selected elements in the document.
public void ChangeStyleName(string styleName)Name of the style to be applied.
Implements:
Changes the borders of the selected tables.
public void ChangeTableBorders(TableBorders tableBorders)The table borders.
Implements:
Changes the background of the selected table cells.
Changes the borders of the selected table cells.
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)The border which will be used for all table cell borders.
Implements:
Changes the content alignment of the selected table cells.
public void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)The text alignment.
verticalAlignmentRadVerticalAlignmentThe vertical alignment.
Implements:
Changes the horizontal content alignment of the selected table cells.
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)The alignment.
Implements:
Changes the padding of the selected table cells.
public void ChangeTableCellPadding(Padding padding)The padding.
Implements:
Changes the cell spacing of the selected tables.
public void ChangeTableCellSpacing(double cellSpacing)The cell spacing.
Implements:
Changes the vertical content alignment of the selected table cells.
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)The alignment.
Implements:
Changes the default cell padding of the selected tables.
public void ChangeTableDefaultCellPadding(Padding padding)The padding which will be used as a default value.
Implements:
Changes the flow direction of the selected tables.
public void ChangeTableFlowDirection(FlowDirection flowDirection)The flow direction.
Implements:
Changes the width of a table column.
public void ChangeTableGridColumnWidth(Table table, int columnIndex, TableWidthUnit width)The table.
columnIndexintThe index of the column.
widthTableWidthUnitThe new value for the column width. If the type of the width is not specified, Fixed will be used.
Implements:
Changes the horizontal alignment of the selected tables.
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)The alignment.
Implements:
Changes the indent of the selected tables.
Changes the layout mode of the selected tables.
public void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)The table.
tableLayoutModeTableLayoutModeThe table layout mode.
Implements:
Changes the look of the selected tables.
The look of a table defines the components of the conditional formatting which will be applied to it.
public void ChangeTableLook(TableLook tableLook)The table look.
Implements:
Changes the preferred width of the selected tables.
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Width of the table.
Implements:
Depending on the current value, enables or disables the repetition of a table row on every page.
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)The table row.
Implements:
Changes the underline color of the selected content.
Changes the underline decoration of the selected content.
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)The value.
Implements:
Clears all the formatting (character and paragraph) from the selected content.
public void ClearAllFormatting()Implements:
Clears the character formatting of the selected content.
public void ClearFormatting()Implements:
Clears the paragraph formatting of the selected content.
public void ClearParagraphFormatting()Clears the tab stops inside the selected paragraphs.
public void ClearTabStops()Implements:
Removes all paragraphs from the current list and continues the first possible list before that paragraph. The paragraph must be in a list and should be first in the list, otherwise this method does nothing.
public bool ContinueListNumbering()A boolean value indicating whether the operation completed successfully.
Implements:
Copies the currently selected document elements into the clipboard.
public void Copy()Implements:
Copies the formatting of the current selection.
public bool CopyFormatting()A value indicating whether the copy was successful.
Implements:
Cuts the currently selected document elements into the clipboard.
public void Cut()Implements:
Decreases the left indent of the selected paragraphs. The default step used for indentation is 24.
public void DecreaseLeftIndent()Decrements the size of the font of the selected content with 2 points.
public void DecrementFontSize()Implements:
Decrements the left indent of the selected paragraphs. The default step used for indentation is 24.
public void DecrementParagraphLeftIndent()Implements:
Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the CaretPosition.
Deletes all comments in the document.
public void DeleteAllComments()Implements:
Deletes an annotation range.
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)The start of the range that will be deleted.
Implements:
Deletes a bookmark.
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)The bookmark range start.
Implements:
Deletes a bookmark.
public void DeleteBookmark(string bookmarkName)Name of the bookmark.
Implements:
Deletes a code block.
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)The CodeAnnotationRangeStart of the block to delete.
Implements:
Deletes the current comment.
public void DeleteComment()Implements:
Deletes a comment.
public void DeleteComment(CommentRangeStart commentRangeStart)The comment range start.
Implements:
Deletes the current hyperlink.
public void DeleteHyperlink()Implements:
Deletes a hyperlink.
public void DeleteHyperlink(HyperlinkRangeStart hyperlinkRangeStart)The hyperlink range start.
Implements:
Deletes a permission range.
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)The permission range start.
Implements:
Deletes the read only range at the current caret position or inside the current selection.
public void DeleteReadOnlyRange()Implements:
Deletes read only range.
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)The read only range that is to be deleted.
Implements:
Deletes the table the current caret position is in.
public void DeleteTable()Implements:
Deletes the current table column which is under the caret position.
public void DeleteTableColumn()Implements:
Deletes the table row under the caret position.
public void DeleteTableRow()Implements:
Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
public void EndUndoGroup()Implements:
Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
public void EndUndoGroup(string groupDisplayText)The display text which will be used for the undo group.
Implements:
Increases the left indent of the selected paragraphs. The default step used for indentation is 24.
public void IncreaseLeftIndent()Increments the size of the font of the selected content with 2 points.
public void IncrementFontSize()Implements:
Increments the left indent of the selected paragraphs. The default step used for indentation is 24.
public void IncrementParagraphLeftIndent()Implements:
Increments the paragraph list level of the selected paragraphs.
public void IncrementParagraphListLevel(int value)A value determining how much the level should be increased.
Inserts an annotation range over the current selection. If the selection is empty, the annotation range is inserted at the caret position.
public void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)The annotation range start.
rangeEndAnnotationRangeEndThe annotation range end.
Implements:
Inserts a bookmark around the current selection. If the selection is empty, the bookmark is inserted at the caret position.
public void InsertBookmark(string bookmarkName)Name of the bookmark.
Implements:
Inserts a caption around the current selection. If the selection is empty, the caption is inserted at the current caret position.
public void InsertCaption(CaptionDefinition captionDefinition, string caption, bool includeLabel, bool insertBelow)The definition of the caption.
captionstringThe caption text to be used.
includeLabelboolIf set to true, the label is included in the caption.
If set to true, the caption is inserted after the current selection.
Implements:
Inserts a code block at the caret position. If the caret position is in code block, replaces the current code block.
public void InsertCodeBlock(string code, CodeFormattingSettings settings)The code to insert.
settingsCodeFormattingSettingsThe settings which will be used for the code block.
Implements:
Inserts a column break into the document at the current caret position.
public void InsertColumnBreak()Implements:
Inserts a comment around the current selection. If the selection is empty, the comment is inserted at the caret position.
Inserts a cross-reference to a bookmark into the document at the current caret position.
public void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)Name of the bookmark.
contentTypeReferenceContentTypeType of the content.
insertAsHyperlinkboolIf set to true, the cross-reference is inserted as a hyperlink.
Implements:
Inserts a cross-reference to a caption into the document at the current caret position.
public void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)The paragraph containing the caption sequence field.
contentTypeReferenceContentTypeThe reference content type. If the paragraph doesn't have applied a Caption style, the method will not be executed.
insertAsHyperlinkboolA parameter indicating whether the cross-reference field should be a hyperlink.
Implements:
Inserts a cross-reference to a paragraph with Heading style into the document at the current caret position.
public void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)The paragraph. If the paragraph doesn't have applied a Heading style, the method will not be executed.
contentTypeReferenceContentTypeType of the content.
insertAsHyperlinkboolIf set to true, the cross-reference is inserted as a hyperlink.
Implements:
Inserts endnote at the current position.
public void InsertEndnote()Implements:
Inserts the endnote at the current position.
Inserts a field into the document at the current caret position in a specified display mode.
public bool InsertField(Field field, FieldDisplayMode displayMode)The field.
displayModeFieldDisplayModeThe display mode.
Returns:True, if the operation completed successfully.
Implements:
Inserts footnote at the current position.
public void InsertFootnote()Implements:
Inserts the footnote at the current position.
Inserts a fragment at a specified position. Document selection should be cleared in advance.
public void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)The fragment to insert.
documentPositionDocumentPositionThe document position to insert the fragment at.
Exceptions:Thrown when there is selection in the document.
Thrown when documentFragment or documentPosition is null.
Implements:
Document selection should be cleared before calling this method, otherwise exception may be thrown.
Inserts a fragment at the current caret position.
public void InsertFragment(DocumentFragment documentFragment)The fragment to insert.
Exceptions:Thrown when documentFragment is null.
Implements:
Inserts a hyperlink in the document.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)The hyperlink info.
inlinesIEnumerable<Inline>The inlines in the hyperlink.
Implements:
Inserts collection of inlines as hyperlink into the document.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText)The hyperlink info.
hyperlinkTextstringThe hyperlink text.
Inserts a hyperlink in the document. The hyperlink will be created around the current selection.
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)The hyperlink info.
Implements:
Inserts inline element into the document at a specified caret position. Document selection should be cleared in advance.
public void InsertInline(Inline inline, DocumentPosition documentPosition)The inline element to insert.
documentPositionDocumentPositionThe document position to insert the inline at.
Exceptions:Thrown when there is selection in the document.
Thrown when inline or documentPosition is null.
Implements:
Document selection should be cleared before calling this method, otherwise exception may be thrown.
Inserts inline element into the document at the current caret position.
public void InsertInline(Inline inline)The inline element to insert.
Exceptions:Thrown when inline is null.
Implements:
Inserts text at the current caret position and adds a new paragraph after it.
Inserts a line break into the document at the current caret position.
public void InsertLineBreak()Implements:
Inserts a non-breaking space into the document at the current caret position.
public void InsertNonBreakingSpace()Inserts a page break into the document at the current caret position.
public void InsertPageBreak()Implements:
Inserts a new paragraph at the current caret position.
public void InsertParagraph()Implements:
Inserts a new permission range over the current selection. If the selection is empty, the permission range is inserted at the caret position.
public void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)The permissions for the new range.
Implements:
Inserts a read only range over the current selection. If the selection is empty, the range is inserted at the caret position.
public void InsertReadOnlyRange()Implements:
Inserts a section break into the document at the current caret position.
public void InsertSectionBreak()Implements:
Inserts a section break of the specified type into the document at the current caret position.
public void InsertSectionBreak(SectionBreakType sectionBreakType)The type of the section break.
Implements:
Inserts a default structured document tag (Content Control). The default type is RichText.
public void InsertStructuredDocumentTag()Inserts a structured document tag (Content Control) based on the provided properties.
public void InsertStructuredDocumentTag(SdtProperties insertProperties)Inserts a structured document tag (Content Control) of the given type.
Inserts a new table in the document.
Inserts a table column in the table which is under the caret position.
public void InsertTableColumn()Implements:
Inserts a table column to the left in the table which is under the caret position.
public void InsertTableColumnToTheLeft()Implements:
Inserts a table column to the right in the table which is under the caret position.
public void InsertTableColumnToTheRight()Implements:
Inserts a new table row in the table under the caret position.
public void InsertTableRow()Implements:
Inserts a table row above the one under the caret position.
public void InsertTableRowAbove()Implements:
Inserts a table row below the one under the caret position.
public void InsertTableRowBelow()Implements:
Produces a mail merged document containing the results for all data records.
public RadDocument MailMerge(bool startEachRecordOnNewPage)true, if each record should start on a new page.
The document containing the result of the operation.
Implements:
Creates a new RadDocument containing the result of merging the template with the values of the current data record.
Merges the currently selected table cells into one.
public void MergeTableCells()Implements:
Moves the current selection along with the selected document elements to a specified position.
public void MoveSelection(DocumentPosition movePosition, bool deleteSelection)The start position where the selection should be moved to.
deleteSelectionbooltrue, if the current selection and contained elements should be deleted on the original position.
Implements:
Pastes the content of the clipboard into the document.
public void Paste()Implements:
Pastes the content of the clipboard into the document.
public void Paste(PasteOption pasteOption)The paste option that will be used.
Implements:
Pastes the currently copied formatting on the current selection.
public bool PasteFormatting()A value indicating whether the paste was successful.
Implements:
Updates all fields in the document with the values evaluated using the first data record.
public bool PreviewFirstMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Updates all fields in the document with the values evaluated using the last data record.
public bool PreviewLastMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Updates all fields in the document with the values evaluated using the next data record.
public bool PreviewNextMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Updates all fields in the document with the values evaluated using the previous data record.
public bool PreviewPreviousMailMergeDataRecord()True, if the operation completed successfully.
Implements:
Re-executes the last undone command group.
public void Redo()Implements:
Rejects all revisions in the document.
public void RejectAllRevisions()Implements:
Rejects a revision.
public void RejectRevision(Revision revision)The revision.
Implements:
Removes a tab stop from the selected paragraphs.
Removes a collection of tab stops in the selected paragraphs.
public void RemoveTabStopRange(IEnumerable<TabStop> tabStops)The tab stops.
Implements:
Changes the width of a table column. The specified width value will be applied with width type Fixed. You could specify different width type through the ChangeTableGridColumnWidth(Table, int, TableWidthUnit) method.
Creates a new list from the current paragraph. The paragraph must be in a list, otherwise this method does nothing.
public bool RestartListNumbering()A boolean value determining whether the operation completed successfully.
Implements:
Sets a watermark to the selected sections.
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)The watermark settings describing the watermark that will be applied.
Implements:
Sets a predefined watermark to the selected sections.
public void SetWatermark(PredefinedWatermarkType predefinedType)Type of the predefined watermark.
Implements:
Splits an annotation range at the specified position, resulting in two new ranges.
public void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)The annotation range start to be split.
positionDocumentPositionThe position where the range start should be split.
Implements:
Splits an annotation range at the caret position, resulting in two new ranges.
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)The annotation range start to be split.
Implements:
Suppress the line numbering for selected paragraphs.
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)The paragraphs.
Implements:
Toggles the display mode of a field.
public void ToggleFieldCodes(FieldRangeStart fieldStart)The field start.
Implements:
Toggles the strike-through of the selected content.
public void ToggleStrikethrough()Implements:
Reverts the last executed command group.
public void Undo()Implements:
Splits the currently selected table cell.
public void UnmergeTableCells()Implements:
Updates all captions in the document related to a caption definition.
public void UpdateAllCaptions(CaptionDefinition captionDefinition)The caption definition.
Implements:
Updates all fields in the document.
public void UpdateAllFields()Implements:
Updates all fields in the document and displays them in the specified display mode.
public void UpdateAllFields(FieldDisplayMode displayMode)The display mode which will be used for the fields.
Implements:
Updates a field.
public void UpdateField(FieldRangeStart fieldStart)The field start.
Implements:
Updates the permissions inside the current selection.
public void UpdatePermissionRanges(IEnumerable<PermissionRangeInfo> permissionsToAdd, IEnumerable<PermissionRangeInfo> permissionsToRemove)Permissions to add.
permissionsToRemoveIEnumerable<PermissionRangeInfo>Permissions to remove.
Implements: