vcPropertyContainer

A container of vcProperty objects.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: vcAction.Properties, vcAssemblyPattern.Properties, vcAssemblyPatternSlot.Properties, vcAssemblyStep.ProcessParameters, ... (see more)

vcAction.Properties
vcAssemblyPattern.Properties
vcAssemblyPatternSlot.Properties
vcAssemblyStep.ProcessParameters
vcAssemblyStep.Properties
vcBaseFrame.Properties
vcBehavior.Properties
vcCommand.Properties
vcComponent.Properties
vcConditionalScope.Properties
vcDof.Properties
vcFeature.Properties
vcFlowStepProcessConfiguration.Properties
vcJointDriver.Properties
vcKinSolver.PassiveValueProperties
vcKinSolver.Properties
vcLayoutItem.Properties
vcLinkJoint.Properties
vcNode.Properties
vcPositionFrame.Properties
vcPositionTarget.Properties
vcProcessFlowGroup.Properties
vcProcessFlowStep.Properties
vcProduct.Properties
vcProductCreatorBatchMode.Properties
vcProductCreatorDistributionMode.Properties
vcProductCreatorFeedBatch.Properties
vcProductCreatorSingleMode.Properties
vcProductCreatorTableMode.Properties
vcProductFilter.Properties
vcProductType.ComponentProperties
vcProductType.ProductProperties
vcProductType.Properties
vcProductTypeAssemblyPatternItem.Properties
vcProgram.Properties
vcPythonProcessHandler.Properties
vcRobotConfiguration.Properties
vcRobotProgram.Variables
vcRobotRoutine.Variables
vcRoutine.Properties
vcRrsRobotController.Properties
vcSequenceProcessConfiguration.Properties
vcSimInterfaceField.Properties
vcStatement.Properties
vcTransportLink.Properties

Properties

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

Name	Type	Access	Description
AllowedReferenceValueTypes	list[String]	R	Gets the list of value types allowed in reference properties in this property container.

Methods

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

Name	Return Type	Parameters	Description
clear	None	None	Deletes all the user-created properties. See more Exceptions: ValueError: When there is no license to modify this property container.
create	vcProperty	vcPropertyType type, String name, Optional Keyword[useExisting = Boolean]	Adds a new property of a given type and name to the property container. See more Parameters: type (vcPropertyType): Type for the created property. name (String): Name for the created property. useExisting (Boolean): Should an existing property with the same type and name be returned instead of erroring. Defaults to True. Exceptions: ValueError: When there is no license to modify this property container. ValueError: When given property name is empty or not unique. Returns: vcProperty: The newly created property.
create	vcProperty	vcStepPropertyType type, String name, Optional Keyword[useExisting = Boolean]	Adds a new step property of a given type and name to the property container. See more Parameters: type (vcStepPropertyType): Type for the created property. name (String): Name for the created property. useExisting (Boolean): Should an existing property with the same type and name be returned instead of erroring. Defaults to True. Exceptions: ValueError: When there is no license to modify this property container. ValueError: When given name is empty. ValueError: When this property container already has a property with same name. Returns: vcStepProperty: The newly created step property.
create	vcProperty	vcEnumPropertyType type, String name, Optional Keyword[useExisting = Boolean]	Adds a new enum property of a given type and name to the property container. See more Parameters: type (vcEnumPropertyType): Type for the created property. name (String): Name for the created property. useExisting (Boolean): Should an existing property with the same type and name be returned instead of erroring. Defaults to True. Exceptions: ValueError: When given name is empty. ValueError: When this property container already has a property with same name. Returns: vcEnumPropertyType: The newly created enum property.
create	vcProperty	vcListPropertyType type, String name, Optional Keyword[useExisting = Boolean]	Adds a new list property of a given type and name to the property container. See more Parameters: type (vcListPropertyType): Type for the created property. name (String): Name for the created property. useExisting (Boolean): Should an existing property with the same type and name be returned instead of erroring. Defaults to True. Exceptions: ValueError: When there is no license to modify this property container. ValueError: When given name is empty. ValueError: When this property container already has a property with same name. Returns: vcListProperty: The newly created list property.
create	vcProperty	vcLimitPropertyType type, String name, Optional Keyword[useExisting = Boolean]	Adds a new limit property of a given type and name to the property container. See more Parameters: type (vcLimitPropertyType): Type for the created property. name (String): Name for the created property. useExisting (Boolean): Should an existing property with the same type and name be returned instead of erroring. Defaults to True. Exceptions: ValueError: When there is no license to modify this property container. ValueError: When given name is empty. ValueError: When this property container already has a property with same name. Returns: vcLimitProperty: The newly created limit property.
create	vcProperty	vcExpressionPropertyType type, String name, Optional Keyword[useExisting = Boolean]	Adds a new expression property of a given type and name to the property container. See more Parameters: type (vcExpressionPropertyType): Type for the created property. name (String): Name for the created property. useExisting (Boolean): Should an existing property with the same type and name be returned instead of erroring. Defaults to True. Exceptions: ValueError: When there is no license to modify this property container. ValueError: When given name is empty. ValueError: When this property container already has a property with same name. Returns: vcExpressionProperty: The newly created expression property.
create	vcProperty	vcReferencePropertyType type, String valueType, String name, Optional Keyword[useExisting = Boolean]	Adds a new reference property of a given type and name to the property container. See more Parameters: type (vcReferencePropertyType): Type for the created property. valueType (String): Type for the reference property value(s). The value must be included in vcPropertyContainer.AllowedReferenceValues. name (String): Name for the created property. useExisting (Boolean): Should an existing property with the same type and name be returned instead of erroring. Defaults to True. Exceptions: ValueError: When there is no license to modify this property container. ValueError: When given name is empty. ValueError: When this property container already has a property with same name. ValueError: When given valueType is not in the list of allowed reference value types of this property container. Returns: vcReferenceProperty: The newly created property.

Events

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

Name	Parameters	Description
OnChanged	vcPropertyContainer container, vcProperty property, vcMoveType moveType	Triggered when content of the property container changes. See more Parameters: container (vcPropertyContainer): The container that changed. property (vcProperty): The property that changed. moveType (vcMoveType): The operation type.