RadDocumentEditor

RadDocument has an API of its own, but using it has a set of limitations. First of all, adding and removing Blocks and Inlines from the document can be done only before the document has been measured – a procedure that calculates the desired size of the spans, paragraphs and the document altogether in order to calculate its layout. These operations are usually invoked by the framework when the document in shown in a RadRichTextBox. However, some of the methods of RadDocument and RadRichTextBox require that the document be measured before their execution, so if such a method is invoked, the document will be measured. Then, adding Paragraphs, Tables, Sections and Spans will break the structure of the document.

Another issue that the use of the methods of RadDocument causes is due to the fact that they are not registered in the undo/redo stack. Thus, once such a method is used, the history stack is cleared and users will no longer be able to undo and redo their previous changes.

What is RadDocumentEditor

On the other hand, RadRichTextBox provides a much richer API for editing the RadDocument instance in it. All respective methods from that API are located in the IDocumentEditor interface which defines all method that edit fields, annotation ranges, document elements, history, headers and footers and so on and is inherited from RadRichTextBox. In that regard, if you are modifying the document in a class that knows of the existence of RadRichTextBox, you can use the methods of RadRichTextBox in order to manipulate the document in a way transparent to the end user.

The appropriate API, however, should be available in cases when you want to modify a document from code without having a RadRichTextBox. For this purpose, a RadDocumentEditor class has been introduced. It also implements the IDocumentEditor interface and includes all relevant methods of RadRichTextBox for manipulating the document programmatically.

How to use RadDocumentEditor

When a RadDocument instance was for some reason created from code – built using the elements hierarchy or imported, it can be passed to a RadDocumentEditor like this:

RadDocumentEditor documentEditor = new RadDocumentEditor(document); 
Dim documentEditor As New RadDocumentEditor(document) 

The newly created documentEditor instance now provides all capabilities that a RadRichTextBox provides. Moreover, you can group several methods so that they are added to the Undo/Redo stack as a single item. This can be achieved like this:

documentEditor.BeginUndoGroup(); 
 
if (documentEditor.Document.CaretPosition.IsPositionInsideTable) 
{ 
    documentEditor.InsertTableRow(); 
    documentEditor.InsertTableRow(); 
    documentEditor.InsertTableRow(); 
    documentEditor.Document.Selection.Clear(); 
} 
 
documentEditor.EndUndoGroup("Insert three table rows"); 
documentEditor.BeginUndoGroup() 
 
If documentEditor.Document.CaretPosition.IsPositionInsideTable Then 
    documentEditor.InsertTableRow() 
    documentEditor.InsertTableRow() 
    documentEditor.InsertTableRow() 
    documentEditor.Document.Selection.Clear() 
End If 
 
documentEditor.EndUndoGroup("Insert three table rows") 

You can also cancel the execution of the undo group, and it won't be recorded in the history:

documentEditor.BeginUndoGroup(); 
 
if (documentEditor.Document.CaretPosition.IsPositionInsideTable) 
{ 
    documentEditor.InsertTableRow(); 
    documentEditor.InsertTableRow(); 
    documentEditor.InsertTableRow(); 
    documentEditor.Document.Selection.Clear(); 
} 
 
documentEditor.CancelUndoGroup(); 
documentEditor.BeginUndoGroup() 
 
If documentEditor.Document.CaretPosition.IsPositionInsideTable Then 
    documentEditor.InsertTableRow() 
    documentEditor.InsertTableRow() 
    documentEditor.InsertTableRow() 
    documentEditor.Document.Selection.Clear() 
End If 
 
documentEditor.CancelUndoGroup() 

One thing to note here is that it is not possible to remove some actions from the undo history altogether, i.e. you cannot perform an action without it getting registered in the Undo/Redo stack. In most cases, however, this is sufficient, as you can group the operations that you do not want to name and show explicitly to the end user with the ones that have been user-initiated and are expected by the person modifying the content of RadRichTextBox.

RadDocumentEditor Methods

