Class
FramesCollection

Collection of frames (Browser objects)

Definition

Namespace:ArtOfTest.WebAii.Core

Assembly:ArtOfTest.WebAii.dll

Syntax:

cs-api-definition
public class FramesCollection : Dictionary<string, Browser>, IDictionary<string, Browser>, ICollection<KeyValuePair<string, Browser>>, IDictionary, ICollection, IReadOnlyDictionary<string, Browser>, IReadOnlyCollection<KeyValuePair<string, Browser>>, IEnumerable<KeyValuePair<string, Browser>>, ISerializable, IDeserializationCallback, IEnumerable<Browser>, IEnumerable

Inheritance: objectDictionary<string, Browser>FramesCollection

Implements: ICollectionICollection<KeyValuePair<string, Browser>>IDeserializationCallbackIDictionaryIDictionary<string, Browser>IEnumerableIEnumerable<Browser>IEnumerable<KeyValuePair<string, Browser>>IReadOnlyCollection<KeyValuePair<string, Browser>>IReadOnlyDictionary<string, Browser>ISerializable

Inherited Members Dictionary<string, Browser>.Add(string, Browser)Dictionary<string, Browser>.Clear()Dictionary<string, Browser>.ContainsKey(string)Dictionary<string, Browser>.ContainsValue(Browser)Dictionary<string, Browser>.GetEnumerator()Dictionary<string, Browser>.GetObjectData(SerializationInfo, StreamingContext)Dictionary<string, Browser>.OnDeserialization(object)Dictionary<string, Browser>.Remove(string)Dictionary<string, Browser>.TryGetValue(string, out Browser)Dictionary<string, Browser>.ComparerDictionary<string, Browser>.CountDictionary<string, Browser>.KeysDictionary<string, Browser>.ValuesDictionary<string, Browser>.this[string]

Constructors

FramesCollection()

Declaration

cs-api-definition
public FramesCollection()

Properties

this[FrameInfo]

Get the frame based on its FrameInfo.

Declaration

cs-api-definition
public Browser this[FrameInfo frameInfo] { get; }

Parameters

frameInfo

FrameInfo

The frameinfo.

Property Value

Browser

The Frame, else null.

Remarks

If more than one frame in the FrameCollection matches the FrameInfo argument, we will return the frame that matches frameInfo.Index.

this[int]

Get the frame at a specific index.

Declaration

cs-api-definition
public Browser this[int index] { get; }

Parameters

index

int

The frame index.

Property Value

Browser

The frame object.

this[string]

Get a frame using its name.

Declaration

cs-api-definition
public Browser this[string name] { get; }

Parameters

name

string

The frame name. (prefix with '~' to indicate partial string)

Property Value

Browser

A frame if matching name found, otherwise 'null'.

Methods

ById(string)

Gets a frame using its id.

Declaration

cs-api-definition
public Browser ById(string frameid)

Parameters

frameid

string

The frame id to find. (prefix with '~' to indicate partial string)

Returns

Browser

The frame Browser object or else null.

BySrc(string)

Gets a frame using its src

Declaration

cs-api-definition
public Browser BySrc(string src)

Parameters

src

string

The src value to search for. (prefix with '~' to indicate partial string)

Returns

Browser

The frame Browser object or else null.

GetEnumerator()

Get the enumerator.

Declaration

cs-api-definition
public IEnumerator<Browser> GetEnumerator()

Returns

IEnumerator<Browser>

This collection's enumerator

Implements IEnumerable<Browser>.GetEnumerator()

GetFramesAsStrings()

Get a list of all frames in this collection.

Declaration

cs-api-definition
public string GetFramesAsStrings()

Returns

string

A description of all frames contained in this collection as a string.

RefreshAllDomTrees()

Refresh all dom trees in this frames collection.

Declaration

cs-api-definition
public void RefreshAllDomTrees()

WaitAllUntilReady()

Waits until all frames are ready.

Declaration

cs-api-definition
public void WaitAllUntilReady()