This topic has not yet been rated - Rate this topic

UIElement3DAutomationPeer Class

Exposes UIElement3D types to UI Automation.

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.Automation.Peers.AutomationPeer
      System.Windows.Automation.Peers.UIElement3DAutomationPeer

Namespace:  System.Windows.Automation.Peers
Assembly:  PresentationCore (in PresentationCore.dll)
public class UIElement3DAutomationPeer : AutomationPeer

The UIElement3DAutomationPeer type exposes the following members.

  Name Description
Public method UIElement3DAutomationPeer Initializes a new instance of the UIElement3DAutomationPeer class.
Top
  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 UIElement3D that is associated with this UIElement3DAutomationPeer.
Top
  Name Description
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method Static member CreatePeerForElement Creates a UIElement3DAutomationPeer for the specified UIElement3D.
Public method Equals(Object) 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 Static member FromElement Returns the UIElement3DAutomationPeer for the specified UIElement3D.
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 Returns the accelerator key for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAcceleratorKey. (Overrides AutomationPeer.GetAcceleratorKeyCore().)
Public method GetAccessKey Gets the access key for the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetAccessKeyCore Returns the access key for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAccessKey. (Overrides AutomationPeer.GetAccessKeyCore().)
Public method GetAutomationControlType Gets the control type for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected method GetAutomationControlTypeCore Returns the control type for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAutomationControlType. (Overrides AutomationPeer.GetAutomationControlTypeCore().)
Public method GetAutomationId Gets the AutomationId of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected method GetAutomationIdCore Returns the string that uniquely identifies the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAutomationId. (Overrides AutomationPeer.GetAutomationIdCore().)
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 Returns the Rect that represents the bounding rectangle of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetBoundingRectangle. (Overrides AutomationPeer.GetBoundingRectangleCore().)
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 Returns the collection of child elements of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetChildren. (Overrides AutomationPeer.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 Returns the name of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetClassName. (Overrides AutomationPeer.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 Returns a Point that represents the clickable space that is on the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetClickablePoint. (Overrides AutomationPeer.GetClickablePointCore().)
Public method GetHashCode Serves as a hash function for a particular type. (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 Returns the string that describes the functionality of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetHelpText. (Overrides AutomationPeer.GetHelpTextCore().)
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 Returns a string that communicates the status of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetItemStatus. (Overrides AutomationPeer.GetItemStatusCore().)
Public method GetItemType Gets a string that describes what kind of item an object represents. (Inherited from AutomationPeer.)
Protected method GetItemTypeCore Returns a human-readable string that represents the item type that the UIElement3D for this UIElement3DAutomationPeer. This method is called by GetItemType. (Overrides AutomationPeer.GetItemTypeCore().)
Public method GetLabeledBy Gets the AutomationPeer for the Label that is targeted to the element. (Inherited from AutomationPeer.)
Protected method GetLabeledByCore Returns the AutomationPeer for the element that targets the UIElement3D for this UIElement3DAutomationPeer. This method is called by GetLabeledBy. (Overrides AutomationPeer.GetLabeledByCore().)
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 Returns the string that represents the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetName. (Overrides AutomationPeer.GetNameCore().)
Public method GetOrientation Gets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
Protected method GetOrientationCore Returns the orientation of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetOrientation. (Overrides AutomationPeer.GetOrientationCore().)
Public method GetParent Gets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
Public method GetPattern Returns the control pattern for the UIElement3D that is associated with this UIElement3DAutomationPeer. (Overrides AutomationPeer.GetPattern(PatternInterface).)
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 Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer currently has keyboard input focus. This method is called by HasKeyboardFocus. (Overrides AutomationPeer.HasKeyboardFocusCore().)
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 Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer is an element that contains data that is presented to the user. This method is called by IsContentElement. (Overrides AutomationPeer.IsContentElementCore().)
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 Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer is understood by the end user as interactive. Optionally, the user might understand the UIElement3D as contributing to the logical structure of the control in the GUI. This method is called by IsControlElement. (Overrides AutomationPeer.IsControlElementCore().)
Public method IsEnabled Gets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer.)
Protected method IsEnabledCore Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer can participate in hit testing or accept focus. This method is called by IsKeyboardFocusable. (Overrides AutomationPeer.IsEnabledCore().)
Public method IsKeyboardFocusable Gets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
Protected method IsKeyboardFocusableCore Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer can accept keyboard focus. This method is called by IsKeyboardFocusable. (Overrides AutomationPeer.IsKeyboardFocusableCore().)
Public method IsOffscreen Gets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
Protected method IsOffscreenCore Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer is off the screen. This method is called by IsOffscreen. (Overrides AutomationPeer.IsOffscreenCore().)
Public method IsPassword Gets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
Protected method IsPasswordCore Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer contains protected content. This method is called by IsPassword. (Overrides AutomationPeer.IsPasswordCore().)
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 Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer is required to be completed on a form. This method is called by IsRequiredForForm. (Overrides AutomationPeer.IsRequiredForFormCore().)
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 UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by SetFocus. (Overrides AutomationPeer.SetFocusCore().)
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

By default, any class that inherits from UIElement3D uses UIElement3DAutomationPeer to communicate with UI Automation.

If you create a class that inherits from UIElement3D, you may want to provide an automation peer to support the functionality of your class. Override the GetClassNameCore method to return a string that represents the type of the element associated with the UIElement3DAutomationPeer. For example, if you create a class called My3DElement and an automation peer called My3DElementAutomationPeer, override the GetClassNameCore method to return the string "My3DElement".

If your class matches one of the known control types, override the GetAutomationControlTypeCore method to return that ControlType. Note that although the existing ControlType values are generally associated with 2D controls, the ControlType indicates a control's functionality, not its appearance. So if your UIElement3D invokes an action when the user clicks it, you probably want GetHelpTextCore to return ControlType.Button.

The behavior of your custom UIElement3D determines what other methods you should override. Each method topic in the UIElement3DAutomationPeer describes how the method is used and when it is appropriate to override it.

UIElement3DAutomationPeer is introduced in the .NET Framework version 3.5. For more information, see .NET Framework Versions and Dependencies.

.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