Class
Settings

Class representing the settings to be used when initializing the framework.

Definition

Namespace:ArtOfTest.WebAii.Core

Assembly:ArtOfTest.WebAii.dll

Syntax:

cs-api-definition
[DataContract]
public class Settings

Inheritance: objectSettings

Constructors

Settings()

Create a new instance of Settings class.

Declaration

cs-api-definition
public Settings()

Settings(Settings)

Create a clone of the passed in settings

Declaration

cs-api-definition
public Settings(Settings settingsToClone)

Parameters

settingsToClone

Settings

Settings(SettingsConfigSectionHandler)

Create a new Settings object from a config section.

Declaration

cs-api-definition
public Settings(SettingsConfigSectionHandler sectionHandler)

Parameters

sectionHandler

SettingsConfigSectionHandler

The config section handler that contains the settings.

Settings(WebSettings, WpfSettings)

Create a new instance of Settings class.

Declaration

cs-api-definition
public Settings(Settings.WebSettings webSettings, Settings.WpfSettings wpfSettings)

Parameters

webSettings

Settings.WebSettings

Web settings

wpfSettings

Settings.WpfSettings

WPF settings

Settings(WebSettings, WpfSettings, ResponsiveWebSettings)

Create a new instance of Settings class.

Declaration

cs-api-definition
public Settings(Settings.WebSettings webSettings, Settings.WpfSettings wpfSettings, Settings.ResponsiveWebSettings responsiveWebSettings)

Parameters

webSettings

Settings.WebSettings

Web settings

wpfSettings

Settings.WpfSettings

WPF settings

responsiveWebSettings

Settings.ResponsiveWebSettings

Responsive web settings

Settings(WebSettings, WpfSettings, ResponsiveWebSettings, DesktopSettings)

Create a new instance of Settings class.

Declaration

cs-api-definition
public Settings(Settings.WebSettings webSettings, Settings.WpfSettings wpfSettings, Settings.ResponsiveWebSettings responsiveWebSettings, Settings.DesktopSettings desktopSettings)

Parameters

webSettings

Settings.WebSettings

Web settings

wpfSettings

Settings.WpfSettings

WPF settings

responsiveWebSettings

Settings.ResponsiveWebSettings

Responsive web settings

desktopSettings

Settings.DesktopSettings

Desktop settings

Fields

ObsoleteProperties

XmlSerializer won't deserialize properties marked as Obsolete So we'll keep a list here of all our obsolete properties, for use when encountering an UnknownElement during Deserialization

Declaration

cs-api-definition
public static readonly Dictionary<string, Type> ObsoleteProperties

Field Value

Dictionary<string, Type>

Properties

AnnotateExecution

Gets/Sets whether to highlight/annotate the target elements that action is being executed against. Default is false.

Declaration

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

Property Value

bool

AnnotationMode

Gets/Sets the annotation mode when annotation is enabled. Default is All.

Declaration

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

Property Value

AnnotationMode

ClientReadyTimeout

Gets/Sets timeout used to wait for a client to be ready after initial launch and after executing a command. (msec.). Default is 60000 msec.

Declaration

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

Property Value

int

CreateLogFile

Gets or sets whether or not to create a log file on disk. This value is read once at initialization time. Changing this value during test execution has no effect. Default is true

Declaration

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

Property Value

bool

Current

The current settings object.

Declaration

cs-api-definition
public static Settings Current { get; }

Property Value

Settings

Desktop

Container for all desktop specific settings

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public Settings.DesktopSettings Desktop { get; set; }

Property Value

Settings.DesktopSettings

DisableDialogMonitoring

Disable handling of dialog windows. Default value is false.

Declaration

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

Property Value

bool

ElementImageSearchDelay

Gets/sets delay before searching element image.

Declaration

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

Property Value

int

ElementImageSearchTimeout

Gets/sets timeout for finding elements by image.

Declaration

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

Property Value

int

ElementWaitTimeout

Gets/Sets the global wait on elements timeout that will be used during execution.

Declaration

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

Property Value

int

EnableImageSearch

Gets/sets whether image search is enabled or not.

Declaration

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

Property Value

bool

ExecuteCommandTimeout

Gets/Sets The timeout to wait for a command request to execute. (msec.). Default is 30000 msec.

Declaration

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

Property Value

int

ExecuteInDevelopmentTests

Gets/Sets the execute In Development tests. By default skip execution of In Development tests.

Declaration

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

Property Value

bool

ExecutionDelay

Gets/Sets an execution delay in between commands. This can help in observing test execution. Default is zero.

Declaration

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

Property Value

int

Is64BitOS

Whether or not we're a 32-bit app running on a 64 bit OS

Declaration

cs-api-definition
public static bool Is64BitOS { get; }

Property Value

bool

IsUserInteractiveMode

Gets whether the test is running in a user interactive mode or as non-user interactive.

Declaration

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

Property Value

bool

LogAnnotations

Gets/Sets whether or not to log annotations to the log file. Default is false.

Declaration

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

Property Value

bool

LogLocation

Gets/Sets the location where to perform all the logging. Default is C:\WebAiiLog.

Declaration

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

Property Value

string

QueryEventLogErrorsOnExit

Gets/Sets whether to query the event log on manager exit for any error logged from automation clients. Any errors will be logged to the test log. Default is false.

Declaration

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

Property Value

bool

RecordingCodec

Gets/Sets the screen recording codec. Default is MJPEG.

Declaration

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

Property Value

RecordingCodec

RecordingFPS

Gets/Sets the screen recording scale. Default is 100%.

Declaration

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

Property Value

int

RecordingMode

Gets/Sets the screen recording mode. Default is Off.

Declaration

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

Property Value

RecordingMode

RecordingOutputLocation

Gets/Sets the screen recording scale. Default is 100%.

Declaration

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

Property Value

string

RecordingScale

Gets/Sets the screen recording scale. Default is 100%.

Declaration

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

Property Value

int

RecordingSizeLimit

Gets/Sets the screen recording size limit. Default is 0 (unlimited).

Declaration

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

Property Value

int

RerunFailedTests

Gets/Sets an auto rerun failed test. This enables auto rerun tests when the test list is finished and some of the tests are failed. Default is false.

Declaration

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

Property Value

bool

ResponsiveWeb

Responsive web settings.

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public Settings.ResponsiveWebSettings ResponsiveWeb { get; set; }

Property Value

Settings.ResponsiveWebSettings

RunnerResponseTimeout

Gets/sets the timeout (how long to wait in msec.) for a response from ArtOfTest.Runner

Declaration

cs-api-definition
[DataMember]
public double RunnerResponseTimeout { get; set; }

Property Value

double

ScrollOnImageSearch

Use scrolling when searching by image.

Declaration

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

Property Value

bool

SearchByImageFirst

Gets/Sets the global search by image first.

Declaration

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

Property Value

bool

SimulatedMouseMoveSpeed

Gets/Sets the simulated mouse move speed for Desktop.Mouse.Move()/DragDrop() operations in pixels/msec. [Typically between 0.1f - .5f] Default is 0.3f

Declaration

cs-api-definition
[DataMember]
public float SimulatedMouseMoveSpeed { get; set; }

Property Value

float

TelerikComponentsVersion

The Telerik Components version to use

Declaration

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

Property Value

TelerikComponentsVersion

UnexpectedDialogAction

Gets/Sets the action of the DialogMonitor when unexpected dialog is encountered.

Declaration

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

Property Value

UnexpectedDialogAction

WaitCheckInterval

Gets/Sets the interval in msec. to use between checks for all the WaitForxx methods. Default is 500 msec.

Declaration

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

Property Value

int

Web

Container for all web specific settings

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public Settings.WebSettings Web { get; set; }

Property Value

Settings.WebSettings

Wpf

Container for all wpf specific settings

Declaration

cs-api-definition
[Browsable(false)]
[DataMember]
public Settings.WpfSettings Wpf { get; set; }

Property Value

Settings.WpfSettings

XMultiMgr

Gets/Sets whether or not to use WebAii 1.1 style connections. Default is false.

Declaration

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

Property Value

bool

Methods

Clone()

Clone the existing settings

Declaration

cs-api-definition
public Settings Clone()

Returns

Settings

The cloned settings

PersistToConfigSection(SettingsConfigSectionHandler)

Persist current Settings to a section handler.

Declaration

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

Parameters

sectionHandler

SettingsConfigSectionHandler

Reset()

Resets all settings to the default system settings of the infrastructure.

The following are the system default settings:

DefaultBrowser=InternetExplorer ClientReadyTimeout=30000 ExecutionCommandTimeout=20000 LogLocation='C:\WebAiiLog' WebAppPhysicalPath="" EnableScriptLogging=false QueryEventLogErrorsOnExit=false LocalWebServer=LocalWebServerType.None EnableUILessRequestViewing=false BaseUrl="" ExecutionDelay=0 AnnotateExecution=false SimulatedMouseMoveSpeed=0.3f waitCheckInterval=500 aspNetDevServer=-1 annotationMode=All logAnnotations=false createLogFile=true killBrowserProcessOnClose=false killBrowsersBeforeStart=false recycleBrowser=false enableSilverlight=false useHttpProxy=false verboseHttpProxy=false SilverlightConnectTimeout=60000msec RecordingMode=Off RecordingCodec=MJPEG RecordingScale=100

Declaration

cs-api-definition
public void Reset()

Validate()

Validate the settings.

Declaration

cs-api-definition
public void Validate()