Share via

SearchSettingsDataSource Class

  • Article

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

Inheritance Hierarchy

Object
  GelDependencyObject
    Microsoft.VisualStudio.PlatformUI.SearchSettingsDataSource

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

Syntax

'Declaration
Public Class SearchSettingsDataSource _
    Inherits GelDependencyObject

public class SearchSettingsDataSource : GelDependencyObject

public ref class SearchSettingsDataSource : public GelDependencyObject

type SearchSettingsDataSource =  
    class 
        inherit GelDependencyObject 
    end

public class SearchSettingsDataSource extends GelDependencyObject

The SearchSettingsDataSource type exposes the following members.

Constructors

  Name Description
Public method SearchSettingsDataSource Creates a new instance of the common search control’s search settings class.

Top

Properties

  Name Description
Public property ControlBorderThickness Gets or sets the thickness of the search control's border. Type: VSUI_TYPE_STRING. Default="1".
Public property ControlMaxWidth Gets or sets the property indicating the maximum width of the common search control. Default is 400.
Public property ControlMinPopupWidth Gets or sets the value indicating the minimum width used by the common search control for displaying popups. Default is 200.
Public property ControlMinWidth Gets or sets the value indicating the minimum width of the common search control. Default is 100.
Public property DefaultTheme Gets the default theme.
Public property 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.
Public property 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.
Public property 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..
Public property PrefixFilterMRUItems The name of the property indicating the maximum number of MRU items to show in the popup. VSUI_TYPE_DWORD. Default=5.
Public property 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.
Public property SearchButtonVisible Determines whether the search button is visible in the common search control. Default is true; the button is visible.
Public property SearchClearTooltip Gets or sets the search button tooltip to display after a search is complete. Default is “Clear search”.
Public property 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.
Public property 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.
Public property 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.
Public property 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).
Public property SearchStartDelay Gets or sets the delay, in milliseconds, until a delayed search starts automatically in the common search control. Default is 1,000 milliseconds.
Public property 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.
Public property SearchStartTooltip Gets or sets the search button tooltip to display before the common search control starts a search. Default is “Search”.
Public property 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).
Public property SearchStopTooltip Gets or sets the search button tooltip to display during a search by the common search control. Default is “Stop search”.
Public property 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”.
Public property 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.
Public property 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.
Public property 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”.
Public property 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.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic member ControlBorderThicknessProperty The name of the property that indicates the Thickness of the search control's border. Type: VSUI_TYPE_STRING. Default="1".
Public fieldStatic member ControlMaxWidthProperty The name of the property that indicates the maximum width of the search control. Type: VSUI_TYPE_DWORD. Default=400.
Public fieldStatic member ControlMinPopupWidthProperty The property indicating the minimum width of the search control's popup. VSUI_TYPE_DWORD. Default=200.
Public fieldStatic member ControlMinWidthProperty The name of the property that indicates the minimum width of the search control. Type: VSUI_TYPE_DWORD. Default=100.
Public fieldStatic member DefaultThemeProperty The name of the DefaultTheme property.
Public fieldStatic member 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.
Public fieldStatic member 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.
Public fieldStatic member 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.
Public fieldStatic member PrefixFilterMRUItemsProperty The name of the PrefixFilterMRUItems property.
Public fieldStatic member 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.
Public fieldStatic member SearchButtonVisibleProperty The name of the property that indicates whether the search button is visible in the search control. Type: VSUI_TYPE_BOOL. Default=True.
Public fieldStatic member SearchClearTooltipProperty The name of the property indicates the tooltip for the search button after a search is complete. VSUI_TYPE_STRING. Default="Clear search".
Public fieldStatic member 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.
Public fieldStatic member 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.
Public fieldStatic member SearchProgressShowDelayProperty
Public fieldStatic member SearchProgressTypeProperty The name of the property that indicates the progress type supported by the window search. Type: VSUI_TYPE_DWORD(VSSEARCHPROGRESSTYPE). Default=SPT_INDETERMINATE.
Public fieldStatic member 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.
Public fieldStatic member 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.
Public fieldStatic member SearchStartTooltipProperty The name of the property that indicates the tooltip for the search button before starting the search. Type: VSUI_TYPE_STRING. Default="Search".
Public fieldStatic member SearchStartTypeProperty The name of the property that indicates the search start type (instant/delayed/ondemand). Type: VSUI_TYPE_DWORD(VSSEARCHSTARTTYPE). Default=SST_DELAYED.
Public fieldStatic member 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".
Public fieldStatic member 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".
Public fieldStatic member 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.
Public fieldStatic member 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.
Public fieldStatic member SearchWatermarkProperty The string displayed in the search box when it's empty and doesn't have the focus. Type: VSUI_TYPE_STRING. Default="Search".
Public fieldStatic member 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.

Top

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.PlatformUI Namespace