CIP Visual Basic.NET documentation for interface "IpfcUDFCustomCreateInstructions"

Interface IpfcUDFCustomCreateInstructions

Description

Contains all options required to place a UDF programmatically. Users can enter attribute data programmatically, or wait for Creo Parametric to interactively prompt for the missing data.

Direct Parent Classes:: IpfcUDFGroupCreateInstructions

Property Summary


`Property`	`AssemblyReference`	`as IpfcComponentPath [optional]`
	This property specifies the path to the placement model from the top-level assembly used by reference selections, if the placement model is not the top level assembly. This is necessary whenever external references are used for placement, or whenever the reference selections are made from a context outside of the placement model.

`Property`	`DependencyType`	`as IpfcUDFDependencyType [optional]`
	The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.

`Property`	`DimDisplayType`	`as IpfcUDFDimensionDisplayType [optional]`
	These values correspond to the options in Creo Parametric for determining the appearance in the model of UDF dimensions and pattern parameters that were not variable in the UDF, and therefore cannot be modified in the model.

`Property`	`ExtReferences`	`as IpfcUDFExternalReferences [optional]`
	This property is deprecated. To specify the path to the placement model from the top-level assembly used by reference selections use the AssemblyReference property.

`Property`	`InstanceName`	`as String [optional]`
	If the UDF contains a family table, this field can be used to select which instance in that table is to be selected. If the UDF contains no family table, or if the generic instance is to be selected, the string should be empty.

`Property`	`Intersections`	`as IpfcUDFAssemblyIntersections [optional]`
	An array of intersections of the UDF and parts within the assembly.

`Property`	`Orientations`	`as IpfcUDFOrientations [optional]`
	An array of orientations that provide the answers to Creo Parametric prompts that use a flip arrow. The order of orientations should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. If you do not provide an orientation that Creo Parametric needs, it uses the default value ``no flip.''

`Property`	`Quadrants`	`as IpfcPoint3Ds [optional]`
	An array of points, which provide the X, Y, and Z coordinates that correspond to the picks answering the Creo Parametric prompts for the feature positions. The order of quadrants should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively.

`Property`	`References`	`as IpfcUDFReferences [optional]`
	An array of element references.

`Property`	`Scale`	`as Double [optional]`
	If the value of the ScaleType field is UDFSCALE_CUSTOM, this field is the user-defined scale factor. Otherwise, this field is ignored.

`Property`	`ScaleType`	`as IpfcUDFScaleType [optional]`
	Specifies what should happen if the UDF used different length units than the model to which it is being applied.

`Property`	`VariantValues`	`as IpfcUDFVariantValues [optional]`
	An array of variable dimensions and pattern parameters

Method Summary


`Function`	`CCpfcUDFCustomCreateInstructions.Create (Name as String) as IpfcUDFCustomCreateInstructions`
	Creates an instructions object, which is used to place a UDF programmatically.

Property Detail

Property AssemblyReference as IpfcComponentPath [optional]

This property specifies the path to the placement model from the top-level assembly used by reference selections, if the placement model is not the top level assembly. This is necessary whenever external references are used for placement, or whenever the reference selections are made from a context outside of the placement model.

Property DependencyType as IpfcUDFDependencyType [optional]

The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.

Property DimDisplayType as IpfcUDFDimensionDisplayType [optional]

These values correspond to the options in Creo Parametric for determining the appearance in the model of UDF dimensions and pattern parameters that were not variable in the UDF, and therefore cannot be modified in the model.

Property ExtReferences as IpfcUDFExternalReferences [optional]

This property is deprecated. To specify the path to the placement model from the top-level assembly used by reference selections use the AssemblyReference property.

If one or more valid component path is supplied for this property, and null is supplied for the AssemblyReference property, the first component path supplied will be used for the AssemblyReference path.

Property InstanceName as String [optional]

If the UDF contains a family table, this field can be used to select which instance in that table is to be selected. If the UDF contains no family table, or if the generic instance is to be selected, the string should be empty.

Property Intersections as IpfcUDFAssemblyIntersections [optional]

An array of intersections of the UDF and parts within the assembly.

Property Orientations as IpfcUDFOrientations [optional]

An array of orientations that provide the answers to Creo Parametric prompts that use a flip arrow. The order of orientations should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. If you do not provide an orientation that Creo Parametric needs, it uses the default value ``no flip.''

Property Quadrants as IpfcPoint3Ds [optional]

An array of points, which provide the X, Y, and Z coordinates that correspond to the picks answering the Creo Parametric prompts for the feature positions. The order of quadrants should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively.

Property References as IpfcUDFReferences [optional]

An array of element references.

Property Scale as Double [optional]

If the value of the ScaleType field is UDFSCALE_CUSTOM, this field is the user-defined scale factor. Otherwise, this field is ignored.

Property ScaleType as IpfcUDFScaleType [optional]

Specifies what should happen if the UDF used different length units than the model to which it is being applied.

Property VariantValues as IpfcUDFVariantValues [optional]

An array of variable dimensions and pattern parameters

Method Detail

Function CCpfcUDFCustomCreateInstructions.Create (Name as String) as IpfcUDFCustomCreateInstructions

Creates an instructions object, which is used to place a UDF programmatically.

Used as a component of IpfcUDFCustomCreateInstructions .

Parameters:

Name: Name of UDF to be placed.

Returns:: Instance of the UDFCustomCreateInstructions object.