InterfaceIDocumentEditor
Defines members for a non-visual editor for RadDocument, which supports history and preserves the validity of the underlying document model.
Definition
Namespace:Telerik.Windows.Documents.Model
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public interface IDocumentEditorProperties
Document
Gets the current document.
Methods
AcceptAllRevisions()
Accepts all revisions in the document.
Declaration
void AcceptAllRevisions()AcceptRevision(Revision)
Accepts a revision.
Declaration
void AcceptRevision(Revision revision)Parameters
revision
The revision.
AddShapeTextBox(ShapeInline)
Initializes a text box element for a shape that does not have any.
Declaration
void AddShapeTextBox(ShapeInline shape)Parameters
shape
The ShapeInline.
AddTabStop(TabStop)
Adds a tab stop to the current paragraph.
Declaration
void AddTabStop(TabStop tabStop)Parameters
tabStop
The tab stop.
AddTabStopRange(IEnumerable<TabStop>)
Adds a tab stop range to the current paragraph.
Declaration
void AddTabStopRange(IEnumerable<TabStop> tabStops)Parameters
tabStops
The tab stop collection.
BeginUndoGroup()
Begins a new group of actions which will appear as a single item in the document history.
Declaration
void BeginUndoGroup()CancelUndoGroup()
Cancels the currently started undo-able group, started with BeginUndoGroup() and undoes the actions executed since the starting of the group.
Declaration
void CancelUndoGroup()ChangeAllFieldsDisplayMode(FieldDisplayMode)
Changes the display mode of all fields in the document.
Declaration
void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)Parameters
displayMode
The display mode which will be used for the fields.
ChangeBaselineAlignment(BaselineAlignment)
Changes the baseline alignment of the selected content.
Declaration
void ChangeBaselineAlignment(BaselineAlignment baselineAlignment)Parameters
baselineAlignment
The baseline alignment to be applied.
ChangeBibliographicStyle(BibliographicReferenceStyleBase)
Changes the bibliographic style of all bibliography related fields in the document.
Declaration
void ChangeBibliographicStyle(BibliographicReferenceStyleBase style)Parameters
style
BibliographicReferenceStyleBase
The new bibliographic style.
ChangeDifferentFirstPageHeaderFooter(bool)
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
void ChangeDifferentFirstPageHeaderFooter(bool value)Parameters
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.
ChangeDifferentOddAndEvenPagesHeaderFooter(bool)
Changes the value determining whether the sections should have different odd and even pages header/footer.
Declaration
void ChangeDifferentOddAndEvenPagesHeaderFooter(bool value)Parameters
value
true, if the even and odd page header/footer should differ.
ChangeDocumentDefaultTabWidth(double)
Changes default tab stop width for the document.
Declaration
void ChangeDocumentDefaultTabWidth(double tabWidth)Parameters
tabWidth
Width of the tab.
ChangeDocumentElementTag(DocumentElement, string)
Changes the Tag property of a specified DocumentElement.
Declaration
void ChangeDocumentElementTag(DocumentElement element, string tag)Parameters
element
The DocumentElement.
tag
The new tag value.
ChangeDocumentEndnotesFirstNumber(int)
Changes the first number of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesFirstNumber(int firstNumber)Parameters
firstNumber
The first number.
ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
numberingFormat
The numbering format.
ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The type of restart for the numbering.
ChangeDocumentEndnotesPosition(EndnotesPosition)
Changes the position of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)Parameters
endnotesPosition
The position.
ChangeDocumentFootnotesFirstNumber(int)
Changes the first number of the footnotes in the document.
Declaration
void ChangeDocumentFootnotesFirstNumber(int firstNumber)Parameters
firstNumber
The first number.
ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the footnotes in the document.
Declaration
void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
numberingFormat
The numbering format.
ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the document.
Declaration
void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The type of restart for the numbering.
ChangeDocumentFootnotesPosition(FootnotesPosition)
Changes the position of the footnotes in the document.
Declaration
void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)Parameters
footnotesPosition
The footnotes position.
ChangeDocumentIsStrictLineBreakingRuleEnabled(bool)
Sets a value determining whether the strict line breaking rule will be applied to Japanese text in this document.
Declaration
void ChangeDocumentIsStrictLineBreakingRuleEnabled(bool value)Parameters
value
if set to true, the strict line breaking rule will be applied.
ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)
Sets the language whose rules should be used for line breaking in the paragraphs.
Declaration
void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)Parameters
lineBreakingRuleLanguage
The line breaking rule language.
ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule)
Sets a rule determining which characters cannot end a line in East-Asian languages.
Declaration
void ChangeDocumentNoLineBreaksAfterRule(LineBreakingRule lineBreakingCharacterRule)Parameters
lineBreakingCharacterRule
The line breaking character rule.
ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule)
Sets a rule determining which characters cannot start a line in East-Asian languages.
Declaration
void ChangeDocumentNoLineBreaksBeforeRule(LineBreakingRule lineBreakingCharacterRule)Parameters
lineBreakingCharacterRule
The rule.
ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)
Changes the display mode of a field.
Declaration
void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)Parameters
fieldStart
The field start.
displayMode
The new display mode.
ChangeFontFamily(FontFamily)
Changes the font family of the selected content.
Declaration
void ChangeFontFamily(FontFamily fontFamily)Parameters
fontFamily
FontFamily
The font family to be applied.
ChangeFontSize(double)
Changes the size of the font of the selected content.
Declaration
void ChangeFontSize(double fontSize)Parameters
fontSize
Size of the font.
ChangeFontStyle(FontStyle)
Changes the font style of the selected content.
Declaration
void ChangeFontStyle(FontStyle fontStyle)Parameters
fontStyle
FontStyle
The font style.
ChangeFontWeight(FontWeight)
Changes the font weight of the selected content. If selection is not present, the current editing style is updated.
Declaration
void ChangeFontWeight(FontWeight fontWeight)Parameters
fontWeight
FontWeight
The font weight.
ChangeForeColor(Color)
Changes the fore color of the selected content.
Declaration
void ChangeForeColor(Color color)Parameters
color
Color
The color.
ChangeHighlightColor(Color)
Changes the highlight color of the selected content.
Declaration
void ChangeHighlightColor(Color color)Parameters
color
Color
The color.
ChangeImageRotateAngle(ImageInline, double)
Changes the rotate angle of an image.
Declaration
void ChangeImageRotateAngle(ImageInline image, double angle)Parameters
image
The ImageInline.
angle
The new angle.
ChangeImageSize(ImageInline, Size)
Changes the size of an image.
Declaration
void ChangeImageSize(ImageInline image, Size size)Parameters
image
The ImageInline which is modified.
size
Size
The new size.
ChangeLineNumberingRestartType(LineNumberingRestartType)
Changes the restart type of line numberings for the selected sections.
Declaration
void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)Parameters
restartType
The line numbering restart type.
ChangeParagraphAutomaticSpacingAfter(bool)
Changes the automatic spacing after of the selected paragraphs.
Declaration
void ChangeParagraphAutomaticSpacingAfter(bool value)Parameters
value
If set to true, the automatic spacing after will be enabled.
ChangeParagraphAutomaticSpacingBefore(bool)
Changes the automatic spacing before of the selected paragraphs.
Declaration
void ChangeParagraphAutomaticSpacingBefore(bool value)Parameters
value
If set to true, the automatic spacing before will be enabled.
ChangeParagraphBackground(Color)
Changes the background of the selected paragraphs.
Declaration
void ChangeParagraphBackground(Color color)Parameters
color
Color
The color.
ChangeParagraphFirstLineIndent(double)
Changes the first line indent of the selected paragraphs.
Declaration
void ChangeParagraphFirstLineIndent(double firstLineIndent)Parameters
firstLineIndent
The first line indent.
ChangeParagraphFlowDirection(FlowDirection)
Changes the flow direction of the selected paragraphs.
Declaration
void ChangeParagraphFlowDirection(FlowDirection flowDirection)Parameters
flowDirection
FlowDirection
The flow direction.
ChangeParagraphIsLineBreakingRuleEnabled(bool)
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
void ChangeParagraphIsLineBreakingRuleEnabled(bool value)Parameters
value
If set to true, East Asian typography rules will be applied to determine which characters may begin and end each line.
ChangeParagraphLeftIndent(double)
Changes the left indent of the selected paragraphs.
Declaration
void ChangeParagraphLeftIndent(double leftIndent)Parameters
leftIndent
The left indent.
ChangeParagraphLineSpacing(double)
Changes the line spacing of the selected paragraphs.
Declaration
void ChangeParagraphLineSpacing(double lineSpacing)Parameters
lineSpacing
The line spacing.
ChangeParagraphLineSpacing(double, LineSpacingType)
Changes the line spacing of the selected paragraphs.
Declaration
void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)Parameters
lineSpacing
The line spacing.
lineSpacingType
Type of the line spacing.
ChangeParagraphLineSpacingType(LineSpacingType)
Changes the type of the line spacing of the selected paragraphs.
Declaration
void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)Parameters
lineSpacingType
Type of the line spacing.
ChangeParagraphListLevel(int)
Changes the list level of the selected paragraphs.
Declaration
void ChangeParagraphListLevel(int listLevel)Parameters
listLevel
The list level.
ChangeParagraphListStyle(ListStyle)
Changes the paragraph list style of the selected paragraphs.
Declaration
void ChangeParagraphListStyle(ListStyle style)Parameters
style
The style.
ChangeParagraphRightIndent(double)
Changes the right indent of the selected paragraphs.
Declaration
void ChangeParagraphRightIndent(double rightIndent)Parameters
rightIndent
The right indent.
ChangeParagraphSpacingAfter(double)
Changes the spacing after of the selected paragraphs.
Declaration
void ChangeParagraphSpacingAfter(double spacingAfter)Parameters
spacingAfter
The spacing after.
ChangeParagraphSpacingBefore(double)
Changes the spacing before of the selected paragraphs.
Declaration
void ChangeParagraphSpacingBefore(double spacingBefore)Parameters
spacingBefore
The spacing before.
ChangeParagraphStyle(StyleDefinition)
Changes the paragraph style of the selected content.
Declaration
void ChangeParagraphStyle(StyleDefinition styleInfo)Parameters
styleInfo
The style information.
ChangeParagraphTextAlignment(RadTextAlignment)
Changes the text alignment of the selected paragraphs.
Declaration
void ChangeParagraphTextAlignment(RadTextAlignment alignment)Parameters
alignment
The alignment.
ChangeRotateTextWithShape(ShapeInline, bool)
Changes a value that indicates whether shape's text box element will rotate when the shape is rotated.
Declaration
void ChangeRotateTextWithShape(ShapeInline shape, bool shouldRotate)Parameters
shape
The ShapeInline.
shouldRotate
The new value that indicates text box element rotation behavior.
ChangeSectionActualPageMargin(Padding)
Changes the page margin of the selected sections respecting their current orientation.
Declaration
void ChangeSectionActualPageMargin(Padding sectionMargin)Parameters
sectionMargin
The margin.
ChangeSectionColumns(SectionColumnCollection)
Changes the section columns for the selected sections.
Declaration
void ChangeSectionColumns(SectionColumnCollection sectionColumns)Parameters
sectionColumns
The section columns.
ChangeSectionColumns(SectionColumnsLayout)
Changes the section columns for a given collection of Section elements.
Declaration
void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)Parameters
sectionColumnsLayout
The section columns layout.
ChangeSectionEndnotesFirstNumber(int)
Changes the first number of the endnotes in the selected sections.
Declaration
void ChangeSectionEndnotesFirstNumber(int firstNumber)Parameters
firstNumber
The first number.
ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the endnotes in the selected sections.
Declaration
void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
numberingFormat
The numbering format.
ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the selected sections.
Declaration
void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The type of restart for the numbering.
ChangeSectionFirstPageNumber(int?)
Changes the first page number of the selected sections.
Declaration
void ChangeSectionFirstPageNumber(int? firstPageNumber)Parameters
firstPageNumber
int?
The first page number.
ChangeSectionFooter(Section, HeaderFooterType, Footer)
Changes the section footer.
Declaration
void ChangeSectionFooter(Section section, HeaderFooterType footerType, Footer footer)Parameters
section
The section.
footerType
Type of the footer.
footer
The footer.
ChangeSectionFooterBottomMargin(int)
Changes the footer bottom margin of the selected sections.
Declaration
void ChangeSectionFooterBottomMargin(int sectionFooterBottomMargin)Parameters
sectionFooterBottomMargin
The section footer bottom margin.
ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, bool)
Changes the value indicating whether the section footer should be linked to the footer of the previous section.
Declaration
void ChangeSectionFooterLinkToPrevious(Section section, HeaderFooterType footerType, bool value)Parameters
section
The section.
footerType
Type of the footer.
value
true if the footer should be linked.
ChangeSectionFootnotesFirstNumber(int)
Changes the first number of the footnotes in the selected sections.
Declaration
void ChangeSectionFootnotesFirstNumber(int firstNumber)Parameters
firstNumber
The first number.
ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the footnotes in the selected sections.
Declaration
void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
numberingFormat
The numbering format.
ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the footnotes in the selected sections.
Declaration
void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
numberingRestartType
The type of restart for the numbering.
ChangeSectionHeader(Section, HeaderFooterType, Header)
Changes the section header.
Declaration
void ChangeSectionHeader(Section section, HeaderFooterType headerType, Header header)Parameters
section
The section.
headerType
Type of the header.
header
The header.
ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, bool)
Changes the value indicating whether the section header should be linked to the header of the previous section.
Declaration
void ChangeSectionHeaderLinkToPrevious(Section section, HeaderFooterType headerType, bool value)Parameters
section
The section.
headerType
Type of the header.
value
true if the header should be linked.
ChangeSectionHeaderTopMargin(int)
Changes the header top margin of the selected sections.
Declaration
void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)Parameters
sectionHeaderTopMargin
The section header top margin.
ChangeSectionLineNumbering(LineNumbering)
Changes the line numbering for the selected sections.
Declaration
void ChangeSectionLineNumbering(LineNumbering lineNumbering)Parameters
lineNumbering
The line numbering.
ChangeSectionPageMargin(Padding)
Changes the page margin of the selected sections.
Declaration
void ChangeSectionPageMargin(Padding sectionMargin)Parameters
sectionMargin
The margin.
ChangeSectionPageOrientation(PageOrientation)
Changes the page orientation of the selected sections.
Declaration
void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)Parameters
sectionPageOrientation
PageOrientation
The page orientation.
ChangeSectionPageSize(Size)
Changes the page size of the selected sections.
Declaration
void ChangeSectionPageSize(Size newSize)Parameters
newSize
Size
The new size. You can use the PaperTypes enumeration to get the desired size from the predefined values.
ChangeShapeAutoFitToText(ShapeInline, bool)
Changes a value that indicates whether the parent shape should be horizontally resized in accordance to the text box element's width.
Declaration
void ChangeShapeAutoFitToText(ShapeInline shape, bool shouldAutoFit)Parameters
shape
The ShapeInline.
shouldAutoFit
The new value that indicates text box element wrap behavior.
ChangeShapeFill(ShapeInline, IShapeFill)
Changes the fill of a shape.
Declaration
void ChangeShapeFill(ShapeInline shape, IShapeFill fill)Parameters
shape
The ShapeInline.
fill
The new fill.
ChangeShapeOutlineDash(ShapeInline, LineDashType)
Changes the width of a shape outline.
Declaration
void ChangeShapeOutlineDash(ShapeInline shape, LineDashType dash)Parameters
shape
The ShapeInline which is modified.
dash
The new dashing pattern.
ChangeShapeOutlineFill(ShapeInline, IShapeOutlineFill)
Changes the fill of a shape outline.
Declaration
void ChangeShapeOutlineFill(ShapeInline shape, IShapeOutlineFill fill)Parameters
shape
The ShapeInline.
fill
The new fill.
ChangeShapeOutlineWidth(ShapeInline, double)
Changes the width of a shape outline.
Declaration
void ChangeShapeOutlineWidth(ShapeInline shape, double width)Parameters
shape
The ShapeInline which is modified.
width
The new width value.
ChangeShapeRotateAngle(ShapeInline, double)
Changes the rotate angle of a shape.
Declaration
void ChangeShapeRotateAngle(ShapeInline shape, double angle)Parameters
shape
The ShapeInline.
angle
The new angle.
ChangeShapeSize(ShapeInline, Size)
Changes the size of a shape.
Declaration
void ChangeShapeSize(ShapeInline shape, Size size)Parameters
shape
The ShapeInline whose size should be changed.
size
Size
The new size.
ChangeShapeTextBottomMargin(ShapeInline, double)
Changes the bottom margin (inset) of the shape's text box element.
Declaration
void ChangeShapeTextBottomMargin(ShapeInline shape, double margin)Parameters
shape
The ShapeInline.
margin
The new bottom margin.
ChangeShapeTextFill(ShapeInline, IShapeFill)
Changes the fill of a shape's text.
Declaration
void ChangeShapeTextFill(ShapeInline shape, IShapeFill fill)Parameters
shape
The ShapeInline.
fill
The new fill.
ChangeShapeTextLeftMargin(ShapeInline, double)
Changes the left margin (inset) of the shape's text box element.
Declaration
void ChangeShapeTextLeftMargin(ShapeInline shape, double margin)Parameters
shape
The ShapeInline.
margin
The new left margin.
ChangeShapeTextOutlineDash(ShapeInline, LineDashType)
Changes the dash of a shape's text outline dash.
Declaration
void ChangeShapeTextOutlineDash(ShapeInline shape, LineDashType dash)Parameters
shape
The ShapeInline which is modified.
dash
The new dashing pattern.
ChangeShapeTextOutlineFill(ShapeInline, IShapeOutlineFill)
Changes the fill of a shape's text outline.
Declaration
void ChangeShapeTextOutlineFill(ShapeInline shape, IShapeOutlineFill fill)Parameters
shape
The ShapeInline.
fill
The new fill.
ChangeShapeTextOutlineWidth(ShapeInline, double)
Changes the width of a shape's outline width.
Declaration
void ChangeShapeTextOutlineWidth(ShapeInline shape, double width)Parameters
shape
The ShapeInline which is modified.
width
The new width value.
ChangeShapeTextRightMargin(ShapeInline, double)
Changes the right margin (inset) of the shape's text box element.
Declaration
void ChangeShapeTextRightMargin(ShapeInline shape, double margin)Parameters
shape
The ShapeInline.
margin
The new right margin.
ChangeShapeTextRotation(ShapeInline, TextRotation)
Changes the rotation angle of the shape's text box element.
Declaration
void ChangeShapeTextRotation(ShapeInline shape, TextRotation rotation)Parameters
shape
The ShapeInline.
rotation
The new rotation angle (in degrees).
ChangeShapeTextTopMargin(ShapeInline, double)
Changes the top margin (inset) of the shape's text box element.
Declaration
void ChangeShapeTextTopMargin(ShapeInline shape, double margin)Parameters
shape
The ShapeInline.
margin
The new top margin.
ChangeShapeTextVerticalAlignment(ShapeInline, RadVerticalAlignment)
Changes the vertical alignment of the shape's text box element.
Declaration
void ChangeShapeTextVerticalAlignment(ShapeInline shape, RadVerticalAlignment alignment)Parameters
shape
The ShapeInline.
alignment
The new vertical alignment.
ChangeShapeTextWrap(ShapeInline, bool)
Changes a value that indicates whether shape's text box element should wrap text vertically.
Declaration
void ChangeShapeTextWrap(ShapeInline shape, bool shouldWrap)Parameters
shape
The ShapeInline.
shouldWrap
The new value that indicates text box element wrap behavior.
ChangeSpanStyle(StyleDefinition)
Changes the span style of the selected content.
Declaration
void ChangeSpanStyle(StyleDefinition styleInfo)Parameters
styleInfo
The style information.
ChangeStrikethrough(bool)
Changes the strike-through of the selected content.
Declaration
void ChangeStrikethrough(bool isStrikethrough)Parameters
isStrikethrough
If set to true, a strike-through will be applied to the selected content.
ChangeStyleName(string)
Applies style with a given name to the selected elements in the document.
Declaration
void ChangeStyleName(string styleName)Parameters
styleName
Name of the style to be applied.
ChangeStyleName(string, bool)
Applies style with a given name to the selected elements in the document.
ChangeTableBorders(TableBorders)
Changes the borders of the selected tables.
Declaration
void ChangeTableBorders(TableBorders tableBorders)Parameters
tableBorders
The table borders.
ChangeTableCellBackground(Color)
Changes the background of the selected table cells.
Declaration
void ChangeTableCellBackground(Color color)Parameters
color
Color
The color.
ChangeTableCellBorders(Border)
Changes the borders of the selected table cells.
ChangeTableCellBorders(TableCellBorders)
Changes the borders of the selected table cells.
Declaration
void ChangeTableCellBorders(TableCellBorders tableCellBorders)Parameters
tableCellBorders
The border which will be used for all table cell borders.
ChangeTableCellContentAlignment(RadTextAlignment, RadVerticalAlignment)
Changes the content alignment of the selected table cells.
Declaration
void ChangeTableCellContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)Parameters
textAlignment
The text alignment.
verticalAlignment
The vertical alignment.
ChangeTableCellHorizontalContentAlignment(RadTextAlignment)
Changes the horizontal content alignment of the selected table cells.
Declaration
void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)Parameters
textAlignment
The alignment.
ChangeTableCellPadding(Padding)
Changes the padding of the selected table cells.
Declaration
void ChangeTableCellPadding(Padding padding)Parameters
padding
The padding.
ChangeTableCellSpacing(double)
Changes the cell spacing of the selected tables.
Declaration
void ChangeTableCellSpacing(double cellSpacing)Parameters
cellSpacing
The cell spacing.
ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)
Changes the vertical content alignment of the selected table cells.
Declaration
void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)Parameters
verticalAlignment
The alignment.
ChangeTableDefaultCellPadding(Padding)
Changes the default cell padding of the selected tables.
Declaration
void ChangeTableDefaultCellPadding(Padding padding)Parameters
padding
The padding which will be used as a default value.
ChangeTableFlowDirection(FlowDirection)
Changes the flow direction of the selected tables.
Declaration
void ChangeTableFlowDirection(FlowDirection flowDirection)Parameters
flowDirection
FlowDirection
The flow direction.
ChangeTableGridColumnWidth(Table, int, TableWidthUnit)
Changes the width of a table column.
Declaration
void ChangeTableGridColumnWidth(Table table, int columnIndex, TableWidthUnit width)Parameters
table
The table.
columnIndex
The index of the column.
width
The new value for the column width.
ChangeTableHorizontalAlignment(RadHorizontalAlignment)
Changes the horizontal alignment of the selected tables.
Declaration
void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)Parameters
alignment
The alignment.
ChangeTableIndent(double)
Changes the indent of the selected tables.
Declaration
void ChangeTableIndent(double indent)Parameters
indent
The indent.
ChangeTableLayoutMode(Table, TableLayoutMode)
Changes the layout mode of the selected tables.
Declaration
void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)Parameters
table
The table.
tableLayoutMode
The table layout mode.
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
void ChangeTableLook(TableLook tableLook)Parameters
tableLook
The table look.
ChangeTablePreferredWidth(TableWidthUnit)
Changes the preferred width of the selected tables.
Declaration
void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Parameters
tableWidth
Width of the table.
ChangeTableRowHeight(TableRow, double)
Changes the height of a table row.
ChangeTableRowRepeatOnEveryPage(TableRow)
Depending on the current value, enables or disables the repetition of a table row on every page.
Declaration
void ChangeTableRowRepeatOnEveryPage(TableRow tableRow)Parameters
tableRow
The table row.
ChangeUnderlineColor(Color)
Changes the underline color of the selected content.
Declaration
void ChangeUnderlineColor(Color color)Parameters
color
Color
The color.
ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)
Changes the underline decoration of the selected content.
Declaration
void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)Parameters
decoration
IUnderlineUIDecorationProvider
The value.
ClearAllFormatting()
Clears all the formatting (character and paragraph) from the selected content.
Declaration
void ClearAllFormatting()ClearFormatting()
Clears the character formatting of the selected content.
Declaration
void ClearFormatting()ClearTabStops()
Clears the tab stops inside the selected paragraphs.
Declaration
void ClearTabStops()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
bool ContinueListNumbering()Returns
A boolean value indicating whether the operation completed successfully.
Copy()
Copies the currently selected document elements into the clipboard.
Declaration
void Copy()CopyFormatting()
Copies the formatting of the current selection.
Declaration
bool CopyFormatting()Returns
A value indicating whether the copy was successful.
Cut()
Cuts the currently selected document elements into the clipboard.
Declaration
void Cut()DecrementFontSize()
Decrements the size of the font of the selected content with 2 points.
Declaration
void DecrementFontSize()DecrementParagraphLeftIndent()
Decrements the left indent of the selected paragraphs.
Declaration
void DecrementParagraphLeftIndent()Delete(bool)
Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the CaretPosition.
DeleteAllComments()
Deletes all comments in the document.
Declaration
void DeleteAllComments()DeleteAnnotationRange(AnnotationRangeStart)
Deletes an annotation range.
Declaration
void DeleteAnnotationRange(AnnotationRangeStart rangeStart)Parameters
rangeStart
The start of the range that will be deleted.
DeleteBookmark(BookmarkRangeStart)
Deletes a bookmark.
Declaration
void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)Parameters
bookmarkRangeStart
The bookmark range start.
DeleteBookmark(string)
Deletes a bookmark.
Declaration
void DeleteBookmark(string bookmarkName)Parameters
bookmarkName
Name of the bookmark.
DeleteCodeBlock(CodeAnnotationRangeStart)
Deletes a code block.
Declaration
void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)Parameters
rangeStart
The CodeAnnotationRangeStart of the block to delete.
DeleteComment(CommentRangeStart)
Deletes a comment.
Declaration
void DeleteComment(CommentRangeStart commentRangeStart)Parameters
commentRangeStart
The comment range start.
DeleteHyperlink(HyperlinkRangeStart)
Deletes a hyperlink.
Declaration
void DeleteHyperlink(HyperlinkRangeStart hyperlinkRangeStart)Parameters
hyperlinkRangeStart
The hyperlink range start.
DeletePermissionRange(PermissionRangeStart)
Deletes a permission range.
Declaration
void DeletePermissionRange(PermissionRangeStart rangeStart)Parameters
rangeStart
The permission range start.
DeleteReadOnlyRange()
Deletes the read only range at the current caret position or inside the current selection.
Declaration
void DeleteReadOnlyRange()DeleteReadOnlyRange(ReadOnlyRangeStart)
Deletes read only range.
Declaration
void DeleteReadOnlyRange(ReadOnlyRangeStart readOnlyRangeStart)Parameters
readOnlyRangeStart
The read only range that is to be deleted.
DeleteTable()
Deletes the table the current caret position is in.
Declaration
void DeleteTable()DeleteTable(Table)
Deletes a table.
DeleteTableColumn()
Deletes the current table column which is under the caret position.
Declaration
void DeleteTableColumn()DeleteTableRow()
Deletes the table row under the caret position.
Declaration
void DeleteTableRow()DeleteTableRow(TableRow)
Deletes a table row.
EditShapeTextBox(ShapeInline)
Initiates editing of a shape's text box element.
Declaration
void EditShapeTextBox(ShapeInline shape)Parameters
shape
The ShapeInline.
EndUndoGroup()
Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
Declaration
void EndUndoGroup()EndUndoGroup(string)
Closes currently started undo-able group, started with BeginUndoGroup(), and adds an action in the document history.
Declaration
void EndUndoGroup(string groupDisplayText)Parameters
groupDisplayText
The display text which will be used for the undo group.
HasEditPermissions()
Return value that indicates if one can edit the document in the current position.
Declaration
bool HasEditPermissions()Returns
Return value that indicates if one can edit the document in the current position.
IncrementFontSize()
Increments the size of the font of the selected content with 2 points.
Declaration
void IncrementFontSize()IncrementParagraphLeftIndent()
Increments the left indent of the selected paragraphs.
Declaration
void IncrementParagraphLeftIndent()Insert(string)
Inserts text into the document at the current caret position.
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
void InsertAnnotationRange(AnnotationRangeStart rangeStart, AnnotationRangeEnd rangeEnd)Parameters
rangeStart
The annotation range start.
rangeEnd
The annotation range end.
InsertBookmark(string)
Inserts a bookmark around the current selection. If the selection is empty, the bookmark is inserted at the caret position.
Declaration
void InsertBookmark(string bookmarkName)Parameters
bookmarkName
Name of the bookmark.
InsertCaption(CaptionDefinition, string, bool, bool)
Inserts a caption around the current selection. If the selection is empty, the caption is inserted at the current caret position.
Declaration
void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)Parameters
definition
The definition of the caption.
caption
The caption text to be used.
includeLabel
If set to true, the label is included in the caption.
insertBelow
If set to true, the caption is inserted after the current selection.
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
void InsertCodeBlock(string code, CodeFormattingSettings settings)Parameters
code
The code to insert.
settings
The settings which will be used for the code block.
InsertColumnBreak()
Inserts a column break into the document at the current caret position.
Declaration
void InsertColumnBreak()InsertComment(Comment)
Inserts a comment around the current selection. If the selection is empty, the comment is inserted at the caret position.
Declaration
void InsertComment(Comment comment)Parameters
comment
The comment.
InsertCrossReferenceToBookmark(string, ReferenceContentType, bool)
Inserts a cross-reference to a bookmark into the document at the current caret position.
Declaration
void InsertCrossReferenceToBookmark(string bookmarkName, ReferenceContentType contentType, bool insertAsHyperlink)Parameters
bookmarkName
Name of the bookmark.
contentType
Type of the content.
insertAsHyperlink
If set to true, the cross-reference is inserted as a hyperlink.
InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, bool)
Inserts a cross-reference to a caption into the document at the current caret position.
Declaration
void InsertCrossReferenceToCaption(Paragraph captionParagraph, ReferenceContentType contentType, bool insertAsHyperlink)Parameters
captionParagraph
The paragraph containing the caption sequence field.
contentType
The reference content type. If the paragraph doesn't have applied a Caption style, the method will not be executed.
insertAsHyperlink
A parameter indicating whether the cross-reference field should be a hyperlink.
InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, bool)
Inserts a cross-reference to a paragraph with Heading style into the document at the current caret position.
Declaration
void InsertCrossReferenceToHeading(Paragraph headingParagraph, ReferenceContentType contentType, bool insertAsHyperlink)Parameters
headingParagraph
The paragraph. If the paragraph doesn't have applied a Heading style, the method will not be executed.
contentType
Type of the content.
insertAsHyperlink
If set to true, the cross-reference is inserted as a hyperlink.
InsertEndnote()
Inserts endnote at the current position.
Declaration
void InsertEndnote()InsertEndnote(Note)
Inserts the endnote at the current position.
InsertField(Field)
Inserts a field into the document at the current caret position.
InsertField(Field, FieldDisplayMode)
Inserts a field into the document at the current caret position in a specified display mode.
Declaration
bool InsertField(Field field, FieldDisplayMode displayMode)Parameters
field
The field.
displayMode
The display mode.
Returns
True, if the operation completed successfully.
InsertFootnote()
Inserts footnote at the current position.
Declaration
void InsertFootnote()InsertFootnote(Note)
Inserts the footnote at the current position.
Declaration
void InsertFootnote(Note footnote)Parameters
footnote
The footnote.
InsertFragment(DocumentFragment)
Inserts a fragment at the current caret position.
Declaration
void InsertFragment(DocumentFragment documentFragment)Parameters
documentFragment
The fragment to insert.
InsertFragment(DocumentFragment, DocumentPosition)
Inserts a fragment at a specified position. Document selection should be cleared in advance.
Declaration
void InsertFragment(DocumentFragment documentFragment, DocumentPosition documentPosition)Parameters
documentFragment
The fragment to insert.
documentPosition
The document position to insert the fragment at.
InsertHyperlink(HyperlinkInfo)
Inserts a hyperlink in the document.
Declaration
void InsertHyperlink(HyperlinkInfo hyperlinkInfo)Parameters
hyperlinkInfo
The hyperlink info.
InsertHyperlink(HyperlinkInfo, IEnumerable<Inline>)
Inserts collection of inlines as hyperlink into the document.
Declaration
void InsertHyperlink(HyperlinkInfo hyperlinkInfo, IEnumerable<Inline> inlines)Parameters
hyperlinkInfo
The hyperlink info.
inlines
The inlines in the hyperlink.
InsertImage(Stream, string)
Inserts an inline image into the document at the current caret position.
InsertInline(Inline)
Inserts inline element into the document at the current caret position.
Declaration
void InsertInline(Inline inline)Parameters
inline
The inline element to insert.
InsertInline(Inline, DocumentPosition)
Inserts inline element into the document at a specified caret position. Document selection should be cleared in advance.
Declaration
void InsertInline(Inline inline, DocumentPosition documentPosition)Parameters
inline
The inline element to insert.
documentPosition
The document position to insert the inline at.
InsertLine(string)
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.
Declaration
void InsertLineBreak()InsertPageBreak()
Inserts a page break into the document at the current caret position.
Declaration
void InsertPageBreak()InsertParagraph()
Inserts a new paragraph at the current caret position.
Declaration
void InsertParagraph()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
void InsertPermissionRange(IEnumerable<PermissionRangeInfo> permissionInfos)Parameters
permissionInfos
IEnumerable<PermissionRangeInfo>
The permissions for the new range.
InsertReadOnlyRange()
Inserts a read only range over the current selection. If the selection is empty, the range is inserted at the caret position.
Declaration
void InsertReadOnlyRange()InsertSectionBreak()
Inserts a section break into the document at the current caret position.
Declaration
void InsertSectionBreak()InsertSectionBreak(SectionBreakType)
Inserts a section break of the specified type into the document at the current caret position.
Declaration
void InsertSectionBreak(SectionBreakType type)Parameters
type
The type of the section break.
InsertShape(ShapeType, Size)
Inserts an inline shape into the document at the current caret position.
Declaration
void InsertShape(ShapeType shapeType, Size size)Parameters
shapeType
The type of shape.
size
Size
Shape's initial size.
InsertTable(Table)
Inserts a table in the document.
InsertTable(int, int)
Inserts a new table in the document.
InsertTableColumn()
Inserts a table column in the table which is under the caret position.
Declaration
void InsertTableColumn()InsertTableColumnToTheLeft()
Inserts a table column to the left in the table which is under the caret position.
Declaration
void InsertTableColumnToTheLeft()InsertTableColumnToTheRight()
Inserts a table column to the right in the table which is under the caret position.
Declaration
void InsertTableColumnToTheRight()InsertTableRow()
Inserts a new table row in the table under the caret position.
Declaration
void InsertTableRow()InsertTableRowAbove()
Inserts a table row above the one under the caret position.
Declaration
void InsertTableRowAbove()InsertTableRowBelow()
Inserts a table row below the one under the caret position.
Declaration
void InsertTableRowBelow()InsertTextBox()
Inserts a placeholder text box element to the document. It comes with a default shape layout.
Declaration
void InsertTextBox()MailMerge(bool)
Produces a mail merged document containing the results for all data records.
Declaration
RadDocument MailMerge(bool startEachRecordOnNewPage)Parameters
startEachRecordOnNewPage
true, if each record should start on a new page.
Returns
The document containing the result of the operation.
MailMergeCurrentRecord()
Creates a new RadDocument containing the result of merging the template with the values of the current data record.
Declaration
RadDocument MailMergeCurrentRecord()Returns
The document.
MergeTableCells()
Merges the currently selected table cells into one.
Declaration
void MergeTableCells()MoveSelection(DocumentPosition, bool)
Moves the current selection along with the selected document elements to a specified position.
Declaration
void MoveSelection(DocumentPosition position, bool deleteSelection)Parameters
position
The start position where the selection should be moved to.
deleteSelection
true, if the current selection and contained elements should be deleted on the original position.
Paste()
Pastes the content of the clipboard into the document.
Declaration
void Paste()Paste(PasteOption)
Pastes the content of the clipboard into the document.
Declaration
void Paste(PasteOption pasteOptions)Parameters
pasteOptions
PasteFormatting()
Pastes the currently copied formatting on the current selection.
Declaration
bool PasteFormatting()Returns
A value indicating whether the paste was successful.
PreviewFirstMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the first data record.
Declaration
bool PreviewFirstMailMergeDataRecord()Returns
True, if the operation completed successfully.
PreviewLastMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the last data record.
Declaration
bool PreviewLastMailMergeDataRecord()Returns
True, if the operation completed successfully.
PreviewMailMergeDataRecordAtIndex(int)
Updates all fields in the document with the values evaluated using a specified data record.
PreviewNextMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the next data record.
Declaration
bool PreviewNextMailMergeDataRecord()Returns
True, if the operation completed successfully.
PreviewPreviousMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the previous data record.
Declaration
bool PreviewPreviousMailMergeDataRecord()Returns
True, if the operation completed successfully.
RejectAllRevisions()
Rejects all revisions in the document.
Declaration
void RejectAllRevisions()RejectRevision(Revision)
Rejects a revision.
Declaration
void RejectRevision(Revision revision)Parameters
revision
The revision.
RemoveTabStop(TabStop)
Removes a tab stop from the selected paragraphs.
Declaration
void RemoveTabStop(TabStop tabStop)Parameters
tabStop
The tab stop.
RemoveTabStopRange(IEnumerable<TabStop>)
Removes a collection of tab stops in the selected paragraphs.
Declaration
void RemoveTabStopRange(IEnumerable<TabStop> tabStops)Parameters
tabStops
The tab stops.
ReplaceTabStop(TabStop, TabStop)
Replaces a tab stop inside the selected paragraphs.
ResizeTableColumn(Table, int, double)
Changes the width of a table column. You could specify different width type through the ChangeTableGridColumnWidth(Table, int, TableWidthUnit) method.
RestartListNumbering()
Creates a new list from the current paragraph. The paragraph must be in a list, otherwise this method does nothing.
Declaration
bool RestartListNumbering()Returns
A boolean value determining whether the operation completed successfully.
SetListNumbering(int)
Skips numbers and starts the counting of the current list from the specified value.
SetWatermark(DocumentWatermarkSettings)
Sets a watermark to the selected sections.
Declaration
void SetWatermark(DocumentWatermarkSettings watermarkSettings)Parameters
watermarkSettings
The watermark settings describing the watermark that will be applied.
SetWatermark(PredefinedWatermarkType)
Sets a predefined watermark to the selected sections.
Declaration
void SetWatermark(PredefinedWatermarkType predefinedType)Parameters
predefinedType
Type of the predefined watermark.
SplitAnnotationRange(AnnotationRangeStart)
Splits an annotation range at the caret position, resulting in two new ranges.
Declaration
void SplitAnnotationRange(AnnotationRangeStart rangeStart)Parameters
rangeStart
The annotation range start to be split.
SplitAnnotationRange(AnnotationRangeStart, DocumentPosition)
Splits an annotation range at the specified position, resulting in two new ranges.
Declaration
void SplitAnnotationRange(AnnotationRangeStart rangeStart, DocumentPosition position)Parameters
rangeStart
The annotation range start to be split.
position
The position where the range start should be split.
SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph>)
Suppress the line numbering for selected paragraphs.
Declaration
void SuppressLineNumberingForCurrentParagraph(IEnumerable<Paragraph> paragraphs)Parameters
paragraphs
The paragraphs.
ToggleBold()
Toggles the font weight of the selected content.
Declaration
void ToggleBold()ToggleFieldCodes(FieldRangeStart)
Toggles the display mode of a field.
Declaration
void ToggleFieldCodes(FieldRangeStart fieldStart)Parameters
fieldStart
The field start.
ToggleItalic()
Toggles the font style of the selected content between and .
Declaration
void ToggleItalic()ToggleStrikethrough()
Toggles the strike-through of the selected content.
Declaration
void ToggleStrikethrough()UnmergeTableCells()
Splits the currently selected table cell.
Declaration
void UnmergeTableCells()UpdateAllCaptions(CaptionDefinition)
Updates all captions in the document related to a caption definition.
Declaration
void UpdateAllCaptions(CaptionDefinition captionDefinition)Parameters
captionDefinition
The caption definition.
UpdateAllFields()
Updates all fields in the document.
Declaration
void UpdateAllFields()UpdateAllFields(FieldDisplayMode)
Updates all fields in the document and displays them in the specified display mode.
Declaration
void UpdateAllFields(FieldDisplayMode displayMode)Parameters
displayMode
The display mode which will be used for the fields.
UpdateField(FieldRangeStart)
Updates a field.
Declaration
void UpdateField(FieldRangeStart fieldStart)Parameters
fieldStart
The field start.
UpdatePermissionRanges(IEnumerable<PermissionRangeInfo>, IEnumerable<PermissionRangeInfo>)
Updates the permissions inside the current selection.
Declaration
void UpdatePermissionRanges(IEnumerable<PermissionRangeInfo> permissionsToAdd, IEnumerable<PermissionRangeInfo> permissionsToRemove)Parameters
permissionsToAdd
IEnumerable<PermissionRangeInfo>
Permissions to add.
permissionsToRemove
IEnumerable<PermissionRangeInfo>
Permissions to remove.