NavigationCommands.Search Property

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.dll

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.

Gets the value that represents the Search command.

public:
 static property System::Windows::Input::RoutedUICommand ^ Search { System::Windows::Input::RoutedUICommand ^ get(); };

public static System.Windows.Input.RoutedUICommand Search { get; }

static member Search : System.Windows.Input.RoutedUICommand

Public Shared ReadOnly Property Search As RoutedUICommand

Property Value

RoutedUICommand

The routed UI command.

Default Values
Key Gesture	F3
UI Text	Search

Examples

The following example shows how to implement code that responds to the Search command in conjunction with a FlowDocumentPageViewer.

<Window
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  x:Class="SDKSample.Search">

  <Window.CommandBindings>
    <CommandBinding
      Command="NavigationCommands.Search"
      CanExecute="navigationCommandSearch_CanExecute"
      Executed="navigationCommandSearch_Executed" />
  </Window.CommandBindings>

<!-- NavigationCommands.Search -->
<MenuItem Command="NavigationCommands.Search" />

<FlowDocumentPageViewer Name="flowDocumentPageViewer">
  <FlowDocument>
    <!-- Document Content-->
    <Paragraph>
      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Sed vulputate, lacus non sagittis pharetra, diam dolor dictum tellus, et hendrerit odio risus nec erat. Nam sollicitudin imperdiet mi. Sed rutrum. Morbi vel nunc. Donec imperdiet. Morbi hendrerit leo. Maecenas imperdiet. Curabitur viverra tempor nisi. Phasellus vitae augue sit amet neque venenatis elementum. Proin posuere lobortis quam. Curabitur et neque. Donec ac sem vitae libero pharetra luctus. Fusce purus. Nulla vehicula, leo commodo dictum lobortis, odio augue accumsan ante, id dictum nisi libero quis diam. Nam augue erat, malesuada eu, tincidunt eu, dictum ut, ante. In vel magna vel ligula faucibus lobortis. Praesent a felis non mi fringilla vulputate. Integer quis tellus cursus elit tincidunt vehicula. Morbi commodo sem eu eros. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae;
    </Paragraph>

  </FlowDocument>
</FlowDocumentPageViewer>

</Window>

using System.Windows;
using System.Windows.Input;

namespace SDKSample
{
    public partial class Search : Window
    {
        public Search()
        {
            InitializeComponent();
        }

        void navigationCommandSearch_CanExecute(object sender, CanExecuteRoutedEventArgs e)
        {
            // Can search of there is a document
            e.CanExecute = (this.flowDocumentPageViewer.Document != null);
        }

        void navigationCommandSearch_Executed(object target, ExecutedRoutedEventArgs e)
        {
            // Implement custom Search handling code
        }
    }
}


Namespace SDKSample
    Partial Public Class Search
        Inherits Window
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub navigationCommandSearch_CanExecute(ByVal sender As Object, ByVal e As CanExecuteRoutedEventArgs)
            ' Can search of there is a document
            e.CanExecute = (Me.flowDocumentPageViewer.Document IsNot Nothing)
        End Sub

        Private Sub navigationCommandSearch_Executed(ByVal target As Object, ByVal e As ExecutedRoutedEventArgs)
            ' Implement custom Search handling code
        End Sub
    End Class
End Namespace

Remarks

This command indicates the intention to search.

There is no implementation for responding to the Search command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example.

XAML Attribute Usage

<object property="NavigationCommands.Search"/>

Applies to