EditingCommands.EnterParagraphBreak Property

Definition

Represents the EnterParagraphBreak command, which requests that a paragraph break be inserted at the current position or over the current selection.

public:
 static property System::Windows::Input::RoutedUICommand ^ EnterParagraphBreak { System::Windows::Input::RoutedUICommand ^ get(); };
public static System.Windows.Input.RoutedUICommand EnterParagraphBreak { get; }
member this.EnterParagraphBreak : System.Windows.Input.RoutedUICommand
Public Shared ReadOnly Property EnterParagraphBreak As RoutedUICommand

Property Value

The requested command. The default key gesture for this command is Enter.

Examples

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.

RichTextBox rTB = new RichTextBox();

EditingCommands.ToggleInsert.Execute(null, rTB);
Dim rTB As New RichTextBox()

EditingCommands.ToggleInsert.Execute(Nothing, rTB)

Remarks

This command is equivalent to the user pressing the ENTER key.

There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer.

This command is natively supported by RichTextBox and TextBox (when the AcceptsReturn property is true).

Important

This command has no effect on a text element unless the AcceptsReturn property of the text element is set to true.

XAML Attribute Usage

<object property="EnterParagraphBreak"/>  

Applies to

See also