Class RadDocumentEditor

Represents a non-visual editor for RadDocument, which supports history and preserves the validity of the underlying document model.

Inheritance
System.Object
RadDocumentEditor
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class RadDocumentEditor : Object, IDocumentEditor, ITextInputCommandsHandler

Constructors

RadDocumentEditor(RadDocument)

Initializes a new instance of the RadDocumentEditor class.

Declaration
public RadDocumentEditor(RadDocument document)
Parameters
RadDocument document

The RadDocument instance which will be edited.

Properties

AcceptsReturn

Gets or sets a value indicating whether the editing operations can insert new paragraphs if needed.

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

Document

Gets the document that is to be edited.

Declaration
public RadDocument Document { get; }
Property Value
RadDocument

Implements

RespectDocumentProtection

Gets or sets a value that indicates whether protection ranges should be respected when editing.

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

true if the protection ranges should be respected; otherwise, false.

RespectNonDeletableRanges

Gets or sets a value indicating whether non-deletable ranges should be respected when editing.

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

true if the non-deletable ranges should be respected; otherwise, false.

RespectReadOnlyRanges

Gets or sets a value indicating whether read-only ranges should be respected when editing.

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

true if the read-only ranges should be respected; otherwise, false.

Methods

AcceptAllRevisions()

Accepts all revisions in the document.

Declaration
public void AcceptAllRevisions()
Implements

AcceptRevision(Revision)

Accepts a revision.

Declaration
public void AcceptRevision(Revision revision)
Parameters
Revision revision

The revision.
Implements

AddShapeTextBox(ShapeInline)

Initializes a text box element for a shape that does not have any.

Declaration
public void AddShapeTextBox(ShapeInline shape)
Parameters
ShapeInline shape

The ShapeInline.
Implements

AddTabStop(TabStop)

Adds a tab stop to the current paragraph.

Declaration
public void AddTabStop(TabStop tabStop)
Parameters
TabStop tabStop

The tab stop.
Implements

AddTabStopRange(IEnumerable<TabStop>)

Adds a tab stop range to the current paragraph.

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

The tab stop collection.
Implements

BeginUndoGroup()

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

Declaration
public void BeginUndoGroup()
Implements

CancelUndoGroup()

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

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

Declaration
public void CancelUndoGroup()
Implements

ChangeAllFieldsDisplayMode(FieldDisplayMode)

Changes the display mode of all fields in the document.

Declaration
public void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

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

ChangeBaselineAlignment(BaselineAlignment)

Changes the baseline alignment of the selected content.

Declaration
public void ChangeBaselineAlignment(BaselineAlignment baselineAlignment)
Parameters
BaselineAlignment baselineAlignment

The baseline alignment to be applied.
Implements

ChangeBibliographicStyle(BibliographicReferenceStyleBase)

Changes the bibliographic style of all bibliography related fields in the document.

Declaration
public void ChangeBibliographicStyle(BibliographicReferenceStyleBase newBibliographicStyle)
Parameters
BibliographicReferenceStyleBase newBibliographicStyle

The new bibliographic style.
Implements

ChangeDifferentFirstPageHeaderFooter(Boolean)

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

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

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

ChangeDifferentOddAndEvenPagesHeaderFooter(Boolean)

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

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

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

ChangeDocumentDefaultTabWidth(Double)

Changes default tab stop width for the document.

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

Width of the tab.
Implements

ChangeDocumentElementTag(DocumentElement, String)

Changes the Tag property of a specified DocumentElement.

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

The DocumentElement.
System.String tag

The new tag value.
Implements

ChangeDocumentEndnotesFirstNumber(Int32)

Changes the first number of the endnotes in the document.

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

The first number.
Implements

ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)

Changes the numbering format of the endnotes in the document.

Declaration
public void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)

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

Declaration
public void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeDocumentEndnotesPosition(EndnotesPosition)

Changes the position of the endnotes in the document.

Declaration
public void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)
Parameters
EndnotesPosition endnotesPosition

The position.
Implements

ChangeDocumentFootnotesFirstNumber(Int32)

Changes the first number of the footnotes in the document.

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

The first number.
Implements

ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)

Changes the numbering format of the footnotes in the document.

Declaration
public void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)

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

Declaration
public void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeDocumentFootnotesPosition(FootnotesPosition)

Changes the position of the footnotes in the document.

Declaration
public void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)
Parameters
FootnotesPosition footnotesPosition

The footnotes position.
Implements

ChangeDocumentIsStrictLineBreakingRuleEnabled(Boolean)

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

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

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

ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)

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

Declaration
public void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)
Parameters
LineBreakingRuleLanguage lineBreakingRuleLanguage

The line breaking rule language.
Implements

ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)

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

Declaration
public void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

The line breaking character rule.
Implements

ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)

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

Declaration
public void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)
Parameters
LineBreakingRule lineBreakingCharacterRule

The rule.
Implements

ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)

Changes the display mode of a field.

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

The field start.
FieldDisplayMode displayMode

The new display mode.
Implements

ChangeFontFamily(FontFamily)

Changes the font family of the selected content.

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

The font family to be applied.
Implements

ChangeFontSize(Double)

Changes the size of the font of the selected content.

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

Size of the font.
Implements

ChangeFontStyle(FontStyle)

Changes the font style of the selected content.

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

The font style.
Implements

ChangeFontWeight(FontWeight)

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

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

The font weight.
Implements

ChangeForeColor(Color)

Changes the fore color of the selected content.

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

The color.
Implements

ChangeHighlightColor(Color)

Changes the highlight color of the selected content.

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

The color.
Implements

ChangeImageRotateAngle(ImageInline, Double)

Changes the rotate angle of an image.

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

The ImageInline.
System.Double angle

The new angle.
Implements

ChangeImageSize(ImageInline, Size)

Changes the size of an image.

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

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

The new size.
Implements

ChangeLineNumberingRestartType(LineNumberingRestartType)

Changes the restart type of line numberings for the selected sections.

Declaration
public void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)
Parameters
LineNumberingRestartType restartType

The line numbering restart type.
Implements

ChangeParagraphAutomaticSpacingAfter(Boolean)

Changes the automatic spacing after of the selected paragraphs.

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

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

ChangeParagraphAutomaticSpacingBefore(Boolean)

Changes the automatic spacing before of the selected paragraphs.

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

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

ChangeParagraphBackground(Color)

Changes the background of the selected paragraphs.

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

The color.
Implements

ChangeParagraphFirstLineIndent(Double)

Changes the first line indent of the selected paragraphs.

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

The first line indent.
Implements

ChangeParagraphFlowDirection(FlowDirection)

Changes the flow direction of the selected paragraphs.

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

The flow direction.
Implements

ChangeParagraphIsLineBreakingRuleEnabled(Boolean)

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

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

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

ChangeParagraphLeftIndent(Double)

Changes the left indent of the selected paragraphs.

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

The left indent.
Implements

ChangeParagraphLineSpacing(Double)

Changes the line spacing of the selected paragraphs.

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

The line spacing.
Implements

ChangeParagraphLineSpacing(Double, LineSpacingType)

Changes the line spacing of the selected paragraphs.

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

The line spacing.
LineSpacingType lineSpacingType

Type of the line spacing.
Implements

ChangeParagraphLineSpacingType(LineSpacingType)

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

Declaration
public void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)
Parameters
LineSpacingType lineSpacingType

Type of the line spacing.
Implements

ChangeParagraphListLevel(Int32)

Changes the list level of the selected paragraphs.

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

The list level.
Implements

ChangeParagraphListStyle(ListStyle)

Changes the paragraph list style of the selected paragraphs.

Declaration
public void ChangeParagraphListStyle(ListStyle style)
Parameters
ListStyle style

The style.
Implements

ChangeParagraphListStyle(ListStyle, IEnumerable<Paragraph>)

Changes the list style of the specified paragraphs.

Declaration
public void ChangeParagraphListStyle(ListStyle style, IEnumerable<Paragraph> paragraphs)
Parameters
ListStyle style

The style.
System.Collections.Generic.IEnumerable<Paragraph> paragraphs

The paragraphs.

ChangeParagraphRightIndent(Double)

Changes the right indent of the selected paragraphs.

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

The right indent.
Implements

ChangeParagraphSpacingAfter(Double)

Changes the spacing after of the selected paragraphs.

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

The spacing after.
Implements

ChangeParagraphSpacingBefore(Double)

Changes the spacing before of the selected paragraphs.

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

The spacing before.
Implements

ChangeParagraphStyle(StyleDefinition)

Changes the paragraph style of the selected content.

Declaration
public void ChangeParagraphStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The style information.
Implements

ChangeParagraphTextAlignment(RadTextAlignment)

Changes the text alignment of the selected paragraphs.

Declaration
public void ChangeParagraphTextAlignment(RadTextAlignment alignment)
Parameters
RadTextAlignment alignment

The alignment.
Implements

ChangeRotateTextWithShape(ShapeInline, Boolean)

Changes a value that indicates whether shape's text box element will rotate when the shape is rotated.

Declaration
public void ChangeRotateTextWithShape(ShapeInline shape, bool shouldRotate)
Parameters
ShapeInline shape

The ShapeInline.
System.Boolean shouldRotate

The new value that indicates text box element rotation behavior.
Implements

ChangeSectionActualPageMargin(Padding)

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

Declaration
public void ChangeSectionActualPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The margin.
Implements

ChangeSectionColumns(SectionColumnCollection)

Changes the section columns for the selected sections.

Declaration
public void ChangeSectionColumns(SectionColumnCollection sectionColumns)
Parameters
SectionColumnCollection sectionColumns

The section columns.
Implements

ChangeSectionColumns(SectionColumnsLayout)

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

Declaration
public void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)
Parameters
SectionColumnsLayout sectionColumnsLayout

The section columns layout.
Implements

ChangeSectionEndnotesFirstNumber(Int32)

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

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

The first number.
Implements

ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)

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

Declaration
public void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)

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

Declaration
public void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeSectionFirstPageNumber(Nullable<Int32>)

Changes the first page number of the selected sections.

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

The first page number.
Implements

ChangeSectionFooter(Section, HeaderFooterType, Footer)

Changes the section footer.

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

The section.
HeaderFooterType footerType

Type of the footer.
Footer footer

The footer.
Implements

ChangeSectionFooterBottomMargin(Int32)

Changes the footer bottom margin of the selected sections.

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

The section footer bottom margin.
Implements

ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, Boolean)

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

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

The section.
HeaderFooterType footerType

Type of the footer.
System.Boolean value

true if the footer should be linked.
Implements

ChangeSectionFootnotesFirstNumber(Int32)

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

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

The first number.
Implements

ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)

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

Declaration
public void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)
Parameters
ListNumberingFormat numberingFormat

The numbering format.
Implements

ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)

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

Declaration
public void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)
Parameters
NumberingRestartType numberingRestartType

The type of restart for the numbering.
Implements

ChangeSectionHeader(Section, HeaderFooterType, Header)

Changes the section header.

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

The section.
HeaderFooterType headerType

Type of the header.
Header header

The header.
Implements

ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, Boolean)

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

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

The section.
HeaderFooterType headerType

Type of the header.
System.Boolean value

true if the header should be linked.
Implements

ChangeSectionHeaderTopMargin(Int32)

Changes the header top margin of the selected sections.

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

The section header top margin.
Implements

ChangeSectionLineNumbering(LineNumbering)

Changes the line numbering for a given collection of Section elements.

Declaration
public void ChangeSectionLineNumbering(LineNumbering lineNumbering)
Parameters
LineNumbering lineNumbering

The line numbering.
Implements

ChangeSectionPageMargin(Padding)

Changes the page margin of the selected sections.

Declaration
public void ChangeSectionPageMargin(Padding sectionMargin)
Parameters
Padding sectionMargin

The margin.
Implements

ChangeSectionPageOrientation(PageOrientation)

Changes the page orientation of the selected sections.

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

The page orientation.
Implements

ChangeSectionPageSize(Size)

Changes the page size of the selected sections.

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

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

ChangeShapeAutoFitToText(ShapeInline, Boolean)

Changes a value that indicates whether the parent shape should be horizontally resized in accordance to the text box element's width.

Declaration
public void ChangeShapeAutoFitToText(ShapeInline shape, bool shouldAutoFit)
Parameters
ShapeInline shape

The ShapeInline.
System.Boolean shouldAutoFit

The new value that indicates text box element wrap behavior.
Implements

ChangeShapeFill(ShapeInline, IShapeFill)

Changes the fill of a shape.

Declaration
public void ChangeShapeFill(ShapeInline shape, IShapeFill fill)
Parameters
ShapeInline shape

The ShapeInline.
IShapeFill fill

The new fill.
Implements

ChangeShapeOutlineDash(ShapeInline, LineDashType)

Changes the dashing pattern of a shape outline.

Declaration
public void ChangeShapeOutlineDash(ShapeInline shape, LineDashType dashType)
Parameters
ShapeInline shape

The ShapeInline.
LineDashType dashType

The new dashing pattern.
Implements

ChangeShapeOutlineFill(ShapeInline, IShapeOutlineFill)

Changes the fill of a shape outline.

Declaration
public void ChangeShapeOutlineFill(ShapeInline shape, IShapeOutlineFill lineFill)
Parameters
ShapeInline shape

The ShapeInline.
IShapeOutlineFill lineFill

The new fill.
Implements

ChangeShapeOutlineWidth(ShapeInline, Double)

Changes the width a shape outline.

Declaration
public void ChangeShapeOutlineWidth(ShapeInline shape, double width)
Parameters
ShapeInline shape

The ShapeInline.
System.Double width

The new width.
Implements

ChangeShapeRotateAngle(ShapeInline, Double)

Changes the rotate angle of a shape.

Declaration
public void ChangeShapeRotateAngle(ShapeInline shape, double angle)
Parameters
ShapeInline shape

The ShapeInline.
System.Double angle

The new angle.
Implements

ChangeShapeSize(ShapeInline, Size)

Changes the size of a shape.

Declaration
public void ChangeShapeSize(ShapeInline shape, Size size)
Parameters
ShapeInline shape

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

The new size.
Implements

ChangeShapeTextBottomMargin(ShapeInline, Double)

Changes the bottom margin (inset) of the shape's text box element.

Declaration
public void ChangeShapeTextBottomMargin(ShapeInline shape, double margin)
Parameters
ShapeInline shape

The ShapeInline.
System.Double margin

The new bottom margin.
Implements

ChangeShapeTextFill(ShapeInline, IShapeFill)

Changes the fill of a shape's text.

Declaration
public void ChangeShapeTextFill(ShapeInline shape, IShapeFill fill)
Parameters
ShapeInline shape

The ShapeInline.
IShapeFill fill

The new fill.
Implements

ChangeShapeTextLeftMargin(ShapeInline, Double)

Changes the left margin (inset) of the shape's text box element.

Declaration
public void ChangeShapeTextLeftMargin(ShapeInline shape, double margin)
Parameters
ShapeInline shape

The ShapeInline.
System.Double margin

The new left margin.
Implements

ChangeShapeTextOutlineDash(ShapeInline, LineDashType)

Changes the dash of a shape's text outline dash.

Declaration
public void ChangeShapeTextOutlineDash(ShapeInline shape, LineDashType dash)
Parameters
ShapeInline shape

The ShapeInline which is modified.
LineDashType dash

The new dashing pattern.
Implements

ChangeShapeTextOutlineFill(ShapeInline, IShapeOutlineFill)

Changes the fill of a shape's text outline.

Declaration
public void ChangeShapeTextOutlineFill(ShapeInline shape, IShapeOutlineFill fill)
Parameters
ShapeInline shape

The ShapeInline.
IShapeOutlineFill fill

The new fill.
Implements

ChangeShapeTextOutlineWidth(ShapeInline, Double)

Changes the width of a shape's outline width.

Declaration
public void ChangeShapeTextOutlineWidth(ShapeInline shape, double width)
Parameters
ShapeInline shape

The ShapeInline which is modified.
System.Double width

The new width value.
Implements

ChangeShapeTextRightMargin(ShapeInline, Double)

Changes the right margin (inset) of the shape's text box element.

Declaration
public void ChangeShapeTextRightMargin(ShapeInline shape, double margin)
Parameters
ShapeInline shape

The ShapeInline.
System.Double margin

The new right margin.
Implements

ChangeShapeTextRotation(ShapeInline, TextRotation)

Changes the rotation angle of the shape's text box element.

Declaration
public void ChangeShapeTextRotation(ShapeInline shape, TextRotation rotation)
Parameters
ShapeInline shape

The ShapeInline.
TextRotation rotation

The new rotation angle (in degrees).
Implements

ChangeShapeTextTopMargin(ShapeInline, Double)

Changes the top margin (inset) of the shape's text box element.

Declaration
public void ChangeShapeTextTopMargin(ShapeInline shape, double margin)
Parameters
ShapeInline shape

The ShapeInline.
System.Double margin

The new top margin.
Implements

ChangeShapeTextVerticalAlignment(ShapeInline, RadVerticalAlignment)

Changes the vertical alignment of a shape text box element.

Declaration
public void ChangeShapeTextVerticalAlignment(ShapeInline shape, RadVerticalAlignment alignment)
Parameters
ShapeInline shape

The ShapeInline.
RadVerticalAlignment alignment

The new vertical alignment.
Implements

ChangeShapeTextWrap(ShapeInline, Boolean)

Changes a value that indicates whether shape's text box element should wrap text vertically.

Declaration
public void ChangeShapeTextWrap(ShapeInline shape, bool shouldWrap)
Parameters
ShapeInline shape

The ShapeInline.
System.Boolean shouldWrap

The new value that indicates text box element wrap behavior.
Implements

ChangeSpanStyle(StyleDefinition)

Changes the span style of the selected content.

Declaration
public void ChangeSpanStyle(StyleDefinition styleInfo)
Parameters
StyleDefinition styleInfo

The style information.
Implements

ChangeStrikethrough(Boolean)

Changes the strike-through of the selected content.

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

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

ChangeStyleName(String)

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

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

Name of the style to be applied.
Implements

ChangeStyleName(String, Boolean)

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

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

Name of the style.
System.Boolean useLinkedStyle

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

ChangeTableBorders(TableBorders)

Changes the borders of the selected tables.

Declaration
public void ChangeTableBorders(TableBorders tableBorders)
Parameters
TableBorders tableBorders

The table borders.
Implements

ChangeTableCellBackground(Color)

Changes the background of the selected table cells.

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

The color.
Implements

ChangeTableCellBorders(Border)

Changes the borders of the selected table cells.

Declaration
public void ChangeTableCellBorders(Border border)
Parameters
Border border

A Border instance which will be applied on all borders of the cell.
Implements

ChangeTableCellBorders(TableCellBorders)

Changes the borders of the selected table cells.

Declaration
public void ChangeTableCellBorders(TableCellBorders tableCellBorders)
Parameters
TableCellBorders tableCellBorders

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

ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)

Changes the content alignment of the selected table cells.

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

The text alignment.
RadVerticalAlignment verticalAlignment

The vertical alignment.
Implements

ChangeTableCellHorizontalContentAlignment(RadTextAlignment)

Changes the horizontal content alignment of the selected table cells.

Declaration
public void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)
Parameters
RadTextAlignment textAlignment

The alignment.
Implements

ChangeTableCellPadding(Padding)

Changes the padding of the selected table cells.

Declaration
public void ChangeTableCellPadding(Padding padding)
Parameters
Padding padding

The padding.
Implements

