Back to Devexpress

RichEditCommands Members

aspnet-js-richeditcommands-dot-underscore-members.md

latest37.0 KB
Original Source

RichEditCommands Members

Contains a set of the available client commands.

Properties

NameDescription
addSpacingAfterParagraphGets a command to add spacing after a paragraph.
addSpacingBeforeParagraphGets a command to add spacing before a paragraph.
assignShortcutGets a command to assign a shortcut to the specified client command.
backspaceGets a command to move the cursor backwards and erase characters in a selected range.
capitalizeEachWordTextCaseGets a command to capitalize each word in the selected sentence.
changeCustomNumberingListGets a command to customize the numbered list parameters.
changeFloatingObjectAbsolutePositionGets a command to change a floating object’s absolute position.
changeFloatingObjectAbsoluteSizeGets a command to change a floating object’s absolute size.
changeFloatingObjectAlignmentPositionGets a command to modify a floating object’s alignment position.
changeFloatingObjectFillColorGets a command to modify a floating object’s background fill color.
changeFloatingObjectLockAnchorGets a command to lock a floating object’s anchor.
changeFloatingObjectLockAspectRatioGets a command to lock a floating object’s aspect ratio.
changeFloatingObjectOutlineColorGets a command to modify a floating object’s outline color.
changeFloatingObjectOutlineWidthGets a command to modify a floating object’s outline width.
changeFloatingObjectRelativePositionGets a command to modify a floating object’s relative position.
changeFloatingObjectRotationGets a command to rotate a floating object.
changeFloatingObjectTextWrappingGets a command to modify a floating object’s text wrapping settings.
changeFontBackColorGets a command to change the background color of characters in a selected range.
changeFontBoldGets a command to change the bold formatting of characters in a selected range.
changeFontForeColorGets a command to change the font color of characters in a selected range.
changeFontFormattingGets a command to change the font formatting of characters in a selected range.
changeFontItalicGets a command to change the italic formatting of characters in a selected range.
changeFontNameGets a command to change the font name of characters in a selected range.
changeFontSizeGets a command to change the font size (in points) of characters in a selected range.
changeFontStrikeoutGets a command to change the strikeout formatting of characters in a selected range.
changeFontSubscriptGets a command to change the subscript formatting of characters in a selected range.
changeFontSuperscriptGets a command to change the superscript formatting of characters in a selected range.
changeFontUnderlineGets a command to change the underline formatting of characters in a selected range.
changeHyperlinkGets a command that changes the specified hyperlink.
changePageColorGets a command to set the background color of all pages contained in the document.
changePageMarginsGets a command to apply page margins settings to sections located within a selected range.
changePageOrientationGets a command to apply page orientation settings to sections located within a selected range.
changePageSizeGets a command to apply page size settings to sections located within a selected range.
changeParagraphBackColorGets a command to change the background color of paragraphs in a selected range.
changeParagraphFormattingGets a command to apply formatting settings to paragraphs within a selected range.
changePictureScaleGets a command to scale a selected in-line picture.
changeSectionColumnsGets a command to apply column layout settings to a section.
changeSectionEqualColumnCountGets a command to change the number of columns having the same width in a section.
changeStyleGets a command to apply a character or paragraph style settings to text in a selected range.
changeTableBorderRepositoryItemGets a command to apply borders’ drawing settings.
changeTableBordersAndShadingGets a command to change the selected table’s borders and shading.
changeTableCellFormattingGets a command to change the cell formatting of the selected table elements.
changeTableCellPreferredWidthGets a command to change the preferred cell width of the selected table rows.
changeTableCellShadingGets a command to change cell shading in selected table cells.
changeTableColumnPreferredWidthGets a command to change the selected table columns’ preferred width.
changeTableFormattingGets a command to change the selected table’s formatting.
changeTableLookGets a command to change the selected table’s style options.
changeTableRowPreferredHeightGets a command to change the selected table rows’ preferred height.
changeTableStyleGets a command to change the selected table’s style.
changeTabsGets a command to change the default tab stop value of a document and apply custom tab settings to the selected paragraphs.
changeTextBoxContentMarginsGets a command to modify a text box’s content margins.
changeTextBoxRelativeSizeGets a command to modify a text box’s relative size settings.
changeTextBoxResizeShapeToFitTextGets a command to resize the shape to fit the text in the text box.
changeViewTypeGets a command to change the Rich Edit’s document view type.
clearFormattingGets a command to reset textual and paragraph formatting in the selected range to default values.
closeHeaderFooterGets a command to substitute a header/footer sub-document with the main sub-document as an active sub-document.
continueNumberingListGets a command to continue the list’s numbering.
copyGets a command to copy the selected text and place it to the clipboard.
copyContentGets a command to copy the selected text and place it to the specified position.
createDateFieldGets a command to insert and update a field with a DATE code.
createFieldGets a command to add a field at the current position in a document.
createMergeFieldGets a command to replace the selection with a MERGEFIELD (a data source column name is passed with a parameter).
createPageCountFieldGets a command to replace the selection with a NUMPAGES field displaying the total number of pages.
createPageFieldGets a command to replace the selection with a PAGE field displaying the current page number.
createTimeFieldGets a command to replace the selection with a TIME field displaying the current time.
cutGets a command to cut the selected text and place it to the clipboard.
decreaseFontSizeGets a command to decrease the selected range’s font size to the closest smaller predefined value (in points).
decreaseIndentGets a command to decrease the indent level of paragraphs in a selected range.
decrementNumberingIndentGets a command to decrement the indent level of paragraphs in a selected numbered list.
decrementParagraphLeftIndentGets a command to decrement the paragraph’s left indent position.
deleteGets a command to delete text and in-line objects in a selected range.
deleteBookmarkGets a command to delete a specific bookmark.
deleteHyperlinkGets a command to delete the selected hyperlink.
deleteHyperlinksGets a command to delete all hyperlinks in the selected range.
deleteTableGets a command to delete the selected table.
deleteTableCellsDialogGets a command to invoke the Delete Cells dialog window.
deleteTableCellsWithShiftHorizontallyGets a command to delete the selected table cells with a horizontal shift.
deleteTableCellsWithShiftVerticallyGets a command to delete the selected table cells with a vertical shift.
deleteTableColumnsGets a command to delete the selected columns in the table.
deleteTableRowsGets a command to delete the selected rows in the table.
fileDownloadGets a command to download the document specifying the file’s extension and name.
fileNewGets a command to create a new empty document.
fileOpenGets a command to open a document stored in the specified file.
fileOpenDialogGets a command to invoke the File Open dialog allowing one to select and load a document file into RichEdit.
filePrintGets a command to invoke a browser-specific Print dialog allowing one to print the current document.
fileSaveGets a command to save the document at its original location on the server.
fileSaveAsGets a command to save a document in a file with the specified path.
fileSaveAsDialogGets a command to invoke the Save As dialog that prompts for a file name and saves the current document in a file with the specified path.
findAllGets a command to find all matches of the specified text in the document.
forceSyncWithServerGets a command to force synchronizing the server document model with the client model and execute a callback function if it is necessary.
getRtfGets a command to receive RTF formatted content from the document in the specified range.
goToBookmarkGets a command to navigate to the specified bookmark.
goToDataRecordGets a command to open the specified data record.
goToFirstDataRecordGets a command to navigate to the first data record.
goToFooterGets a command to substitute a header sub-document with a footer sub-document of the same page as an active sub-document.
goToHeaderGets a command to substitute a footer sub-document with a header sub-document of the same page as an active sub-document.
goToLastDataRecordGets a command to navigate to the last data record of the bound data source.
goToNextDataRecordGets a command to navigate to the next data record of the bound data source.
goToNextHeaderFooterGets a command to substitute a current header/footer with a header/footer of the next section as an active sub-document.
goToPreviousDataRecordGets a command to navigate to the previous data record of the bound data source.
goToPreviousHeaderFooterGets a command to substitute a current header/footer with a header/footer of the previous section as an active sub-document.
hideFindResultsGets a command to hide the search results.
increaseFontSizeGets a command to increase the font size of characters in a selected range to the closest larger predefined value (in points).
increaseIndentGets a command to increment the indent level of paragraphs in a selected range.
incrementNumberingIndentGets a command to increment the indent level of paragraphs in a selected numbered list.
incrementParagraphLeftIndentGets a command to increment the left indent of paragraphs in a selected range.
insertBookmarkGets a command to insert a new bookmark that references the current selection.
insertColumnBreakGets a command to insert a column break at the current position in the document.
insertContentFromServerGets a command to insert content created on the server to the client model.
insertEquationsCaptionGets a command to add a caption (numbered label) to an equation.
insertFiguresCaptionGets a command to add a caption (numbered label) to a figure.
insertFloatingTextBoxGets a command to insert a floating text box.
insertFooterGets a command to create a footer sub-document (if it is not yet created) and set it as an active sub-document instead of the main sub-document.
insertHeaderGets a command to create a header sub-document (if it is not yet created) and set it as an active sub-document instead of the main sub-document.
insertHtmlGets a command to add an HTML formatted content in place of a selected range.
insertHyperlinkGets a command to insert and update a hyperlink field in place of a selected range.
insertLineBreakGets a command to insert the line break at the current position in the document.
insertNonBreakingSpaceGets a command to add a non-breaking space in place of a selected range
insertNumerationGets a command to insert numeration to a paragraph making it a numbering list item.
insertPageBreakGets a command to insert a page break at the current position in the document.
insertParagraphGets a command to insert a paragraph break at the current position in the document.
insertPictureGets a command to insert an inline picture stored by the specified web address.
insertRtfGets a command to add RTF formatted content at the specified position.
insertSectionBreakEvenPageGets a command to insert a section break and starts a new section on the next even-numbered page.
insertSectionBreakNextPageGets a command to insert a section break and starts a new section on the next page.
insertSectionBreakOddPageGets a command to insert a section break and starts a new section on the next odd-numbered page.
insertSymbolGets a command to insert characters into a document instead of a selected range.
insertTabGets a command to insert a tab character at the current position in the document.
insertTableGets a command to insert a rectangular table of the specified size.
insertTableCellsDialogGets a command to invoke the Insert Cells dialog window.
insertTableCellsWithShiftToTheVerticallyGets a command to insert table cells with a vertical shift into the selected table.
insertTableCellWithShiftToTheLeftGets a command to insert table cells with a horizontal shift into the selected table.
insertTableColumnToTheLeftGets a command to insert a table column to the left of the current position in the table.
insertTableColumnToTheRightGets a command to insert a table column to the right of the current position in the table.
insertTableOfContentsGets a command to insert a table of contents.
insertTableOfEquationsGets a command to create a table of equations on the base of equation captions.
insertTableOfFiguresGets a command to create a table of figures on the base of figures captions.
insertTableOfTablesGets a command to create a table of tables on the base of tables captions.
insertTableRowAboveGets a command to insert a row in the table above the selected row.
insertTableRowBelowGets a command to insert a row in the table below the selected row.
insertTablesCaptionGets a command to add a caption (numbered label) to a table.
insertTextGets a command to insert text in place of a selected range.
linkHeaderFooterToPreviousGets a command to link a header/footer to the previous section, so it has the same content.
mailMergeAndDownloadGets a command to perform a mail merge and download the merged document.
mailMergeAndSaveAsGets a command to perform a mail merge and save the merged document to the server.
mailMergeDialogGets a command to invoke the Export Range dialog window to start a mail merge.
makeTextLowerCaseGets a command to convert selected text to lower case.
makeTextSentenceCaseGets a command changing all selected text to the sentence case capitalization.
makeTextUpperCaseGets a command to convert selected text to upper case.
mergeFieldDialogGets a command to invoke the Insert Merge Field dialog window.
mergeTableCellsGets a command to merge the selected cells.
moveContentGets a command to move the selected range.
openCustomNumberingListDialogGets a command to invoke the Customize Numbered List dialog window.
openFindAndReplaceDialogGets a command to invoke the Find and Replace dialog window.
openFindPanelGets a command to invoke the Search Panel allowing end-users to search text and navigate through search results.
openFontFormattingDialogGets a command to invoke the Font dialog window.
openHyperlinkGets a command to go to a bookmark or URI contained within the selected hyperlink.
openInsertBookmarkDialogGets a command to invoke the Bookmark dialog window.
openInsertHyperlinkDialogGets a command to invoke the Hyperlink dialog window.
openInsertPictureDialogGets a command to invoke the Insert Image dialog window.
openInsertSymbolDialogGets a command to invoke the Symbols dialog window.
openInsertTableDialogGets a command to invoke the Insert Table dialog window.
openLayoutOptionsDialogGets a command to invoke the Layout dialog window to customize the settings of a floating object.
openNumberingListDialogGets a command to invoke the Bulleted and Numbering dialog window.
openPageMarginsDialogGets a command to invoke the Margins tab of the Page Setup dialog window.
openPagePaperSizeDialogGets a command to invoke the Paper tab of the Page Setup dialog window.
openParagraphFormattingDialogGets a command to invoke the Indents And Spacing tab of the Paragraph dialog window.
openSectionColumnsDialogGets a command to invoke the Columns dialog window.
openSpellingDialogGets a command to invoke the Spelling dialog window.
openTableBordersAndShadingDialogGets a command to invoke the Borders tab of the Borders and Shading dialog window.
openTableFormattingDialogGets a command to invoke the Table tab of the Table Properties dialog window.
openTabsDialogGets a command to invoke the Tabs dialog window.
pasteGets a command to paste the text from the clipboard over the selection.
redoGets a command to reverse actions of the previous RichEditCommands.undo command.
removeNextWordGets a command to remove the next word.
removeNumerationGets a command to exclude the selected paragraphs from the numbered list.
removePrevWordGets a command to remove the previous word.
removeSpacingAfterParagraphGets a command to remove spacing after the selected paragraph.
removeSpacingBeforeParagraphGets a command to remove spacing before the selected paragraph.
removeTableCellBordersGets a command to remove the borders of the selected table cells.
replaceAllGets a command to replace all matches of the specified text with new characters.
replaceNextGets a command to find and replace a next match of the specified text after the cursor position with new characters.
restartNumberingListGets a command to restart the numbering list.
setDifferentFirstPageHeaderFooterGets a command to enable (or disable if it is enabled) a different page header and footer for the first page of the current section.
setDifferentOddAndEvenPagesHeaderFooterGets a command to enable (or disable if it is enabled) a different page header and footer for odd and even pages of the current section.
setDoubleParagraphSpacingGets a command to format a selected paragraph with double line spacing.
setFullscreenGets a command to toggle the fullscreen mode.
setPageSizeDialogGets a command to invoke the Page Setup dialog.
setParagraphLevelGets a command to apply a paragraph level to the selected text
setSesquialteralParagraphSpacingGets a command to format a current paragraph with one and a half line spacing.
setSingleParagraphSpacingGets a command to format a current paragraph with single line spacing.
showAllFieldCodesGets a command to display all field codes in place of the fields in the document.
showFieldCodesGets a command to display the selected field’s codes.
showHiddenSymbolsGets a command to toggle hidden symbol visibility.
showHorizontalRulerGets a command to toggle the horizontal ruler’s visibility.
showMergedDataGets a command to display or hide actual data in MERGEFIELD fields.
showTableGridLinesGets a command to toggle the display of grid lines for a table with no borders applied - on/off.
splitTableCellsGets a command to split the selected table cells.
splitTableCellsDialogGets a command to invoke the Split Cells dialog window.
switchTextCaseGets a command to switch the text capitalization in the selection.
toggleBulletedListGets a command to toggle between the bulleted paragraph and normal text.
toggleMultilevelListGets a command to toggle between the multilevel list style and normal text.
toggleNumberingListGets a command to toggle between the numbered paragraph and normal text.
toggleParagraphAlignmentCenterGets a command to toggle centered paragraph alignment on and off.
toggleParagraphAlignmentJustifyGets a command to toggle justified paragraph alignment on and off.
toggleParagraphAlignmentLeftGets a command to toggle left paragraph alignment on and off.
toggleParagraphAlignmentRightGets a command to toggle right paragraph alignment on and off.
toggleTableAutoFitContentsGets a command that fits the specified table to its contents.
toggleTableAutoFitWindowGets a command that fits the specified table to a document’s window.
toggleTableCellAlignBottomCenterGets a command to apply bottom-center alignment for the selected cells.
toggleTableCellAlignBottomLeftGets a command to apply bottom-left alignment for the selected cells.
toggleTableCellAlignBottomRightGets a command to apply bottom-right alignment for the selected cells.
toggleTableCellAlignMiddleCenterGets a command to apply middle-center alignment for the selected cells.
toggleTableCellAlignMiddleLeftGets a command to apply middle-left alignment for the selected cells.
toggleTableCellAlignMiddleRightGets a command to apply middle-right alignment for the selected cells.
toggleTableCellAlignTopCenterGets a command to apply top-center alignment for the selected cells.
toggleTableCellAlignTopLeftGets a command to apply top-left alignment for the selected cells.
toggleTableCellAlignTopRightGets a command to apply top-right alignment for the selected cells.
toggleTableCellAllBordersGets a command to apply (or cancel) border settings to all borders of the selected cells.
toggleTableCellBottomBorderGets a command to apply (or cancel) border settings of the bottom border for the selected cells.
toggleTableCellInsideBordersGets a command to apply (or cancel) border settings of the inside borders for the selected cells.
toggleTableCellInsideHorizontalBordersGets a command to apply (or cancel) border settings of the inside horizontal borders for the selected cells.
toggleTableCellInsideVerticalBordersGets a command to apply (or cancel) border settings of the inside vertical borders for the selected cells.
toggleTableCellLeftBorderGets a command to apply (or cancel) border settings of the left border for the selected cells.
toggleTableCellOutsideBordersGets a command to apply (or cancel) border settings of the outside borders for the selected cells.
toggleTableCellRightBorderGets a command to apply (or cancel) border settings of the right border for the selected cells.
toggleTableCellTopBorderGets a command to apply (or cancel) border settings of the top border for the selected cells.
toggleTableFixedColumnWidthGets a command that disables automatic adjusting of the selected table.
toggleTextCaseGets a command to toggle case for each character - upper case becomes lower, lower case becomes upper.
undoGets a command to cancel changes caused by the previous command.
updateAllFieldsGets a command to update all fields in the document.
updateFieldGets a command to update each field’s result in the selection.
updateTableOfContentsGets a command to update a table of contents.

Methods

NameDescription
beginUpdateGets a command to prevent the control UI from being updated until the RichEditCommands.endUpdate method is called.
endUpdateRe-enables render operations after a call to the RichEditCommands.beginUpdate method and forces immediate re-rendering.

See Also

RichEditCommands Class