Class UiaFlavor

Namespace

Ranorex.Plugin

Assembly

Ranorex.Plugin.Uia.dll

The flavor for Windows Presentation Foundation (WPF) support.

public class UiaFlavor : Flavor

Inheritance

object

MarshalByRefObject

Flavor

UiaFlavor

Inherited Members

Flavor.InheritsFrom(string)

Flavor.ToString()

Flavor.OnGlueRuleRegistered(GlueRuleRegisteredEventArgs)

Flavor.Enabled

Flavor.Name

Flavor.DisplayName

Flavor.BaseFlavorName

Flavor.BaseFlavor

Flavor.Description

Flavor.GlueRules

Flavor.UidAttributeName

Flavor.GlueRuleRegistered

MarshalByRefObject.MemberwiseClone(bool)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.CreateObjRef(Type)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

EnableNativeUiaSupport

Gets or sets a value indicating whether to provide elements for non-WPF windows natively implementing UIA.

public bool EnableNativeUiaSupport { get; set; }

Property Value

bool

Remarks

Setting this value to true instructs the plugin to provide elements also for non-WPF windows which natively implement the UIA interface.

EnableWinAppFrameFiltering

Gets or sets a value indicating whether frame filtering for Windows apps is enabled.

public bool EnableWinAppFrameFiltering { get; set; }

Property Value

bool

Remarks

If set to true, the frames of Windows apps introduced with Windows 10 are filtered and all relevant elements of those frames are displayed as child of the app element. This allows for transparent automation of Windows apps in windowed and full-screen mode.

ExpensiveAttributesEnabled

Gets or sets a value indicating if computationally expensive attributes are enabled, e.g. RowIndex, Index, or Index.

public bool ExpensiveAttributesEnabled { get; set; }

Property Value

bool

Remarks

Setting this value to true will instruct the plugin to evaluate attributes that are expensive to compute and may result in longer delays when getting such attributes. Note that spying an element with such expensive attributes may then take considerable time.

ForceRecognitionOfContextMenusWithUIAPlugin

Gets or sets a value indicating whether the plugin will try to recognize context menus.

public bool ForceRecognitionOfContextMenusWithUIAPlugin { get; set; }

Property Value

bool

Remarks

If set to true, context menus will be recognized with UIA plugin if possible. Otherwise, they will be recognized with MSAA plugin.

ForceVirtualItemRealization

Gets or sets a value indicating if virtual items are realized when trying to get their child elements.

public bool ForceVirtualItemRealization { get; set; }

Property Value

bool

Remarks

Setting this value to true will allow to search lists with virtual items, but realizing may have undesired effects on the list depending on the list implementation e.g. that the list is scrolled to make the realized item visible.

Instance

Gets the local instance of this flavor.

public static UiaFlavor Instance { get; }

Property Value

UiaFlavor

SubscribeToFocusChangedEvent

Gets or sets a value indicating whether the plugin subscribes to the UIA FocusChangedEvent (change requires Ranorex restart).

public bool SubscribeToFocusChangedEvent { get; set; }

Property Value

bool

Remarks

If set to true, the plugin subscribes to the UIA FocusChangedEvent which may cause applications (like MS PowerPoint) to create more UIA elements and thus may improve object recognition, but may also negatively influence performance.

UseDesktopImageCapture

Defines whether capturing screenshots from elements of this flavor should use the desktop capturing method.

public override bool UseDesktopImageCapture { get; }

Property Value

bool

UseItemContainerPattern

Gets or sets a value indicating whether to use the ItemContainerPattern to iterate lists.

public bool UseItemContainerPattern { get; set; }

Property Value

bool

Remarks

Setting this value to true instructs the plugin to use the ItemContainerPattern to iterate items of virtual lists that implement this UI Automation pattern. Depending on the implementation of the control, iterating children using this pattern should also return items that are currently scrolled out of view, but might also be slower than the usual way to get child elements.

Note that switching this setting can render existing RanoreXPaths invalid for controls implementing the ItemContainerPattern.

UseWinAppDebugMode

Gets or sets a value indicating whether the debugging mode for Windows apps will be enabled.

public bool UseWinAppDebugMode { get; set; }

Property Value

bool

Remarks

If set to true, the debugging mode for Windows apps will be enabled, causing them to not be suspended until the logon session is closed (user logout). When set to false, the plugin will instead try to resume suspended apps when it needs to access them (possible race condition may cause freeze until app is manually resumed).