vcPythonStatement

A process statement that contains a Python script to customize its execution.

See in: Overview

Module: vcProcessModel

Parent: vcStatement

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Filter	vcProductFilter	R	Gets the filter.
IsProductFilterVisible	Boolean	RW	Gets or sets whether the product filter UI is visible in the process editor. Default is False.
Language	vcLanguageType	RW	Gets or sets the script language of the statement.
Script	String	RW	Gets or sets the executable Python code of the statement.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
demoteFromCombinationFilter	vcProductFilter	None	Downgrades back to filter, filter count must have 1 or 0 filters. See more Returns: vcProductFilter: The modified filter. Exceptions: TypeError: When the filter is not a CombinationFilter. TypeError: When CombinationFilter has more than 1 sub-filters.
promoteToCombinationFilter	vcProductFilter	None	Upgrades current filter to combination filter. See more Returns: vcProductFilter: The modified filter. Exceptions: TypeError: When the filter is already a CombinationFilter.
readSvgIconFromFile	None	String OR PathLike iconPath	Reads in an svg file to display in process editor. See more Parameters: iconPath (String): Svg file path. If empty, the current icon is reset. Exceptions: ValueError: When iconPath does not exist or is an invalid svg file.
replaceFrom	vcProductFilter	vcStatement statement	Sets filter from other container. See more Parameters: statement (vcStatement): The statement to replace the filter from. Has to be a statement with a filter container. Returns: vcProductFilter: The modified filter. Exceptions: AttributeError: When argument is a statement without a filter container.
setFilter	vcProductFilter	vcProductFilterType filterType	Sets to specific filter. See more Parameters: filterType (vcProductFilterType): The type of filter to set to. Returns: vcProductFilter: The new filter. Exceptions: AttributeError: When the argument filterType is ProductType.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnFilterChanged	None	Triggered when filter is changed.