Export (0) Print
Expand All

UIElement3DAutomationPeer Class

Exposes UIElement3D types to UI Automation.

Namespace:  System.Windows.Automation.Peers
Assembly:  PresentationCore (in PresentationCore.dll)

type UIElement3DAutomationPeer =  
    class 
        inherit AutomationPeer 
    end

The UIElement3DAutomationPeer type exposes the following members.

  NameDescription
Public methodUIElement3DAutomationPeerInitializes a new instance of the UIElement3DAutomationPeer class.
Top

  NameDescription
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyEventsSourceGets 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 propertyIsHwndHostGets a value that indicates whether the element that is associated with this AutomationPeer hosts hwnds in Windows Presentation Foundation (WPF). (Inherited from AutomationPeer.)
Public propertyOwnerGets the UIElement3D that is associated with this UIElement3DAutomationPeer.
Top

  NameDescription
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodStatic memberCreatePeerForElementCreates a UIElement3DAutomationPeer for the specified UIElement3D.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodStatic memberFromElementReturns the UIElement3DAutomationPeer for the specified UIElement3D.
Public methodGetAcceleratorKeyGets the accelerator key combinations for the element that is associated with the UI Automation peer.  (Inherited from AutomationPeer.)
Protected methodGetAcceleratorKeyCoreReturns the accelerator key for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAcceleratorKey. (Overrides AutomationPeer.GetAcceleratorKeyCore().)
Public methodGetAccessKeyGets the access key for the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetAccessKeyCoreReturns the access key for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAccessKey. (Overrides AutomationPeer.GetAccessKeyCore().)
Public methodGetAutomationControlTypeGets the control type for the element that is associated with the UI Automation peer. (Inherited from AutomationPeer.)
Protected methodGetAutomationControlTypeCoreReturns the control type for the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAutomationControlType. (Overrides AutomationPeer.GetAutomationControlTypeCore().)
Public methodGetAutomationIdGets the AutomationId of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetAutomationIdCoreReturns the string that uniquely identifies the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetAutomationId. (Overrides AutomationPeer.GetAutomationIdCore().)
Public methodGetBoundingRectangleGets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetBoundingRectangleCoreReturns 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 methodGetChildrenGets 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 methodGetChildrenCoreReturns the collection of child elements of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetChildren. (Overrides AutomationPeer.GetChildrenCore().)
Public methodGetClassNameGets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. (Inherited from AutomationPeer.)
Protected methodGetClassNameCoreReturns the name of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetClassName. (Overrides AutomationPeer.GetClassNameCore().)
Public methodGetClickablePointGets a Point on the element that is associated with the automation peer that responds to a mouse click. (Inherited from AutomationPeer.)
Protected methodGetClickablePointCoreReturns 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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetHelpTextGets text that describes the functionality of the control that is associated with the automation peer. (Inherited from AutomationPeer.)
Protected methodGetHelpTextCoreReturns 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 methodGetHostRawElementProviderCoreTells 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 methodGetItemStatusGets text that conveys the visual status of the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected methodGetItemStatusCoreReturns 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 methodGetItemTypeGets a string that describes what kind of item an object represents. (Inherited from AutomationPeer.)
Protected methodGetItemTypeCoreReturns 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 methodGetLabeledByGets the AutomationPeer for the Label that is targeted to the element. (Inherited from AutomationPeer.)
Protected methodGetLabeledByCoreReturns the AutomationPeer for the element that targets the UIElement3D for this UIElement3DAutomationPeer. This method is called by GetLabeledBy. (Overrides AutomationPeer.GetLabeledByCore().)
Public methodGetLocalizedControlTypeGets a human-readable localized string that represents the AutomationControlType value for the control that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected methodGetLocalizedControlTypeCoreWhen overridden in a derived class, is called by GetLocalizedControlType. (Inherited from AutomationPeer.)
Public methodGetNameGets text that describes the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected methodGetNameCoreReturns the string that represents the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetName. (Overrides AutomationPeer.GetNameCore().)
Public methodGetOrientationGets a value that indicates the explicit control orientation, if any. (Inherited from AutomationPeer.)
Protected methodGetOrientationCoreReturns the orientation of the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by GetOrientation. (Overrides AutomationPeer.GetOrientationCore().)
Public methodGetParentGets the AutomationPeer that is the parent of this AutomationPeer. (Inherited from AutomationPeer.)
Public methodGetPatternReturns the control pattern for the UIElement3D that is associated with this UIElement3DAutomationPeer. (Overrides AutomationPeer.GetPattern(PatternInterface).)
Public methodGetPeerFromPointGets an AutomationPeer from the specified point. (Inherited from AutomationPeer.)
Protected methodGetPeerFromPointCoreWhen overridden in a derived class, is called from GetPeerFromPoint. (Inherited from AutomationPeer.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHasKeyboardFocusGets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus. (Inherited from AutomationPeer.)
Protected methodHasKeyboardFocusCoreReturns 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 methodInvalidatePeerTriggers 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 methodIsContentElementGets 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 methodIsContentElementCoreReturns 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 methodIsControlElementGets 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 methodIsControlElementCoreReturns 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 methodIsEnabledGets a value that indicates whether the element associated with this automation peer supports interaction. (Inherited from AutomationPeer.)
Protected methodIsEnabledCoreReturns 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 methodIsKeyboardFocusableGets a value that indicates whether the element can accept keyboard focus. (Inherited from AutomationPeer.)
Protected methodIsKeyboardFocusableCoreReturns 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 methodIsOffscreenGets a value that indicates whether an element is off the screen. (Inherited from AutomationPeer.)
Protected methodIsOffscreenCoreReturns 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 methodIsPasswordGets a value that indicates whether the element contains sensitive content. (Inherited from AutomationPeer.)
Protected methodIsPasswordCoreReturns 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 methodIsRequiredForFormGets a value that indicates whether the element that is associated with this peer must be completed on a form. (Inherited from AutomationPeer.)
Protected methodIsRequiredForFormCoreReturns 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 methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodPeerFromProviderGets an AutomationPeer for the specified IRawElementProviderSimple proxy. (Inherited from AutomationPeer.)
Protected methodProviderFromPeerGets the IRawElementProviderSimple for the specified AutomationPeer. (Inherited from AutomationPeer.)
Public methodRaiseAsyncContentLoadedEventCalled by the AutomationPeer to raise the AsyncContentLoadedEvent event. (Inherited from AutomationPeer.)
Public methodRaiseAutomationEventRaises an automation event. (Inherited from AutomationPeer.)
Public methodRaisePropertyChangedEventRaises an event to notify the automation client of a changed property value. (Inherited from AutomationPeer.)
Public methodResetChildrenCacheSynchronously resets the tree of child elements by calling GetChildrenCore. (Inherited from AutomationPeer.)
Public methodSetFocusSets the keyboard focus on the element that is associated with this automation peer. (Inherited from AutomationPeer.)
Protected methodSetFocusCoreSets the keyboard input focus on the UIElement3D that is associated with this UIElement3DAutomationPeer. This method is called by SetFocus. (Overrides AutomationPeer.SetFocusCore().)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodVerifyAccessEnforces 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.5.2, 4.5.1, 4.5, 4, 3.5 SP1, 3.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft