Skip to main content

VCL Rich Edit Control: Supported Commands List

  • 33 minutes to read

The Rich Edit Control provides a comprehensive set of commands that provide access to numerous text formatting options and built-in customization dialogs for your end-users. These commands are implemented by TAction objects, which you can link to the elements of your UI manually or employ the automatic Ribbon or Toolbar UI generating feature.

A

AddParagraphsToTableOfContentsPlaceholder
Modifies the availability of the TableOfContentsSetParagraphBodyTextLevel, TableOfContentsSetParagraphHeading1Level, TableOfContentsSetParagraphHeading2Level, TableOfContentsSetParagraphHeading3Level, TableOfContentsSetParagraphHeading4Level, TableOfContentsSetParagraphHeading5Level, TableOfContentsSetParagraphHeading6Level, [TableOfContentsSetParagraphHeading7Level](xref:176013#CommandsList_TableOfContentsSetParagraphHeading7Level), TableOfContentsSetParagraphHeading8Level, and TableOfContentsSetParagraphHeading9Level commands in a drop-down menu depending on the current state of both the Rich Edit control and a document in it. Link this command to a TdxBarSubItem or TdxBarButton object displaying the drop-down menu with the ten paragraph style commands listed above. Normally, the AddParagraphsToTableOfContentsPlaceholder command is used by the Rich Edit control’s automatic UI generator.

C

ChangeFloatingObjectFillColor
Link this command to a TcxColorComboBox or TdxRibbonColorGalleryItem item control in a Ribbon or Toolbar UI to allow end-users to assign a picked color to the background of the selected floating object. Use the ChangeFloatingObjectOutlineColor and ChangeFloatingObjectOutlineWidth commands to customize the floating object’s outline.

ChangeFloatingObjectOutlineColor
Link this command to a TcxColorComboBox or TdxRibbonColorGalleryItem item control in a Ribbon or Toolbar UI to allow end-users to assign a picked color to the selected floating object’s outline. Use the ChangeFloatingObjectFillColor and ChangeFloatingObjectOutlineWidth commands to change the floating object’s background color and outline width, respectively.

ChangeFloatingObjectOutlineWidth
Link this command to a TcxComboBox item control in a Ribbon or Toolbar UI to allow end-users to assign a selected value as the selected floating object’s outline width. To change the floating object’s background and outline colors, use the ChangeFloatingObjectFillColor and ChangeFloatingObjectOutlineColor commands, respectively.

ChangeFontColor
Link this command to a TcxColorComboBox or TdxRibbonColorGalleryItem item control in a Ribbon or Toolbar UI to allow end-users to assign a picked color to the active font. To change the font typeface and size, use the ChangeFontName and ChangeFontSize commands, respectively.

ChangeFontName
Link this command to a TcxFontNameComboBox item control in a Ribbon or Toolbar UI to allow end-users to apply the selected font typeface to the active font. To change the font color and size, use the ChangeFontColor and ChangeFontSize commands, respectively.

ChangeFontSize
Link this command to a TcxComboBox item control in a Ribbon or Toolbar UI to allow end-users to apply the selected value as the current font size in a document. To change the font typeface and color, use the ChangeFontName and ChangeFontColor commands, respectively.

ChangePageColor
Link this command to a TcxColorComboBox or TdxRibbonColorGalleryItem item control in a Ribbon or Toolbar UI to allow end-users to apply the picked color to the document’s background.

ChangeSectionLineNumbering
Modifies the availability of the SetSectionLineNumberingNone, SetSectionLineNumberingContinuous, SetSectionLineNumberingRestartNewPage, SetSectionLineNumberingRestartNewSection, and ShowLineNumberingForm commands in drop-down menu depending on the current state of both the Rich Edit control and a document in it. Link this command to a TdxBarSubItem or TdxBarButton object displaying the drop-down menu with the five line numbering commands listed above. Normally, the ChangeSectionLineNumbering command is used by the Rich Edit control’s automatic UI generator.

CheckSpelling
Invokes the Spelling dialog.

ClosePageHeaderFooter
Disables the header or footer editing mode and positions the caret at the beginning of the current document page. To enable the header or footer editing mode, use the EditPageHeader and EditPageFooter commands, respectively.

CopySelection

Copies the selected text fragment or floating object to the clipboard. To cut and paste document selections, use the CutSelection and PasteSelection commands, respectively.

A user can reproduce the CopySelection command’s function by pressing the Ctrl+C key combination.

CreateField
Inserts an empty document field designated by the curly brackets and places the caret between them. An end-user can type necessary identifiers and keys to create a document field manually.

CutSelection

Moves the selected text fragment or floating object to the clipboard. To copy and paste document selections, use the CopySelection and PasteSelection commands, respectively.

A user can reproduce the CutSelection command’s function by pressing the Ctrl+X key combination.

D

DecreaseFontSize

Decreases the current font (i.e., applied to the active word or current text selection) by one position in the Rich Edit control’s set of predefined font size values. Use the IncreaseFontSize command in order to increase the current font size.

To specify the exact font size value instead of using the predefined font size list, use the ChangeFontSize command instead.

DecrementIndent
Decreases an indent of the selected or current paragraph by 0.5 inch regardless of the measurement units used by the Rich Edit control. This command cannot be used to set negative paragraph indent values. To increase the current paragraph’s indent, use the IncrementIndent command.

DeleteTable
Deletes a table in which the caret or selection is located.

DeleteTableColumns
Deletes the number of columns corresponding to the width (in cells) of the current selection in a table. The Rich Edit control deletes a single column if the caret is located in a table cell. In order to delete rows, use the DeleteTableRows command.

DeleteTableRows
Deletes the number of rows corresponding to the height (in cells) of the current selection in a table. The Rich Edit control deletes a single row if the caret is located in a table cell. In order to delete columns, use the DeleteTableColumns command.

E

EditPageFooter
Enables the document footer editing mode. Use the ClosePageHeaderFooter command in order to disable the footer editing mode. To switch between the header and footer editing modes, use the GoToPageHeader and GoToPageFooter commands.

EditPageHeader
Enables the document header editing mode. Use the ClosePageHeaderFooter command in order to disable the header editing mode. To switch between the header and footer editing modes, use the GoToPageHeader and GoToPageFooter commands.

EncryptDocument
Invokes the Encrypt the contents of this file encryption dialog that allows an end-user to assign, modify, or remove an encryption password for a document.

F

FloatingObjectBringForward
Raises the selected floating object’s position by one in the same document layer. To lower a floating object by one position, use the FloatingObjectSendBackward command.

FloatingObjectBringInFrontOfText
Moves the selected floating object to the “foreground” document layer. Use the FloatingObjectSendBehindText command to move a floating object behind text.

FloatingObjectBringToFront
Positions the selected floating object above other floating objects within the same document layer. To put the selected floating object behind all others within the same document layer, use the FloatingObjectSendToBack command.

FloatingObjectSendBackward
Lowers the selected floating object’s z-order by one. To raise the floating object by one position in the same document layer, use the FloatingObjectBringForward command.

FloatingObjectSendBehindText
Moves the selected floating object to the document’s “background” layer.

FloatingObjectSendToBack
Sets the selected floating object’s z-order to 0 moving it behind other floating objects in the same document layer.

G

GoToNextPageHeaderFooter
Moves the caret to the header or footer on the next document page, depending on whether the header or footer editing mode is currenly active. Use the GoToPreviousPageHeaderFooter command to move the caret in the opposite direction.

GoToPageFooter
Activates the document footer editing mode when the header editing mode is active. Use this command to move the caret from header to footer in the same page. To move the caret in the opposite direction, use the GoToPageHeader command.

GoToPageHeader
Activates the document header editing mode when the footer editing mode is active. Use this command to move the caret from footer to header in the same page. To move the caret in the opposite direction, use the GoToPageFooter command.

GoToPreviousPageHeaderFooter
Moves the caret to the header or footer on the preceding document page, depending on whether the header or footer editing mode is currently active. Use the GoToNextPageHeaderFooter command to move the caret in the opposite direction.

I

IncreaseFontSize

Increases the current font (i.e., the font applied to a selected text fragment or the active word) size by one position in the Rich Edit control’s set of predefined font size values. To decrease the current font size, use the DecreaseFontSize command.

In order to specify the exact font size value instead of using the predefined font size list, use the ChangeFontSize command.

IncrementIndent
Increases an indent of the selected or current paragraph by 0.5 inch, regardless of the measurement units used by the Rich Edit control. To decrease the paragraph indent, use the DecrementIndent command.

InsertCaptionPlaceholder
Modifies the availability of the InsertFigureCaption, InsertTableCaption, and InsertEquationCaption commands in a drop-down menu depending on the current state of both the Rich Edit control and a document in it. Link this command to a TdxBarSubItem or TdxBarButton object displaying the drop-down menu with the three caption insertion commands listed above. Normally, the InsertCaptionPlaceholder command is used by the Rich Edit control’s automatic UI generator.

InsertColumnBreak
Inserts a column break at the current caret position in the document.

InsertEquationsCaption
Inserts a numbered caption designed to label equations in the document. Each caption inserted by this command can be used as a table of equations entry.

InsertFiguresCaption
Inserts a numbered caption designed to label illustrations within the document. Each caption inserted by this command can be used as a table of figures entry.

InsertFloatingObjectPicture
Invokes the Open dialog allowing an end-user to select a bitmap file for insertion as a floating object anchored to the current paragraph.

InsertPageBreak
Inserts a page break at the current caret position and starts a new section on the next document page.

InsertPageCountField
Inserts a document field displaying the total number of pages into the document header and/or footer. In order to insert the current page number, use the InsertPageNumberField command.

InsertPageNumberField
Inserts a document field displaying the current page number into the document header and/or footer. In order to insert the total number of pages in the document, use the InsertPageCountField command.

InsertPicture
Invokes the Open dialog, allowing an end-user to specify a bitmap file inserted as an inline image at the current caret position in the document.

InsertSectionBreakNextPage
Inserts a page break at the caret position and starts a new document section on the next page.

InsertSectionBreakOddPage
Inserts a section break at the caret position and begins a new section on the next odd-numbered document page.

InsertSectionBreakEvenPage
Inserts a section break at the caret position and begins a new section on the next even-numbered document page.

InsertTableColumnToTheLeft
The InsertTableColumnToTheLeft, InsertTableColumnToTheRight, InsertTableRowAbove, and InsertTableRowBelow commands are designed to expand an existing table in the respective directions.

InsertTableColumnToTheRight
The InsertTableColumnToTheLeft, InsertTableColumnToTheRight, InsertTableRowAbove, and InsertTableRowBelow commands are designed to expand an existing table in the respective directions.

InsertTableOfContents
Inserts a table of contents based on the document paragraphs to which the heading styles are applied.

InsertTableOfFigures
Inserts a table of contents that refers to the labeled images in the document.

InsertTableOfFiguresPlaceholder
Modifies the availability of the InsertTableOfFigures, InsertTableOfTables, and InsertTableOfEquations commands in a drop-down menu depending on the current state of both the Rich Edit control and a document in it. Link this command to a TdxBarSubItem or TdxBarButton object displaying the drop-down menu with the three table insertion commands listed above. Normally, the InsertTableOfFiguresPlaceholder command is used by the Rich Edit control’s automatic UI generator.

InsertTableOfTables
Inserts a table of contents that refers to sequentially numbered captions designed to label tables in the document.

InsertTablesCaption
Inserts a numbered caption designed to label tables in the document. Each caption inserted by this command can be used as a table of tables entry.

InsertTableOfEquations
Inserts a table of contents that refers to sequentially numbered captions designed to label equations in the document.

InsertTableRowAbove
The InsertTableColumnToTheLeft, InsertTableColumnToTheRight, InsertTableRowAbove, and InsertTableRowBelow commands are designed to expand an existing table in the respective directions.

InsertTableRowBelow
The InsertTableColumnToTheLeft, InsertTableColumnToTheRight, InsertTableRowAbove, and InsertTableRowBelow commands are designed to expand an existing table in the respective directions.

InsertTextBox
Inserts a floating text box and anchors it to the current paragraph.

L

LoadDocument

The LoadDocument, NewDocument, SaveDocument, and SaveDocumentAs commands provide the Rich Edit control’s document file management functionality to end-users.

This command invokes the Open dialog allowing an end-user to select and load a supported document file to the Rich Edit control.

M

MergeTableCells
Merges the current table cell selection.

N

NewDocument

The LoadDocument, NewDocument, SaveDocument, and SaveDocumentAs commands provide the Rich Edit control’s document file management functionality to end-users.

Link this command to a UI element to allow end-users to create a new document in the Rich Edit control. Alternatively, an end-user can press the Ctrl+N key combination in order to achieve the same goal, provided that the NewDocument command is available.

The availability of the NewDocument command depends on the Rich Edit control’s Options.Behavior.CreateNew property value.

O

OpenHyperlink
Activates the currently selected hyperlink.

P

PasteSelection

The CopySelection, CutSelection, and PasteSelection commands provide the Rich Edit control’s clipboard management functionality to end-users.

This command pastes the clipboard contents (i.e., a floating object, bitmap, or text) into a document. To achieve the same end, an end-user can press the Ctrl+V key combination, provided that the PasteSelection command is available.

ProtectDocument
Invokes the Start Enforcing Protection dialog for an unprotected document. To cancel the document password protection, use the UnprotectDocument command.

R

Redo

The Undo and Redo commands provide the Rich Edit control’s action history functionality to end-users.

Restores the last undone action previously performed in the current document. An end-user can press the Ctrl+Y key combination in order to achieve the same goal, provided that the Redo command is available.

RemoveHyperlinkField
Removes the selected hyperlink document field. The hyperlink’s anchor text is not affected by this command.

ResetTableCellBorders
Removes all table borders in the current cell selection.

S

SaveDocument

The LoadDocument, NewDocument, SaveDocument, and SaveDocumentAs commands provide the Rich Edit control’s document file management functionality to end-users.

Link this command to a UI element to allow an end-user to save changes made to the currently opened document in the Rich Edit control. Alternatively, an end-user can press the Ctrl+S key combination in order to achieve the same goal, provided that the SaveDocument command is available.

SaveDocumentAs

The LoadDocument, NewDocument, SaveDocument, and SaveDocumentAs commands provide the Rich Edit control’s document file management functionality to end-users.

Link this command to a UI element to allow an end-user to save the current document to a file specified by using the Save As dialog window. Alternatively, an end-user can press the F12 key in order to achieve the same goal, provided that the SaveDocumentAs command is available.

SearchFind

The SearchFind, SearchFindNext, and SearchReplace commands are providing the content search and replace functionality within the Rich Edit control. Unlike SearchFindNext, the SearchFind and SearchReplace commands are always available.

Link this command to a UI element to allow an end-user to invoke the Find and Replace dialog window with the active Find tab. Alternatively, an end-user can press the Ctrl+F key combination in order to achieve the same goal.

SearchFindNext

The SearchFind, SearchFindNext, and SearchReplace commands are providing the content search and replace functionality within the Rich Edit control. The SearchFindNext command is available only when the first match is found within a document.

Link this command to a UI element to allow an end-user to find the next match within a document. Alternatively, an end-user can click the Find Next button in the Find and Replace dialog window.

SearchReplace](

The SearchFind, SearchFindNext, and SearchReplace commands are providing the content search and replace functionality within the Rich Edit control. Unlike SearchFindNext, the SearchFind and SearchReplace commands are always available.

Link this command to a UI element to allow an end-user to invoke the Find and Replace dialog window with the active Replace tab. Alternatively, an end-user can press the Ctrl+H key combination in order to achieve the same goal.

SelectAll
Selects everything within the current document. An end-user can achieve the same end by pressing the Ctrl+A key combination.

SetDoubleParagraphSpacing

The SetDoubleParagraphSpacing, SetSesquialteralParagraphSpacing, and SetSingleParagraphSpacing commands are used to change the spacing between lines in a document’s paragraph.

This command sets the double line spacing in either the active or selected paragraph(s).

SetFloatingObjectBehindTextWrapType
Moves the currently selected floating object to the “background” document layer. Use the SetFloatingObjectInFrontOfTextWrapType command to move the floating object to the “foreground” document layer.

SetFloatingObjectBottomCenterAlignment
Positions the selected floating object at the bottom center section of the document page.

SetFloatingObjectBottomLeftAlignment
Positions the selected floating object at the bottom left section of the document page.

SetFloatingObjectBottomRightAlignment
Positions the selected floating object at the bottom right section of the document page.

SetFloatingObjectInFrontOfTextWrapType
Moves the selected floating object to the “foreground” document layer. Use the SetFloatingObjectBehindTextWrapType command to anchor the selected floating object to the “background” document layer.

SetFloatingObjectMiddleCenterAlignment
Positions the selected floating object at the middle center section of the document page.

SetFloatingObjectMiddleLeftAlignment
Positions the selected floating object at the middle left section of the document page.

SetFloatingObjectMiddleRightAlignment
Positions the selected floating object at the middle right section of the document page.

SetFloatingObjectSquareTextWrapType
Anchors the selected floating object to the “text” document layer and wraps the text around all sides of a square bounding the floating object.

SetFloatingObjectThroughTextWrapType
Anchors the selected floating object to the “text” document layer and wraps the text around an irregular shape bounding the floating object. The wrapped text fills any blank spaces found in an irregular shape. Since this functionality is not ye implemented, the SetFloatingObjectThroughTextWrapType command works identically to SetFloatingObjectSquareTextWrapType.

SetFloatingObjectTightTextWrapType
Anchors the selected floating object to the “text” document layer and wraps the text tightly around the floating object. Since this functionality is not yet implemented, the SetFloatingObjectTightTextWrapType command works identically to SetFloatingObjectSquareTextWrapType.

SetFloatingObjectTopAndBottomTextWrapType
Anchors the selected floating object to the “text” document layer and places the text strictly above and below the floating object.

SetFloatingObjectTopCenterAlignment
Positions the selected floating object at the top center section of the document page.

SetFloatingObjectTopLeftAlignment
Positions the selected floating object at the top left section of the document page.

SetFloatingObjectTopRightAlignment
Positions the selected floating object at the top right section of the document page.

SetLandscapePageOrientation

The SetLandscapePageOrientation and SetPortraitPageOrientation commands are used to switch between the landscape and portrait page orientations in the Rich Edit control.

This command applies the landscape page orientation to the current document.

SetPortraitPageOrientation

The SetLandscapePageOrientation and SetPortraitPageOrientation commands are used to switch between the landscape and portrait page orientations in the Rich Edit control.

This command applies the portrait page orientation to the current document.

SetSectionOneColumns
Arranges the current section’s content into a single column. Use the SetSectionTwoColumns and SetSectionThreeColumns commands to rearrange a document section into two or three identical columns, respectively.

SetSectionThreeColumns
Arranges the current section’s content into three identical columns. Use the SetSectionOneColumn and SetSectionTwoColumns commands to rearrange a document section into one or two columns, respectively.

SetSectionTwoColumns
Arranges the current section’s content into two identical columns. Use the SetSectionOneColumn and SetSectionThreeColumns commands to rearrange a document section into one or three columns, respectively.

SetSectionLineNumberingNone
Disables line numbering for the current document section.

SetSectionLineNumberingContinuous
Sets sequential line numbering throughout the current document.

SetSectionLineNumberingRestartNewPage
In this mode, each document page has its own line numbering.

SetSectionLineNumberingRestartNewSection
In this mode each document section has its own line numbering. All pages in a single section are sequentially numbered.

SetSesquialteralParagraphSpacing

The SetDoubleParagraphSpacing, SetSesquialteralParagraphSpacing, and SetSingleParagraphSpacing commands are used to change the spacing between lines in a document’s paragraph.

This command sets the sesquialteral line spacing in either the active or selected paragraph(s).

SetSingleParagraphSpacing

The SetDoubleParagraphSpacing, SetSesquialteralParagraphSpacing, and SetSingleParagraphSpacing commands are used to change the spacing between lines in a document’s paragraph.

This command sets single line spacing in either the active or selected paragraph(s).

ShowAllFieldCodes

The AllFieldCodes and AllFieldResult commands are used to switch between the field code and field value display modes in the Rich Edit control.

This command displays document field codes instead of the result values.

ShowAllFieldResults

The AllFieldCodes and AllFieldResult commands are used to switch between the field code and field value display modes in the Rich Edit control.

This command displays the up-to-date document field results.

ShowBookmarkForm
Invokes the Bookmark dialog.

ShowColumnSetupForm
Invokes the Columns Setup dialog.

ShowDeleteTableCellsForm
Invokes the Delete Cells dialog for a table in which the selection is located.

ShowEditStyleForm
Invokes the Modify Style dialog allowing an end-user to customize the document styles.

ShowFloatingObjectLayoutOptionsForm
Invokes the Layout dialog for the selected inline image or floating object.

ShowFontForm

Invokes the Font dialog.

The availability of the ShowFontForm command depends on the Rich Edit control’s Options.DocumentCapabilities.CharacterFormatting property value.

ShowHyperlinkForm
Invokes the Insert Hyperlink dialog.

ShowInsertMergeFieldForm
Invokes the Insert Merge Field dialog allowing an end-user to insert the merge field from the database into the current document.

ShowInsertTableCellsForm
Invokes the Insert Cells dialog for a table in which the selection is located.

ShowInsertTableForm
Invokes the Insert Table dialog.

ShowLineNumberingForm
Invokes the Line Numbers dialog.

ShowMergeDatabaseRecordsForm
Invokes the Merge Options dialog.

ShowNumberingForm
Invokes the “Bullets and Numbering” dialog.

ShowPageMarginsSetupForm

The ShowPageMarginsSetupForm, ShowPagePaperSetupForm, and ShowPageSetupForm commands are used to invoke the Page Setup dialog window with different active tabs.

Link this command to a UI element to allow end-users to invoke the Page Setup dialog window with the active Margins tab.

ShowPagePaperSetupForm

The ShowPageMarginsSetupForm, ShowPagePaperSetupForm, and ShowPageSetupForm commands are used to invoke the Page Setup dialog window with different active tabs.

Link this command to a UI element to allow end-users to invoke the Page Setup dialog window with the active Paper tab.

ShowPageSetupForm
Link this command to a UI element to allow end-users to invoke the Page Setup dialog window. To invoke the Page Setup dialog with a specific active tab, use the ShowPageMarginsSetupForm or ShowPagePaperSetupForm commands.

ShowParagraphForm

Link this command to a UI element to allow an end-user to invoke the Paragraph dialog window.

The availability of the ShowParagraphForm command depends on the Rich Edit control’s Options.DocumentCapabilities.ParagraphFormatting property value.

ShowRangeEditingPermissions
Invokes the Editing Permissions dialog allowing an end-user to manage editing permissions for a document range.

ShowPrintForm
Invokes the Print dialog. Note that the ShowPrintForm command requires both the TdxComponentPrinter component and a valid rich edit report link.

ShowPrintPreviewForm
Invokes the Print Preview dialog. Note that the ShowPrintPreviewForm command requires both the TdxComponentPrinter component and a valid rich edit report link.

ShowSplitTableCellsForm

Link this command to a UI element to allow an end-user to invoke the Split Cells dialog window.

The ShowSplitTableCellsForm command is available only if the focus is located within a table.

ShowSymbolForm
Link this command to a UI element to allow an end-user to invoke the Symbol dialog window.

ShowTablePropertiesForm

Link this command to a UI element to allow an end-user to invoke the Table Properties dialog window.

The ShowTablePropertiesForm command is available only if the focus is located within a table.

ShowTableStyleForm
Invokes the Modify Style for the table in which the caret, a text selection, or selected image is located.

SplitTable

Link this command to a UI element to allow an end-user to split a table in two either at the row in which the caret is located or at the top row (or cell) within the selection.

The SplitTable command is available only if the focus is located within a table.

SwitchToDraftView

The SwitchToDraftView, SwitchToiPrintLayoutView, and SwitchToSimpleView commands allow an end-user to switch between the available document representations within the Rich Edit control.

Link this command to a UI element to allow end-users to switch the current document representation to the Draft View.

You can programmatically switch the Rich Edit control to the Draft View mode by assigning the TdxRichEditViewType.Draft value to the control’s ActiveViewType property.

SwitchToPrintLayoutView

The SwitchToDraftView, SwitchToPrintLayoutView, and SwitchToSimpleView commands allow an end-user to switch between the available document representations within the Rich Edit control.

Link this command to a UI element to allow end-users to switch the current document representation to the Print Layout View.

You can programmatically switch the Rich Edit control to the Print Layout View mode by assigning the TdxRichEditViewType.PrintLayout value to the control’s ActiveViewType property.

SwitchToSimpleView

The SwitchToDraftView, SwitchToPrintLayoutView, and SwitchToSimpleView commands allow an end-user to switch between the available document representations within the Rich Edit control.

Link this command to a UI element to allow end-users to switch the current document representation to the Simple View.

You can programmatically switch the Rich Edit control to the Simple View mode by assigning the TdxRichEditViewType.Simple value to the control’s ActiveViewType property.

T

TableOfContentsSetParagraphBodyTextLevel
Applies the default style to all selected paragraphs or the paragraph in which the caret (or selection) is currently located.

TableOfContentsSetParagraphHeading1Level | TableOfContentsSetParagraphHeading2Level | TableOfContentsSetParagraphHeading3Level | TableOfContentsSetParagraphHeading4Level | TableOfContentsSetParagraphHeading5Level | TableOfContentsSetParagraphHeading6Level | TableOfContentsSetParagraphHeading7Level | TableOfContentsSetParagraphHeading8Level | TableOfContentsSetParagraphHeading9Level
These commands apply the respective Heading styles to all selected paragraphs or the paragraph in which the caret (or text selection) is currently located. Use the TableOfContentsSetParagraphBodyTextLevel command to return the default style to the selected paragraph(s).

TextHighlight
Highlights the current text selection with a color.

TextLowerCase

Link this command to a UI element to allow end-users to convert text to lowercase. The TextLowerCase command is applied to either the selection or to the edited word (i.e., the word in which the caret is currently located).

If the caret is located within lowercase text, the TextLowerCase command has no effect. To convert text to uppercase, use the TextUpperCase command instead.

[TextUpperCase]

Link this command to a UI element to allow end-users to convert text to uppercase. The TextUpperCase command is applied to either the selection or to the edited word (i.e., the word in which the caret is currently located).

If the caret is located within an uppercase text or there are only uppercase characters within the current selection, the TextUpperCase command has no effect. To convert text to lowercase, use the TextLowerCase command instead.

ToggleBulletedList
Link this command to a UI element to allow users to switch add or remove a bulleted list.

ToggleDifferentFirstPages
Link this command to a UI element to allow end-users to create different headers and footers for the first page of a document or section.

ToggleDifferentOddAndEvenPages
Link this command to a UI element to allow end-users to create different headers and/or headers for odd and even pages of a document or section.

ToggleFieldCodes
Link this command to a UI element to allow end-users to display or hide field codes in the document.

ToggleFontBold

Applies/removes the Bold font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document, and the caret is not located within a word’s bounds).