ChangeTableCellSpacing(Double)

Changes the cell spacing of the selected tables.

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

The cell spacing.
Implements

ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)

Changes the vertical content alignment of the selected table cells.

Declaration
public void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)
Parameters
RadVerticalAlignment verticalAlignment

The alignment.
Implements

ChangeTableDefaultCellPadding(Padding)

Changes the default cell padding of the selected tables.

Declaration
public void ChangeTableDefaultCellPadding(Padding padding)
Parameters
Padding padding

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

ChangeTableFlowDirection(FlowDirection)

Changes the flow direction of the selected tables.

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

The flow direction.
Implements

ChangeTableGridColumnWidth(Table, Int32, TableWidthUnit)

Changes the width of a table column.

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

The table.
System.Int32 columnIndex

The index of the column.
TableWidthUnit width

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

ChangeTableHorizontalAlignment(RadHorizontalAlignment)

Changes the horizontal alignment of the selected tables.

Declaration
public void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)
Parameters
RadHorizontalAlignment alignment

The alignment.
Implements

ChangeTableIndent(Double)

Changes the indent of the selected tables.

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

The indent.
Implements

ChangeTableLayoutMode(Table, TableLayoutMode)

Changes the layout mode of the selected tables.

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

The table.
TableLayoutMode tableLayoutMode

The table layout mode.
Implements

ChangeTableLook(TableLook)

Changes the look of the selected tables.

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

Declaration
public void ChangeTableLook(TableLook tableLook)
Parameters
TableLook tableLook

The table look.
Implements

ChangeTablePreferredWidth(TableWidthUnit)

Changes the preferred width of the selected tables.

Declaration
public void ChangeTablePreferredWidth(TableWidthUnit tableWidth)
Parameters
TableWidthUnit tableWidth

Width of the table.
Implements

ChangeTableRowHeight(TableRow, Double)

Changes the height of a table row.

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

The table row.
System.Double height

The height.
Implements

ChangeTableRowRepeatOnEveryPage(TableRow)

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

Declaration
public void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)
Parameters
TableRow tableRow

The table row.
Implements

ChangeUnderlineColor(Color)

Changes the underline color of the selected content.

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

The color.
Implements

ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)

Changes the underline decoration of the selected content.

Declaration
public void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)
Parameters
IUnderlineUIDecorationProvider decoration

The value.
Implements

ClearAllFormatting()

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

Declaration
public void ClearAllFormatting()
Implements

ClearFormatting()

Clears the character formatting of the selected content.

Declaration
public void ClearFormatting()
Implements

ClearParagraphFormatting()

Clears the paragraph formatting of the selected content.

Declaration
public void ClearParagraphFormatting()

ClearTabStops()

Clears the tab stops inside the selected paragraphs.

Declaration
public void ClearTabStops()
Implements

ContinueListNumbering()

Removes all paragraphs from the current list and continues the first possible list before that paragraph. The paragraph must be in a list and should be first in the list, otherwise this method does nothing.

Declaration
public bool ContinueListNumbering()
Returns
System.Boolean

A boolean value indicating whether the operation completed successfully.
Implements

Copy()

Copies the currently selected document elements into the clipboard.

Declaration
public void Copy()
Implements

CopyFormatting()

Copies the formatting of the current selection.

Declaration
public bool CopyFormatting()
Returns
System.Boolean

A value indicating whether the copy was successful.
Implements

Cut()

Cuts the currently selected document elements into the clipboard.

Declaration
public void Cut()
Implements

DecreaseLeftIndent()

Decreases the left indent of the selected paragraphs. The default step used for indentation is 24.

Declaration
public void DecreaseLeftIndent()

DecrementFontSize()

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

Declaration
public void DecrementFontSize()
Implements

DecrementParagraphLeftIndent()

Decrements the left indent of the selected paragraphs. The default step used for indentation is 24.

Declaration
public void DecrementParagraphLeftIndent()
Implements

Delete(Boolean)

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

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

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

Implements

DeleteAllComments()

Deletes all comments in the document.

Declaration
public void DeleteAllComments()
Implements

DeleteAnnotationRange(AnnotationRangeStart)

Deletes an annotation range.

Declaration
public void DeleteAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The start of the range that will be deleted.
Implements

DeleteBookmark(String)

Deletes a bookmark.

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

Name of the bookmark.
Implements

DeleteBookmark(BookmarkRangeStart)

Deletes a bookmark.

Declaration
public void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)
Parameters
BookmarkRangeStart bookmarkRangeStart

The bookmark range start.
Implements

DeleteCodeBlock(CodeAnnotationRangeStart)

Deletes a code block.

Declaration
public void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)
Parameters
CodeAnnotationRangeStart rangeStart

The CodeAnnotationRangeStart of the block to delete.
Implements

DeleteComment()

Deletes the current comment.

Declaration
public void DeleteComment()
Implements

DeleteComment(CommentRangeStart)

Deletes a comment.

Declaration
public void DeleteComment(CommentRangeStart commentRangeStart)
Parameters
CommentRangeStart commentRangeStart

