Class
Settings.WebSettings

Definition

Namespace:ArtOfTest.WebAii.Core

Assembly:ArtOfTest.WebAii.dll

Syntax:

cs-api-definition
[DataContract]
public class Settings.WebSettings

Inheritance: objectSettings.WebSettings

Constructors

WebSettings()

Declaration

cs-api-definition
public WebSettings()

WebSettings(BrowserType)

Create a new Settings object.

Declaration

cs-api-definition
public WebSettings(BrowserType defaultBrowser)

Parameters

defaultBrowser

BrowserType

The default browser to use.

WebSettings(BrowserType, string)

Create a new Settings object.

Declaration

cs-api-definition
public WebSettings(BrowserType defaultBrowser, string baseUrl)

Parameters

defaultBrowser

BrowserType

The default browser to use.

baseUrl

string

The baseUrl to use.

WebSettings(WebSettings)

Create a clone of the passed in settings

Declaration

cs-api-definition
public WebSettings(Settings.WebSettings settingsToClone)

Parameters

settingsToClone

Settings.WebSettings

WebSettings(WebSettingsConfigSectionHandler)

Create a new Settings object from a config section.

Declaration

cs-api-definition
public WebSettings(WebSettingsConfigSectionHandler sectionHandler)

Parameters

sectionHandler

WebSettingsConfigSectionHandler

The config section handler that contains the settings.

WebSettings(string)

Create a new Settings.Web object.

Declaration

cs-api-definition
public WebSettings(string baseUrl)

Parameters

baseUrl

string

The baseUrl to use

Properties

AspNetDevServerPhysicalPath

Gets the physical path

Declaration

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

Property Value

string

AspNetDevServerPort

Gets/Sets the AspNetDevServer (if used) port to use. If this is not set (-1) a random port will be generated each time the manager is created.

Declaration

cs-api-definition
[DataMember]
public int AspNetDevServerPort { get; set; }

Property Value

int

AutoCalibrateBrowsers

Gets or sets whether or not to automatically calibrate the installed browsers which are selected for execution of the testlist. Note: Open browser instances will be closed or killed Default is false.

Declaration

cs-api-definition
[DataMember]
public bool AutoCalibrateBrowsers { get; set; }

Property Value

bool

BaseUrl

Gets/Sets the base url to use for all NavigateTo commands. When set NavigateTo will be used as relative url. The hierarchy will be local, then Test List, then Project defined BaseUrl.

Declaration

cs-api-definition
[DataMember]
public string BaseUrl { get; set; }

Property Value

string

Browser

Serves as a wrapper of the DefaultBrowser property.

Declaration

cs-api-definition
public BrowserExecutionType Browser { get; set; }

Property Value

BrowserExecutionType

ChromiumFirstInteractionDelay

Gets or Sets initial wait time after Chromium browsers navigation to a new URL.

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public int ChromiumFirstInteractionDelay { get; set; }

Property Value

int

ClientMessageReceivedTimeout

Gets/Sets amount of time to wait for a CDP browser to process a message

Declaration

cs-api-definition
[DataMember]
[Browsable(false)]
public int ClientMessageReceivedTimeout { get; set; }

Property Value

int

DefaultBrowser

Gets/Sets a supported default browser type (IE,FireFox ...etc). Default is InternetExplorer.

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public BrowserType DefaultBrowser { get; set; }

Property Value

BrowserType

EnableScriptLogging

Gets/Sets whether or not to enable script logging. Default is false.

Declaration

cs-api-definition
[DataMember]
public bool EnableScriptLogging { get; set; }

Property Value

bool

EnableSilverlight

Gets/Sets whether or not to enable Silverlight automation. Default is false.

Declaration

cs-api-definition
[DataMember]
[Obsolete("Silverlight support has been deprecated!")]
[Browsable(false)]
public bool EnableSilverlight { get; set; }

Property Value

bool

EnableUILessRequestViewing

Gets/Sets whether or not to allow debugging of UILess page requests using a UI browser like IE. Default is false.

Declaration

cs-api-definition
[DataMember]
public bool EnableUILessRequestViewing { get; set; }

Property Value

bool

ExecutingBrowsers

Declaration

cs-api-definition
[Browsable(true)]
[DataMember]
public List<BrowserExecutionType> ExecutingBrowsers { get; set; }

Property Value

List<BrowserExecutionType>

FirefoxMinimumJSClickDelay

Gets or Sets the minimum wait time after Firefox browser performs a JS click.

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public int FirefoxMinimumJSClickDelay { get; set; }

Property Value

int

KillBrowserProcessOnClose

Gets or sets whether to make sure the browser process is killed when closing the browser. Note: Firefox is a single process browser. If you are using multiple browser instances and this setting is on, it will kill all open instances of Firefox when you close one of the instances. Default is false.

Declaration

cs-api-definition
[DataMember]
public bool KillBrowserProcessOnClose { get; set; }

Property Value

bool

KillBrowsersBeforeStart

Kill all executing browser instances before test list starts. Does not affect remote execution runs.

Declaration

cs-api-definition
[DataMember]
public bool KillBrowsersBeforeStart { get; set; }

Property Value

bool

LocalWebServer

Gets/Sets the local web server to use to serve pages. Default is None.

Declaration

cs-api-definition
[DataMember]
public LocalWebServerType LocalWebServer { get; set; }

Property Value

LocalWebServerType

RecycleBrowser

When set to true, once instance of the browser will be launched and recycled through out the test bed and tests until Manager.Dispose is called.

Declaration

cs-api-definition
[DataMember]
public bool RecycleBrowser { get; set; }

Property Value

bool

SilverlightApplicationPath

Gets/Sets the path from which to load a silverlight application

Declaration

cs-api-definition
[DataMember]
[Obsolete("Silverlight support has been deprecated!")]
[Browsable(false)]
public string SilverlightApplicationPath { get; set; }

Property Value

string

SilverlightConnectTimeout

Gets/Sets the Silverlight Application load timeout

Declaration

cs-api-definition
[DataMember]
[Obsolete("Silverlight support has been deprecated!")]
[Browsable(false)]
public int SilverlightConnectTimeout { get; set; }

Property Value

int

UseBrowserExtension

Specify if Chrome or Edge extension should be used to communicate with the browser. Browser extension support has been deprecated! This will always return false.

Declaration

cs-api-definition
[DataMember]
[Obsolete("Browser extension support has been deprecated! This will always return false.")]
[Browsable(false)]
public bool UseBrowserExtension { get; set; }

Property Value

bool

UseHttpProxy

Gets/Sets whether or not to use the built-in http proxy during automation. Default is false.

Declaration

cs-api-definition
[DataMember]
public bool UseHttpProxy { get; set; }

Property Value

bool

UseMultiBrowserExecution

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public bool UseMultiBrowserExecution { get; set; }

Property Value

bool

VerboseHttpProxy

Gets/Sets whether the HTTP proxy produces lots of tracing output. Default is false.

Declaration

cs-api-definition
[DataMember]
public bool VerboseHttpProxy { get; set; }

Property Value

bool

WebAppPhysicalPath

Gets/Sets the physical path to the application to test when running under the ASP.NET development server. Default is string.empty.

C:\Inetpub\wwwroot\myApp</example>

Declaration

cs-api-definition
[DataMember]
public string WebAppPhysicalPath { get; set; }

Property Value

string

WebComponents

Enable Web Components. Default is true (supported).

Declaration

cs-api-definition
[Browsable(true)]
[DataMember]
public bool WebComponents { get; set; }

Property Value

bool

WebKitExecutionDelay

Declaration

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

Property Value

int

Methods

PersistToConfigSection(WebSettingsConfigSectionHandler)

Persist current Settings to a section handler.

Declaration

cs-api-definition
public void PersistToConfigSection(WebSettingsConfigSectionHandler sectionHandler)

Parameters

sectionHandler

WebSettingsConfigSectionHandler

SetWebAppPhysicalBase(string)

Set the WebApp Physical base to be used when using relative WebAppPhysicalBase.

Declaration

cs-api-definition
public void SetWebAppPhysicalBase(string physicalBase)

Parameters

physicalBase

string

Physical app base

Validate()

Declaration

cs-api-definition
public void Validate()