A user can reproduce the ToggleFontBold command’s function by pressing the Ctrl+B key combination.

ToggleFontDoubleStrikeout

Applies/removes the Double Strikeout font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document and the caret is not located within a word’s bounds).

The ToggleFontDoubleStrikeout command’s effect is a substitute for the previously applied Strikeout font attribute.

ToggleFontDoubleUnderline

Applies/removes the Double Underline font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document and the caret is not located within a word’s bounds).

The ToggleFontDoubleUnderline command’s effect is a substitute for the previously applied Underline font attribute.

ToggleFontItalic

Applies/removes the Italic font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document and the caret is not located within a word’s bounds).

A user can reproduce the command’s function by pressing the Ctrl+I key combination.

ToggleFontStrikeout

Applies/removes the Strikeout font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document and the caret is not located within a word’s bounds).

The ToggleFontStrikeout command’s effect is a substitute for the previously applied Double Strikeout font attribute.

ToggleFontSubscript

Applies/removes the Subscript font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document, and the caret is not located within a word’s bounds).

The ToggleFontSubscript command’s effect is a substitute for the previously applied Superscript font attribute.

ToggleFontSuperscript

Applies/removes the Superscript font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document, and the caret is not located within a word’s bounds).

The ToggleFontSuperscript command’s effect is a substitute for the previously applied Subscript font attribute.

