Share via


SearchControlAutomationPeer Class

Exposes UI automation support for the Visual Studio common search control.

Inheritance Hierarchy

Object
  DispatcherObject
    AutomationPeer
      UIElementAutomationPeer
        FrameworkElementAutomationPeer
          Microsoft.VisualStudio.PlatformUI.SearchControlAutomationPeer

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

Syntax

'Declaration
Public Class SearchControlAutomationPeer _
    Inherits FrameworkElementAutomationPeer _
    Implements IExpandCollapseProvider
public class SearchControlAutomationPeer : FrameworkElementAutomationPeer, 
    IExpandCollapseProvider
public ref class SearchControlAutomationPeer : public FrameworkElementAutomationPeer, 
    IExpandCollapseProvider
type SearchControlAutomationPeer =  
    class 
        inherit FrameworkElementAutomationPeer 
        interface IExpandCollapseProvider 
    end
public class SearchControlAutomationPeer extends FrameworkElementAutomationPeer implements IExpandCollapseProvider

The SearchControlAutomationPeer type exposes the following members.

Constructors

  Name Description
Public method SearchControlAutomationPeer Creates a new instance of the class with the specified common search control owner.

Top

Properties

  Name Description
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property EventsSource Gets or sets an AutomationPeer that is reported to the automation client as a source for all the events that come from this AutomationPeer. (Inherited from AutomationPeer.)
Protected property IsHwndHost Gets a value that indicates whether the element that is associated with this AutomationPeer hosts hwnds in Windows Presentation Foundation (WPF). (Inherited from AutomationPeer.)
Public property Owner Gets the UIElement that is associated with this UIElementAutomationPeer. (Inherited from UIElementAutomationPeer.)

Top

