Edit

Share via


UIElement3DAutomationPeer Class

Definition

Exposes UIElement3D types to UI Automation.

public ref class UIElement3DAutomationPeer : System::Windows::Automation::Peers::AutomationPeer
public class UIElement3DAutomationPeer : System.Windows.Automation.Peers.AutomationPeer
type UIElement3DAutomationPeer = class
    inherit AutomationPeer
Public Class UIElement3DAutomationPeer
Inherits AutomationPeer
Inheritance
UIElement3DAutomationPeer

Remarks

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 Versions and Dependencies.

Constructors

UIElement3DAutomationPeer(UIElement3D)

Initializes a new instance of the UIElement3DAutomationPeer class.

Properties

Dispatcher

Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
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)
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)
Owner

Gets the UIElement3D that is associated with this UIElement3DAutomationPeer.

Methods

CheckAccess()

Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
CreatePeerForElement(UIElement3D)

Creates a UIElement3DAutomationPeer for the specified UIElement3D.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FromElement(UIElement3D)

Returns the UIElement3DAutomationPeer for the specified UIElement3D.

GetAcceleratorKey()

Gets the accelerator key combinations for the element that is associated with the UI Automation peer.

(Inherited from AutomationPeer)
GetAcceleratorKeyCore()

Returns the accelerator key for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAcceleratorKey().

GetAccessKey()

Gets the access key for the element that is associated with the automation peer.

(Inherited from AutomationPeer)
GetAccessKeyCore()

Returns the access key for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAccessKey().

GetAutomationControlType()

Gets the control type for the element that is associated with the UI Automation peer.

(Inherited from AutomationPeer)
GetAutomationControlTypeCore()

Returns the control type for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAutomationControlType().

GetAutomationId()

Gets the AutomationId of the element that is associated with the automation peer.

(Inherited from AutomationPeer)
GetAutomationIdCore()

Returns the string that uniquely identifies the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAutomationId().

GetBoundingRectangle()

Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.

(Inherited from AutomationPeer)
GetBoundingRectangleCore()

Returns the Rect that represents the bounding rectangle of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetBoundingRectangle().

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)
GetChildrenCore()

Returns the collection of child elements of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetChildren().

GetClassName()

Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer.

(Inherited from AutomationPeer)
GetClassNameCore()

Returns the name of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetClassName().

GetClickablePoint()

Gets a Point on the element that is associated with the automation peer that responds to a mouse click.

(Inherited from AutomationPeer)
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().

GetControlledPeers()

Provides UI Automation with a list of elements affected or controlled by this AutomationPeer.

(Inherited from AutomationPeer)
GetControlledPeersCore()

When overridden in a derived class, provides UI Automation with a list of elements affected or controlled by this AutomationPeer.

(Inherited from AutomationPeer)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetHeadingLevel() (Inherited from AutomationPeer)
GetHeadingLevelCore()
GetHeadingLevelCore() (Inherited from AutomationPeer)
GetHelpText()

Gets text that describes the functionality of the control that is associated with the automation peer.

(Inherited from AutomationPeer)
GetHelpTextCore()

Returns the string that describes the functionality of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetHelpText().

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)
GetItemStatus()

Gets text that conveys the visual status of the element that is associated with this automation peer.

(Inherited from AutomationPeer)
GetItemStatusCore()

Returns a string that communicates the status of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetItemStatus().

GetItemType()

Gets a string that describes what kind of item an object represents.

(Inherited from AutomationPeer)
GetItemTypeCore()

Returns a human-readable string that represents the item type that the UIElement3D for this UIElement3DAutomationPeer. This method is called by GetItemType().

GetLabeledBy()

Gets the AutomationPeer for the Label that is targeted to the element.

(Inherited from AutomationPeer)
GetLabeledByCore()

Returns the AutomationPeer for the element that targets the UIElement3D for this UIElement3DAutomationPeer. This method is called by GetLabeledBy().

GetLiveSetting()

Gets the notification characteristics of a live region that is associated with this automation peer.

(Inherited from AutomationPeer)
GetLiveSettingCore()

Gets the notification characteristics of the live region of the UIElement3D object that is associated with this UIElement3DAutomationPeer. This method is called by GetLiveSetting().

GetLiveSettingCore()

