IVariable¶
- class IVariable¶
Bases:
ImpactCOMWrapperBase- Summary:
Represents a parametric variable.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property choice_count¶
Gets choice_count.
- Summary:
Returns the number of choices for this variable.
- Remarks:
This property should only be accessed if variable_type = vtChoiceList.
- Returns:
The value of choice_count.
- Return type:
choice_count (int)
- property choice_preview_layer¶
Gets choice_preview_layer.
- Summary:
Gets the preview layer to be used for each choice by index.
- Remarks:
This property should only be accessed if variable_type = vtChoiceList.
- Returns:
The value of choice_preview_layer.
- Return type:
choice_preview_layer (str)
- property choice_prompt¶
Gets choice_prompt.
- Summary:
Gets the prompt used for each choice by index.
- Remarks:
This property should only be accessed if variable_type = vtChoiceList.
- Returns:
The value of choice_prompt.
- Return type:
choice_prompt (str)
- property display_mode¶
Gets display_mode.
- Summary:
The Display Mode
- Remarks:
Introduced in Impact 13.0.0.54
- Returns:
The value of display_mode.
- Return type:
- property expression¶
Gets Expression.
- Summary:
Gets the expression of the variable.
- Returns:
The value of Expression.
- Return type:
expression (str)
- property group¶
Gets Group.
- Summary:
The IVariableGroup the variable belongs to.
- Remarks:
You can assign the variable to a new IVariableGroup.
- Returns:
The value of Group.
- Return type:
- property label_indent¶
Gets label_indent.
- Summary:
The label indentation value
- Remarks:
Introduced in Impact 13.0.0.50
- Returns:
The value of label_indent.
- Return type:
label_indent (int)
- property material_variable¶
Gets material_variable.
- Summary:
Returns true if the variable is a material variable.
- Returns:
The value of material_variable.
- Return type:
material_variable (bool)
- property name¶
Gets Name.
- Summary:
The variable name.
- Returns:
The value of Name.
- Return type:
name (str)
- property prompt¶
Gets Prompt.
- Summary:
The variable prompt.
- Returns:
The value of Prompt.
- Return type:
prompt (str)
- property read_only¶
Gets read_only.
- Summary:
Returns true if the variable is read only.
- Returns:
The value of read_only.
- Return type:
read_only (bool)
- property text_alignment¶
Gets text_alignment.
- Summary:
The text alignment
- Remarks:
Introduced in Impact 13.0.0.50
- Returns:
The value of text_alignment.
- Return type:
- property text_font_bold¶
Gets text_font_bold.
- Summary:
Whether or not the text font is bold
- Remarks:
Introduced in Impact 13.0.0.50
- Returns:
The value of text_font_bold.
- Return type:
text_font_bold (bool)
- property text_font_colour¶
Gets text_font_colour.
- Summary:
The text font colour
- Returns:
The value of text_font_colour.
- Return type:
text_font_colour (int)
- property text_font_italic¶
Gets text_font_italic.
- Summary:
Whether or not the text font is italic
- Remarks:
Introduced in Impact 13.0.0.50
- Returns:
The value of text_font_italic.
- Return type:
text_font_italic (bool)
- property text_font_size¶
Gets text_font_size.
- Summary:
The text font size
- Returns:
The value of text_font_size.
- Return type:
- property text_font_underline¶
Gets text_font_underline.
- Summary:
Whether or not the text font is underlined
- Remarks:
Introduced in Impact 13.0.0.50
- Returns:
The value of text_font_underline.
- Return type:
text_font_underline (bool)
- property text_frame_shape¶
Gets text_frame_shape.
- Summary:
The text frame shape
- Returns:
The value of text_frame_shape.
- Return type:
- property text_frame_style¶
Gets text_frame_style.
- Summary:
The text frame style
- Remarks:
Introduced in Impact 13.0.0.50
- Returns:
The value of text_frame_style.
- Return type:
- property value¶
Gets Value.
- Summary:
The variable value.
- Returns:
The value of Value.
- Return type:
value (any)
- property variable_type¶
Gets variable_type.
- Summary:
The variable type.
- Returns:
The value of variable_type.
- Return type:
- property visible¶
Gets Visible.
- Summary:
Returns true if the variable is visible.
- Returns:
The value of Visible.
- Return type:
visible (bool)
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.