StaticTextTableVariable¶

class StaticTextTableVariable¶

Returned by

VariableApi.CreateStaticTextTableVariable

AddEntry(value)¶

Adds an entry to the Texttable.

Parameters:

value : str¶: The new entry

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:: A copy of this object
Return type:: StaticTextTableVariable

GetDescription()¶

Returns the description of the variable.

Returns:: Description of variable
Return type:: str

GetEntries()¶

Returns all entries of the Texttable.

Returns:: All Entries of the Texttable.
Return type:: list[str]

GetEntry(index)¶

Returns the value at a specific index of the Texttable.

Parameters:

index : int¶: Index of the entry whose value is to be set

Returns:

value at the given index

Return type:

str

GetInitialValue()¶

Returns the initial value of the Texttable.

Returns:: The initial value of the Texttable
Return type:: str

GetName()¶

Returns the name of the variable.

Returns:: Name of variable
Return type:: str

GetType()¶

Returns the type of the initial value of the variable.

Returns:: type of the initial value
Return type:: str

IsParameter()¶

Returns whether the variable is a parameter.

Returns:: True if parameter, else False
Return type:: boolean

IsRecorded()¶

Returns whether the variable is recorded during execution.

Returns:: True if recorded, else False
Return type:: boolean

IsReturn()¶

Returns whether the variable is a return value.

Returns:: True if return value, else False
Return type:: boolean

RemoveEntry(index)¶

Removes an entry from the Texttable.

Parameters:

index : int¶: Index of the entry to remove

SetDescription(description)¶

Sets the description of the variable.

Parameters:

description : str¶: Description of variable

SetEntry(index, value)¶

Sets the value at a specific index in the Texttable.

Parameters:

index : int¶: Index of the entry whose value is to be set
value : str¶: new value

SetInitialValue(value)¶

Sets the initial value of the Texttable.

Parameters:

value : str¶: The initial value of the Texttable.

SetParameter(enable=True)¶

Sets whether the variable is a parameter or not.

Parameters:

enable : boolean¶: Whether the variable is a parameter or not

SetRecorded(enable=True)¶

Sets the recording state of the variable to the value of enable.

Parameters:

enable : boolean¶: Whether to enable the recording of the variable

SetReturn(enable=True)¶

Sets whether the variable is a return value or not.

Parameters:

enable : boolean¶: Whether the variable is a return value or not