Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

EditingCommands Class

.NET Framework 4

Provides a standard set of editing related commands.

System.Object
  System.Windows.Documents.EditingCommands

Namespace:  System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)
C#
C++
F#
VB
Copy 
public static class EditingCommands

The EditingCommands type exposes the following members.

  Name Description
Public property Static member AlignCenter Represents the AlignCenter command, which requests that the current paragraph or a selection of paragraphs be centered.
Public property Static member AlignJustify Represents the AlignJustify command, which requests that the current paragraph or a selection of paragraphs be justified.
Public property Static member AlignLeft Represents the AlignLeft command, which requests that a selection of content be aligned left.
Public property Static member AlignRight Represents the AlignRight command, which requests that a selection of content be aligned right.
Public property Static member Backspace Represents the Backspace command, which requests that a backspace be entered at the current position or over the current selection.
Public property Static member CorrectSpellingError Represents the CorrectSpellingError command, which requests that any misspelled word at the current position be corrected.
Public property Static member DecreaseFontSize Represents the DecreaseFontSize command, which requests that the font size for the current selection be decreased by 1 point.
Public property Static member DecreaseIndentation Represents the DecreaseIndentation command, which requests that indentation for the current paragraph be decreased by one tab stop.
Public property Static member Delete Represents the Delete command, which requests that the current selection be deleted.
Public property Static member DeleteNextWord Represents the DeleteNextWord command, which requests that the next word (relative to a current position) be deleted.
Public property Static member DeletePreviousWord Represents the DeletePreviousWord command, which requests that the previous word (relative to a current position) be deleted.
Public property Static member EnterLineBreak Represents the EnterLineBreak command, which requests that a line break be inserted at the current position or over the current selection.
Public property Static member EnterParagraphBreak Represents the EnterParagraphBreak command, which requests that a paragraph break be inserted at the current position or over the current selection.
Public property Static member IgnoreSpellingError Represents the IgnoreSpellingError command, which requests that any instances of misspelled words at the current position or in the current selection be ignored.
Public property Static member IncreaseFontSize Represents the IncreaseFontSize command, which requests that the font size for the current selection be increased by 1 point.
Public property Static member IncreaseIndentation Represents the IncreaseIndentation command, which requests that indentation for the current paragraph be increased by one tab stop.
Public property Static member MoveDownByLine Represents the MoveDownByLine command, which requests that the caret move down by one line.
Public property Static member MoveDownByPage Represents the MoveDownByPage command, which requests that the caret move down by one page.
Public property Static member MoveDownByParagraph Represents the MoveDownByParagraph command, which requests that the caret move down by one paragraph.
Public property Static member MoveLeftByCharacter Represents the MoveLeftByCharacter command, which requests that the caret move one character left.
Public property Static member MoveLeftByWord Represents the MoveLeftByWord command, which requests that the caret move one word left.
Public property Static member MoveRightByCharacter Represents the MoveRightByCharacter command, which requests that the caret move one character right.
Public property Static member MoveRightByWord Represents the MoveRightByWord command, which requests that the caret move right by one word.
Public property Static member MoveToDocumentEnd Represents the MoveToDocumentEnd command, which requests that the caret move to the very end of content.
Public property Static member MoveToDocumentStart Represents the MoveToDocumentStart command, which requests that the caret move to the very beginning of content.
Public property Static member MoveToLineEnd Represents the MoveToLineEnd command, which requests that the caret move to the end of the current line.
Public property Static member MoveToLineStart Represents the MoveToLineStart command, which requests that the caret move to the beginning of the current line.
Public property Static member MoveUpByLine Represents the MoveUpByLine command, which requests that the caret move up by one line.
Public property Static member MoveUpByPage Represents the MoveUpByPage command, which requests that the caret move up by one page.
Public property Static member MoveUpByParagraph Represents the MoveUpByParagraph command, which requests that the caret move up by one paragraph.
Public property Static member SelectDownByLine Represents the SelectDownByLine command, which requests that the current selection be expanded down by one line.
Public property Static member SelectDownByPage Represents the SelectDownByPage command, which requests that the current selection be expanded down by one page.
Public property Static member SelectDownByParagraph Represents the SelectDownByParagraph command, which requests that the current selection be expanded down by one paragraph.
Public property Static member SelectLeftByCharacter Represents the SelectLeftByCharacter command, which requests that the current selection be expanded left by one character.
Public property Static member SelectLeftByWord Represents the SelectLeftByWord command, which requests that the current selection be expanded left by one word.
Public property Static member SelectRightByCharacter Represents the SelectRightByCharacter command, which requests that the current selection be expanded right by one character.
Public property Static member SelectRightByWord Represents the SelectRightByWord command, which requests that the current selection be expanded right by one word.
Public property Static member SelectToDocumentEnd Represents the SelectToDocumentEnd command, which requests that the current selection be expanded to the very end of content.
Public property Static member SelectToDocumentStart Represents the SelectToDocumentStart command, which requests that the current selection be expanded to the very beginning of content.
Public property Static member SelectToLineEnd Represents the SelectToLineEnd command, which requests that the current selection be expanded to the end of the current line.
Public property Static member SelectToLineStart Represents the SelectToLineStart command, which requests that the current selection be expanded to the beginning of the current line.
Public property Static member SelectUpByLine Represents the SelectUpByLine command, which requests that the current selection be expanded up by one line.
Public property Static member SelectUpByPage Represents the SelectUpByPage command, which requests that the current selection be expanded up by one page.
Public property Static member SelectUpByParagraph Represents the SelectUpByParagraph command, which requests that the current selection be expanded up by one paragraph.
Public property Static member TabBackward Represents the TabBackward command.
Public property Static member TabForward Represents the TabForward command.
Public property Static member ToggleBold Represents the ToggleBold command, which requests that Bold formatting be toggled on the current selection.
Public property Static member ToggleBullets Represents the ToggleBullets command, which requests that unordered list (also referred to as bulleted list) formatting be toggled on the current selection.
Public property Static member ToggleInsert Represents the ToggleInsert command, which toggles the typing mode between Insert and Overtype.
Public property Static member ToggleItalic Represents the ToggleItalic command, which requests that Italic formatting be toggled on the current selection.
Public property Static member ToggleNumbering Represents the ToggleNumbering command, which requests that ordered list (also referred to as numbered list) formatting be toggled on the current selection.
Public property Static member ToggleSubscript Represents the ToggleSubscript command, which requests that subscript formatting be toggled on the current selection.
Public property Static member ToggleSuperscript Represents the ToggleSuperscript command, which requests that superscript formatting be toggled on the current selection.
Public property Static member ToggleUnderline Represents the ToggleUnderline command, which requests that Underline formatting be toggled on the current selection.
Top

The following table shows the editing commands and the associated default key gestures (with key names from the Key and ModifierKeys enumerations).

Editing command

Default key gesture

AlignCenter

Ctrl +E

AlignJustify

Ctrl +J

AlignLeft

Ctrl +L

AlignRight

Ctrl +R

Backspace

Backspace

CorrectSpellingError

no default key gesture

DecreaseFontSize

Ctrl +OemOpenBrackets

DecreaseIndentation

Ctrl +Shift+T

Delete

Delete

DeleteNextWord

Ctrl +Delete

DeletePreviousWord

Ctrl +Backspace

EnterLineBreak

Shift +Enter

EnterParagraphBreak

Enter

IgnoreSpellingError

no default key gesture

IncreaseFontSize

Ctrl +OemCloseBrackets

IncreaseIndentation

Ctrl +T

MoveDownByLine

Down

MoveDownByPage

PageDown

MoveDownByParagraph

Ctrl +Down

MoveLeftByCharacter

Left

MoveLeftByWord

Ctrl +Left

MoveRightByCharacter

Right

MoveRightByWord

Ctrl +Right

MoveToDocumentEnd

Ctrl +End

MoveToDocumentStart

Ctrl +Home

MoveToLineEnd

End

MoveToLineStart

Home

MoveUpByLine

Up

MoveUpByPage

PageUp

MoveUpByParagraph

Ctrl +Up

SelectDownByLine

Shift +Down

SelectDownByPage

Shift +PageDown

SelectDownByParagraph

Ctrl +Shift+Down

SelectLeftByCharacter

Shift +Left

SelectLeftByWord

Ctrl +Shift+Left

SelectRightByCharacter

Shift +Right

SelectRightByWord

Ctrl +Shift+Right

SelectToDocumentEnd

Ctrl +Shift+End

SelectToDocumentStart

Ctrl +Shift+Home

SelectToLineEnd

Shift +End

SelectToLineStart

Shift +Home

SelectUpByLine

Shift +Up

SelectUpByPage

Shift +PageUp

SelectUpByParagraph

Ctrl +Shift+Up

TabBackward

Shift +Tab

TabForward

Tab

ToggleBold

Ctrl +B

ToggleBullets

Ctrl +Shift+L

ToggleInsert

Insert

ToggleItalic

Ctrl +I

ToggleNumbering

Ctrl +Shift+N

ToggleSubscript

Ctrl +OemPlus

ToggleSuperscript

Ctrl +Shift+OemPlus

ToggleUnderline

Ctrl +U

Caret movement commands and selection expanding commands share a common set of default key gestures, the general difference being the addition of the Shift key to differentiate selection commands from caret movement commands. For example, the MoveLeftByCharacter command has a default key gesture of Left, and the corresponding SelectLeftByCharacter command has a default key gesture of Shift+Left.

In general, the command definitions provided by the EditingCommands class do not make use of command parameters (the parameter parameter expected by the Execute method).

For more information on commands and commanding, see Input Overview.

The following example demonstrates how to invoke an editing command on an object that supports the command.

For this example, a RichTextBox serves as the command target. Note that RichTextBox implements the IInputElement interface (inherited from FrameworkElement), and that it includes native support for many editing commands.

The first argument for the Execute method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be null for editing commands.

The second argument specifies the object to which the command will be routed. This object must implement the IInputElement interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command.

C#
VB
Copy 

RichTextBox rTB = new RichTextBox();

EditingCommands.ToggleInsert.Execute(null, rTB);

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