SearchPopupNavigationService Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.PlatformUI

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

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.

Helper class providing navigation support and tracking of current location amongst the navigable child controls of a search control's popup

public ref class SearchPopupNavigationService abstract sealed

public ref class SearchPopupNavigationService abstract sealed

class SearchPopupNavigationService abstract sealed

public static class SearchPopupNavigationService

type SearchPopupNavigationService = class

Public Class SearchPopupNavigationService

Inheritance: Object
SearchPopupNavigationService

Fields

CurrentLocationProperty	CurrentLocation property is set internally and tracks the current navigation location within a popup
CurrentLocationSetModeProperty	CurrentLocationSetMode property is set automatically to track how CurrentLocation was last changed (by keyboard/mouse)
IsCurrentLocationProperty	IsCurrentLocation property can be set on popup child elements to make that element the active location in the popup (sets CurrentLocation for the popup). Also, the IsCurrentLocation property on the previous active location (if any) will be automatically cleared.
IsNavigableProperty	IsNavigable property can be set on popup child elements to indicate they are valid navigation stops. Setting it on a popup child element also registers the control to be automatically made the current navigation location when the control is hovered or clicked.
IsNavigationEnabledProperty	IsNavigationEnabled property can be set on a popup to enable or disable changes to the current location

Attached Properties

CurrentLocation	Gets or sets the current navigation location within this popup.
CurrentLocationSetMode	Gets or sets the property that tracks whether the CurrentLocation was last changed by keyboard or by mouse.
IsCurrentLocation	Gets or sets the flag indicating whether this element is the current location.
IsNavigable	Gets or sets the flag indicating whether it is possible to navigate to this element.
IsNavigationEnabled	Gets or sets the flag indicating whether navigation is enabled on this popup.

Methods

GetCurrentLocation(Popup)	Returns the current navigation location in a search control's popup when the popup is open
GetCurrentLocationSetMode(Popup)	Obtains the value tracking whether the CurrentLocation was last changed by keyboard or by mouse.
GetIsCurrentLocation(FrameworkElement)	Gets or sets the flag indicating whether the specified element is the current location.
GetIsNavigable(FrameworkElement)	Gets or sets the flag indicating whether it is possible to navigate to the specified element.
GetIsNavigationEnabled(Popup)	Gets the flag indicating whether navigation is enabled on the specified popup.
SetCurrentLocation(Popup, FrameworkElement)	Sets the current navigation location in a search control’s popup when the popup is open.
SetCurrentLocationSetMode(Popup, CurrentLocationSetMode)	Sets the value which tracks whether the CurrentLocation was last changed by keyboard or by mouse.
SetIsCurrentLocation(FrameworkElement, Boolean)	Sets the flag indicating whether the specified element is the current location.
SetIsNavigable(FrameworkElement, Boolean)	Sets the IsNavigable property.
SetIsNavigationEnabled(Popup, Boolean)	Sets the flag indicating whether navigation is enabled on the popup.

Applies to

Share via