Location Class

Represents an abstract, relative location within an element or on the screen.

Inheritance Hierarchy

SystemObject
RanorexLocation

Namespace: Ranorex
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06

Syntax

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(LocationLocationConverter))]
public class Location : IEquatable<Location>

<SerializableAttribute>
<TypeConverterAttribute(GetType(LocationLocationConverter))>
Public Class Location
	Implements IEquatable(Of Location)

The Location type exposes the following members.

Constructors

	Name	Description
	Location	Initializes a new instance of the Location class. This is equivalent to using 'Location.Center'.
	Location(Bitmap)	Initializes a new instance of the Location class specifying an image to search for.
	Location(Point)	Initializes a new instance of the Location class, using a pixel value.
	Location(PointF)	Initializes a new instance of the Location class, using a proportional position.
	Location(Double, Double)	Initializes a new instance of the Location class, using a proportional position.
	Location(Bitmap, ImagingFindOptions)	Initializes a new instance of the Location class specifying an image to search for using the specified options.
	Location(Bitmap, Location)	Initializes a new instance of the Location class specifying an image to search for and a relative location inside the found image.
	Location(Int32, Int32)	Initializes a new instance of the Location class, using a pixel value.
	Location(Bitmap, Location, ImagingFindOptions)	Initializes a new instance of the Location class using an image to search for and a relative location inside the found image.

Top

Properties

	Name	Description
	Center	Represents the center of an element.
	CenterLeft	Represents the left center location of an element.
	CenterRight	Represents the center right location of an element.
	Feature	Gets or sets an image that should be searched inside an element.
	FeatureOptions	Gets or sets the options for searching the Feature image.
	FixedLocation	Gets the relative pixel location if IsFixed is true. Throws an exception if the location is proportional.
	IsFixed	Gets a value indicating whether this instance is fixed, i.e. has a fixed pixel value.
	IsImageBased	Gets a value indicating whether this instance searches for a Feature image inside an element to get a relative offset inside the element.
	IsProportional	Gets a value indicating whether this instance is proportional, i.e. is proportional to the width and height of the element.
	LowerCenter	Represents the lower center location of an element.
	LowerLeft	Represents the lower left corner of an element.
	LowerRight	Represents the lower right corner of an element.
	ProportionalLocation	Gets the proportional location if IsFixed is false. Throws an exception if the location is fixed.
	StandardValues	Gets an array of the standard locations.
	UpperCenter	Represents the upper center location of an element.
	UpperLeft	Represents the upper left corner of an element.
	UpperRight	Represents the upper right corner of an element.

Top

Methods

	Name	Description
	Clone	Creates a new instance that is equal to this instance.
	Equals(Object)	Determines whether the specified Object is equal to the current Location. (Overrides ObjectEquals(Object).)
	Equals(Location)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetElementLocation	Gets the coordinates of a given Location corresponding to the specified element.
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode.)
	GetLocationForRect	Gets the coordinates of a given Location corresponding to the specified rectangle.
	GetScreenLocation	Gets the screen coordinates of a given Location corresponding to the specified element.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Parse	Creates a new instance of the Location class from its string representation.
	ToString	Returns a String that represents the current Location. (Overrides ObjectToString.)
	TryParse	Tries to creates a new instance of the Location class from its string representation.

Top

Operators

	Name	Description
	Equality	Implements the operator ==.
	(Bitmap to Location)	Performs an implicit conversion from Bitmap to Location.
	(Point to Location)	Performs an implicit conversion from Point to Location.
	(PointF to Location)	Performs an implicit conversion from PointF to Location.
	(String to Location)	Performs an implicit conversion from String to Location.
	Inequality	Implements the operator !=.

Top

Remarks

A location is a relative offset inside an element. It can either be specified by a fixed pixel value (x,y), a percentage of an element's height or width (e.g. Center, UpperRight), or an image that should be found inside the element.

Reference

Ranorex Namespace