CIP JavaScript documentation for class " pfcUDFReference"

Class pfcUDFReference

Description

This class describes an array of element references.

Property Summary


`boolean`	`IsExternal`
	Determines whether reference is to current solid or to an external solid.

`string`	`PromptForReference`
	String given to user if placing UDF interactively.

`pfcSelection`	`ReferenceItem`
	Item used for reference.

Method Summary


`static pfcUDFReference`	`Create (string PromptForReference, pfcSelection ReferenceItem)`
	Creates a UDF reference that is required when placing a UDF with references.

Property Detail

boolean IsExternal

Determines whether reference is to current solid or to an external solid.

string PromptForReference

String given to user if placing UDF interactively.

pfcSelection ReferenceItem

Item used for reference.

Method Detail

static pfcUDFReference Create (string PromptForReference, pfcSelection ReferenceItem)

Creates a UDF reference that is required when placing a UDF with references.

Used as a component of pfcUDFCustomCreateInstructions .

Parameters:

PromptForReference: String that would be given to user if placing UDF interactively.
ReferenceItem: Item to use as reference. Include component path if reference is external.