The comment range start.
Implements

DeleteHyperlink(HyperlinkRangeStart)

Deletes a hyperlink.

Declaration
public void DeleteHyperlink(HyperlinkRangeStart hyperlinkRangeStart)
Parameters
HyperlinkRangeStart hyperlinkRangeStart

The hyperlink range start.
Implements

DeletePermissionRange(PermissionRangeStart)

Deletes a permission range.

Declaration
public void DeletePermissionRange(PermissionRangeStart permissionRangeStart)
Parameters
PermissionRangeStart permissionRangeStart

The permission range start.
Implements

DeleteReadOnlyRange()

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

Declaration
public void DeleteReadOnlyRange()
Implements

DeleteReadOnlyRange(ReadOnlyRangeStart)

Deletes read only range.

Declaration
public void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)
Parameters
ReadOnlyRangeStart readOnlyRangeStart

The read only range that is to be deleted.
Implements

DeleteTable()

Deletes the table the current caret position is in.

Declaration
public void DeleteTable()
Implements

DeleteTable(Table)

Deletes a table.

Declaration
public void DeleteTable(Table table)
Parameters
Table table

The Table to delete.
Implements

DeleteTableColumn()

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

Declaration
public void DeleteTableColumn()
Implements

DeleteTableRow()

Deletes the table row under the caret position.

Declaration
public void DeleteTableRow()
Implements

DeleteTableRow(TableRow)

Deletes a table row.

Declaration
public void DeleteTableRow(TableRow row)
Parameters
TableRow row

The TableRow to delete.
Implements

EditShapeTextBox(ShapeInline)

Initiates editing of a shape's text box element.

Declaration
public void EditShapeTextBox(ShapeInline shape)
Parameters
ShapeInline shape

The ShapeInline.
Implements

EndUndoGroup()

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

Declaration
public void EndUndoGroup()
Implements

EndUndoGroup(String)

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

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

The display text which will be used for the undo group.
Implements

IncreaseLeftIndent()

Increases the left indent of the selected paragraphs. The default step used for indentation is 24.

Declaration
public void IncreaseLeftIndent()

IncrementFontSize()

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

Declaration
public void IncrementFontSize()
Implements

IncrementParagraphLeftIndent()

Increments the left indent of the selected paragraphs. The default step used for indentation is 24.

Declaration
public void IncrementParagraphLeftIndent()
Implements

IncrementParagraphListLevel(Int32)

Increments the paragraph list level of the selected paragraphs.

Declaration
public void IncrementParagraphListLevel(int value)
Parameters
System.Int32 value

A value determining how much the level should be increased.

Insert(String)

Inserts text into the document at the current caret position.

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

The text to insert.
Returns
System.Boolean

Implements

InsertAnnotationRange(AnnotationRangeStart, AnnotationRangeEnd)

Inserts an annotation range over the current selection. If the selection is empty, the annotation range is inserted at the caret position.

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

The annotation range start.
AnnotationRangeEnd rangeEnd

The annotation range end.
Implements

InsertBookmark(String)

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

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

Name of the bookmark.
Implements

InsertCaption(CaptionDefinition, String, Boolean, Boolean)

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

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

The definition of the caption.
System.String caption

The caption text to be used.
System.Boolean includeLabel

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

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

InsertCodeBlock(String, CodeFormattingSettings)

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

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

The code to insert.
CodeFormattingSettings settings

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

InsertColumnBreak()

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

Declaration
public void InsertColumnBreak()
Implements

InsertComment(Comment)

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

Declaration
public void InsertComment(Comment comment)
Parameters
Comment comment

The comment.
Implements

InsertCrossReferenceToBookmark(String, ReferenceContentType, Boolean)

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

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

Name of the bookmark.
ReferenceContentType contentType

Type of the content.
System.Boolean insertAsHyperlink

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

InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, Boolean)

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

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

The paragraph containing the caption sequence field.
ReferenceContentType contentType

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

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

InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, Boolean)

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

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

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

Type of the content.
System.Boolean insertAsHyperlink

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

InsertEndnote()

Inserts endnote at the current position.

Declaration
public void InsertEndnote()
Implements

InsertEndnote(Note)

Inserts the endnote at the current position.

Declaration
public void InsertEndnote(Note endnote)
Parameters
Note endnote

The endnote.
Implements

InsertField(Field)

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

Declaration
public bool InsertField(Field field)
Parameters
Field field

The field.
Returns
System.Boolean

True, if the operation completed successfully.
Implements

InsertField(Field, FieldDisplayMode)

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

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

The field.
FieldDisplayMode displayMode

The display mode.
Returns
System.Boolean

True, if the operation completed successfully.
Implements

InsertFootnote()

Inserts footnote at the current position.

Declaration
public void InsertFootnote()
Implements

InsertFootnote(Note)

Inserts the footnote at the current position.

Declaration
public void InsertFootnote(Note footnote)
Parameters
Note footnote

The footnote.
Implements