ToggleFontUnderline

Applies/removes the Underline font attribute to/from the current text selection/edited word (or the currently used font, if no text is selected within a document, and the caret is not located within a word’s bounds).

The ToggleFontUnderline command’s effect is a substitute for the previously applied Double Underline font attribute.

ToggleHeaderFooterLinkToPrevious
Link this command to a UI element to allow end-users to link a header/footer to the previous document section.

ToggleMultiLevelList
Link this command to a UI element to allow users to add or remove a multi-level list.

ToggleParagraphAlignmentCenter

Link this command to a UI element to allow end-users to center a paragraph between the left and right document margins. If the ToggleParagraphAlignmentCenter is applied to an already centered paragraph, the previously used text alignment command (i.e., ToggleParagraphAlignmentLeft, ToggleParagraphAlignmentJustify, or ToggleParagraphAlignmentRight) is applied to it instead.

The ToggleParagraphAlignmentCenter command is applied to either a selected or active (i.e., the paragraph in which the caret is currently located) paragraph. If the selected (or active) paragraph is centered, the linked UI element is highlighted.

The availability of the ToggleParagraphAlignmentCenter command depends on the Rich Edit control’s Options.DocumentCapabilities.ParagraphFormatting property value.

ToggleParagraphAlignmentJustify

Link this command to a UI element to allow end-users to justify a paragraph (i.e., its content is aligned with both the left and right document margins). If the ToggleParagraphAlignmentJustify command is applied to an already justified paragraph, the previously used text alignment command (i.e., ToggleParagraphAlignmentLeft, ToggleParagraphAlignmentCenter, or ToggleParagraphAlignmentRight) is applied to it instead.

