TsMessageDialog¶
- class TsMessageDialog¶
Returned by
- 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:
-
CreateButton(labelExpr, returnExpr, insPos=
None)¶ Creates a button and inserts it at the given position.
- DeactivateSaveInVariable()¶
Deactivates the save in variable option.
- DeactivateTimeOut()¶
Deactivates the time out option.
- DeleteTranslatedCommentText(language)¶
Deletes a comment for the test step in the given language.
- Parameters:
- language : str¶
Language of the text (‘en_US’, ‘de_DE’, ‘zh_CN’)
- GetActionColumnText()¶
Returns the text value of the “action” column.
- Returns:
Action column text
- Return type:
str
- GetButtonCount()¶
Returns the count of buttons that are defined.
- Returns:
Button count
- Return type:
integer
- GetButtonLabelExpressionByIndex(idx)¶
Returns the button label expression of the button specified by idx.
- Parameters:
- idx : integer¶
Index of the button
- Returns:
Label expression of the button
- Return type:
str
- GetButtonReturnExpressionByIndex(idx)¶
Returns the button return expression of the button specified by idx.
- Parameters:
- idx : integer¶
Index of the button
- Returns:
Return expression of the button
- Return type:
str
- GetButtons()¶
Returns all buttons as dictionary containing labels as keys and return expressions as values.
- Returns:
Dictionary of labels and return expressions
- Return type:
dict[string, string]
- GetComment()¶
Returns the comment of the test step in the current test case language.
- Returns:
Comment text as shown in the comment tab
- Return type:
str
- GetCommentColumnText()¶
Returns the text value of the “comment” column.
- Returns:
Comment column text
- Return type:
str
- GetDialogDescriptionExpression()¶
Returns the dialog description expression.
- Returns:
Dialog description expression
- Return type:
str
- GetDialogTitleExpression()¶
Returns the dialog title expression.
- Returns:
Dialog title expression
- Return type:
str
- GetError()¶
Returns a list of errors. Note that the error messages depend on the program language ecu.test is set to. Because of that we do not recommend to check against exact error messages, unless you are certain about the respective program language.
- Returns:
List of errors
- Return type:
list[str]
- GetIndex()¶
Returns the zero based index in the parent.
- Returns:
Zero based index
- Return type:
integer
- GetLineNo()¶
Returns the test steps line number within its test case.
- Returns:
Line number
- Return type:
int
- GetMessageType()¶
Returns the type of the message dialog.
- Returns:
Message dialog type. Must be one of [u’INFO’, u’QUESTION’, u’WARNING’, u’ERROR’]
- Return type:
str
- GetParameterColumnText()¶
Returns the text value of the “parameter” column.
- Returns:
Parameter column text
- Return type:
str
- GetParent()¶
Returns the parent test step.
- Returns:
The parent test step or None if it is a top level test step.
- Return type:
- GetSaveInVariableName()¶
Returns the save in variable name.
- Returns:
Save in variable name
- Return type:
str
- GetTags()¶
Returns the tags set for this step.
- Returns:
A (sorted) list of tags
- Return type:
list[str]
- GetTestManagementId()¶
Returns the test management id of the test step.
- Returns:
Test step id.
- Return type:
str
- GetTestStepId()¶
Returns the test step id.
- Returns:
test step id
- Return type:
str
- GetTimeOutExpression()¶
Returns the time out expression that defines that maximum user input time in milliseconds. If the user exceeds this time the dialog will be closed.
- Returns:
Time out expression
- Return type:
str
- GetTranslatedCommentText(language)¶
Returns the text value of the “comment” column in the given language.
- Parameters:
- language : str¶
Language of the requested text (‘en_US’, ‘de_DE’, ‘zh_CN’)
- Returns:
Comment column text
- Return type:
str
- GetType()¶
Returns the type (class name) of the test step, e.g.
“TsPreconditionBlock”
“TsWait”
“TsIfThenElse”
“TsSwitchCase”
“TsCaseNode”
- Returns:
Type (class name) of the test step
- Return type:
str
- GetValueColumnText()¶
Returns the text value of the “value” column in your current test case language.
- Returns:
Value column text
- Return type:
str
- IsBreakpoint()¶
Checks whether the test step is a break point.
- Returns:
True if test step is a break point, else False
- Return type:
boolean
- IsContainer()¶
Returns True, if the test step supports calling GetChildren as well as manipulating the structure of its children. (e. g. via inserting or deleting sub test steps).
- Returns:
True if it can contain test steps, else False
- Return type:
boolean
- IsEnabled()¶
Returns the state of the test step.
- Returns:
True if test step is enabled, otherwise False
- Return type:
bool
- IsInPostcondition()¶
Returns True if the test step is located in a postcondition
- Returns:
True if the test step is located in a postcondition, else Flase
- Return type:
bool
- IsInPrecondition()¶
Returns True if the test step is located in a precondition
- Returns:
True if the test step is located in a precondition, else False
- Return type:
bool
- IsMaximizeEnabled()¶
Returns whether the window will be maximized or not.
- Returns:
Whether the window will be maximized
- Return type:
boolean
- IsOk()¶
Returns the internal state of correctness of the test step.
- Returns:
True if no problems were found, else False
- Return type:
boolean
- IsVisible()¶
Checks whether the test step is visible. This depends on the test step itself or a parent test step being disabled.
- Returns:
True if test step is visible, else False
- Return type:
boolean
- RemoveButtonByIndex(idx)¶
Removes the button specified by idx.
- Parameters:
- idx : integer¶
Index of the button
- SetBreakpoint(enable)¶
Sets or unsets the test step to act as a break point.
- Parameters:
- enable : boolean¶
True if test step is a break point, else False
- SetButtonLabelExpressionByIndex(labelExpr, idx)¶
Sets the button label expression of the button specified by idx.
- SetButtonReturnExpressionByIndex(returnExpr, idx)¶
Sets the button return expression of the button specified by idx.
- SetComment(comment)¶
Sets a comment for the test step in the current test case language.
- Parameters:
- comment : str¶
Text to be displayed in the comment tab
- SetDialogDescriptionExpression(descrExpr)¶
Sets the dialog description expression.
- Parameters:
- descrExpr : str¶
Dialog description expression
- SetDialogTitleExpression(titleExpression)¶
Sets the dialog title expression.
- Parameters:
- titleExpression : str¶
Dialog title expression
-
SetEnabled(state=
True)¶ Enable or disable the test step.
- Parameters:
- state : bool¶
True (Default) to enable, False to disable the test step.
-
SetMaximize(maximize=
True)¶ Sets whether the window will be maximized or not.
- Parameters:
- maximize : boolean¶
Whether the window will be maximized
- SetMessageType(msgType)¶
Sets the type of the message dialog.
- Parameters:
- msgType : str¶
Message dialog type. Must be one of [u’INFO’, u’QUESTION’, u’WARNING’, u’ERROR’]
- SetSaveInVariableName(varName)¶
Sets the save in variable name.
- Parameters:
- varName : str¶
Variable name
- SetTags(tags)¶
Set the list of tags for this step. The list of tags will be sorted and stored.
- Parameters:
The list of tags
- SetTestManagementId(testManagementId)¶
Sets the test management id of the test step.
- Parameters:
- testManagementId : str¶
Test management id of the test step
- SetTimeOutExpression(timeoutExpr)¶
Sets the time out expression that defines that maximum user input time in milliseconds. If the user exceeds this time the dialog will be closed.
- Parameters:
- timeoutExpr : str¶
Time out expression