Class

Sentence

Gets the descriptor associated with this Sentence.

Declaration

public AutomationDescriptor Descriptor { get; }

Property Value

Gets the display name for this sentence.

Declaration

public string DisplayName { get; }

Property Value

Exteneded EditParam info

Declaration

public DescriptorValueStore ExtendedEditParamInfo { get; }

Property Value

Gets whether the descriptor associated with this sentence has a live descriptor (i.e. has its Targets[] collection initialized with live Elements)

Declaration

public bool HasLiveDescriptor { get; }

Property Value

Get whether the sentence is build in the execution context (for instance the logical step execution). ///

Declaration

public bool IsExecutionContext { get; set; }

Property Value

Whether all the sentence param are set.

Declaration

public bool IsValid { get; }

Property Value

Gets the dictionary of params. The key is the parameter PropertyName.

Declaration

public IDictionary<string, SentenceParam> Params { get; }

Property Value

Gets the SentenceParam list of this Sentence (in correct order as per the definition)

Declaration

public IList<SentenceParam> ParamsList { get; }

Property Value

Get a string representation of this sentence. Ignore properties that are not set

Declaration

public string PreviewString { get; }

Property Value

Assign a descriptor to this sentence

Declaration

public void AssignDescriptor(AutomationDescriptor descriptor)

Parameters

Clone this sentence

Declaration

public Sentence Clone()

Returns

Given a descriptor, build a sentence from it. Will use the first sentence definition if multiple is defined.

Declaration

public static Sentence CreateNew(AutomationDescriptor descriptor, bool throwOnError, bool isExecutionContext)

Parameters

Returns

Generate a list of preview sentences

Declaration

public Sentence[] GeneratePreviewList()

Returns

Given a type, return any sentence definitions set on it.

Declaration

public static SentenceAttribute[] GetSentenceDefinitions(Type type)

Parameters

Returns

Called when the UI is about to load this sentence

Declaration

public void OnLoad()

If the descritpor associated with this sentence if a VerificationDescriptor and has a live descriptor, this method will perform the validation as if the descriptor is being executed

Declaration

public string PerformVerificationValidation()

Returns

Persist the values of this sentence to its associated descritpr

Declaration

public void PersistToDescriptor()

Populates any extended edit parameter info.

Declaration

public void PopulateExtendEditInfo()

Populate the param values of the sentence from the associated descriptor

Declaration

public void PopulateParamValues()

Given a value store, populate the sentence param values

Declaration

public void PopulateParamValues(DescriptorValueStore valuesStore, bool populateMissingValuesFromDescriptor)

Parameters

The sentence defintion

Declaration

public override string ToString()

Returns

Overrides object.ToString()