The ToggleParagraphAlignmentJustify command is applied to either a selected or active (i.e., the paragraph in which the caret is currently located) paragraph. If the selected (or active) paragraph is justified, the linked UI element is highlighted.

The availability of the ToggleParagraphAlignmentJustify command depends on the Rich Edit control’s Options.DocumentCapabilities.ParagraphFormatting property value.

This is the most common text alignment setting. However, a paragraph is aligned to the left document margin.

ToggleParagraphAlignmentLeft

Link this command to a UI element to allow end-users to align a paragraph to the left document margin. If the ToggleParagraphAlignmentLeft command is applied to the left-aligned paragraph, the previously used text alignment command (i.e., ToggleParagraphAlignmentCenter, ToggleParagraphAlignmentJustify, or ToggleParagraphAlignmentRight) is applied to it instead.

The ToggleParagraphAlignmentLeft command is applied to either a selected or active (i.e., the paragraph in which the caret is currently located) paragraph. If the selected (or active) paragraph is aligned to the left document margin, the linked UI element is highlighted.

The availability of the ToggleParagraphAlignmentLeft command depends on the Rich Edit control’s Options.DocumentCapabilities.ParagraphFormatting property value.

ToggleParagraphAlignmentRight

Link this command to a UI element to allow end-users to align a paragraph to the right document margin. If the ToggleParagraphAlignmentRight command is applied to a right-aligned paragraph, the previously used text alignment command (i.e., ToggleParagraphAlignmentLeft, ToggleParagraphAlignmentCenter, or ToggleParagraphAlignmentJustify) is applied to it instead.

