SearchSettingsDataSource 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.9.37000

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.

Data source class for the search settings used by the search control

public ref class SearchSettingsDataSource : Microsoft::Internal::VisualStudio::PlatformUI::GelDependencyObject

[Windows::Foundation::Metadata::WebHostHidden]
class SearchSettingsDataSource : Microsoft::Internal::VisualStudio::PlatformUI::GelDependencyObject

public class SearchSettingsDataSource : Microsoft.Internal.VisualStudio.PlatformUI.GelDependencyObject

type SearchSettingsDataSource = class
    inherit GelDependencyObject

Public Class SearchSettingsDataSource
Inherits GelDependencyObject

Inheritance: Microsoft.Internal.VisualStudio.PlatformUI.GelDependencyObject
SearchSettingsDataSource

Constructors

SearchSettingsDataSource()

Creates a new instance of the common search control’s search settings class.

Fields

ControlBorderThicknessProperty	The name of the property that indicates the Thickness of the search control's border. Type: VSUI_TYPE_STRING. Default="1".
ControlMaxWidthProperty	The name of the property that indicates the maximum width of the search control. Type: VSUI_TYPE_DWORD. Default=400.
ControlMinPopupWidthProperty	The property indicating the minimum width of the search control's popup. VSUI_TYPE_DWORD. Default=200.
ControlMinWidthProperty	The name of the property that indicates the minimum width of the search control. Type: VSUI_TYPE_DWORD. Default=100.
ControlPaddingThicknessProperty
DefaultThemeProperty	The name of the DefaultTheme property.
ForwardEnterKeyOnSearchStartProperty	The name of the property that indicates whether the search control forwards the enter key event after search is started. Type: VSUI_TYPE_BOOL. Default=False.
HwndSourceBackgroundColorProperty	The name of the property that represents an ARGB background color for the HwndSource. This setting is ignored if it is 0, or if the search control is parented under a WPF element. VSUI_TYPE_DWORD, Default=0.
LiveSettingProperty
MaximumMRUItemsProperty	The name of the property that indicates the maximum number of MRU items to show in the popup. Type: VSUI_TYPE_DWORD. Default=5.
PrefixFilterMRUItemsProperty	The name of the PrefixFilterMRUItems property.
RestartSearchIfUnchangedProperty	The name of the property that indicates whether the search will be restarted on pressing Enter or selecting MRU item from the list, even if the search string is not changed. Type: VSUI_TYPE_BOOL. Default=False.
SearchButtonVisibleProperty	The name of the property that indicates whether the search button is visible in the search control. Type: VSUI_TYPE_BOOL. Default=True.
SearchClearTooltipProperty	The name of the property indicates the tooltip for the search button after a search is complete. VSUI_TYPE_STRING. Default="Clear search".
SearchPopupAutoDropdownProperty	The name of the property that indicates whether the search popup is automatically shown on typing (for delayed and on-demand searches only). Type: VSUI_TYPE_BOOL. Default=True.
SearchPopupCloseDelayProperty	The name of the property that indicates the delay in milliseconds after a search is automatically started after which the search popup is automatically closed. Type: VSUI_TYPE_DWORD. Default=4000ms.
SearchProgressShowDelayProperty
SearchProgressTypeProperty	The name of the property that indicates the progress type supported by the window search. Type: VSUI_TYPE_DWORD(VSSEARCHPROGRESSTYPE). Default=SPT_INDETERMINATE.
SearchStartDelayProperty	The name of the property that indicates the delay in milliseconds after which a search starts automatically (for delayed search type). Type: VSUI_TYPE_DWORD. Default=1000ms.
SearchStartMinCharsProperty	The name of the property that indicates the minimum number of characters that have relevance for the window search. The window host waits for the user to type at least the minimum number of characters before calling IVsWindowSearch to start a new search. Type; VSUI_TYPE_DWORD. Default=1.
SearchStartTooltipProperty	The name of the property that indicates the tooltip for the search button before starting the search. Type: VSUI_TYPE_STRING. Default="Search".
SearchStartTypeProperty	The name of the property that indicates the search start type (instant/delayed/ondemand). Type: VSUI_TYPE_DWORD(VSSEARCHSTARTTYPE). Default=SST_DELAYED.
SearchStopTooltipProperty	The name of the property that indicates the tooltip for the search button while the search is performed. Type: VSUI_TYPE_STRING. Default="Stop search".
SearchTooltipProperty	The name of the property that indicates the tooltip for the search edit box. Type: VSUI_TYPE_STRING. Default="Type words to search for".
SearchTrimsWhitespacesProperty	The name of the property that indicates whether the search string has whitespaces trimmed from beginning and end before starting a search or adding the item to MRU list. Type: VSUI_TYPE_BOOL. Default=True.
SearchUseMRUProperty	The name of the property that indicates whether the search control should display MRU items in the drop-down popup. Type VSUI_TYPE_BOOL. Default=True.
SearchWatermarkProperty	The string displayed in the search box when it's empty and doesn't have the focus. Type: VSUI_TYPE_STRING. Default="Search".
SearchWatermarkWhenFocusedProperty
UseDefaultThemeColorsProperty	The name of the property that indicates whether the search control should use only the colors of the default theme. This is usually set to true when the search control is hosted in a dialog whose colors don't change when the IDE theme changes. Type: VSUI_TYPE_BOOL. Default=False.

