SearchSettingsDataSource Class

 

Represents the search settings used by the Visual Studio common search control.

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

System.Object
  Microsoft.Internal.VisualStudio.PlatformUI.GelDependencyObject
    Microsoft.VisualStudio.PlatformUI.SearchSettingsDataSource

public class SearchSettingsDataSource : GelDependencyObject

NameDescription
System_CAPS_pubmethodSearchSettingsDataSource()

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

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.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticControlBorderThicknessProperty

The name of the property that indicates the Thickness of the search control's border. Type: VSUI_TYPE_STRING. Default="1".

System_CAPS_pubfieldSystem_CAPS_staticControlMaxWidthProperty

The name of the property that indicates the maximum width of the search control. Type: VSUI_TYPE_DWORD. Default=400.

System_CAPS_pubfieldSystem_CAPS_staticControlMinPopupWidthProperty

The property indicating the minimum width of the search control's popup. VSUI_TYPE_DWORD. Default=200.

System_CAPS_pubfieldSystem_CAPS_staticControlMinWidthProperty

The name of the property that indicates the minimum width of the search control. Type: VSUI_TYPE_DWORD. Default=100.

System_CAPS_pubfieldSystem_CAPS_staticDefaultThemeProperty

The name of the DefaultTheme property.

System_CAPS_pubfieldSystem_CAPS_staticForwardEnterKeyOnSearchStartProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticHwndSourceBackgroundColorProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticMaximumMRUItemsProperty

The name of the property that indicates the maximum number of MRU items to show in the popup. Type: VSUI_TYPE_DWORD. Default=5.

System_CAPS_pubfieldSystem_CAPS_staticPrefixFilterMRUItemsProperty

The name of the PrefixFilterMRUItems property.

System_CAPS_pubfieldSystem_CAPS_staticRestartSearchIfUnchangedProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticSearchButtonVisibleProperty

The name of the property that indicates whether the search button is visible in the search control. Type: VSUI_TYPE_BOOL. Default=True.

System_CAPS_pubfieldSystem_CAPS_staticSearchClearTooltipProperty

The name of the property indicates the tooltip for the search button after a search is complete. VSUI_TYPE_STRING. Default="Clear search".

System_CAPS_pubfieldSystem_CAPS_staticSearchPopupAutoDropdownProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticSearchPopupCloseDelayProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticSearchProgressShowDelayProperty

System_CAPS_pubfieldSystem_CAPS_staticSearchProgressTypeProperty

The name of the property that indicates the progress type supported by the window search. Type: VSUI_TYPE_DWORD(VSSEARCHPROGRESSTYPE). Default=SPT_INDETERMINATE.

System_CAPS_pubfieldSystem_CAPS_staticSearchStartDelayProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticSearchStartMinCharsProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticSearchStartTooltipProperty

The name of the property that indicates the tooltip for the search button before starting the search. Type: VSUI_TYPE_STRING. Default="Search".

System_CAPS_pubfieldSystem_CAPS_staticSearchStartTypeProperty

The name of the property that indicates the search start type (instant/delayed/ondemand). Type: VSUI_TYPE_DWORD(VSSEARCHSTARTTYPE). Default=SST_DELAYED.

System_CAPS_pubfieldSystem_CAPS_staticSearchStopTooltipProperty

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

System_CAPS_pubfieldSystem_CAPS_staticSearchTooltipProperty

The name of the property that indicates the tooltip for the search edit box. Type: VSUI_TYPE_STRING. Default="Type words to search for".

System_CAPS_pubfieldSystem_CAPS_staticSearchTrimsWhitespacesProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticSearchUseMRUProperty

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.

System_CAPS_pubfieldSystem_CAPS_staticSearchWatermarkProperty

The string displayed in the search box when it's empty and doesn't have the focus. Type: VSUI_TYPE_STRING. Default="Search".

System_CAPS_pubfieldSystem_CAPS_staticUseDefaultThemeColorsProperty

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: