Interface IFrame
A Web frame object that represents both the frame element in a frame set and an embedded frame that uses the iframe element.
Inherited Members
Namespace: HP.LFT.SDK.Web
Assembly: HP.LFT.SDK.dll
Syntax
public interface IFrame : ITestObject, IWebTestObject, IWebDescriber, ITestObjectDescriber, ILocationInfoProvider, ISupportsNativeObject, IVisibleProvider
Remarks
The frame is a separate HTML document that is part of the test object hierarchy.
Properties
Text
The inner text of the body element.
Declaration
string Text { get; }
Property Value
| Type | Description |
|---|---|
| string |
Url
The URL of the frame.
Declaration
string Url { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
Describe<TChild>(IDescription)
Describes a child test object.
Declaration
TChild Describe<TChild>(IDescription description) where TChild : class, ITestObject
Parameters
| Type | Name | Description |
|---|---|---|
| IDescription | description | The child test object description |
Returns
| Type | Description |
|---|---|
| TChild | The requested child test object with its description |
Type Parameters
| Name | Description |
|---|---|
| TChild | The child test object type |
Remarks
The current instance test object is the parent of the returned test object. This test object is searched for only when an operation on this test object is invoked. This means that if the test object is not found in the application, this command will still succeed. In this case, an exception is thrown only when an operation is invoked.
Describe<TChild>(CSSDescription)
Describes a child test object using the provided CSS selector.
Declaration
TChild Describe<TChild>(CSSDescription cssSelector) where TChild : class, IWebElement
Parameters
| Type | Name | Description |
|---|---|---|
| CSSDescription | cssSelector | The CSS selector query used to find the child test object |
Returns
| Type | Description |
|---|---|
| TChild | The requested child test object with its description |
Type Parameters
| Name | Description |
|---|---|
| TChild | The child test object type |
Remarks
The current instance test object is the parent of the returned test object. This test object is searched for only when an operation on this test object is invoked. This means that if the test object is not found in the application, this command will still succeed. In this case, an exception is thrown only when an operation is invoked.
Describe<TChild>(XPathDescription)
Describes a child test object using the provided XPath.
Declaration
TChild Describe<TChild>(XPathDescription xpath) where TChild : class, IWebElement
Parameters
| Type | Name | Description |
|---|---|---|
| XPathDescription | xpath | The XPath used to find the child test object |
Returns
| Type | Description |
|---|---|
| TChild | The requested child test object with its description |
Type Parameters
| Name | Description |
|---|---|
| TChild | The child test object type |
Remarks
The current instance test object is the parent of the returned test object. This test object is searched for only when an operation on this test object is invoked. This means that if the test object is not found in the application, this command will still succeed. In this case, an exception is thrown only when an operation is invoked.
RunJavaScript(string)
Runs the given JavaScript code in the frame's context and returns the result.
Declaration
string RunJavaScript(string scriptToRun)
Parameters
| Type | Name | Description |
|---|---|---|
| string | scriptToRun | The JavaScript code to run. |
Returns
| Type | Description |
|---|---|
| string | The result of running the JavaScript code as a string. |
RunJavaScript<TResult>(string)
Runs the given JavaScript code in the frame's context and returns the result.
Declaration
TResult RunJavaScript<TResult>(string scriptToRun)
Parameters
| Type | Name | Description |
|---|---|---|
| string | scriptToRun | The JavaScript code to run |
Returns
| Type | Description |
|---|---|
| TResult | The result of running the JavaScript code converted to TResult |
Type Parameters
| Name | Description |
|---|---|
| TResult | The type of return value |
Sync()
Waits for the frame's state to be idle.
Declaration
void Sync()