SearchSettingsDataSource Properties

 

Namespace:   Microsoft.VisualStudio.PlatformUI
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

NameDescription
System_CAPS_pubpropertyControlBorderThickness

Gets or sets the thickness of the search control's border. Type: VSUI_TYPE_STRING. Default="1".

System_CAPS_pubpropertyControlMaxWidth

Gets or sets the property indicating the maximum width of the common search control. Default is 400.

System_CAPS_pubpropertyControlMinPopupWidth

Gets or sets the value indicating the minimum width used by the common search control for displaying popups. Default is 200.

System_CAPS_pubpropertyControlMinWidth

Gets or sets the value indicating the minimum width of the common search control. Default is 100.

System_CAPS_pubpropertyDefaultTheme

Gets the default theme.

System_CAPS_pubpropertyForwardEnterKeyOnSearchStart

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.

System_CAPS_pubpropertyHwndSourceBackgroundColor

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.

System_CAPS_pubpropertyMaximumMRUItems

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.

.

System_CAPS_pubpropertyPrefixFilterMRUItems

The name of the property indicating the maximum number of MRU items to show in the popup. VSUI_TYPE_DWORD. Default=5.

System_CAPS_pubpropertyRestartSearchIfUnchanged

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.

System_CAPS_pubpropertySearchButtonVisible

Determines whether the search button is visible in the common search control. Default is true; the button is visible.

System_CAPS_pubpropertySearchClearTooltip

Gets or sets the search button tooltip to display after a search is complete. Default is “Clear search”.

System_CAPS_pubpropertySearchPopupAutoDropdown

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.

System_CAPS_pubpropertySearchPopupCloseDelay

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.

System_CAPS_pubpropertySearchProgressShowDelay

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.

System_CAPS_pubpropertySearchProgressType

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).

System_CAPS_pubpropertySearchStartDelay

Gets or sets the delay, in milliseconds, until a delayed search starts automatically in the common search control. Default is 1,000 milliseconds.

System_CAPS_pubpropertySearchStartMinChars

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.

System_CAPS_pubpropertySearchStartTooltip

Gets or sets the search button tooltip to display before the common search control starts a search. Default is “Search”.

System_CAPS_pubpropertySearchStartType

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).

System_CAPS_pubpropertySearchStopTooltip

Gets or sets the search button tooltip to display during a search by the common search control. Default is “Stop search”.

System_CAPS_pubpropertySearchTooltip

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”.

System_CAPS_pubpropertySearchTrimsWhitespaces

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.

System_CAPS_pubpropertySearchUseMRU

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.

System_CAPS_pubpropertySearchWatermark

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”.

System_CAPS_pubpropertyUseDefaultThemeColors

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.

Return to top
Show: