Class
ExistsVerificationDescriptor

Definition

Namespace:ArtOfTest.WebAii.Design.IntrinsicTranslators.Descriptors

Assembly:ArtOfTest.WebAii.Design.dll

Syntax:

cs-api-definition
[DataContract(Namespace = "http://artoftest.com/schemas/WebAiiDesignCanvas/1.0.0")]
[Sentence("Exists", "Wait for element 'exists' is {Exists}", false)]
[SupportsImageCapture(false)]
[ImageNotApplicableNotification("Wait for exist step does not record image by default.")]
public class ExistsVerificationDescriptor : VerificationDescriptor, INotifyPropertyChanged, ICustomTypeDescriptor, IExtensibleDataObject, IQuickTasks

Inheritance: objectDataBoundObjectAutomationDescriptorVerificationDescriptorExistsVerificationDescriptor

Derived Classes: ElementExistsVerificationDescriptor

Implements: ICustomTypeDescriptorIExtensibleDataObjectINotifyPropertyChangedIQuickTasks

Inherited Members VerificationDescriptor.EnsureTargetsAreCurrent()VerificationDescriptor.SetRole(VerificationDescriptorRole)VerificationDescriptor.GetDescriptionPrefix()VerificationDescriptor.DataBindVariableNameVerificationDescriptor.TimeoutVerificationDescriptor.CheckIntervalVerificationDescriptor.EnsureStateIsCurrentVerificationDescriptor.SupportsWaitVerificationDescriptor.SupportsExtractionVerificationDescriptor.SupportsConvertToCodeAutomationDescriptor._elementDescriptorsAutomationDescriptor._dataBindingExpressionsAutomationDescriptor._typeAutomationDescriptor._waitOnElementsExistFirstAutomationDescriptor._searchByImageFirstAutomationDescriptor._waitOnElementsExistTimeoutAutomationDescriptor._pauseTypeAutomationDescriptor._testMethodAutomationDescriptor._editorTypeAutomationDescriptor._quickTasksAutomationDescriptor._targetsAutomationDescriptor._hasQuickTaskAutomationDescriptor._dynamicReadOnlyPropertiesAutomationDescriptor._dynamicVisibilityPropertiesAutomationDescriptor.OnBeforeElementDescriptorAdded(string, ITargetElement, FindExpressionElement)AutomationDescriptor.OnBeforeConfirmRecording(object)AutomationDescriptor.GetProjectLanguage()AutomationDescriptor.Clone()AutomationDescriptor.UsesTarget(string)AutomationDescriptor.HasRequiredValue(string, object)AutomationDescriptor.IsDataBound(string)AutomationDescriptor.BindData(string)AutomationDescriptor.BindDataCode(string, string, Type)AutomationDescriptor.ChangeTarget(ElementDescriptor, string)AutomationDescriptor.GetParentsReference(ElementDescriptor)AutomationDescriptor.CreateElementReference(string)AutomationDescriptor.CreateElementReference(string, bool, int)AutomationDescriptor.GetValidVariableName(string)AutomationDescriptor.GetNumberedVariableName(string)AutomationDescriptor.InvokeMethod(string, string, params object[])AutomationDescriptor.InvokeMethod(string, string, CodeGenerationLanguage, params object[])AutomationDescriptor.InvokeMethod(string, Type, bool, string, params object[])AutomationDescriptor.InvokeMethod(string, Type, bool, string, CodeGenerationLanguage, params object[])AutomationDescriptor.InvokeMethod(string, bool, string, params object[])AutomationDescriptor.InvokeMethod(string, bool, string, CodeGenerationLanguage, params object[])AutomationDescriptor.InvokeMethod(CodeExpression, bool, string, params object[])AutomationDescriptor.InvokeMethod(CodeExpression, bool, string, CodeGenerationLanguage, params object[])AutomationDescriptor.InvokeWaitForExistsMethod(CodeExpression)AutomationDescriptor.ParseParameters(object[], out bool, CodeGenerationLanguage)AutomationDescriptor.InvokeWaitMethod(string, Type, int, int, CodeExpression)AutomationDescriptor.InvokeWaitMethod(string, Type, int, int, CodeExpression, CodeGenerationLanguage)AutomationDescriptor.GenerateLambdaVariableRef()AutomationDescriptor.GenerateLambdaVariableRef(int)AutomationDescriptor.GenerateLambdaExpression(CodeVariableReferenceExpression, CodeExpression, bool)AutomationDescriptor.GenerateLambdaExpression(CodeVariableReferenceExpression[], CodeExpression, bool)AutomationDescriptor.GenerateTernaryExpression(CodeExpression, CodeExpression, CodeExpression)AutomationDescriptor.GetLambdaVariableReference()AutomationDescriptor.GetLambdaExpression(CodeGenerationLanguage, CodeExpression)AutomationDescriptor.GetLambdaExpression(CodeGenerationLanguage, CodeExpression, bool)AutomationDescriptor.GetNoParamLamdaExpression(CodeGenerationLanguage, CodeExpression)AutomationDescriptor.InvokeWaitMethod(string, Type, int, int, string, params object[])AutomationDescriptor.InvokeWaitMethod(string, Type, int, int, string, CodeGenerationLanguage, params object[])AutomationDescriptor.SetProperty(string, Type, object)AutomationDescriptor.SetProperty(string, Type, object, CodeGenerationLanguage)AutomationDescriptor.SetProperty(CodeExpression, object)AutomationDescriptor.SetProperty(CodeExpression, object, CodeGenerationLanguage)AutomationDescriptor.NotifyElementNameChange(ElementDescriptor)AutomationDescriptor.GetHashCode()AutomationDescriptor.OnPropertyChanged(string)AutomationDescriptor.GetAttributes()AutomationDescriptor.GetClassName()AutomationDescriptor.GetComponentName()AutomationDescriptor.GetConverter()AutomationDescriptor.GetDefaultEvent()AutomationDescriptor.GetDefaultProperty()AutomationDescriptor.GetEditor(Type)AutomationDescriptor.GetEvents(Attribute[])AutomationDescriptor.GetEvents()AutomationDescriptor.GetProperties(Attribute[])AutomationDescriptor.GetProperties()AutomationDescriptor.GetPropertyOwner(PropertyDescriptor)AutomationDescriptor.AreSameIncludingElements(AutomationDescriptor, AutomationDescriptor)AutomationDescriptor.ConsolidateText(string, string)AutomationDescriptor.ConsolidateText(string, string, TextTypingInfo)AutomationDescriptor.ToString()AutomationDescriptor.CreateControlFromTarget<TControl>(string, int)AutomationDescriptor.CreateControlFromElement<TControl>(Element, int)AutomationDescriptor.SupportsElementType(Type)AutomationDescriptor.PrimaryPropertiesAutomationDescriptor.RequiredAssemblyReferencesAutomationDescriptor.SecondaryTargetKeyAutomationDescriptor.PauseAutomationDescriptor.DontUseDomStateAutomationDescriptor.RunsAgainstAutomationDescriptor.RunsAgainstVersionAutomationDescriptor.RunsAgainstVersionCompareAutomationDescriptor.ConstraintsAutomationDescriptor.IsSearchByImageApllicableAutomationDescriptor.TargetsAutomationDescriptor.ElementDescriptorsAutomationDescriptor.HasQuickTasksAutomationDescriptor.QuickTasksAutomationDescriptor.StepTypeAutomationDescriptor.LogMessageOnFailureAutomationDescriptor.TestMethodAutomationDescriptor.EditorTypeAutomationDescriptor.EditorTypeStringAutomationDescriptor.DataBindingExpressionsAutomationDescriptor.DynamicReadOnlyPropertiesAutomationDescriptor.DynamicVisibilityPropertiesAutomationDescriptor.TargetsCustomControlTypesAutomationDescriptor.SecondaryTargetAutomationDescriptor.CustomOrFriendlyDescriptionAutomationDescriptor.DescriptorTypeAutomationDescriptor.CodeGenModeAutomationDescriptor.TargetSearchAlgorithmAutomationDescriptor.ExtensionDataAutomationDescriptor.PropertyChangedDataBoundObject._dataDataBoundObject.BindData<T>(string)DataBoundObject.BindDataCode(string)DataBoundObject.BindDataCode(string, PropertyInfo)DataBoundObject.Data

Constructors

ExistsVerificationDescriptor()

Declaration

cs-api-definition
public ExistsVerificationDescriptor()

ExistsVerificationDescriptor(ITargetElement, bool)

Create a new ExistsVerificationDescriptor

Declaration

cs-api-definition
public ExistsVerificationDescriptor(ITargetElement element, bool existsNot)

Parameters

element

ITargetElement

The target element

existsNot

bool

Properties

Exists

Declaration

cs-api-definition
[PrimaryProperty]
[SentenceParam("exists?", AutomationDescriptorType.Extraction, IsExtractedValue = true)]
[DataDriven]
public bool Exists { get; set; }

Property Value

bool

ExistsNot

Gets or sets whether to verify non-existence

Declaration

cs-api-definition
[Browsable(false)]
[DataMember(Name = "ExistsNot")]
[PrimaryProperty]
public bool ExistsNot { get; set; }

Property Value

bool

FriendlyDescription

Get a friendly description of this descriptor to show in the scenario explorer.

Declaration

cs-api-definition
public override string FriendlyDescription { get; }

Property Value

string

Overrides AutomationDescriptor.FriendlyDescription

IsWaitOnly

Gets whether this descriptor can only be used for sync.

Declaration

cs-api-definition
public override bool IsWaitOnly { get; }