When overridden in a derived class, returns the notification characteristics of a live region. Called by the GetLiveSetting() method.

(Inherited from AutomationPeer)
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)
GetLocalizedControlTypeCore()

When overridden in a derived class, is called by GetLocalizedControlType().

(Inherited from AutomationPeer)
GetName()

Gets text that describes the element that is associated with this automation peer.

(Inherited from AutomationPeer)
GetNameCore()

Returns the string that represents the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetName().

GetOrientation()

Gets a value that indicates the explicit control orientation, if any.

(Inherited from AutomationPeer)
GetOrientationCore()

Returns the orientation of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetOrientation().

GetParent()

Gets the AutomationPeer that is the parent of this AutomationPeer.

(Inherited from AutomationPeer)
GetPattern(PatternInterface)

Returns the control pattern for the UIElement3D that is associated with this UIElement3DAutomationPeer.

GetPeerFromPoint(Point)

Gets an AutomationPeer from the specified point.

(Inherited from AutomationPeer)
GetPeerFromPointCore(Point)

When overridden in a derived class, is called from GetPeerFromPoint(Point).

(Inherited from AutomationPeer)
GetPositionInSet()

Attempts to get the value of the PositionInSet property.

(Inherited from AutomationPeer)
GetPositionInSetCore()

Reads PositionInSetProperty and returns the value of the PositionInSet attached property.

GetPositionInSetCore()

When overridden in a derived class, provides UI Automation with a one-based integer value that describes the position this element occupies in a group or set.

(Inherited from AutomationPeer)
GetSizeOfSet()

Attempts to get the value of the SizeOfSet property.

(Inherited from AutomationPeer)
GetSizeOfSetCore()

Provides a value for UI Automation's SizeOfSet property.

GetSizeOfSetCore()

When overridden in a derived class, provides UI Automation with the size of the group or set that this element belongs to.

(Inherited from AutomationPeer)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
HasKeyboardFocus()

Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus.

(Inherited from AutomationPeer)
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().

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)
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)
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().

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)
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().

IsDialog() (Inherited from AutomationPeer)
IsDialogCore()
IsDialogCore() (Inherited from AutomationPeer)
IsEnabled()

Gets a value that indicates whether the element associated with this automation peer supports interaction.

(Inherited from AutomationPeer)
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().

IsKeyboardFocusable()

Gets a value that indicates whether the element can accept keyboard focus.

(Inherited from AutomationPeer)
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().

IsOffscreen()

Gets a value that indicates whether an element is off the screen.

(Inherited from AutomationPeer)
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().

IsPassword()

Gets a value that indicates whether the element contains sensitive content.

(Inherited from AutomationPeer)
IsPasswordCore()

Returns a value that indicates whether the UIElement3D that is associated with this UIElement3DAutomationPeer contains protected content. This method is called by IsPassword().

IsRequiredForForm()

Gets a value that indicates whether the element that is associated with this peer must be completed on a form.

(Inherited from AutomationPeer)
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().

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
PeerFromProvider(IRawElementProviderSimple)

Gets an AutomationPeer for the specified IRawElementProviderSimple proxy.

(Inherited from AutomationPeer)
ProviderFromPeer(AutomationPeer)

Gets the IRawElementProviderSimple for the specified AutomationPeer.

(Inherited from AutomationPeer)
RaiseAsyncContentLoadedEvent(AsyncContentLoadedEventArgs)

Called by the AutomationPeer to raise the AsyncContentLoadedEvent event.

(Inherited from AutomationPeer)
RaiseAutomationEvent(AutomationEvents)

Raises an automation event.

(Inherited from AutomationPeer)
RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String) (Inherited from AutomationPeer)
RaisePropertyChangedEvent(AutomationProperty, Object, Object)

Raises an event to notify the automation client of a changed property value.

(Inherited from AutomationPeer)
ResetChildrenCache()

Synchronously resets the tree of child elements by calling GetChildrenCore().

(Inherited from AutomationPeer)
SetFocus()

Sets the keyboard focus on the element that is associated with this automation peer.

(Inherited from AutomationPeer)
SetFocusCore()

Sets the keyboard input focus on the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by SetFocus().

ToString()

Returns a string that represents the current object.

(Inherited from Object)
VerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)

Applies to