Method Description
InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd) Inserts an annotation range over the current selection. If the selection is empty, the annotation range is inserted at the caret position.
SplitAnnotationRange(AnnotationRangeStart rangeStart) Splits an annotation range at the caret position, resulting in two new ranges.
SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position) Splits an annotation range at the specified position, resulting in two new ranges.
DeleteAnnotationRange(AnnotationRangeStart rangeStart) Deletes an annotation range.
InsertBookmark(string bookmarkName) Inserts a bookmark around the current selection. If the selection is empty, the bookmark is inserted at the caret position.
InsertBookmark(string bookmarkName) Deletes the bookmark with the specifies name.
DeleteBookmark(BookmarkRangeStart bookmarkRangeStart) Deletes the bookmark with the specifies start range
InsertComment(Comment comment) Inserts a comment around the current selection. If the selection is empty, the comment is inserted at the caret position.
DeleteComment() Deletes the comment at the caret postion.
DeleteAllComments() Deletes all comments in the document.
InsertPermissionRange(IEnumerable permissionInfos) Inserts a new permission range over the current selection. If the selection is empty, the permission range is inserted at the caret position.
DeletePermissionRange(PermissionRangeStart permissionRangeStart) Deletes a permission range.
UpdatePermissionRanges(IEnumerable permissionsToAdd, IEnumerable permissionsToRemove) Updates the permissions inside the current selection.
InsertReadOnlyRange() Inserts a read only range over the current selection. If the selection is empty noting is inserted.
DeleteReadOnlyRange() Deletes the read only range at the current caret position or inside the current selection.
DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart) Deletes read only range.
InsertFootnote() Inserts footnote at the current position.
InsertFootnote(Note footnote) Inserts the passed footnode.
InsertEndnote() Inserts endnote at the current position.
InsertEndnote(Note endnote) Inserts the passed endnode.
InsertHyperlink(HyperlinkInfo hyperlinkInfo) Inserts a hyperlink in the document. The hyperlink will be created around the current selection.
InsertHyperlink(HyperlinkInfo hyperlinkInfo, string hyperlinkText) Inserts a hyperlink with spesific text into the document.
DeleteHyperlink() Deletes the current hyperlink.
DeleteHyperlink(HyperlinkRangeStart hyperlinkRangeStart) Deletes a hyperlink with the specifies start element.
PreviewFirstMailMergeDataRecord() Updates all fields in the document with the values evaluated using the first data record.
PreviewLastMailMergeDataRecord() Updates all fields in the document with the values evaluated using the last data record.
PreviewPreviousMailMergeDataRecord() Updates all fields in the document with the values evaluated using the previous data record.
PreviewNextMailMergeDataRecord() Updates all fields in the document with the values evaluated using the next data record.
PreviewMailMergeDataRecordAtIndex(int index) Updates all fields in the document with the values evaluated using a specified data record.
MailMergeCurrentRecord() Creates a new RadDocument" containing the result of merging the template with the values of the current data record.
MailMerge(bool startEachRecordOnNewPage) Produces a mail merged document containing the results for all data records.
AcceptRevision(Revision revision) Accepts a revision.
RejectRevision(Revision revision) Rejects a revision.
AcceptAllRevisions() Accepts all revisions in the document.
RejectAllRevisions() Rejects all revisions in the document.
Method Description
InsertFragment(DocumentFragment documentFragment) Inserts a fragment at the current caret position.
InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition) Inserts a fragment at a specified position. Document selection should be cleared in advance.
Insert(string text) Inserts text into the document at the current caret position.
InsertImage(Stream imageStream, string extension) Inserts an inline image into the document at the current caret position.
InsertInline(Inline inline) Inserts inline element into the document at the current caret position.
InsertInline(Inline inline, DocumentPosition documentPosition) Inserts inline element into the document at a specified caret position. Document selection should be cleared in advance.
InsertParagraph() Inserts a new paragraph at the current caret position.
InsertLine(string text) Inserts text at the current caret position and adds a new paragraph after it.
InsertLineBreak() Inserts a line break into the document at the current caret position.
InsertPageBreak() Inserts a page break into the document at the current caret position.
InsertColumnBreak() Inserts a column break into the document at the current caret position.
InsertNonBreakingSpace() Inserts a non-breaking space into the document at the current caret position.
InsertSectionBreak() Inserts a section break into the document at the current caret position.
InsertSectionBreak(SectionBreakType sectionBreakType) Inserts a section break of the specified type into the document at the current caret position.
InsertCodeBlock(string code, CodeFormattingSettings settings) Inserts a code block at the caret position. If the caret position is in code block, replaces the current code block.
InsertTable(int rows, int columns) Inserts a new table with spesic row and column count.
InsertTable(int rows, int columns, bool shouldInsertParagraphBeforeTable) Inserts a new table in the document.Optioanly isnerts a new paragrpah before it.
InsertTable(Table table) Inserts a table in the document. The tale instance is copied before insertion.
InsertTableColumn() Inserts a table column in the table which is under the caret position.
InsertTableColumnToTheLeft() Inserts a table column to the left in the table which is under the caret position.
InsertTableColumnToTheRight() Inserts a table column to the right in the table which is under the caret position.
InsertTableRow() Inserts a new table row in the table under the caret position.
InsertTableRowAbove() Inserts a table row above the one under the caret position.
InsertTableRowBelow() Inserts a table row below the one under the caret position.
MergeTableCells() Merges the currently selected table cells into one.
UnmergeTableCells() Splits the currently selected table cell.
Delete(bool deletePrevious) Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the CaretPosition.
DeleteTable() Deletes the table the current caret position is in.
DeleteTable(Table table) Deletes a passed table instance.
DeleteTableRow(TableRow row) Deletes a table row.
DeleteTableColumn() Deletes the current table column which is under the caret position.
ResizeTableColumn(Table table, int columnIndex, double columnWidth) Changes the width of a table column. The specified width value will be applied with width type TableWidthUnitType.Fixed"
ChangeTableGridColumnWidth(Table table, int columnIndex, TableWidthUnit width) Changes the width of a table column.
DeleteTableRow() Deletes the table row under the caret position.
DeleteCodeBlock(CodeAnnotationRangeStart rangeStart) Deletes a code block.
Copy() Copies the currently selected document elements into the clipboard.
Cut() Cuts the currently selected document elements into the clipboard.
CopyFormatting() Copies the formatting of the current selection.
PasteFormatting() Pastes the currently copied formatting on the current selection.
MoveSelection(DocumentPosition movePosition, bool deleteSelection) Moves the current selection along with the selected document elements to a specified position.
RestartListNumbering() Creates a new list from the current paragraph. The paragraph must be in a list, otherwise this method does nothing.
ContinueListNumbering() Removes all paragraphs from the current list and continues the first possible list before that paragraph. The paragraph must be in a list and should be first in the list, otherwise this method does nothing.
SetListNumbering(int numbersToSkip) Skips numbers and starts the counting of the current list from the specified value.
Method Description
ChangeSectionHeader(Section section, HeaderFooterType headerType, Header header) Changes the section header.
ChangeSectionFooter(Section section, HeaderFooterType footerType, Footer footer) Changes the section footer.
ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value) Changes the value indicating whether the section header should be linked to the header of the previous section.
ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value) Changes the value indicating whether the section header should be linked to the header of the previous section.
ChangeSectionFooterLinkToPrevious Changes the value indicating whether the section footer should be linked to the footer of the previous section.

