Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

UITechnologyElementProxy Class

Proxy UITechnologyElement class. Extension plugins must override this and customize their technology element behavior.


Namespace:  Microsoft.VisualStudio.TestTools.UITesting
Assemblies:   Microsoft.VisualStudio.TestTools.WindowsStore.UITesting (in Microsoft.VisualStudio.TestTools.WindowsStore.UITesting.dll)
  Microsoft.VisualStudio.TestTools.UITesting (in Microsoft.VisualStudio.TestTools.UITesting.dll)

public abstract class UITechnologyElementProxy : UITechnologyElement

The UITechnologyElementProxy type exposes the following members.

Protected methodUITechnologyElementProxyInitializes the proxy element with the given technology manager.

Public propertyAutomationElement (Overrides UITechnologyElement.AutomationElement.)
Public propertyChildIndexGets the 0-based position in the parent element's collection. (Overrides UITechnologyElement.ChildIndex.)
Public propertyClassNameGets the class name of this element. (Overrides UITechnologyElement.ClassName.)
Public propertyControlTypeNameGets the universal control type of this element. (Overrides UITechnologyElement.ControlTypeName.)
Public propertyFriendlyNameGets the user-friendly name for this element like display text that will help the user to quickly recognize the element on the screen. (Overrides UITechnologyElement.FriendlyName.)
Public propertyIsLeafNodeGets whether this element is a leaf node (that is does not have any children) or not. (Overrides UITechnologyElement.IsLeafNode.)
Public propertyIsPasswordGets a value that indicates whether this element contains protected content or not. (Overrides UITechnologyElement.IsPassword.)
Public propertyIsTreeSwitchingRequiredGets whether the tree switching is required for window-less tree switching cases. (Overrides UITechnologyElement.IsTreeSwitchingRequired.)
Public propertyNameGets the name of this element. (Overrides UITechnologyElement.Name.)
Public propertyNativeElementGets the underlying native technology element (like IAccessible) corresponding this element. (Overrides UITechnologyElement.NativeElement.)
Public propertyQueryIdGets a QueryId that can be used to uniquely identify/find this element. In some cases, such as TreeItem, the QueryIds might contain the complete element hierarchy but most of the time it will contain only important ancestors of the element. The technology manager must decide which ancestor to capture in the hierarchy by appropriately setting the QueryId.Ancestor property of each element. The APIs in condition classes like AndCondition.ToString() and AndCondition.Parse() may be used to convert from this class to string or vice-versa. EXT-PROTO1-NOTES: This QID also recursively converts all the ancestor core technology elements into the extension element and stitches the ancestor hierarchy appropriately. (Overrides UITechnologyElement.QueryId.)
Public propertySupportLevel (Inherited from UITechnologyElement.)
Public propertySwitchingElementGets or sets the container element if one technology is hosted inside another technology. This is used by the framework. (Overrides UITechnologyElement.SwitchingElement.)
Public propertyTechnologyManagerGets the corresponding technology manager. (Overrides UITechnologyElement.TechnologyManager.)
Public propertyTechnologyNameGets the name of the corresponding technology. This value should be same as UITechnologyManager.TechnologyName. (Overrides UITechnologyElement.TechnologyName.)
Public propertyTopLevelElementGets or sets the top level window corresponding to this element. The top level windows are typically children of desktop. If this is not set, the framework will set this to the top-most ancestor of the element (after ignoring the desktop as ancestor). (Overrides UITechnologyElement.TopLevelElement.)
Public propertyValueGets the value of this element. (Overrides UITechnologyElement.Value.)
Public propertyWindowHandleGets the handle to the Win32 window that contains this element. (Overrides UITechnologyElement.WindowHandle.)
Public propertyWindowTitles (Inherited from UITechnologyElement.)

Public methodCachePropertiesCaches all the common properties of this element for future use so that these properties can be used later even when the underlining UI control no longer exists. This typically includes properties like Name, ClassName, ControlType, QueryId and other properties used in identification string. (Overrides UITechnologyElement.CacheProperties().)
Public methodEnsureVisibleByScrollingScrolls this element into view. If the technology manager does not support scrolling multiple containers, then the outPointX and outPointY should be returned as -1, -1. (Overrides UITechnologyElement.EnsureVisibleByScrolling(Int32, Int32, Int32, Int32).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Overrides Object.Equals(Object).)
Public methodEquals(IUITechnologyElement)Determines whether the specified object is equal to the current object. (Overrides UITechnologyElement.Equals(IUITechnologyElement).)
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 methodGetBoundingRectangleGets the coordinates of the rectangle that completely encloses this element. (Overrides UITechnologyElement.GetBoundingRectangle(Int32, Int32, Int32, Int32).)
Public methodGetClickablePointGets a clickable point for this element. The framework will use this to obtain clickable point if UITechnologyElement.GetOption(UITechnologyElementOption.GetClickablePointFrom) returns GetClickablePointFromTechnologyManager. To use the default algorithm provided by the framework, throw NotSupportedException. (Overrides UITechnologyElement.GetClickablePoint(Int32, Int32).)
Public methodGetHashCodeGets the hash code for this object. .NET Design Guidelines suggests overriding this too if Equals is overridden. (Overrides Object.GetHashCode().)
Public methodGetNativeControlTypeGets the native control type of this element. This can be used in tandem with the universal type obtained via GetControlType() when just the ControlType is not enough to differentiate a control. For example, if the native technology element is HTML, this could be the tag name. (Overrides UITechnologyElement.GetNativeControlType(NativeControlTypeKind).)
Public methodGetOptionGets the option for this IUITechnologyElement. (Overrides UITechnologyElement.GetOption(UITechnologyElementOption).)
Public methodGetPropertyValueGets the value for the specified property for this element. (Overrides UITechnologyElement.GetPropertyValue(String).)
Public methodGetQueryIdForRelatedElementGets the QueryId for the related element specified by UITestElementKind. (Overrides UITechnologyElement.GetQueryIdForRelatedElement(UITestElementKind, Object, Int32).)
Public methodGetRequestedState(AccessibleStates)Gets the current state information of this element for the given requested states. If the element does not support querying only the selective states, it can return the complete state information. (Overrides UITechnologyElement.GetRequestedState(AccessibleStates).)
Public methodGetRequestedState(AccessibleStates) (Overrides UITechnologyElement.GetRequestedState(AccessibleStates).)
Public methodGetRightToLeftPropertyGets the true/false value for right to left format based on the kind specified. (Overrides UITechnologyElement.GetRightToLeftProperty(RightToLeftKind).)
Public methodGetScrolledPercentageGets the amount scrolled in percentage. (Overrides UITechnologyElement.GetScrolledPercentage(ScrollDirection, IUITechnologyElement).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeProgrammaticScrollInitializes this element to do programmatic scrolling. (Overrides UITechnologyElement.InitializeProgrammaticScroll().)
Public methodInvokeProgrammaticActionPerforms programmatic action, based on the ProgrammaticActionOption passed, on this element. (Overrides UITechnologyElement.InvokeProgrammaticAction(ProgrammaticActionOption).)
Public methodIsInteractable (Inherited from UITechnologyElement.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPerformKeyboardAction (Inherited from UITechnologyElement.)
Public methodPerformMouseAction (Inherited from UITechnologyElement.)
Public methodScrollProgrammaticallyDoes the programmatic scrolling for this element. (Overrides UITechnologyElement.ScrollProgrammatically(ScrollDirection, ScrollAmount).)
Public methodSetFocusSets the focus on this element. (Overrides UITechnologyElement.SetFocus().)
Public methodSetOptionSets the option for this IUITechnologyElement. (Overrides UITechnologyElement.SetOption(UITechnologyElementOption, Object).)
Public methodSetPropertyValue Performs a SetProperty action (Inherited from UITechnologyElement.)
Public methodToStringGets the string representation of this control. (Overrides Object.ToString().)
Public methodWaitForReadyWaits for the element to be ready for user action. (Overrides UITechnologyElement.WaitForReady().)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft