IDocumentEditor
Defines members for 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 interface IDocumentEditorDerived Classes:
Properties
Gets the current document.
RadDocument Document { get; }Methods
Accepts all revisions in the document.
void AcceptAllRevisions()Accepts a revision.
Adds a tab stop to the current paragraph.
Adds a tab stop range to the current paragraph.
void AddTabStopRange(IEnumerable<TabStop> tabStops)The tab stop collection.
Begins a new group of actions which will appear as a single item in the document history.
void BeginUndoGroup()Cancels the currently started undo-able group, started with BeginUndoGroup() and undoes the actions executed since the starting of the group.
void CancelUndoGroup()Changes the display mode of all fields in the document.
void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)The display mode which will be used for the fields.
Changes the baseline alignment of the selected content.
void ChangeBaselineAlignment(BaselineAlignment baselineAlignment)The baseline alignment to be applied.
Changes the bibliographic style of all bibliography related fields in the document.
void ChangeBibliographicStyle(BibliographicReferenceStyleBase style)The new bibliographic style.
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.
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.
Changes the value determining whether the sections should have different odd and even pages header/footer.
void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)true, if the even and odd page header/footer should differ.
Changes default tab stop width for the document.
Changes the Tag property of a specified DocumentElement.
void ChangeDocumentElementTag(DocumentElement element, string tag)The DocumentElement.
tagstringThe new tag value.
Changes the first number of the endnotes in the document.
void ChangeDocumentEndnotesFirstNumber(int firstNumber)The first number.
Changes the numbering format of the endnotes in the document.
void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Changes the type of numbering restart of the endnotes in the document.
void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Changes the position of the endnotes in the document.
void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)The position.
Changes the first number of the footnotes in the document.
void ChangeDocumentFootnotesFirstNumber(int firstNumber)The first number.
Changes the numbering format of the footnotes in the document.
void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Changes the type of numbering restart of the endnotes in the document.
void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Changes the position of the footnotes in the document.
void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)The footnotes position.
Sets a value determining whether the strict line breaking rule will be applied to Japanese text in this document.
void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)if set to true, the strict line breaking rule will be applied.
Sets the language whose rules should be used for line breaking in the paragraphs.
void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)The line breaking rule language.
Sets a rule determining which characters cannot end a line in East-Asian languages.
void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)The line breaking character rule.
Sets a rule determining which characters cannot start a line in East-Asian languages.
void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)The rule.
Changes the display mode of a field.
void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)The field start.
displayModeFieldDisplayModeThe new display mode.
Changes the font family of the selected content.
void ChangeFontFamily(FontFamily fontFamily)The font family to be applied.
Changes the size of the font of the selected content.
Changes the font style of the selected content.
Changes the font weight of the selected content. If selection is not present, the current editing style is updated.
Changes the fore color of the selected content.
Changes the highlight color of the selected content.
Changes the rotate angle of an image.
void ChangeImageRotateAngle(ImageInline image, double angle)The ImageInline.
angledoubleThe new angle.
Changes the size of an image.
void ChangeImageSize(ImageInline image, Size size)The ImageInline which is modified.
sizeSizeThe new size.
Changes the restart type of line numberings for the selected sections.
void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)The line numbering restart type.
Changes the automatic spacing after of the selected paragraphs.
void ChangeParagraphAutomaticSpacingAfter(bool value)If set to true, the automatic spacing after will be enabled.
Changes the automatic spacing before of the selected paragraphs.
void ChangeParagraphAutomaticSpacingBefore(bool value)If set to true, the automatic spacing before will be enabled.
Changes the background of the selected paragraphs.
Changes the first line indent of the selected paragraphs.
void ChangeParagraphFirstLineIndent(double firstLineIndent)The first line indent.
Changes the flow direction of the selected paragraphs.
void ChangeParagraphFlowDirection(FlowDirection flowDirection)The flow direction.
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.
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.
Changes the left indent of the selected paragraphs.
Changes the line spacing of the selected paragraphs.
void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)The line spacing.
lineSpacingTypeLineSpacingTypeType of the line spacing.
Changes the line spacing of the selected paragraphs.
void ChangeParagraphLineSpacing(double lineSpacing)The line spacing.
Changes the type of the line spacing of the selected paragraphs.
void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)Type of the line spacing.
Changes the list level of the selected paragraphs.
Changes the paragraph list style of the selected paragraphs.
Changes the right indent of the selected paragraphs.
void ChangeParagraphRightIndent(double rightIndent)The right indent.
Changes the spacing after of the selected paragraphs.
void ChangeParagraphSpacingAfter(double spacingAfter)The spacing after.
Changes the spacing before of the selected paragraphs.
void ChangeParagraphSpacingBefore(double spacingBefore)The spacing before.
Changes the paragraph style of the selected content.
void ChangeParagraphStyle(StyleDefinition styleInfo)The style information.
Changes the text alignment of the selected paragraphs.
void ChangeParagraphTextAlignment(RadTextAlignment alignment)The alignment.
Changes the page margin of the selected sections respecting their current orientation.
void ChangeSectionActualPageMargin(Padding sectionMargin)The margin.
Changes the section columns for the selected sections.
void ChangeSectionColumns(SectionColumnCollection sectionColumns)The section columns.
Changes the section columns for a given collection of Section elements.
void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)The section columns layout.
Changes the first number of the endnotes in the selected sections.
void ChangeSectionEndnotesFirstNumber(int firstNumber)The first number.
Changes the numbering format of the endnotes in the selected sections.
void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Changes the type of numbering restart of the endnotes in the selected sections.
void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Changes the first page number of the selected sections.
void ChangeSectionFirstPageNumber(int? firstPageNumber)The first page number.
Changes the section footer.
void ChangeSectionFooter(Section section, HeaderFooterType footerType, Footer footer)The section.
footerTypeHeaderFooterTypeType of the footer.
footerFooterThe footer.
Changes the footer bottom margin of the selected sections.
void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)The section footer bottom margin.
Changes the value indicating whether the section footer should be linked to the footer of the previous section.
void ChangeSectionFooterLinkToPrevious(Section section, HeaderFooterType footerType, bool value)The section.
footerTypeHeaderFooterTypeType of the footer.
valuebooltrue if the footer should be linked.
Changes the first number of the footnotes in the selected sections.
void ChangeSectionFootnotesFirstNumber(int firstNumber)The first number.
Changes the numbering format of the footnotes in the selected sections.
void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)The numbering format.
Changes the type of numbering restart of the footnotes in the selected sections.
void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)The type of restart for the numbering.
Changes the section header.
void ChangeSectionHeader(Section section, HeaderFooterType headerType, Header header)The section.
headerTypeHeaderFooterTypeType of the header.
headerHeaderThe header.
Changes the value indicating whether the section header should be linked to the header of the previous section.
void ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value)The section.
headerTypeHeaderFooterTypeType of the header.
valuebooltrue if the header should be linked.
Changes the header top margin of the selected sections.
void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)The section header top margin.
Changes the line numbering for the selected sections.
void ChangeSectionLineNumbering(LineNumbering lineNumbering)The line numbering.
Changes the page margin of the selected sections.
Changes the page orientation of the selected sections.
void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)The page orientation.
Changes the page size of the selected sections.
void ChangeSectionPageSize(Size newSize)The new size. You can use the PaperTypes enumeration to get the desired size from the predefined values.
Changes the span style of the selected content.
void ChangeSpanStyle(StyleDefinition styleInfo)The style information.
Changes the strike-through of the selected content.
void ChangeStrikethrough(bool isStrikethrough)If set to true, a strike-through will be applied to the selected content.
Applies style with a given name to the selected elements in the document.
void ChangeStyleName(string styleName)Name of the style to be applied.
Changes the borders of the selected tables.
void ChangeTableBorders(TableBorders tableBorders)The table borders.
Changes the background of the selected table cells.
Changes the borders of the selected table cells.
void ChangeTableCellBorders(TableCellBorders tableCellBorders)The border which will be used for all table cell borders.
Changes the content alignment of the selected table cells.
void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)The text alignment.
verticalAlignmentRadVerticalAlignmentThe vertical alignment.
Changes the horizontal content alignment of the selected table cells.
void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)The alignment.
Changes the padding of the selected table cells.
Changes the cell spacing of the selected tables.
Changes the vertical content alignment of the selected table cells.
void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)The alignment.
Changes the default cell padding of the selected tables.
void ChangeTableDefaultCellPadding(Padding padding)The padding which will be used as a default value.
Changes the flow direction of the selected tables.
void ChangeTableFlowDirection(FlowDirection flowDirection)The flow direction.
Changes the width of a table column.
void ChangeTableGridColumnWidth(Table table, int columnIndex, TableWidthUnit width)The table.
columnIndexintThe index of the column.
widthTableWidthUnitThe new value for the column width.
Changes the horizontal alignment of the selected tables.
void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)The alignment.
Changes the indent of the selected tables.
Changes the layout mode of the selected tables.
void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)The table.
tableLayoutModeTableLayoutModeThe table layout mode.
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.
Changes the preferred width of the selected tables.
void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Width of the table.
Depending on the current value, enables or disables the repetition of a table row on every page.
void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)The table row.
Changes the underline color of the selected content.
Changes the underline decoration of the selected content.
void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)The value.
Clears all the formatting (character and paragraph) from the selected content.
void ClearAllFormatting()Clears the character formatting of the selected content.
void ClearFormatting()Clears the tab stops inside the selected paragraphs.
void ClearTabStops()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.
bool ContinueListNumbering()A boolean value indicating whether the operation completed successfully.
Copies the currently selected document elements into the clipboard.
void Copy()Copies the formatting of the current selection.
Cuts the currently selected document elements into the clipboard.
void Cut()Decrements the size of the font of the selected content with 2 points.
void DecrementFontSize()Decrements the left indent of the selected paragraphs.
void DecrementParagraphLeftIndent()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.
void DeleteAllComments()Deletes an annotation range.
void DeleteAnnotationRange(AnnotationRangeStart rangeStart)The start of the range that will be deleted.
Deletes a bookmark.
void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)The bookmark range start.
Deletes a bookmark.
Deletes a code block.
void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)The CodeAnnotationRangeStart of the block to delete.
Deletes the current comment.
void DeleteComment()Deletes a comment.
void DeleteComment(CommentRangeStart commentRangeStart)The comment range start.
Deletes the current hyperlink.
void DeleteHyperlink()Deletes a hyperlink.
void DeleteHyperlink(HyperlinkRangeStart hyperlinkRangeStart)The hyperlink range start.
Deletes a permission range.
void DeletePermissionRange(PermissionRangeStart rangeStart)The permission range start.
Deletes the read only range at the current caret position or inside the current selection.
void DeleteReadOnlyRange()Deletes read only range.
void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)The read only range that is to be deleted.
Deletes the table the current caret position is in.
void DeleteTable()Deletes the current table column which is under the caret position.
void DeleteTableColumn()Deletes the table row under the caret position.
void DeleteTableRow()Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
void EndUndoGroup()Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
void EndUndoGroup(string groupDisplayText)The display text which will be used for the undo group.
Increments the size of the font of the selected content with 2 points.
void IncrementFontSize()Increments the left indent of the selected paragraphs.
void IncrementParagraphLeftIndent()Inserts an annotation range over the current selection. If the selection is empty, the annotation range is inserted at the caret position.
void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)The annotation range start.
rangeEndAnnotationRangeEndThe annotation range end.
Inserts a bookmark around the current selection. If the selection is empty, the bookmark is inserted at the caret position.
Inserts a caption around the current selection. If the selection is empty, the caption is inserted at the current caret position.
void InsertCaption(CaptionDefinition definition, 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.
Inserts a code block at the caret position. If the caret position is in code block, replaces the current code block.
void InsertCodeBlock(string code, CodeFormattingSettings settings)The code to insert.
settingsCodeFormattingSettingsThe settings which will be used for the code block.
Inserts a column break into the document at the current caret position.
void InsertColumnBreak()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.
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.
Inserts a cross-reference to a caption into the document at the current caret position.
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.
Inserts a cross-reference to a paragraph with Heading style into the document at the current caret position.
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.
Inserts endnote at the current position.
void InsertEndnote()Inserts the endnote at the current position.
Inserts a field into the document at the current caret position in a specified display mode.
bool InsertField(Field field, FieldDisplayMode displayMode)The field.
displayModeFieldDisplayModeThe display mode.
Returns:True, if the operation completed successfully.
Inserts footnote at the current position.
void InsertFootnote()Inserts the footnote at the current position.
Inserts a fragment at a specified position. Document selection should be cleared in advance.
void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)The fragment to insert.
documentPositionDocumentPositionThe document position to insert the fragment at.
Inserts a fragment at the current caret position.
void InsertFragment(DocumentFragment documentFragment)The fragment to insert.
Inserts collection of inlines as hyperlink into the document.
void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)The hyperlink info.
inlinesIEnumerable<Inline>The inlines in the hyperlink.
Inserts a hyperlink in the document.
void InsertHyperlink(HyperlinkInfo hyperlinkInfo)The hyperlink info.
Inserts inline element into the document at a specified caret position. Document selection should be cleared in advance.
void InsertInline(Inline inline, DocumentPosition documentPosition)The inline element to insert.
documentPositionDocumentPositionThe document position to insert the inline at.
Inserts inline element into the document at the current caret position.
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.
void InsertLineBreak()Inserts a page break into the document at the current caret position.
void InsertPageBreak()Inserts a new paragraph at the current caret position.
void InsertParagraph()Inserts a new permission range over the current selection. If the selection is empty, the permission range is inserted at the caret position.
void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)The permissions for the new range.
Inserts a read only range over the current selection. If the selection is empty, the range is inserted at the caret position.
void InsertReadOnlyRange()Inserts a section break into the document at the current caret position.
void InsertSectionBreak()Inserts a section break of the specified type into the document at the current caret position.
void InsertSectionBreak(SectionBreakType type)The type of the section break.
Inserts a table in the document.
Inserts a table column in the table which is under the caret position.
void InsertTableColumn()Inserts a table column to the left in the table which is under the caret position.
void InsertTableColumnToTheLeft()Inserts a table column to the right in the table which is under the caret position.
void InsertTableColumnToTheRight()Inserts a new table row in the table under the caret position.
void InsertTableRow()Inserts a table row above the one under the caret position.
void InsertTableRowAbove()Inserts a table row below the one under the caret position.
void InsertTableRowBelow()Produces a mail merged document containing the results for all data records.
RadDocument MailMerge(bool startEachRecordOnNewPage)true, if each record should start on a new page.
The document containing the result of the operation.
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.
void MergeTableCells()Moves the current selection along with the selected document elements to a specified position.
void MoveSelection(DocumentPosition position, 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.
Pastes the content of the clipboard into the document.
void Paste()Pastes the content of the clipboard into the document.
Pastes the currently copied formatting on the current selection.
Updates all fields in the document with the values evaluated using the first data record.
bool PreviewFirstMailMergeDataRecord()True, if the operation completed successfully.
Updates all fields in the document with the values evaluated using the last data record.
bool PreviewLastMailMergeDataRecord()True, if the operation completed successfully.
Updates all fields in the document with the values evaluated using the next data record.
bool PreviewNextMailMergeDataRecord()True, if the operation completed successfully.
Updates all fields in the document with the values evaluated using the previous data record.
bool PreviewPreviousMailMergeDataRecord()True, if the operation completed successfully.
Re-executes the last undone command group.
void Redo()Rejects all revisions in the document.
void RejectAllRevisions()Rejects a revision.
Removes a tab stop from the selected paragraphs.
Removes a collection of tab stops in the selected paragraphs.
void RemoveTabStopRange(IEnumerable<TabStop> tabStops)The tab stops.
Changes the width of a table column. 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.
bool RestartListNumbering()A boolean value determining whether the operation completed successfully.
Sets a watermark to the selected sections.
void SetWatermark(DocumentWatermarkSettings watermarkSettings)The watermark settings describing the watermark that will be applied.
Sets a predefined watermark to the selected sections.
void SetWatermark(PredefinedWatermarkType predefinedType)Type of the predefined watermark.
Splits an annotation range at the specified position, resulting in two new ranges.
void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)The annotation range start to be split.
positionDocumentPositionThe position where the range start should be split.
Splits an annotation range at the caret position, resulting in two new ranges.
void SplitAnnotationRange(AnnotationRangeStart rangeStart)The annotation range start to be split.
Suppress the line numbering for selected paragraphs.
void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)The paragraphs.
Toggles the font weight of the selected content.
void ToggleBold()Toggles the display mode of a field.
void ToggleFieldCodes(FieldRangeStart fieldStart)The field start.
Toggles the strike-through of the selected content.
void ToggleStrikethrough()Reverts the last executed command group.
void Undo()Splits the currently selected table cell.
void UnmergeTableCells()Updates all captions in the document related to a caption definition.
void UpdateAllCaptions(CaptionDefinition captionDefinition)The caption definition.
Updates all fields in the document.
void UpdateAllFields()Updates all fields in the document and displays them in the specified display mode.
void UpdateAllFields(FieldDisplayMode displayMode)The display mode which will be used for the fields.
Updates a field.
void UpdateField(FieldRangeStart fieldStart)The field start.
Updates the permissions inside the current selection.
void UpdatePermissionRanges(IEnumerable<PermissionRangeInfo> permissionsToAdd, IEnumerable<PermissionRangeInfo> permissionsToRemove)Permissions to add.
permissionsToRemoveIEnumerable<PermissionRangeInfo>Permissions to remove.