CIP JAVA documentation for class "com.ptc.pfc.pfcUDFCreate.UDFReference"

Interface UDFReference

package com.ptc.pfc.pfcUDFCreate; public interface UDFReference extends jxobject

Description

This class describes an array of element references.

Method Summary
`boolean`	`GetIsExternal ()` Get method for attribute "IsExternal" Determines whether reference is to current solid or to an external solid.
`String`	`GetPromptForReference ()` Get method for attribute "PromptForReference" String given to user if placing UDF interactively.
`Selection`	`GetReferenceItem ()` Get method for attribute "ReferenceItem" Item used for reference.
`void`	`SetIsExternal (boolean value)` Set method for attribute "IsExternal" Determines whether reference is to current solid or to an external solid.
`void`	`SetPromptForReference (String value)` Set method for attribute "PromptForReference" String given to user if placing UDF interactively.
`void`	`SetReferenceItem (Selection value)` Set method for attribute "ReferenceItem" Item used for reference.

Method Detail

GetPromptForReference/SetPromptForReference

`String`	`GetPromptForReference`	`()`
`void`	`SetPromptForReference`	`(String value)`

String given to user if placing UDF interactively.

GetReferenceItem/SetReferenceItem

`Selection`	`GetReferenceItem`	`()`
`void`	`SetReferenceItem`	`(Selection value)`

Item used for reference.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetIsExternal/SetIsExternal

`boolean`	`GetIsExternal`	`()`
`void`	`SetIsExternal`	`(boolean value)`

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

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF