Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

UITechnologyElementProxy Class

 

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

Namespace:   Microsoft.VisualStudio.TestTools.UITesting
Assembly:  Microsoft.VisualStudio.TestTools.UITesting (in Microsoft.VisualStudio.TestTools.UITesting.dll)

System.Object
  Microsoft.VisualStudio.TestTools.UITest.Extension.UITechnologyElement
    Microsoft.VisualStudio.TestTools.UITesting.UITechnologyElementProxy

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_protmethodUITechnologyElementProxy(UITechnologyManagerProxy, IUITechnologyElement)

Initializes the proxy element with the given technology manager.

NameDescription
System_CAPS_pubpropertyAutomationElement
System_CAPS_pubpropertyChildIndex

Gets the 0-based position in the parent element's collection.(Overrides UITechnologyElement.ChildIndex.)

System_CAPS_pubpropertyClassName

Gets the class name of this element.(Overrides UITechnologyElement.ClassName.)

System_CAPS_pubpropertyControlTypeName

Gets the universal control type of this element.(Overrides UITechnologyElement.ControlTypeName.)

System_CAPS_pubpropertyFriendlyName

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

System_CAPS_pubpropertyIsLeafNode

Gets whether this element is a leaf node (that is does not have any children) or not.(Overrides UITechnologyElement.IsLeafNode.)

System_CAPS_pubpropertyIsPassword

Gets a value that indicates whether this element contains protected content or not.(Overrides UITechnologyElement.IsPassword.)

System_CAPS_pubpropertyIsTreeSwitchingRequired

Gets whether the tree switching is required for window-less tree switching cases.(Overrides UITechnologyElement.IsTreeSwitchingRequired.)

System_CAPS_pubpropertyName

Gets the name of this element.(Overrides UITechnologyElement.Name.)

System_CAPS_pubpropertyNativeElement

Gets the underlying native technology element (like IAccessible) corresponding this element.(Overrides UITechnologyElement.NativeElement.)

System_CAPS_pubpropertyQueryId

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

System_CAPS_pubpropertySupportLevel

Gets a value that is used by the test recording and playback engine to find a matching UITechnologyManager for this element.(Inherited from UITechnologyElement.)

System_CAPS_pubpropertySwitchingElement

Gets or sets the container element if one technology is hosted inside another technology.

This is used by the framework.(Overrides UITechnologyElement.SwitchingElement.)

System_CAPS_pubpropertyTechnologyManager

Gets the corresponding technology manager.(Overrides UITechnologyElement.TechnologyManager.)

System_CAPS_pubpropertyTechnologyName

Gets the name of the corresponding technology.

This value should be same as UITechnologyManager.TechnologyName.(Overrides UITechnologyElement.TechnologyName.)

System_CAPS_pubpropertyTopLevelElement

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

System_CAPS_pubpropertyValue

Gets the value of this element.(Overrides UITechnologyElement.Value.)

System_CAPS_pubpropertyWindowHandle

Gets the handle to the Win32 window that contains this element.(Overrides UITechnologyElement.WindowHandle.)

System_CAPS_pubpropertyWindowTitles

Gets a list of the top-level window titles, of which one is the ancestor of this element.(Inherited from UITechnologyElement.)

NameDescription
System_CAPS_pubmethodCacheProperties()

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

System_CAPS_pubmethodEnsureVisibleByScrolling(Int32, Int32, Int32, Int32)

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

System_CAPS_pubmethodEquals(IUITechnologyElement)

Determines whether the specified object is equal to the current object.(Overrides UITechnologyElement.Equals(IUITechnologyElement).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Overrides Object.Equals(Object).)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetBoundingRectangle(Int32, Int32, Int32, Int32)

Gets the coordinates of the rectangle that completely encloses this element.(Overrides UITechnologyElement.GetBoundingRectangle(Int32, Int32, Int32, Int32).)

System_CAPS_pubmethodGetClickablePoint(Int32, Int32)

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

System_CAPS_pubmethodGetHashCode()

Gets the hash code for this object.

.NET Design Guidelines suggests overriding this too if Equals is overridden.(Overrides Object.GetHashCode().)

System_CAPS_pubmethodGetNativeControlType(NativeControlTypeKind)

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

System_CAPS_pubmethodGetOption(UITechnologyElementOption)

Gets the option for this IUITechnologyElement.(Overrides UITechnologyElement.GetOption(UITechnologyElementOption).)

System_CAPS_pubmethodGetPropertyValue(String)

Gets the value for the specified property for this element.(Overrides UITechnologyElement.GetPropertyValue(String).)

System_CAPS_pubmethodGetQueryIdForRelatedElement(UITestElementKind, Object, Int32)

Gets the QueryId for the related element specified by UITestElementKind.(Overrides UITechnologyElement.GetQueryIdForRelatedElement(UITestElementKind, Object, Int32).)

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

System_CAPS_pubmethodGetRightToLeftProperty(RightToLeftKind)

Gets the true/false value for right to left format based on the kind specified.(Overrides UITechnologyElement.GetRightToLeftProperty(RightToLeftKind).)

System_CAPS_pubmethodGetScrolledPercentage(ScrollDirection, IUITechnologyElement)
System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeProgrammaticScroll()

Initializes this element to do programmatic scrolling.(Overrides UITechnologyElement.InitializeProgrammaticScroll().)

System_CAPS_pubmethodInvokeProgrammaticAction(ProgrammaticActionOption)

Performs programmatic action, based on the ProgrammaticActionOption passed, on this element.(Overrides UITechnologyElement.InvokeProgrammaticAction(ProgrammaticActionOption).)

System_CAPS_pubmethodIsInteractable()

Checks if the element is visible and interactable at this instance.

The plugins should overload this generic implementation to be more accurate and performant.(Inherited from UITechnologyElement.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodPerformKeyboardAction(String)

(Inherited from UITechnologyElement.)

System_CAPS_pubmethodPerformMouseAction(String)

(Inherited from UITechnologyElement.)

System_CAPS_pubmethodScrollProgrammatically(ScrollDirection, ScrollAmount)

Does the programmatic scrolling for this element.(Overrides UITechnologyElement.ScrollProgrammatically(ScrollDirection, ScrollAmount).)

System_CAPS_pubmethodSetFocus()

Sets the focus on this element.(Overrides UITechnologyElement.SetFocus().)

System_CAPS_pubmethodSetOption(UITechnologyElementOption, Object)

Sets the option for this IUITechnologyElement.(Overrides UITechnologyElement.SetOption(UITechnologyElementOption, Object).)

System_CAPS_pubmethodSetPropertyValue(String, Object)

Performs a SetProperty action (Inherited from UITechnologyElement.)

System_CAPS_pubmethodToString()

Gets the string representation of this control.(Overrides Object.ToString().)

System_CAPS_pubmethodWaitForReady()

Waits 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.

Return to top
Show: