Property¶

class Property¶

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:: Property

GetDefaultValue()¶

Returns the property’s default value.

Returns:: The default value
Return type:: str
See:: Property.GetValueType()

GetDisplayName()¶

Returns the display name of the property.

Returns:: The display name of the property
Return type:: str

GetDomain(allowOnlineQuery=False)¶

Returns the domain of allowed values of this property.

Some properties need to partially connect the tool they belong to in order to determine possible values. Use the parameter allowOnlineQuery to allow that. If you don’t, you might get a dummy entry “<online query>” instead of the actual values.

Parameters:

allowOnlineQuery : bool¶: Onlineabfrage zulassen

Returns:

List of valid values

Return type:

list[str]

GetName()¶

Returns the internal name of the property.

Returns:: The name of the property
Return type:: str

GetValue()¶

Returns the used property value, which is either the configured value or the default value, in case the property is not set.

Returns:: The configured value of the property, or the default value if not set
Return type:: str
See:: Property.GetValueType()

GetValueType()¶

Returns the value type of this property.

Returns:: Value type of this property
Return type:: str

IsReadOnly()¶

Returns whether the property is read-only.

Returns:: Property is read-only?
Return type:: boolean

SetValue(value)¶

Overwrites the value of this property.

Parameters:

value : str¶: New value

See:

GetDomain()

Unset()¶: Specifies that the property is set to its default value.