Properties

ControlBorderThickness	Gets or sets the thickness of the search control's border. Type: VSUI_TYPE_STRING. Default="1".
ControlMaxWidth	Gets or sets the property indicating the maximum width of the common search control. Default is 400.
ControlMinPopupWidth	Gets or sets the value indicating the minimum width used by the common search control for displaying popups. Default is 200.
ControlMinWidth	Gets or sets the value indicating the minimum width of the common search control. Default is 100.
ControlPaddingThickness
DefaultTheme	Gets the default theme.
ForwardEnterKeyOnSearchStart	Gets or sets the flag indicating whether the common search control forwards the `enter-key` event after a search is started. Default is `false`, indicating that the `enter-key` event is not forwarded by the control.
HwndSourceBackgroundColor	Gets an ARGB background color for the HwndSource. This setting is ignored if it is 0, or if the search control is parented under a WPF element. Type: VSUI_TYPE_DWORD, Default=0.
LiveSetting
MaximumMRUItems	Gets or sets the value indicating the maximum number of most-recently-used (MRU) items to show in the drop-down list of the common search control. Default is 5 items..
PrefixFilterMRUItems	The name of the property indicating the maximum number of MRU items to show in the popup. VSUI_TYPE_DWORD. Default=5.
RestartSearchIfUnchanged	Determines whether searches will be restarted, even if the search string is not changed, by pressing Enter or selecting a most-recently-used (MRU) item from the list. Default is `false`; the search will not be restarted.
SearchButtonVisible	Determines whether the search button is visible in the common search control. Default is `true`; the button is visible.
SearchClearTooltip	Gets or sets the search button tooltip to display after a search is complete. Default is “Clear search”.
SearchPopupAutoDropdown	Determines whether the search popup is automatically shown when the user begins typing. This is only relevant for delayed and on-demand searches in the common search control. Default is `true`; the search popup is automatically shown.
SearchPopupCloseDelay	Gets or sets the delay, in milliseconds, after a search is automatically started in the search control, until the search popup is automatically closed. Default is 4,000 milliseconds.
SearchProgressShowDelay	Gets or sets the delay, in milliseconds, after a search is started in the search control, until the progress indicator automatically displays. This delay enables fast searches to complete without showing progress. Default is 200 milliseconds.
SearchProgressType	Gets or sets the progress type supported by the common search control. Default is 0 `SPT_INDETERMINATE`, indicating the search will be an infinite-loop animation, because exact search progress cannot be determined. Value can be 0 (SPT_NONE, no display), 1 (SPT_INDETERMINATE, infinite-loop animation) or 2 (SPT_DETERMINATE, 0-100% progress bar).
SearchStartDelay	Gets or sets the delay, in milliseconds, until a delayed search starts automatically in the common search control. Default is 1,000 milliseconds.
SearchStartMinChars	Gets or sets the minimum number of characters for relevance in a search. The common search control will wait to start a new search until the user types at least the minimum number of characters. Default is 1 character.
SearchStartTooltip	Gets or sets the search button tooltip to display before the common search control starts a search. Default is “Search”.
SearchStartType	Gets or sets the search start type of the common search control. Default is delayed; start type can be instant(`SST_INSTANT`), delayed(`SST_DELAYED`) or on-demand(`SST_ONDEMAND`).
SearchStopTooltip	Gets or sets the search button tooltip to display during a search by the common search control. Default is “Stop search”.
SearchTooltip	Gets or sets the value indicating the tooltip for the search box of the Visual Studio common search control. Default is “Type words to search for”.
SearchTrimsWhitespaces	Determines whether the common search control trims whitespace from the beginning and end of the search string before starting a search or adding the item to the most-recently-used (MRU) list. Default is `true`; whitespace is trimmed from the string before it is used.
SearchUseMRU	Determines whether the Visual Studio common search control displays most-recently-used (MRU) items in the drop-down list. Default is `true`; the drop-down list is displayed.
SearchWatermark	Gets or sets the string to display in the common search control when it is empty and does not have the focus. Default is “Search”.
SearchWatermarkWhenFocused
UseDefaultThemeColors	Determines whether the search control should only use the colors of the default theme. This is usually set to true when the search control is hosted in a dialog whose colors don't change when the IDE theme changes. Type: VSUI_TYPE_BOOL. Default=False.

Applies to