InsertFragment(DocumentFragment)

Inserts a fragment at the current caret position.

Declaration
public void InsertFragment(DocumentFragment documentFragment)
Parameters
DocumentFragment documentFragment

The fragment to insert.
Implements
Exceptions
System.ArgumentNullException

Thrown when documentFragment is null.

InsertFragment(DocumentFragment, DocumentPosition)

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

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

The fragment to insert.
DocumentPosition documentPosition

The document position to insert the fragment at.
Implements
Remarks

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

Exceptions
System.InvalidOperationException

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

Thrown when documentFragment or documentPosition is null.

InsertHyperlink(HyperlinkInfo)

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

Declaration
public void InsertHyperlink(HyperlinkInfo hyperlinkInfo)
Parameters
HyperlinkInfo hyperlinkInfo

The hyperlink info.
Implements

InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)

Inserts a hyperlink in the document.

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

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

The inlines in the hyperlink.
Implements

InsertHyperlink(HyperlinkInfo, String)

Inserts collection of inlines as hyperlink into the document.

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

The hyperlink info.
System.String hyperlinkText

The hyperlink text.

InsertImage(Stream, String)

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

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

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

The extension specifying the image format.
Implements

InsertInline(Inline)

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

Declaration
public void InsertInline(Inline inline)
Parameters
Inline inline

The inline element to insert.
Implements
Exceptions
System.ArgumentNullException

Thrown when inline is null.

InsertInline(Inline, DocumentPosition)

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

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

The inline element to insert.
DocumentPosition documentPosition

The document position to insert the inline at.
Implements
Remarks

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

Exceptions
System.InvalidOperationException

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

Thrown when inline or documentPosition is null.

InsertLine(String)

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

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

The text.
Implements

InsertLineBreak()

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

Declaration
public void InsertLineBreak()
Implements

InsertNonBreakingSpace()

Inserts a non-breaking space into the document at the current caret position.

Declaration
public void InsertNonBreakingSpace()

InsertPageBreak()

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

Declaration
public void InsertPageBreak()
Implements

InsertParagraph()

Inserts a new paragraph at the current caret position.

Declaration
public void InsertParagraph()
Implements

InsertPermissionRange(IEnumerable<PermissionRangeInfo>)

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

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

The permissions for the new range.
Implements

InsertReadOnlyRange()

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

Declaration
public void InsertReadOnlyRange()
Implements

InsertSectionBreak()

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

Declaration
public void InsertSectionBreak()
Implements

InsertSectionBreak(SectionBreakType)

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

Declaration
public void InsertSectionBreak(SectionBreakType sectionBreakType)
Parameters
SectionBreakType sectionBreakType

The type of the section break.
Implements

InsertShape(ShapeType, Size)

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

Declaration
public void InsertShape(ShapeType shapeType, Size size)
Parameters
ShapeType shapeType

The type of shape.
System.Windows.Size size

Shape's initial size.
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
SdtProperties insertProperties

InsertStructuredDocumentTag(SdtType)

Inserts a structured document tag (Content Control) of the given type.

Declaration
public void InsertStructuredDocumentTag(SdtType insertType)
Parameters
SdtType insertType

InsertTable(Int32, Int32)

Inserts a new table in the document.

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

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

Number of the columns in the table.
Implements

InsertTable(Int32, Int32, Boolean)

Inserts a new table in the document.

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

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

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

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

InsertTable(Table)

Inserts a table in the document.

Note: The Table instance inserted in the document is a cloning of the one passed for the table parameter. Making subsequent changes to the Table is not possible using the same object.

Declaration
public void InsertTable(Table table)
Parameters
Table table

The table.
Implements

InsertTable(Table, Boolean)

Inserts the table.

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

The table.
System.Boolean shouldInsertParagraphBeforeTable

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

The Table instance inserted in the document is a cloning of the one passed for the table parameter. Making subsequеnt changes to the Table is not possible.

InsertTableColumn()

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

Declaration
public void InsertTableColumn()
Implements

InsertTableColumnToTheLeft()

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

Declaration
public void InsertTableColumnToTheLeft()
Implements

InsertTableColumnToTheRight()

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

Declaration
public void InsertTableColumnToTheRight()
Implements

InsertTableRow()

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

Declaration
public void InsertTableRow()
Implements

InsertTableRowAbove()

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

Declaration
public void InsertTableRowAbove()
Implements

InsertTableRowBelow()

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

Declaration
public void InsertTableRowBelow()
Implements

InsertTextBox()

Inserts a placeholder text box element to the document. It comes with a default shape layout.

Declaration
public void InsertTextBox()
Implements

MailMerge(Boolean)

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

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

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

The document containing the result of the operation.
Implements

MailMergeCurrentRecord()

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

Declaration
public RadDocument MailMergeCurrentRecord()
Returns
RadDocument

The document.
Implements

MergeTableCells()

Merges the currently selected table cells into one.

Declaration
public void MergeTableCells()
Implements