Fields realated

Method Description
InsertField(Field field) Inserts a field into the document at the current caret position.
InsertField(Field field, FieldDisplayMode displayMode) Inserts a field into the document at the current caret position in a specified display mode.
ToggleFieldCodes(FieldRangeStart fieldStart) Toggles the display mode of a field.
ChangeFieldDisplayMode(FieldRangeStart fieldRangeStart, FieldDisplayMode displayMode) Changes the display mode of a field.
UpdateField(FieldRangeStart fieldStart) Updates a field.
UpdateAllFields() Updates all fields in the document.
UpdateAllFields(FieldDisplayMode displayMode) Updates all fields in the document and displays them in the specified display mode.
ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode) Changes the display mode of all fields in the document.
ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle) Changes the bibliographic style of all bibliography related fields in the document.
InsertCaption(CaptionDefinition captionDefinition, string caption, bool includeLabel, bool insertBelow) Inserts a caption around the current selection. If the selection is empty, the caption is inserted at the current caret position.
UpdateAllCaptions(CaptionDefinition captionDefinition) Updates all captions in the document related to a caption definition.
InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink) Inserts a cross-reference to a bookmark into the document at the current caret position.
InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink) Inserts a cross-reference to a paragraph with Heading style into the document at the current caret position.
InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink) Inserts a cross-reference to a caption into the document at the current caret position.
Method Description
ChangeStyleName(string styleName) Applies style with a given name to the selected elements in the document.
ChangeStyleName(string styleName, bool useLinkedStyle) Applies style with a given name to the selected elements in the document.
ChangeDocumentElementTag(DocumentElement element, string tag) Changes the Tag property of a specified DocumentElement.
ChangeFontWeight(FontWeight fontWeight) Changes the font weight of the selected content. If selection is not present, the current editing style is updated.
ChangeFontStyle(FontStyle fontStyle) Changes the font style of the selected content.
ChangeStrikethrough(bool isStriketrough) Changes the strike-through of the selected content.
ToggleBold() Toggles the font weight of the selected content between FontWeights.Bold and FontWeights.Normal.
ToggleItalic() Toggles the font style of the selected content between FontStyles.Italic and FontStyles.Normal.
ToggleStrikethrough() Toggles the strike-through of the selected content.
ChangeBaselineAlignment(BaselineAlignment baselineAlignment) Changes the baseline alignment of the selected content.
ChangeFontFamily(FontFamily fontFamily) Changes the font family of the selected content.
ChangeFontSize(double fontSize) Changes the size of the font of the selected content.
DecrementFontSize() Decrements the size of the font of the selected content with 2 points.
IncrementFontSize() Increments the size of the font of the selected content with 2 points.
ChangeSpanStyle(StyleDefinition styleInfo) Changes the span style of the selected content.
ChangeForeColor(Color color) Changes the fore color of the selected content.
ChangeHighlightColor(Color color) Changes the highlight color of the selected content.
ChangeUnderlineColor(Color color) Changes the underline color of the selected content.
ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration) Changes the underline decoration of the selected content.
ClearFormatting() Clears the character formatting of the selected content.
ChangeImageSize(ImageInline image, Size size) Changes the size of an image.
ChangeImageRotateAngle(ImageInline image, double angle) Changes the rotate angle of an image.
ChangeParagraphStyle(StyleDefinition styleInfo) Changes the paragraph style of the selected content.
ChangeParagraphListStyle(ListStyle style, IEnumerable paragraphs) Changes the list style of the specified paragraphs.
ChangeParagraphListStyle(ListStyle style) Changes the paragraph list style of the selected paragraphs.
ChangeParagraphTextAlignment(RadTextAlignment alignment) Changes the text alignment of the selected paragraphs.
ChangeParagraphBackground(Color color) Changes the background of the selected paragraphs.
ChangeParagraphFlowDirection(FlowDirection flowDirection) Changes the flow direction of the selected paragraphs.
ChangeParagraphLineSpacing(double lineSpacing) Changes the line spacing of the selected paragraphs.
ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType) Changes the type of the line spacing of the selected paragraphs.
ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType) Changes the line spacing of the selected paragraphs.
IncreaseLeftIndent() Increases the left indent of the selected paragraphs. The default step used for indentation is 24.
DecreaseLeftIndent() Decreases the left indent of the selected paragraphs. The default step used for indentation is 24.
IncrementParagraphLeftIndent() Increments the left indent of the selected paragraphs. The default step used for indentation is 24.
DecrementParagraphLeftIndent() Decrements the left indent of the selected paragraphs. The default step used for indentation is 24.
ChangeParagraphLeftIndent(double leftIndent) Changes the left indent of the selected paragraphs.
ChangeParagraphRightIndent(double rightIndent) Changes the right indent of the selected paragraphs.
ChangeParagraphFirstLineIndent(double firstLineIndent) Changes the first line indent of the selected paragraphs.
ChangeParagraphSpacingBefore(double spacingBefore) Changes the spacing before of the selected paragraphs.
ChangeParagraphAutomaticSpacingBefore(bool value) Changes the automatic spacing before of the selected paragraphs.
ChangeParagraphSpacingAfter(double spacingAfter) Changes the spacing after of the selected paragraphs.
ChangeParagraphAutomaticSpacingAfter(bool value) Changes the automatic spacing after of the selected paragraphs.
ChangeParagraphListLevel(int listLevel) Changes the list level of the selected paragraphs.
IncrementParagraphListLevel(int value) Increments the paragraph list level of the selected paragraphs.
ReplaceTabStop(TabStop oldTabStop, TabStop newTabStop) Replaces a tab stop inside the selected paragraphs.
AddTabStop(TabStop tabStop) Adds a tab stop to the current paragraph.
AddTabStopRange(IEnumerable tabStops) Adds a tab stop range to the current paragraph.
RemoveTabStop(TabStop tabStop) Removes a tab stop from the selected paragraphs.
RemoveTabStopRange(IEnumerable tabStops) Removes a collection of tab stops in the selected paragraphs.
ClearTabStops() Clears the tab stops inside the selected paragraphs.
ClearParagraphFormatting() Clears the paragraph formatting of the selected content.
ClearAllFormatting() Clears all the formatting (character and paragraph) from the selected content.
ChangeParagraphIsLineBreakingRuleEnabled(bool value) Changes the Paragraph.IsLineBreakingRuleEnabled property. This property indicates whether East Asian typography rules will be applied to determine which characters may begin and end each line.
ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode) Changes the layout mode of the selected tables.
ChangeTableDefaultCellPadding(Padding padding) Changes the default cell padding of the selected tables.
ChangeTableFlowDirection(FlowDirection flowDirection) Changes the flow direction of the selected tables.
ChangeTableIndent(double indent) Changes the indent of the selected tables.
ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment) Changes the horizontal alignment of the selected tables.
ChangeTablePreferredWidth(TableWidthUnit tableWidth) Changes the preferred width of the selected tables.
ChangeTableBorders(TableBorders tableBorders) Changes the borders of the selected tables.
ChangeTableCellSpacing(double cellSpacing) Changes the cell spacing of the selected tables.
ChangeTableLook(TableLook tableLook) Changes the look of the selected tables.
ChangeTableRowHeight(TableRow tableRow, double height) Changes the height of a table row.
ChangeTableRowRepeatOnEveryPage(TableRow tableRow) Depending on the current value, enables or disables the repetition of a table row on every page.
ChangeTableCellBackground(Color color) Changes the background of the selected table cells.
ChangeTableCellBorders(Border border) Changes the borders of the selected table cells.
ChangeTableCellBorders(TableCellBorders tableCellBorders) Changes the borders of the selected table cells.
ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment) Changes the content alignment of the selected table cells.
hangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment) Changes the vertical content alignment of the selected table cells.
ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment) Changes the horizontal content alignment of the selected table cells.
ChangeTableCellPadding(Padding padding) Changes the padding of the selected table cells.
ChangeSectionActualPageMargin(Padding sectionMargin) Changes the page margin of the selected sections respecting their current orientation.
ChangeSectionPageMargin(Padding sectionMargin) Changes the page margin of the selected sections.
ChangeSectionPageOrientation(PageOrientation sectionPageOrientation) Changes the page orientation of the selected sections.
ChangeSectionPageSize(Size newSize) Changes the page size of the selected sections.
ChangeDifferentFirstPageHeaderFooter(bool value) 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.
ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin) Changes the header top margin of the selected sections.
ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin) Changes the footer bottom margin of the selected sections.
ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat) Changes the numbering format of the footnotes in the selected sections.
ChangeSectionFootnotesFirstNumber(int firstNumber) Changes the first number of the footnotes in the selected sections.
ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType) Changes the type of numbering restart of the footnotes in the selected sections.
ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat) Changes the numbering format of the endnotes in the selected sections.
ChangeSectionEndnotesFirstNumber(int firstNumber) Changes the first number of the endnotes in the selected sections.
ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType) Changes the type of numbering restart of the endnotes in the selected sections.
SetWatermark(PredefinedWatermarkType predefinedType) Sets a predefined watermark to the selected sections.
SetWatermark(DocumentWatermarkSettings watermarkSettings) Sets a watermark to the selected sections.
ChangeSectionFirstPageNumber(int? firstPageNumber) Changes the first page number of the selected sections.
ChangeSectionColumns(SectionColumnCollection sectionColumns) Changes the section columns for the selected sections.
ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout) Changes the section columns for a given collection of section elements.
ChangeDifferentOddAndEvenPagesHeaderFooter(bool value) Changes the value determining whether the sections should have different odd and even pages header/footer.
ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat) Changes the numbering format of the footnotes in the document.
ChangeDocumentFootnotesFirstNumber(int firstNumber) Changes the first number of the footnotes in the document.
ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType) Changes the type of numbering restart of the endnotes in the document.
ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition) Changes the position of the footnotes in the document.
ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat) Changes the numbering format of the endnotes in the document.
ChangeDocumentEndnotesFirstNumber(int firstNumber) Changes the first number of the endnotes in the document.
ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType) Changes the type of numbering restart of the endnotes in the document.
ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition) Changes the position of the endnotes in the document.
ChangeDocumentDefaultTabWidth(double tabWidth) Changes default tab stop width for the document.
ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value) Sets a value determining whether the strict line breaking rule will be applied to Japanese text in this document.
ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule) Sets a rule determining which characters cannot start a line in East-Asian languages.
ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule) Sets a rule determining which characters cannot end a line in East-Asian languages.
ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage) Sets the language whose rules should be used for line breaking in the paragraphs.

See Also

In this article
Not finding the help you need? Improve this article