Interface IDocumentEditor
Defines members for a non-visual editor for Rad
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Controls.RichTextBox.dll
Syntax
public interface IDocumentEditorProperties
Document
Methods
AcceptAllRevisions()
Accepts all revisions in the document.
Declaration
void AcceptAllRevisions()AcceptRevision(Revision)
Accepts a revision.
Declaration
void AcceptRevision(Revision revision)Parameters
|
Revision
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 Shape |
AddTabStop(TabStop)
Adds a tab stop to the current paragraph.
Declaration
void AddTabStop(TabStop tabStop)Parameters
|
Tab The tab stop. |
AddTabStopRange(IEnumerable<TabStop>)
Adds a tab stop range to the current paragraph.
Declaration
void AddTabStopRange(IEnumerable<TabStop> tabStops)Parameters
|
System. 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 Begin
Declaration
void CancelUndoGroup()ChangeAllFieldsDisplayMode(FieldDisplayMode)
Changes the display mode of all fields in the document.
Declaration
void ChangeAllFieldsDisplayMode(FieldDisplayMode displayMode)Parameters
|
Field 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
|
Baseline 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
|
Bibliographic The new bibliographic style. |
ChangeDifferentFirstPageHeaderFooter(Boolean)
ChangeDifferentOddAndEvenPagesHeaderFooter(Boolean)
ChangeDocumentDefaultTabWidth(Double)
Changes default tab stop width for the document.
Declaration
void ChangeDocumentDefaultTabWidth(double tabWidth)Parameters
|
System. Width of the tab. |
ChangeDocumentElementTag(DocumentElement, String)
Changes the Tag property of a specified DocumentElement.
Declaration
void ChangeDocumentElementTag(DocumentElement element, string tag)Parameters
|
Document The Document |
|
System. The new tag value. |
ChangeDocumentEndnotesFirstNumber(Int32)
Changes the first number of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesFirstNumber(int firstNumber)Parameters
|
System. The first number. |
ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
|
List The numbering format. |
ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The type of restart for the numbering. |
ChangeDocumentEndnotesPosition(EndnotesPosition)
Changes the position of the endnotes in the document.
Declaration
void ChangeDocumentEndnotesPosition(EndnotesPosition endnotesPosition)Parameters
|
Endnotes The position. |
ChangeDocumentFootnotesFirstNumber(Int32)
Changes the first number of the footnotes in the document.
Declaration
void ChangeDocumentFootnotesFirstNumber(int firstNumber)Parameters
|
System. The first number. |
ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the footnotes in the document.
Declaration
void ChangeDocumentFootnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
|
List The numbering format. |
ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the document.
Declaration
void ChangeDocumentFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The type of restart for the numbering. |
ChangeDocumentFootnotesPosition(FootnotesPosition)
Changes the position of the footnotes in the document.
Declaration
void ChangeDocumentFootnotesPosition(FootnotesPosition footnotesPosition)Parameters
|
Footnotes The footnotes position. |
ChangeDocumentIsStrictLineBreakingRuleEnabled(Boolean)
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
|
System. if set to |
ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage)
Sets the language whose rules should be used for line breaking in the paragraphs.
Declaration
void ChangeDocumentLineBreakingRuleLanguage(LineBreakingRuleLanguage lineBreakingRuleLanguage)Parameters
|
Line 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
|
Line 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
|
Line The rule. |
ChangeFieldDisplayMode(FieldRangeStart, FieldDisplayMode)
Changes the display mode of a field.
Declaration
void ChangeFieldDisplayMode(FieldRangeStart fieldStart, FieldDisplayMode displayMode)Parameters
|
Field The field start. |
|
Field The new display mode. |
ChangeFontFamily(FontFamily)
Changes the font family of the selected content.
Declaration
void ChangeFontFamily(FontFamily fontFamily)Parameters
|
System. The font family to be applied. |
ChangeFontSize(Double)
Changes the size of the font of the selected content.
Declaration
void ChangeFontSize(double fontSize)Parameters
|
System. Size of the font. |
ChangeFontStyle(FontStyle)
Changes the font style of the selected content.
Declaration
void ChangeFontStyle(FontStyle fontStyle)Parameters
|
System. 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
|
System. The font weight. |
ChangeForeColor(Color)
Changes the fore color of the selected content.
Declaration
void ChangeForeColor(Color color)Parameters
|
System. The color. |
ChangeHighlightColor(Color)
Changes the highlight color of the selected content.
Declaration
void ChangeHighlightColor(Color color)Parameters
|
System. The color. |
ChangeImageRotateAngle(ImageInline, Double)
Changes the rotate angle of an image.
Declaration
void ChangeImageRotateAngle(ImageInline image, double angle)Parameters
|
Image The Image |
|
System. The new angle. |
ChangeImageSize(ImageInline, Size)
Changes the size of an image.
Declaration
void ChangeImageSize(ImageInline image, Size size)Parameters
|
Image The Image |
|
System. The new size. |
ChangeLineNumberingRestartType(LineNumberingRestartType)
Changes the restart type of line numberings for the selected sections.
Declaration
void ChangeLineNumberingRestartType(LineNumberingRestartType restartType)Parameters
|
Line The line numbering restart type. |
ChangeParagraphAutomaticSpacingAfter(Boolean)
Changes the automatic spacing after of the selected paragraphs.
Declaration
void ChangeParagraphAutomaticSpacingAfter(bool value)Parameters
|
System. If set to |
ChangeParagraphAutomaticSpacingBefore(Boolean)
Changes the automatic spacing before of the selected paragraphs.
Declaration
void ChangeParagraphAutomaticSpacingBefore(bool value)Parameters
|
System. If set to |
ChangeParagraphBackground(Color)
Changes the background of the selected paragraphs.
Declaration
void ChangeParagraphBackground(Color color)Parameters
|
System. The color. |
ChangeParagraphFirstLineIndent(Double)
Changes the first line indent of the selected paragraphs.
Declaration
void ChangeParagraphFirstLineIndent(double firstLineIndent)Parameters
|
System. The first line indent. |
ChangeParagraphFlowDirection(FlowDirection)
Changes the flow direction of the selected paragraphs.
Declaration
void ChangeParagraphFlowDirection(FlowDirection flowDirection)Parameters
|
System. The flow direction. |
ChangeParagraphIsLineBreakingRuleEnabled(Boolean)
Changes the Is
Declaration
void ChangeParagraphIsLineBreakingRuleEnabled(bool value)Parameters
|
System. If set to |
ChangeParagraphLeftIndent(Double)
Changes the left indent of the selected paragraphs.
Declaration
void ChangeParagraphLeftIndent(double leftIndent)Parameters
|
System. The left indent. |
ChangeParagraphLineSpacing(Double)
Changes the line spacing of the selected paragraphs.
Declaration
void ChangeParagraphLineSpacing(double lineSpacing)Parameters
|
System. The line spacing. |
ChangeParagraphLineSpacing(Double, LineSpacingType)
Changes the line spacing of the selected paragraphs.
Declaration
void ChangeParagraphLineSpacing(double lineSpacing, LineSpacingType lineSpacingType)Parameters
|
System. The line spacing. |
|
Line Type of the line spacing. |
ChangeParagraphLineSpacingType(LineSpacingType)
Changes the type of the line spacing of the selected paragraphs.
Declaration
void ChangeParagraphLineSpacingType(LineSpacingType lineSpacingType)Parameters
|
Line Type of the line spacing. |
ChangeParagraphListLevel(Int32)
Changes the list level of the selected paragraphs.
Declaration
void ChangeParagraphListLevel(int listLevel)Parameters
|
System. The list level. |
ChangeParagraphListStyle(ListStyle)
Changes the paragraph list style of the selected paragraphs.
Declaration
void ChangeParagraphListStyle(ListStyle style)Parameters
|
List The style. |
ChangeParagraphRightIndent(Double)
Changes the right indent of the selected paragraphs.
Declaration
void ChangeParagraphRightIndent(double rightIndent)Parameters
|
System. The right indent. |
ChangeParagraphSpacingAfter(Double)
Changes the spacing after of the selected paragraphs.
Declaration
void ChangeParagraphSpacingAfter(double spacingAfter)Parameters
|
System. The spacing after. |
ChangeParagraphSpacingBefore(Double)
Changes the spacing before of the selected paragraphs.
Declaration
void ChangeParagraphSpacingBefore(double spacingBefore)Parameters
|
System. The spacing before. |
ChangeParagraphStyle(StyleDefinition)
Changes the paragraph style of the selected content.
Declaration
void ChangeParagraphStyle(StyleDefinition styleInfo)Parameters
|
Style The style information. |
ChangeParagraphTextAlignment(RadTextAlignment)
Changes the text alignment of the selected paragraphs.
Declaration
void ChangeParagraphTextAlignment(RadTextAlignment alignment)Parameters
|
Rad The alignment. |
ChangeRotateTextWithShape(ShapeInline, Boolean)
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 Shape |
|
System. 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
|
Padding
sectionMargin
The margin. |
ChangeSectionColumns(SectionColumnCollection)
Changes the section columns for the selected sections.
Declaration
void ChangeSectionColumns(SectionColumnCollection sectionColumns)Parameters
|
Section The section columns. |
ChangeSectionColumns(SectionColumnsLayout)
Changes the section columns for a given collection of Section elements.
Declaration
void ChangeSectionColumns(SectionColumnsLayout sectionColumnsLayout)Parameters
|
Section The section columns layout. |
ChangeSectionEndnotesFirstNumber(Int32)
Changes the first number of the endnotes in the selected sections.
Declaration
void ChangeSectionEndnotesFirstNumber(int firstNumber)Parameters
|
System. The first number. |
ChangeSectionEndnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the endnotes in the selected sections.
Declaration
void ChangeSectionEndnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
|
List The numbering format. |
ChangeSectionEndnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the endnotes in the selected sections.
Declaration
void ChangeSectionEndnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The type of restart for the numbering. |
ChangeSectionFirstPageNumber(Nullable<Int32>)
Changes the first page number of the selected sections.
Declaration
void ChangeSectionFirstPageNumber(Nullable<int> firstPageNumber)Parameters
|
System. The first page number. |
ChangeSectionFooter(Section, HeaderFooterType, Footer)
ChangeSectionFooterBottomMargin(Int32)
ChangeSectionFooterLinkToPrevious(Section, HeaderFooterType, Boolean)
ChangeSectionFootnotesFirstNumber(Int32)
Changes the first number of the footnotes in the selected sections.
Declaration
void ChangeSectionFootnotesFirstNumber(int firstNumber)Parameters
|
System. The first number. |
ChangeSectionFootnotesNumberingFormat(ListNumberingFormat)
Changes the numbering format of the footnotes in the selected sections.
Declaration
void ChangeSectionFootnotesNumberingFormat(ListNumberingFormat numberingFormat)Parameters
|
List The numbering format. |
ChangeSectionFootnotesNumberingRestartType(NumberingRestartType)
Changes the type of numbering restart of the footnotes in the selected sections.
Declaration
void ChangeSectionFootnotesNumberingRestartType(NumberingRestartType numberingRestartType)Parameters
|
Numbering The type of restart for the numbering. |
ChangeSectionHeader(Section, HeaderFooterType, Header)
ChangeSectionHeaderLinkToPrevious(Section, HeaderFooterType, Boolean)
ChangeSectionHeaderTopMargin(Int32)
Changes the header top margin of the selected sections.
Declaration
void ChangeSectionHeaderTopMargin(int sectionHeaderTopMargin)Parameters
|
System. The section header top margin. |
ChangeSectionLineNumbering(LineNumbering)
Changes the line numbering for the selected sections.
Declaration
void ChangeSectionLineNumbering(LineNumbering lineNumbering)Parameters
|
Line The line numbering. |
ChangeSectionPageMargin(Padding)
Changes the page margin of the selected sections.
Declaration
void ChangeSectionPageMargin(Padding sectionMargin)Parameters
|
Padding
sectionMargin
The margin. |
ChangeSectionPageOrientation(PageOrientation)
Changes the page orientation of the selected sections.
Declaration
void ChangeSectionPageOrientation(PageOrientation sectionPageOrientation)Parameters
|
Telerik. The page orientation. |
ChangeSectionPageSize(Size)
Changes the page size of the selected sections.
Declaration
void ChangeSectionPageSize(Size newSize)Parameters
|
System. The new size. You can use the Telerik. |
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
void ChangeShapeAutoFitToText(ShapeInline shape, bool shouldAutoFit)Parameters
|
Shape The Shape |
|
System. 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 Shape |
|
IShape The new fill. |
ChangeShapeOutlineDash(ShapeInline, LineDashType)
Changes the width of a shape outline.
Declaration
void ChangeShapeOutlineDash(ShapeInline shape, LineDashType dash)Parameters
|
Shape The Shape |
|
Line The new dashing pattern. |
ChangeShapeOutlineFill(ShapeInline, IShapeOutlineFill)
Changes the fill of a shape outline.
Declaration
void ChangeShapeOutlineFill(ShapeInline shape, IShapeOutlineFill fill)Parameters
|
Shape The Shape |
|
IShape The new fill. |
ChangeShapeOutlineWidth(ShapeInline, Double)
Changes the width of a shape outline.
Declaration
void ChangeShapeOutlineWidth(ShapeInline shape, double width)Parameters
|
Shape The Shape |
|
System. The new width value. |
ChangeShapeRotateAngle(ShapeInline, Double)
Changes the rotate angle of a shape.
Declaration
void ChangeShapeRotateAngle(ShapeInline shape, double angle)Parameters
|
Shape The Shape |
|
System. The new angle. |
ChangeShapeSize(ShapeInline, Size)
Changes the size of a shape.
Declaration
void ChangeShapeSize(ShapeInline shape, Size size)Parameters
|
Shape The Shape |
|
System. 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 Shape |
|
System. 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 Shape |
|
IShape 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 Shape |
|
System. 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 Shape |
|
Line 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 Shape |
|
IShape 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 Shape |
|
System. 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 Shape |
|
System. 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 Shape |
|
Text 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 Shape |
|
System. 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 Shape |
|
Rad The new vertical alignment. |
ChangeShapeTextWrap(ShapeInline, Boolean)
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 Shape |
|
System. 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
|
Style The style information. |
ChangeStrikethrough(Boolean)
Changes the strike-through of the selected content.
Declaration
void ChangeStrikethrough(bool isStrikethrough)Parameters
|
System. If set to |
ChangeStyleName(String)
Applies style with a given name to the selected elements in the document.
Declaration
void ChangeStyleName(string styleName)Parameters
|
System. Name of the style to be applied. |
ChangeStyleName(String, Boolean)
Applies style with a given name to the selected elements in the document.
Declaration
void ChangeStyleName(string styleName, bool useLinkedStyle)Parameters
|
System. Name of the style. |
|
System. If true, the linked style may be used depending on the selection. |
ChangeTableBorders(TableBorders)
Changes the borders of the selected tables.
Declaration
void ChangeTableBorders(TableBorders tableBorders)Parameters
|
Table The table borders. |
ChangeTableCellBackground(Color)
Changes the background of the selected table cells.
Declaration
void ChangeTableCellBackground(Color color)Parameters
|
System. The color. |
ChangeTableCellBorders(Border)
Changes the borders of the selected table cells.
Declaration
void ChangeTableCellBorders(Border border)Parameters
ChangeTableCellBorders(TableCellBorders)
Changes the borders of the selected table cells.
Declaration
void ChangeTableCellBorders(TableCellBorders tableCellBorders)Parameters
|
Table 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
|
Rad The text alignment. |
|
Rad The vertical alignment. |
ChangeTableCellHorizontalContentAlignment(RadTextAlignment)
Changes the horizontal content alignment of the selected table cells.
Declaration
void ChangeTableCellHorizontalContentAlignment(RadTextAlignment textAlignment)Parameters
|
Rad The alignment. |
ChangeTableCellPadding(Padding)
Changes the padding of the selected table cells.
Declaration
void ChangeTableCellPadding(Padding padding)Parameters
|
Padding
padding
The padding. |
ChangeTableCellSpacing(Double)
Changes the cell spacing of the selected tables.
Declaration
void ChangeTableCellSpacing(double cellSpacing)Parameters
|
System. The cell spacing. |
ChangeTableCellVerticalContentAlignment(RadVerticalAlignment)
Changes the vertical content alignment of the selected table cells.
Declaration
void ChangeTableCellVerticalContentAlignment(RadVerticalAlignment verticalAlignment)Parameters
|
Rad The alignment. |
ChangeTableDefaultCellPadding(Padding)
Changes the default cell padding of the selected tables.
Declaration
void ChangeTableDefaultCellPadding(Padding padding)Parameters
|
Padding
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
|
System. The flow direction. |
ChangeTableGridColumnWidth(Table, Int32, TableWidthUnit)
Changes the width of a table column.
Declaration
void ChangeTableGridColumnWidth(Table table, int columnIndex, TableWidthUnit width)Parameters
|
Table
table
The table. |
|
System. The index of the column. |
|
Table The new value for the column width. |
ChangeTableHorizontalAlignment(RadHorizontalAlignment)
Changes the horizontal alignment of the selected tables.
Declaration
void ChangeTableHorizontalAlignment(RadHorizontalAlignment alignment)Parameters
|
Rad The alignment. |
ChangeTableIndent(Double)
Changes the indent of the selected tables.
Declaration
void ChangeTableIndent(double indent)Parameters
|
System. The indent. |
ChangeTableLayoutMode(Table, TableLayoutMode)
Changes the layout mode of the selected tables.
Declaration
void ChangeTableLayoutMode(Table table, TableLayoutMode tableLayoutMode)Parameters
|
Table
table
The table. |
|
Table 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
|
Table The table look. |
ChangeTablePreferredWidth(TableWidthUnit)
Changes the preferred width of the selected tables.
Declaration
void ChangeTablePreferredWidth(TableWidthUnit tableWidth)Parameters
|
Table Width of the table. |
ChangeTableRowHeight(TableRow, Double)
Changes the height of a table row.
Declaration
void ChangeTableRowHeight(TableRow tableRow, double rowHeight)Parameters
|
Table The table row. |
|
System. The height. |
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
|
Table The table row. |
ChangeUnderlineColor(Color)
Changes the underline color of the selected content.
Declaration
void ChangeUnderlineColor(Color color)Parameters
|
System. The color. |
ChangeUnderlineDecoration(IUnderlineUIDecorationProvider)
Changes the underline decoration of the selected content.
Declaration
void ChangeUnderlineDecoration(IUnderlineUIDecorationProvider decoration)Parameters
|
IUnderline 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
|
System. 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
|
System. 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(Boolean)
Deletes content from the document. If the Selection is not empty, deletes the selected content. Otherwise, deletes the character next to the Caret
Declaration
bool Delete(bool deletePrevious)Parameters
|
System. If the selection is empty, indicates whether to delete the character before or after the caret. |
Returns
|
System.
|
DeleteAllComments()
Deletes all comments in the document.
Declaration
void DeleteAllComments()DeleteAnnotationRange(AnnotationRangeStart)
Deletes an annotation range.
Declaration
void DeleteAnnotationRange(AnnotationRangeStart rangeStart)Parameters
|
Annotation The start of the range that will be deleted. |
DeleteBookmark(String)
Deletes a bookmark.
Declaration
void DeleteBookmark(string bookmarkName)Parameters
|
System. Name of the bookmark. |
DeleteBookmark(BookmarkRangeStart)
Deletes a bookmark.
Declaration
void DeleteBookmark(BookmarkRangeStart bookmarkRangeStart)Parameters
|
Bookmark The bookmark range start. |
DeleteCodeBlock(CodeAnnotationRangeStart)
Deletes a code block.
Declaration
void DeleteCodeBlock(CodeAnnotationRangeStart rangeStart)Parameters
|
Code The Code |
DeleteComment()
Deletes the current comment.
Declaration
void DeleteComment()DeleteComment(CommentRangeStart)
Deletes a comment.
Declaration
void DeleteComment(CommentRangeStart commentRangeStart)Parameters
|
Comment The comment range start. |
DeleteHyperlink()
Deletes the current hyperlink.
Declaration
void DeleteHyperlink()DeleteHyperlink(HyperlinkRangeStart)
Deletes a hyperlink.
Declaration
void DeleteHyperlink(HyperlinkRangeStart hyperlinkRangeStart)Parameters
|
Hyperlink The hyperlink range start. |
DeletePermissionRange(PermissionRangeStart)
Deletes a permission range.
Declaration
void DeletePermissionRange(PermissionRangeStart rangeStart)Parameters
|
Permission 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
|
Read 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.
Declaration
void DeleteTable(Table table)Parameters
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.
Declaration
void DeleteTableRow(TableRow row)Parameters
EditShapeTextBox(ShapeInline)
Initiates editing of a shape's text box element.
Declaration
void EditShapeTextBox(ShapeInline shape)Parameters
|
Shape The Shape |
EndUndoGroup()
Closes currently started undo-able group, started with Begin
Declaration
void EndUndoGroup()EndUndoGroup(String)
Closes currently started undo-able group, started with Begin
Declaration
void EndUndoGroup(string groupDisplayText)Parameters
|
System. 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
|
System. 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.
Declaration
bool Insert(string text)Parameters
|
System. The text to insert. |
Returns
|
System.
|
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
|
Annotation The annotation range start. |
|
Annotation 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
|
System. Name of the bookmark. |
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
void InsertCaption(CaptionDefinition definition, string caption, bool includeLabel, bool insertBelow)Parameters
|
Caption The definition of the caption. |
|
System. The caption text to be used. |
|
System. If set to |
|
System. If set to |
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
|
System. The code to insert. |
|
Code 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
comment
The comment. |
InsertCrossReferenceToBookmark(String, ReferenceContentType, Boolean)
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
|
System. Name of the bookmark. |
|
Reference Type of the content. |
|
System. If set to |
InsertCrossReferenceToCaption(Paragraph, ReferenceContentType, Boolean)
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
|
Paragraph
captionParagraph
The paragraph containing the caption sequence field. |
|
Reference The reference content type. If the paragraph doesn't have applied a Caption style, the method will not be executed. |
|
System. A parameter indicating whether the cross-reference field should be a hyperlink. |
InsertCrossReferenceToHeading(Paragraph, ReferenceContentType, Boolean)
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
|
Paragraph
headingParagraph
The paragraph. If the paragraph doesn't have applied a Heading style, the method will not be executed. |
|
Reference Type of the content. |
|
System. If set to |
InsertEndnote()
Inserts endnote at the current position.
Declaration
void InsertEndnote()InsertEndnote(Note)
Inserts the endnote at the current position.
Declaration
void InsertEndnote(Note endnote)Parameters
|
Note
endnote
The endnote. |
InsertField(Field)
Inserts a field into the document at the current caret position.
Declaration
bool InsertField(Field field)Parameters
|
Field
field
The field. |
Returns
|
System. True, if the operation completed successfully. |
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
field
The field. |
|
Field The display mode. |
Returns
|
System. 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
|
Note
footnote
The footnote. |
InsertFragment(DocumentFragment)
Inserts a fragment at the current caret position.
Declaration
void InsertFragment(DocumentFragment documentFragment)Parameters
|
Document 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
|
Document The fragment to insert. |
|
Document The document position to insert the fragment at. |
InsertHyperlink(HyperlinkInfo)
Inserts a hyperlink in the document.
Declaration
void InsertHyperlink(HyperlinkInfo hyperlinkInfo)Parameters
|
Hyperlink 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
|
Hyperlink The hyperlink info. |
|
System. The inlines in the hyperlink. |
InsertImage(Stream, String)
Inserts an inline image into the document at the current caret position.
Declaration
void InsertImage(Stream imageStream, string extension)Parameters
|
System. The stream to the image's contents. |
|
System. The extension specifying the image format. |
InsertInline(Inline)
Inserts inline element into the document at the current caret position.
Declaration
void InsertInline(Inline inline)Parameters
|
Inline
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
inline
The inline element to insert. |
|
Document The document position to insert the inline at. |
InsertLine(String)
Inserts text at the current caret position and adds a new paragraph after it.
Declaration
void InsertLine(string text)Parameters
|
System. The text. |
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
|
System. 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
|
Section 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
|
Shape The type of shape. |
|
System. Shape's initial size. |
InsertTable(Int32, Int32)
Inserts a new table in the document.
Declaration
void InsertTable(int rows, int columns)Parameters
|
System. Number of the rows in the table. |
|
System. Number of the columns in the table. |
InsertTable(Table)
Inserts a table in the document.
Declaration
void InsertTable(Table table)Parameters
|
Table
table
The table. |
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(Boolean)
Produces a mail merged document containing the results for all data records.
Declaration
RadDocument MailMerge(bool startEachRecordOnNewPage)Parameters
|
System.
|
Returns
|
Rad The document containing the result of the operation. |
MailMergeCurrentRecord()
Creates a new Rad
Declaration
RadDocument MailMergeCurrentRecord()Returns
|
Rad The document. |
MergeTableCells()
Merges the currently selected table cells into one.
Declaration
void MergeTableCells()MoveSelection(DocumentPosition, Boolean)
Moves the current selection along with the selected document elements to a specified position.
Declaration
void MoveSelection(DocumentPosition position, bool deleteSelection)Parameters
|
Document The start position where the selection should be moved to. |
|
System.
|
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
|
Paste
|
PasteFormatting()
Pastes the currently copied formatting on the current selection.
Declaration
bool PasteFormatting()Returns
|
System. 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
|
System. 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
|
System. True, if the operation completed successfully. |
PreviewMailMergeDataRecordAtIndex(Int32)
Updates all fields in the document with the values evaluated using a specified data record.
Declaration
bool PreviewMailMergeDataRecordAtIndex(int index)Parameters
|
System. The index of the record to be shown. |
Returns
|
System. True, if the operation completed successfully. |
PreviewNextMailMergeDataRecord()
Updates all fields in the document with the values evaluated using the next data record.
Declaration
bool PreviewNextMailMergeDataRecord()Returns
|
System. 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
|
System. True, if the operation completed successfully. |
Redo()
Re-executes the last undone command group.
Declaration
void Redo()RejectAllRevisions()
Rejects all revisions in the document.
Declaration
void RejectAllRevisions()RejectRevision(Revision)
Rejects a revision.
Declaration
void RejectRevision(Revision revision)Parameters
|
Revision
revision
The revision. |
RemoveTabStop(TabStop)
Removes a tab stop from the selected paragraphs.
Declaration
void RemoveTabStop(TabStop tabStop)Parameters
|
Tab The tab stop. |
RemoveTabStopRange(IEnumerable<TabStop>)
Removes a collection of tab stops in the selected paragraphs.
Declaration
void RemoveTabStopRange(IEnumerable<TabStop> tabStops)Parameters
|
System. The tab stops. |
ReplaceTabStop(TabStop, TabStop)
Replaces a tab stop inside the selected paragraphs.
Declaration
void ReplaceTabStop(TabStop oldTabStop, TabStop newTabStop)Parameters
ResizeTableColumn(Table, Int32, Double)
Changes the width of a table column.
You could specify different width type through the Change
Declaration
void ResizeTableColumn(Table table, int columnIndex, double columnWidth)Parameters
|
Table
table
The table. |
|
System. The index of the column. |
|
System. The new value for the column width. |
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
|
System. A boolean value determining whether the operation completed successfully. |
SetListNumbering(Int32)
Skips numbers and starts the counting of the current list from the specified value.
Declaration
bool SetListNumbering(int numbersToSkip)Parameters
|
System. The numbers to skip. |
Returns
|
System. A boolean value indicating whether the operation completed successfully. |
SetWatermark(DocumentWatermarkSettings)
Sets a watermark to the selected sections.
Declaration
void SetWatermark(DocumentWatermarkSettings watermarkSettings)Parameters
|
Document 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
|
Predefined 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
|
Annotation 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
|
Annotation The annotation range start to be split. |
|
Document 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
|
System. 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
|
Field The field start. |
ToggleItalic()
Toggles the font style of the selected content between System.
Declaration
void ToggleItalic()ToggleStrikethrough()
Toggles the strike-through of the selected content.
Declaration
void ToggleStrikethrough()Undo()
Reverts the last executed command group.
Declaration
void Undo()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
|
Caption 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
|
Field The display mode which will be used for the fields. |
UpdateField(FieldRangeStart)
Updates a field.
Declaration
void UpdateField(FieldRangeStart fieldStart)Parameters
|
Field 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
|
System. Permissions to add. |
|
System. Permissions to remove. |