MoveSelection(DocumentPosition, Boolean)

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

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

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

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

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.

Declaration
public void Paste(PasteOption pasteOption)
Parameters
PasteOption pasteOption

The paste option that will be used.
Implements

PasteFormatting()

Pastes the currently copied formatting on the current selection.

Declaration
public bool PasteFormatting()
Returns
System.Boolean

A value indicating whether the paste was successful.
Implements

PreviewFirstMailMergeDataRecord()

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

Declaration
public bool PreviewFirstMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

PreviewLastMailMergeDataRecord()

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

Declaration
public bool PreviewLastMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

PreviewMailMergeDataRecordAtIndex(Int32)

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

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

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

True, if the operation completed successfully.
Implements

PreviewNextMailMergeDataRecord()

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

Declaration
public bool PreviewNextMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

PreviewPreviousMailMergeDataRecord()

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

Declaration
public bool PreviewPreviousMailMergeDataRecord()
Returns
System.Boolean

True, if the operation completed successfully.
Implements

Redo()

Re-executes the last undone command group.

Declaration
public void Redo()
Implements

RejectAllRevisions()

Rejects all revisions in the document.

Declaration
public void RejectAllRevisions()
Implements

RejectRevision(Revision)

Rejects a revision.

Declaration
public void RejectRevision(Revision revision)
Parameters
Revision revision

The revision.
Implements

RemoveTabStop(TabStop)

Removes a tab stop from the selected paragraphs.

Declaration
public void RemoveTabStop(TabStop tabStop)
Parameters
TabStop tabStop

The tab stop.
Implements

RemoveTabStopRange(IEnumerable<TabStop>)

Removes a collection of tab stops in the selected paragraphs.

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

The tab stops.
Implements

ReplaceTabStop(TabStop, TabStop)

Replaces a tab stop inside the selected paragraphs.

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

The old tab stop.
TabStop newTabStop

The new tab stop.
Implements

ResizeTableColumn(Table, Int32, Double)

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

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

The table.
System.Int32 columnIndex

The index of the column.
System.Double columnWidth

The new value for the column width.
Implements

RestartListNumbering()

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

Declaration
public bool RestartListNumbering()
Returns
System.Boolean

A boolean value determining whether the operation completed successfully.
Implements

SetListNumbering(Int32)

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

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

The numbers to skip.
Returns
System.Boolean

A boolean value indicating whether the operation completed successfully.
Implements

SetWatermark(DocumentWatermarkSettings)

Sets a watermark to the selected sections.

Declaration
public void SetWatermark(DocumentWatermarkSettings watermarkSettings)
Parameters
DocumentWatermarkSettings watermarkSettings

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

SetWatermark(PredefinedWatermarkType)

Sets a predefined watermark to the selected sections.

Declaration
public void SetWatermark(PredefinedWatermarkType predefinedType)
Parameters
PredefinedWatermarkType predefinedType

Type of the predefined watermark.
Implements

SplitAnnotationRange(AnnotationRangeStart)

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

Declaration
public void SplitAnnotationRange(AnnotationRangeStart rangeStart)
Parameters
AnnotationRangeStart rangeStart

The annotation range start to be split.
Implements

SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)

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

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

The annotation range start to be split.
DocumentPosition position

The position where the range start should be split.
Implements

SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph>)

Suppress the line numbering for selected paragraphs.

Declaration
public void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)
Parameters
System.Collections.Generic.IEnumerable<Paragraph> paragraphs

The paragraphs.
Implements

ToggleBold()

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

Declaration
public void ToggleBold()
Implements

ToggleFieldCodes(FieldRangeStart)

Toggles the display mode of a field.

Declaration
public void ToggleFieldCodes(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.
Implements

ToggleItalic()

Toggles the font style of the selected content between System.Windows.FontStyles.Italic and System.Windows.FontStyles.Normal.

Declaration
public void ToggleItalic()
Implements

ToggleStrikethrough()

Toggles the strike-through of the selected content.

Declaration
public void ToggleStrikethrough()
Implements

Undo()

Reverts the last executed command group.

Declaration
public void Undo()
Implements

UnmergeTableCells()

Splits the currently selected table cell.

Declaration
public void UnmergeTableCells()
Implements

UpdateAllCaptions(CaptionDefinition)

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

Declaration
public void UpdateAllCaptions(CaptionDefinition captionDefinition)
Parameters
CaptionDefinition captionDefinition

The caption definition.
Implements

UpdateAllFields()

Updates all fields in the document.

Declaration
public void UpdateAllFields()
Implements

UpdateAllFields(FieldDisplayMode)

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

Declaration
public void UpdateAllFields(FieldDisplayMode displayMode)
Parameters
FieldDisplayMode displayMode

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

UpdateField(FieldRangeStart)

Updates a field.

Declaration
public void UpdateField(FieldRangeStart fieldStart)
Parameters
FieldRangeStart fieldStart

The field start.
Implements

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

Updates the permissions inside the current selection.

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

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

Permissions to remove.
Implements

Extension Methods