Property Value

bool

Overrides VerificationDescriptor.IsWaitOnly

PrimaryTarget

Declaration

cs-api-definition
public override ElementDescriptor PrimaryTarget { get; set; }

Property Value

ElementDescriptor

Overrides AutomationDescriptor.PrimaryTarget

PrimaryTargetKey

Gets the primary target key

Declaration

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

Property Value

string

Overrides AutomationDescriptor.PrimaryTargetKey

SearchByImageFirst

Declaration

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

Property Value

SearchElementOrderType

TechnologyType

Gets the technology that this step runs against

Declaration

cs-api-definition
public override TechnologyType TechnologyType { get; }

Property Value

TechnologyType

Overrides AutomationDescriptor.TechnologyType

UseStepWaitOnElementsTimout

Declaration

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

Property Value

bool

Overrides AutomationDescriptor.UseStepWaitOnElementsTimout

WaitOnElements

Declaration

cs-api-definition
[Browsable(false)]
[DataMember(Name = "WaitOnElements")]
public override bool WaitOnElements { get; set; }

Property Value

bool

Overrides AutomationDescriptor.WaitOnElements

WaitOnElementsTimeout

Declaration

cs-api-definition
[Browsable(false)]
[DataMember(Name = "WaitOnElementsTimeout")]
public override int WaitOnElementsTimeout { get; set; }

Property Value

int

Overrides AutomationDescriptor.WaitOnElementsTimeout

Methods

CreateElementFindExpression(string)

Creates a CodeDOM expression for the element's terminal FindExpression

Declaration

cs-api-definition
protected override CodeExpression CreateElementFindExpression(string elementKey)

Parameters

elementKey

string

Key into this descriptors collection of element descriptors for the desired element

Returns

CodeExpression

A CodeDOM expression that constructs a new FindExpression specifying the desired element

Overrides AutomationDescriptor.CreateElementFindExpression(string)

ExtractData(IAutomationHost, DescriptorValueStore)

Extract verification data from the live Targets.

Declaration

cs-api-definition
public override void ExtractData(IAutomationHost targetBrowser, DescriptorValueStore dataStore)

Parameters

targetBrowser

IAutomationHost

The target browser.

dataStore

DescriptorValueStore

Overrides VerificationDescriptor.ExtractData(IAutomationHost, DescriptorValueStore)

GetQuickTasks()

Declaration

cs-api-definition
public virtual IQuickTask[] GetQuickTasks()

Returns

IQuickTask[]

Implements IQuickTasks.GetQuickTasks()

PerformWait(IAutomationHost)

Helper routine that can perform a wait until the verification defined by this descriptor passes or the this.Timeout is reached.

Declaration

cs-api-definition
public override VerificationWaitResult PerformWait(IAutomationHost host)

Parameters

host

IAutomationHost

The host object

Returns

VerificationWaitResult

Overrides VerificationDescriptor.PerformWait(IAutomationHost)

ToCode()

This method is called when the user requests code generation. The framework initializes the TestMethod property of this object with a new instance that this method simply needs to add its custom codegen to it.

Declaration

cs-api-definition
public override void ToCode()

Overrides AutomationDescriptor.ToCode()

Verify(DescriptorValueStore)

Given a value store, verify against the constraints defined by this descriptor

Declaration

cs-api-definition
public override VerificationResult Verify(DescriptorValueStore dataStore)

Parameters

dataStore

DescriptorValueStore

The data store were values are captured

Returns

VerificationResult

The verification result.

Overrides VerificationDescriptor.Verify(DescriptorValueStore)