RanorexRanorex Documentation
FlavorElement Class
NamespacesRanorex.CoreFlavorElement
A container for flavor-specific element data which handles the default element properties.
Declaration Syntax
C#Visual BasicVisual C++
[SerializableAttribute]
public abstract class FlavorElement : MarshalByRefObject
<SerializableAttribute>
Public MustInherit Class FlavorElement
	Inherits MarshalByRefObject
[SerializableAttribute]
public ref class FlavorElement abstract : public MarshalByRefObject
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
FlavorElement(String)
Creates a new flavor element.

AssertArgumentType(Type, Object)
Validates the type of an argument.

AssertArgumentType(Type, Object, Boolean)
Validates the type of an argument.

AssertArgumentTypes(array<Type>[]()[][], array<Object>[]()[][])
Validates a list of argument objects against a list of types.

AssertArgumentTypes(array<Type>[]()[][], array<Object>[]()[][], array<Boolean>[]()[][])
Validates a list of argument objects against a list of types.

AssertEventHandler(Delegate, Type)
Validates that the given delegate is a valid event handler with the specified type of event arguments.

CanReplace(FlavorElement)
Returns a value specifying if this flavor element can replace elem.

CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
DontCache
Indicates that the element should not be cached. Defaults to false.

ElementRectangle
The client or screen rectangle of the flavor element depending on the value returned by IsClientRectangle.

Enabled
True if the element is enabled. If the element cannot be enabled or disabled, return true.

EnsureVisible()()()()
Ensures that the flavor element is visible.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
EvaluateExpensiveAttributes
Gets a value indicating whether expensive attributes should be evaluated.

Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Flavor
The flavor of the flavor element.

FlavorName
The flavor name of the flavor element.

Focus()()()()
Focuses the flavor element, if possible.

ForceGeometricSearchAll
Determines if the ElementRectangle is expected to be outside the bounds of its parent rectangle, and might be invisible. Forces FindChildFromPointByRectangle() to switch to 'search all' behavior.

GetAttributeValue(Element, String)
Needs to be implemented for attribute value read access.

GetChildLineageFromPoint(Point, FindRefineMode%)
Returns a list of flavor elements that is the lineage to the flavor element at the specified screen location.

GetChildLineageFromUid(String, UidFindResult%)
Gets the child lineage from the current element to the element with the given unique id.

GetDynamicDescriptors(IList<(Of <<'(AttributeDescriptor>)>>)%, IList<(Of <<'(ActionDescriptor>)>>)%)
Gets the descriptors for the dynamic attributes and actions that the element supports.

GetElementCapabilities(Element, Role%, array<String>[]()[][]%, String%)
Supplies the role, a list of capabilities and a preferred capability names to the caller. This method called when building a new element from the flavor element.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetInitialValues()()()()
Gets the initial cachable values which are then stored in the active cache session, if any.

GetLifetimeService()()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetRuntimeTokenValues()()()()
Gets the runtime token values. This must be implemented by the flavors.

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
HasFocus
True if the element has the focus.

HitTest(Point)
Performs an optional hit test on a point within the element's rectangle. The default implementation returns 'true'.

InitializeLifetimeService()()()()
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
InvokeAction(Element, String, array<Object>[]()[][])
Needs to be implemented for element action invocation.

IsClientRectangle
Determines if the ElementRectangle property returns client or screen coordinates.

IsEqual(FlavorElement)
Compares to flavor elements. This should be implemented using the best comparison method available.

IsUidDomainRoot
Gets a value indicating whether this flavor element can act as a unique id domain root.

MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MinPathAttributes
Indicates that the minimum number of attributes to use when creating an RxPath location step for this element. Defaults to 0.

SetAttributeValue(Element, String, Object)
Needs to be implemented for attribute value write access.

SubscribeEvent(Element, String, Delegate)
Needs to be implemented to provide event subscription.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UnsubscribeEvent(Element, String, Delegate)
Needs to be implemented to provide event subscription.

Valid
True if the flavor element is still valid.

Visible
True if the element is visible.

Inheritance Hierarchy

Assembly: Ranorex.Core (Module: Ranorex.Core.dll) Version: 4.0.4.23593 (4.0.4.23593)