The ToggleParagraphAlignmentRight command is applied to either a selected or active (i.e., the paragraph in which the caret is currently located) paragraph. If the selected (or active) paragraph is aligned to the right document margin, the linked UI element is highlighted.

The availability of the ToggleParagraphAlignmentRight command depends on the Rich Edit control’s Options.DocumentCapabilities.ParagraphFormatting property value.

ToggleShowHorizontalRuler

Link this command to a UI element to allow end-users to hide or display the horizontal ruler in the Rich Edit control. When invoked, the ToggleShowHorizontalRuler command hides the ruler if it is currently visible or displays the previously hidden horizontal ruler. If the ruler is visible, this command highlights the linked UI element.

The ToggleShowHorizontalRuler command is available if either the Print Layout or Draft document View is selected. In the case of the Simple document representation, the linked UI element is inactive.

The current value of the Rich Edit control’s Options.HorizontalRuler.Visibility property does not affect availability of the ToggleShowHorizontalRuler command.

ToggleShowTableGridLines
Link this command to a UI element to allow end-users to hide or display grid lines for a table without printable borders.

ToggleShowVerticalRuler

Link this command to a UI element to allow end-users to hide or display the vertical ruler in the Rich Edit control. When invoked, the ToggleShowVerticalRuler command hides the ruler if it is currently visible or displays the previously hidden vertical ruler. If the ruler is visible, this command highlights the linked UI element.

Unlike ToggleShowHorizontalRuler, the ToggleShowVerticalRuler command is available only when the Print Layout document View is selected. If the Simple or Draft document representation is selected, the linked UI element is disabled.

The current value of the Rich Edit control’s Options.VerticalRuler.Visibility property does not affect availability of the ToggleShowVerticalRuler command.

ToggleShowWhitespace

Link this command to a UI element to allow end-users to switch visibility of whitespace characters (including tabs, spaces, etc).

If whitespace characters are displayed within the active document, the linked UI element is highlighted.

ToggleSimpleNumberingList
Link this command to a UI element to allow users to add or remove a simple numbered list.

ToggleTableAutoFitContents
Link this command to a UI element to allow users to fit table content.

ToggleTableAutoFitWindow
Link this command to a UI element to allow users to fit table content.

ToggleTableCellsAllBorders

Link this command to a UI element to allow an end-user to hide or display all cell borders within the current selection at once.

The ToggleTableCellsAllBorders command is available only if the focus is located within a table.

To hide or display individual cell borders, use the ToggleTableCellsBottomBorder, ToggleTableCellsLeftBorder, ToggleTableCellsTopBorder, and ToggleTableCellsRightBorder commands.

ToggleTableCellsBottomBorder

The ToggleTableCellsLeftBorder, ToggleTableCellsTopBorder, ToggleTableCellsRightBorder, and ToggleTableCellsBottomBorder commands are designed to hide/display individual outer borders of the table cell selection area.

