vcConfigurableProductTypeFilter

vcConfigurableProductTypeFilter is a product filter type that can be configured through the properties shown in the Visual Components user interface.

After a vcConfigurableProductTypeFilter object has been created with the constructor, it must be bound to a statement (vcStatement) in vcProcessRoutine. Binding adds the properties of vcConfigurableProductTypeFilter to the parent object, so that the properties are accessible both through the Python API and in the Visual Components user interface.


Inherits: vcProductTypeFilter

Properties

Name Type Access Description
AcceptAllProductTypes Boolean RW (Deprecated) Use vcProductFilter.IsEnabled property instead.

When set to True, any product is accepted and AcceptedFlowGroups and AcceptedProductTypes are ignored.

AcceptAllProductTypes property is synchronized with an inverse of vcProductFilter.IsEnabled.
This way:
  • Setting AcceptAllProductTypes to True will set IsEnabled to False.
  • Setting IsEnabled to True will set AcceptAllProductTypes to False.
AcceptAllProductTypesProperty vcProperty R Returns True if all product types are accepted.

Returns False if some product types are not accepted.
AcceptedFlowGroupsProperty vcProperty R Returns the list of flow groups (vcProcessFlowGroup) that are accepted.
AcceptedProductTypesProperty vcProperty R Returns the list of product types (vcProductType) that are accepted.

Constructors

Name Return Type Parameters Description
new vcConfigurableProductTypeFilter None Creates a new vcConfigurableProductTypeFilter object and returns the new product type filter.

Methods

Name Return Type Parameters Description
bindToStatement None vcStatement parentObject,
[Integer startingVarGroup]
Adds the filter properties to the given parentObject. If the filter is already bound, this method first removes the filter properties from the current parent object, and then adds the properties to the new parent object.

To remove the filter properties from the current parent object, set the value of parentObject to None.   startingVarGroup defines the vcProperty.Group value to assign to the first of the properties. The group of the other properties is based on that value. This defines the order of the properties in the Visual Components user interface in relation to the other properties of the parent object.   The default of startingVarGroup value is 10.