SearchSettingsDataSource Class

Article
07/12/2014

This class represents the search settings used by the Visual Studio common search control.

Inheritance Hierarchy

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

Namespace: Microsoft.VisualStudio.PlatformUI
Assembly: Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.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
	SearchSettingsDataSource	Creates a new instance of the Visual Studio common search control’s search settings class.

Top

Properties

	Name	Description
	ControlMaxWidth	Gets or sets the property indicating the maximum width of the Visual Studio common search control. Default is 400.
	ControlMinPopupWidth	Gets or sets the value indicating the minimum width used by the Visual Studio common search control for displaying popups. Default is 200.
	ControlMinWidth	Gets or sets the value indicating the minimum width of the Visual Studio common search control. Default is 100.
	ForwardEnterKeyOnSearchStart	Gets or sets the flag indicating whether the Visual Studio 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.
	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 Visual Studio common search control. Default is 5 items..
	RestartSearchIfUnchanged	Gets or sets a flag indicating 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	Gets or sets a flag indicating whether the search button is visible in the Visual Studio common search control. Default is true; the button is visible.
	SearchClearTooltip	Gets or sets the value indicating the search button tooltip to display after a search is complete. Default is “Clear search”.
	SearchPopupAutoDropdown	Gets or sets a flag indicating whether the search popup is automatically shown when the user begins typing. This is only relevant for delayed and on-demand searches in the Visual Studio common search control. Default is true; the search popup is automatically shown.
	SearchPopupCloseDelay	Gets or sets the value indicating 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 value indicating 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 value indicating the progress type supported by the Visual Studio 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 value indicating the delay, in milliseconds, until a delayed search starts automatically in the Visual Studio common search control. Default is 1,000 milliseconds.
	SearchStartMinChars	Gets or sets the value indicating the minimum number of characters for relevance in a search. The Visual Studio 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 value indicating the search button tooltip to display before the Visual Studio common search control starts a search. Default is “Search”.
	SearchStartType	Gets or sets the value indicating the search start type of the Visual Studio 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 value indicating the search button tooltip to display during a search by the Visual Studio 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	Gets or sets the flag indicating whether the Visual Studio 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	Gets or sets a flag indicating 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 value indicating the string to display in the Visual Studio common search control when it is empty and does not have the focus. Default is “Search”.
	UseDefaultThemeColors

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(GelProperty)	Microsoft internal use only. Gets the value of the given [GelProperty] for this [GelDependencyObject]. (Inherited from GelDependencyObject.)
	Invoke(String, Object)	Microsoft internal use only. Invokes a given [GelVerb] defined in this [GelDependencyObject]. (Inherited from GelDependencyObject.)
	Invoke(GelVerb, Object)	Microsoft internal use only. Invokes a given [GelVerb] defined in this [GelDependencyObject]. (Inherited from GelDependencyObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnClose	Microsoft internal use only. (Inherited from GelDependencyObject.)
	OnPropertyChanged	Microsoft internal use only. (Inherited from GelDependencyObject.)
	ResetValue	Microsoft internal use only. Resets the value of the given [GelProperty] for this [GelDependencyObject] to its default value. (Inherited from GelDependencyObject.)
	SetValue(GelProperty, Boolean)	(Inherited from GelDependencyObject.)
	SetValue(GelProperty, Object)	Microsoft internal use only. Sets the value of the given [GelProperty] for this [GelDependencyObject]. (Inherited from GelDependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	ControlMaxWidthProperty
	ControlMinPopupWidthProperty
	ControlMinWidthProperty
	ForwardEnterKeyOnSearchStartProperty
	MaximumMRUItemsProperty
	RestartSearchIfUnchangedProperty
	SearchButtonVisibleProperty
	SearchClearTooltipProperty
	SearchPopupAutoDropdownProperty
	SearchPopupCloseDelayProperty
	SearchProgressShowDelayProperty
	SearchProgressTypeProperty
	SearchStartDelayProperty
	SearchStartMinCharsProperty
	SearchStartTooltipProperty
	SearchStartTypeProperty
	SearchStopTooltipProperty
	SearchTooltipProperty
	SearchTrimsWhitespacesProperty
	SearchUseMRUProperty
	SearchWatermarkProperty
	UseDefaultThemeColorsProperty

Top

Explicit Interface Implementations

	Name	Description
	IVsUIDataSource.AdvisePropertyChangeEvents	Microsoft internal use only. Registers to be notified when a property changes. (Inherited from GelDependencyObject.)
	IVsUIDataSource.Close	Microsoft internal use only. Closes this data source. (Inherited from GelDependencyObject.)
	IVsUIDataSource.EnumProperties	Microsoft internal use only. Returns an enumeration of the available properties. (Inherited from GelDependencyObject.)
	IVsUIDataSource.EnumVerbs	Microsoft internal use only. Returns an enumeration of verbs for the data source. (Inherited from GelDependencyObject.)
	IVsUIDataSource.GetShapeIdentifier	Microsoft internal use only. Returns the shape identifier for this data source. Two data sources with the same shape identifier will have exactly the same properties and verbs. (Inherited from GelDependencyObject.)
	IVsUIDataSource.GetValue	Microsoft internal use only. Returns the value of a property. (Inherited from GelDependencyObject.)
	IVsUIDataSource.Invoke	Microsoft internal use only. Invokes a verb on the data source. (Inherited from GelDependencyObject.)
	IVsUIDataSource.QueryValue	Microsoft internal use only. Returns the type, format and value of a property. (Inherited from GelDependencyObject.)
	IVsUIDataSource.ResetValue	Microsoft internal use only. Sets a property to its default value. (Inherited from GelDependencyObject.)
	IVsUIDataSource.SetValue	Microsoft internal use only. Sets a property to a value. (Inherited from GelDependencyObject.)
	IVsUIDataSource.UnadvisePropertyChangeEvents	Microsoft internal use only. Stops receiving notifications when properties change. (Inherited from GelDependencyObject.)
	IVsUIDispatch.EnumVerbs	Microsoft internal use only. Lists the verbs in a data source. (Inherited from GelDependencyObject.)
	IVsUIDispatch.Invoke	Microsoft internal use only. Invokes a verb on a data source. (Inherited from GelDependencyObject.)
	IVsUISimpleDataSource.Close	Microsoft internal use only. Closes the data source. (Inherited from GelDependencyObject.)
	IVsUISimpleDataSource.EnumVerbs	Microsoft internal use only. Returns a enumeration of verbs for the data source. (Inherited from GelDependencyObject.)
	IVsUISimpleDataSource.Invoke	Microsoft internal use only. Executes a verb on the data source. (Inherited from GelDependencyObject.)

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.

Share via