EditingCommands.ToggleUnderline Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the ToggleUnderline command, which requests that Underline formatting be toggled on the current selection.
public:
static property System::Windows::Input::RoutedUICommand ^ ToggleUnderline { System::Windows::Input::RoutedUICommand ^ get(); };public static System.Windows.Input.RoutedUICommand ToggleUnderline { get; }static member ToggleUnderline : System.Windows.Input.RoutedUICommandPublic Shared ReadOnly Property ToggleUnderline As RoutedUICommandProperty Value
The requested command. The default key gesture for this command is Ctrl+U.
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
When the selection is empty and the caret is within a word, the selection is expanded to include the entire word.
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.
XAML Attribute Usage
<object property="ToggleUnderline"/>