Link this command to a UI element to allow an end-user to hide or display a bottom cell border within the current table cell selection.

The ToggleTableCellsBottomBorder command is available only if the focus is located within a table.

To hide/display all outer borders of the table cell selection area simultaneously, use the ToggleTableCellsOutsideBorder command.

ToggleTableCellsBottomCenterAlignment
Link this command to a UI element to allow end-users to center contents at the bottom of the selected table cell(s).

ToggleTableCellsBottomLeftAlignment
Link this command to a UI element to allow end-users to align contents to the left and bottom borders of the selected table cell(s).

ToggleTableCellsBottomRightAlignment
Link this command to a UI element to allow end-users to align contents to the right and bottom borders of the selected table cell(s).

ToggleTableCellsInsideBorder

Link this command to a UI element to allow an end-user to hide or display all inner borders of the table cell selection simultaneously.

The ToggleTableCellsInsideBorder command is available only if the focus is located within a table.

To hide/display outer borders of the table cell selection area, use the ToggleTableCellsOutsideBorder command.

To hide/display individual inner borders of the table cell selection area, use the ToggleTableCellsInsideHorizontalBorder and ToggleTableCellsInsideVerticalBorder commands.

ToggleTableCellsInsideHorizontalBorder
The ToggleTableCellsInsideHorizontalBorder and ToggleTableCellsInsideVerticalBorder commands are designed to hide/display individual inner borders of the table cell selection area.

