Back to all docs
API Reference / ArtOfTest.WebAii.Core / FrameInfo

Class
FrameInfo

Information regarding a specific frame

Definition

Namespace:ArtOfTest.WebAii.Core

Assembly:ArtOfTest.WebAii.dll

Syntax:
cs-api-definition
[DataContract(Name = "FrameInfo")]
public class FrameInfo : INotifyPropertyChanged, ICloneable

Inheritance: objectFrameInfo

Implements: ICloneableINotifyPropertyChanged

Constructors

FrameInfo()

Create a new FrameInfo object.

Declaration

cs-api-definition
public FrameInfo()

FrameInfo(string, string, string, int)

Create a new FrameInfo object.

Declaration

cs-api-definition
public FrameInfo(string id, string name, string src, int index)

Parameters

id

string

The Frame's id.

name

string

The Frame's name.

src

string

The Frame's src.

index

int

The Frame's index.

FrameInfo(string, string, string, string, int, bool)

Create a new FrameInfo object.

Declaration

cs-api-definition
public FrameInfo(string id, string name, string baseURL, string query, int index, bool useQuery)

Parameters

id

string

The Frame's id.

name

string

The Frame's name.

baseURL

string

The base URL of the frame's src attribute.

query

string

The query part of the frame's src attribute.

index

int

The Frame's index.

useQuery

bool

Whether or not to compare the query part when comparing FrameInfo objects.

FrameInfo(string, string, string, string, int, bool, bool)

Create a new FrameInfo object.

Declaration

cs-api-definition
public FrameInfo(string id, string name, string baseURL, string query, int index, bool useQuery, bool usesBaseUrlHost)

Parameters

id

string

The Frame's id.

name

string

The Frame's name.

baseURL

string

The base URL of the frame's src attribute.

query

string

The query part of the frame's src attribute.

index

int

The Frame's index.

useQuery

bool

Whether or not to compare the query part when comparing FrameInfo objects.

usesBaseUrlHost

bool

Whether or not to compare the baseURL part when comparing FrameInfo objects.

FrameInfo(string, string, string, string, int, bool, bool, string)

Create a new FrameInfo object.

Declaration

cs-api-definition
public FrameInfo(string id, string name, string baseURL, string query, int index, bool useQuery, bool usesBaseUrlHost, string testStudioTag)

Parameters

id

string

The Frame's id.

name

string

The Frame's name.

baseURL

string

The base URL of the frame's src attribute.

query

string

The query part of the frame's src attribute.

index

int

The Frame's index.

useQuery

bool

Whether or not to compare the query part when comparing FrameInfo objects.>

usesBaseUrlHost

bool

Whether or not to compare the baseURL part when comparing FrameInfo objects.

testStudioTag

string

TestStudio tag.

Properties

BaseURL

The frame's src value. Used only if id/name is not set.

Declaration

cs-api-definition
[DataMember(Name = "_baseURL")]
public string BaseURL { get; set; }

Property Value

string

Id

Get frame id.

Declaration

cs-api-definition
[DataMember(Name = "_id")]
public string Id { get; set; }

Property Value

string

Index

Get frame index.

Declaration

cs-api-definition
[DataMember(Name = "_index")]
public int Index { get; set; }

Property Value

int

Name

Get frame name.

Declaration

cs-api-definition
[DataMember(Name = "_name")]
public string Name { get; set; }

Property Value

string

Query

The frame's query part of the src value. Used only if id/name is not set.

Declaration

cs-api-definition
[DataMember(Name = "_query", IsRequired = false)]
public string Query { get; set; }

Property Value

string

Rectangle

The last rectangle value using GetRectangle();

Declaration

cs-api-definition
[Browsable(false)]
public Rectangle Rectangle { get; }

Property Value

Rectangle

Src

The frame's src value. Used only if id/name is not set.

Declaration

cs-api-definition
[Browsable(false)]
public string Src { get; set; }

Property Value

string

TestStudioTag

Get frame id.

Declaration

cs-api-definition
[DataMember(Name = "TestStudioTag")]
public string TestStudioTag { get; set; }

Property Value

string

UniqueId

Gets the unique id of the frame for that session. Note: This property is not garanteed to be the same between requests to the same page so it shouldn't be serialized as part of this frame's information. This is an IE specific property.

Declaration

cs-api-definition
[Browsable(false)]
public string UniqueId { get; }

Property Value

string

UseQuery

Whether or not to include the query string when comparing the src string.

Declaration

cs-api-definition
[DataMember(Name = "_useQuery", IsRequired = false)]
public bool UseQuery { get; set; }

Property Value

bool

Methods

Clone()

Clone a frame info object.

Declaration

cs-api-definition
public object Clone()

Returns

object

The frame info object.

Implements ICloneable.Clone()

Equals(object)

Determines if two FrameInfo objects are equal.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

The object to comapre to.

Returns

bool

True/False whether the two objects are equal.

Overrides object.Equals(object)

GetHashCode()

Get hash code of this FrameInfo object.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

The hash code.

Overrides object.GetHashCode()

GetIndexer(out string)

Get the set indexer on this FrameInfo

Declaration

cs-api-definition
public object GetIndexer(out string frameFindParamParameter)

Parameters

frameFindParamParameter

string

Returns the index type being used to locate this IFrame.

Returns

object

The value of index used to locate this IFrame.

GetRectangle()

Returns this Frame's Rectangle in screen coordinates.

Declaration

cs-api-definition
public Rectangle GetRectangle()

Returns

Rectangle

The frame's rectangular screen coordinates.

Exceptions

ArithmeticException

Thrown when we can't get the rectangle coordinates of a Frame from the browser.

ToString()

String representation of the frame info.

Declaration

cs-api-definition
public override string ToString()

Returns

string

The string.

Overrides object.ToString()

Events

PropertyChanged

Occurs when a property on the FrameInfo object changes.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged

In this article
DefinitionConstructorsFrameInfo()FrameInfo(string, string, string, int)FrameInfo(string, string, string, string, int, bool)FrameInfo(string, string, string, string, int, bool, bool)FrameInfo(string, string, string, string, int, bool, bool, string)PropertiesBaseURLIdIndexNameQueryRectangleSrcTestStudioTagUniqueIdUseQueryMethodsClone()Equals(object)GetHashCode()GetIndexer(out string)GetRectangle()ToString()EventsPropertyChanged
Not finding the help you need?
Contact Support