Methods

  Name Description
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
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 GetAcceleratorKey Gets the accelerator key combinations for the element that is associated with the UI Automation peer.  (Inherited from AutomationPeer.)
Protected method GetAcceleratorKeyCore Gets the accelerator key for the UIElement that is associated with this UIElementAutomationPeer. This method is called by GetAcceleratorKey. (Inherited from UIElementAutomationPeer.)
Public method GetAccessKey Gets the access key for the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetAccessKeyCore Gets the access key for the UIElement that is associated with this UIElementAutomationPeer.This method is called by GetAccessKey. (Inherited from UIElementAutomationPeer.)
Public method GetAutomationControlType Gets the control type for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected method GetAutomationControlTypeCore When overridden in a derived class, is called by GetAutomationControlType. (Overrides UIElementAutomationPeer.GetAutomationControlTypeCore.)
Public method GetAutomationId Gets the AutomationId of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetAutomationIdCore Gets the string that uniquely identifies the FrameworkElement that is associated with this FrameworkElementAutomationPeer. Called by GetAutomationId. (Inherited from FrameworkElementAutomationPeer.)
Public method GetBoundingRectangle Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetBoundingRectangleCore Gets the Rect that represents the bounding rectangle of the UIElement that is associated with this UIElementAutomationPeer. This method is called by GetBoundingRectangle. (Inherited from UIElementAutomationPeer.)
Public method GetChildren Gets the collection of GetChildren elements that are represented in the UI Automation tree as immediate child elements of the automation peer. (Inherited from AutomationPeer.)
Protected method GetChildrenCore When overridden in a derived class, is called by GetChildren. (Overrides UIElementAutomationPeer.GetChildrenCore.)
Public method GetClassName Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. (Inherited from AutomationPeer.)
Protected method GetClassNameCore When overridden in a derived class, is called by GetClassName. (Overrides UIElementAutomationPeer.GetClassNameCore.)
Public method GetClickablePoint Gets a Point on the element that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer.)
Protected method GetClickablePointCore Gets a Point that represents the clickable space that is on the UIElement that is associated with this UIElementAutomationPeer. This method is called by GetClickablePoint. (Inherited from UIElementAutomationPeer.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetHelpText Gets text that describes the functionality of the control that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetHelpTextCore Gets the string that describes the functionality of the ContentElement that is associated with this ContentElementAutomationPeer. Called by GetHelpText. (Inherited from FrameworkElementAutomationPeer.)
Protected method GetHostRawElementProviderCore Tells UI Automation where in the UI Automation tree to place the hwnd being hosted by a Windows Presentation Foundation (WPF) element. (Inherited from AutomationPeer.)
Public method GetItemStatus Gets text that conveys the visual status of the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method GetItemStatusCore Gets a string that communicates the visual status of the UIElement that is associated with this UIElementAutomationPeer. This method is called by GetItemStatus. (Inherited from UIElementAutomationPeer.)
Public method GetItemType Gets a string that describes what kind of item an object represents. (Inherited from AutomationPeer.)
Protected method GetItemTypeCore Gets a human-readable string that contains the item type that the UIElement for this UIElementAutomationPeer represents. This method is called by GetItemType. (Inherited from UIElementAutomationPeer.)
Public method GetLabeledBy Gets the AutomationPeer for the Label that is targeted to the element. (Inherited from AutomationPeer.)
Protected method GetLabeledByCore Gets the AutomationPeer for the element that is targeted to the UIElement for this UIElementAutomationPeer. This method is called by GetLabeledBy. (Inherited from UIElementAutomationPeer.)
Public method GetLocalizedControlType Gets a human-readable localized string that represents the AutomationControlType value for the control that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method GetLocalizedControlTypeCore When overridden in a derived class, is called by GetLocalizedControlType. (Inherited from AutomationPeer.)
Public method GetName Gets text that describes the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method GetNameCore Gets the text label of the ContentElement that is associated with this ContentElementAutomationPeer. Called by GetName. (Inherited from FrameworkElementAutomationPeer.)
Public method GetOrientation Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
Protected method GetOrientationCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer is laid out in a specific direction. This method is called by GetOrientation. (Inherited from UIElementAutomationPeer.)
Public method GetParent Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
Public method GetPattern When overridden in a derived class, gets the control pattern that is associated with the specified PatternInterface. (Overrides UIElementAutomationPeer.GetPattern(PatternInterface).)
Public method GetPeerFromPoint Gets an AutomationPeer from the specified point. (Inherited from AutomationPeer.)
Protected method GetPeerFromPointCore When overridden in a derived class, is called from GetPeerFromPoint. (Inherited from AutomationPeer.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HasKeyboardFocus Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer.)
Protected method HasKeyboardFocusCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer currently has keyboard input focus. This method is called by HasKeyboardFocus. (Inherited from UIElementAutomationPeer.)
Public method InvalidatePeer Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the Automation Client if the properties changed. (Inherited from AutomationPeer.)
Public method IsContentElement Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user. (Inherited from AutomationPeer.)
Protected method IsContentElementCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer is an element that contains data that is presented to the user. This method is called by IsContentElement. (Inherited from UIElementAutomationPeer.)
Public method IsControlElement Gets a value that indicates whether the element is understood by the user as interactive or as contributing to the logical structure of the control in the GUI. (Inherited from AutomationPeer.)
Protected method IsControlElementCore Gets or sets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer is understood by the end user as interactive. Optionally, the user might understand the UIElement as contributing to the logical structure of the control in the GUI. This method is called by IsControlElement. (Inherited from UIElementAutomationPeer.)
Public method IsEnabled Gets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer.)
Protected method IsEnabledCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable. (Inherited from UIElementAutomationPeer.)
Public method IsKeyboardFocusable Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
Protected method IsKeyboardFocusableCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable. (Inherited from UIElementAutomationPeer.)
Public method IsOffscreen Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
Protected method IsOffscreenCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer is off the screen. This method is called by IsOffscreen. (Inherited from UIElementAutomationPeer.)
Public method IsPassword Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
Protected method IsPasswordCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer contains protected content. This method is called by IsPassword. (Inherited from UIElementAutomationPeer.)
Public method IsRequiredForForm Gets a value that indicates whether the element that is associated with this peer must be completed on a form. (Inherited from AutomationPeer.)
Protected method IsRequiredForFormCore Gets a value that indicates whether the UIElement that is associated with this UIElementAutomationPeer is required to be completed on a form. This method is called by IsRequiredForForm. (Inherited from UIElementAutomationPeer.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method PeerFromProvider Gets an AutomationPeer for the specified IRawElementProviderSimple proxy. (Inherited from AutomationPeer.)
Protected method ProviderFromPeer Gets the IRawElementProviderSimple for the specified AutomationPeer. (Inherited from AutomationPeer.)
Public method RaiseAsyncContentLoadedEvent Called by the AutomationPeer to raise the AsyncContentLoadedEvent event. (Inherited from AutomationPeer.)
Public method RaiseAutomationEvent Raises an automation event. (Inherited from AutomationPeer.)
Public method RaisePropertyChangedEvent Raises an event to notify the automation client of a changed property value. (Inherited from AutomationPeer.)
Public method ResetChildrenCache Synchronously resets the tree of child elements by calling GetChildrenCore. (Inherited from AutomationPeer.)
Public method SetFocus Sets the keyboard focus on the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected method SetFocusCore Sets the keyboard input focus on the UIElement that is associated with this UIElementAutomationPeer. This method is called by SetFocus. (Inherited from UIElementAutomationPeer.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IExpandCollapseProvider.Collapse Determines that the control is collapsed.
Explicit interface implemetationPrivate method IExpandCollapseProvider.Expand Determines that the control is expanded.
Explicit interface implemetationPrivate property IExpandCollapseProvider.ExpandCollapseState Gets or sets the ExpandCollapseState attribute.

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