ToggleTableCellsInsideVerticalBorder
The ToggleTableCellsInsideHorizontalBorder and ToggleTableCellsInsideVerticalBorder commands are designed to hide/display individual inner borders of the table cell selection area.

ToggleTableCellsLeftBorder

The ToggleTableCellsLeftBorder, ToggleTableCellsTopBorder, ToggleTableCellsRightBorder, and ToggleTableCellsBottomBorder commands are designed to hide/display individual outer borders of the table cell selection area.

Link this command to a UI element to allow an end-user to hide or display a left cell border within the current table cell selection.

The ToggleTableCellsLeftBorder command is available only if the focus is located within a table.

To hide/display all outer borders of the table cell selection area simultaneously, use the ToggleTableCellsOutsideBorder command.

ToggleTableCellsMiddleCenterAlignment
Link this command to a UI element to allow end-users to center contents within the selected cell(s) both horizontally and vertically.

ToggleTableCellsMiddleLeftAlignment
Link this command to a UI element to allow end-users to center contents at the left border of the selected cell(s).

ToggleTableCellsMiddleRightAlignment
Link this command to a UI element to allow end-users to center contents at the right border of the selected cell(s).

ToggleTableCellsOutsideBorder

Link this command to a UI element to allow an end-user to hide or display all outer borders of the table cell selection simultaneously.

The ToggleTableCellsOutsideBorder command is available only if the focus is located within a table.

To hide/display internal borders of the table cell selection area, use the ToggleTableCellsInsideBorder command.

To hide/display individual outer borders of the table cell selection area, use the ToggleTableCellsLeftBorder, ToggleTableCellsTopBorder, ToggleTableCellsRightBorder, and ToggleTableCellsBottomBorder commands.

ToggleTableCellsRightBorder

The ToggleTableCellsLeftBorder, ToggleTableCellsTopBorder, ToggleTableCellsRightBorder, and ToggleTableCellsBottomBorder commands are designed to hide/display individual outer borders of the table cell selection area.

Link this command to a UI element to allow an end-user to hide or display a right border within the current table cell selection.

The ToggleTableCellsRightBorder command is available only if the focus is located within a table.

To hide/display all outer borders of the table cell selection area simultaneously, use the ToggleTableCellsOutsideBorder command.

ToggleTableCellsTopBorder

The ToggleTableCellsLeftBorder, ToggleTableCellsTopBorder, ToggleTableCellsRightBorder, and ToggleTableCellsBottomBorder commands are designed to hide/display individual outer borders of the table cell selection area.

Link this command to a UI element to allow an end-user to hide or display a top border within the current table cell selection.

The ToggleTableCellsTopBorder command is available only if the focus is located within a table.

To hide/display all outer borders of the table cell selection area simultaneously, use the ToggleTableCellsOutsideBorder command.

ToggleTableCellsTopCenterAlignment
Link this command to a UI element to allow end-users to center contents at the top of the selected cell(s).

ToggleTableCellsTopLeftAlignment
Link this command to a UI element to allow end-users to align contents to the left and top borders of the selected table cell(s).

ToggleTableCellsTopRightAlignment
Aligns the table content to the top and right borders of the selected table cell(s).

ToggleTableFixedColumnWidth
Link this command to a UI element to allow users to enable fixed column width.

ToggleTextCase
Switches the case for all individual characters in the document selection.

ToggleViewMergedData
Switches the visibility of actual data in the MERGEFIELD document fields.

U

Undo

The Undo and Redo commands provide the Rich Edit control’s action history functionality to end-users.

Link this command to a UI element to allow an end-user to undo their last actions performed within the Rich Edit control. Alternatively, an end-user can press the Ctrl+Z key combination in order to achieve the same goal provided that the Undo command is available.

You can programmatically emulate the effect of the Undo command by invoking the Rich Edit control’s Undo procedure.

Availability of the Undo command depends on both the Rich Edit control’s Options.Behavior.Undo property value and the undo actions list’s content.

UnprotectDocument
Invokes the Unprotect Document dialog allowing an end-user to cancel the document protection from accidental changes.

UpdateField
Updates the document field in which the caret is located. To update all fields within the current selection or all merged data fields within the document, use the UpdateFields or ToggleViewMergedData command, respectively.

*UpdateFields
Updates all document fields (including nested fields) in the selected range.

UpdateTableOfContents
Updates a table of contents (i.e., the content of a TOC document field) in which the caret or text selection is currently located.

UpdateTableOfFigures
Updates a table of figures, pictures, or equations (i.e., the content of a TOC document field) in which the caret or text selection is currently located.

Z

ZoomIn
Zooms the active document View in by 10%.

ZoomOut
Zooms the active document View out by 10%.

ZoomPercent
Link this command to a TcxComboBox item control in a Ribbon or Toolbar UI to allow end-users to set the selected zoom factor value for the current document View.