CIP JavaScript documentation for class " pfcModelItem"

Class pfcModelItem

Description

This class defines a model item.

A model item is an object associated with a model (such as feature, surface, dimension, etc.) that is identified by an integer.

The possible types of model item are as follows:

ITEM_FEATURE
ITEM_SURFACE
ITEM_EDGE
ITEM_COORD_SYS
ITEM_AXIS
ITEM_POINT
ITEM_QUILT
ITEM_CURVE
ITEM_LAYER
ITEM_NOTE
ITEM_DIMENSION
ITEM_REF_DIMENSION

Direct Parent Classes:: pfcChild, pfcActionSource, pfcRelationOwner, pfcParameterOwner

Direct Known Subclasses:: pfcLayer, pfcSolidGeometryLayerItem, pfcBaseDimension, pfcFeature, pfcEdge, pfcSurface, pfcCoordSystem, pfcAxis, pfcQuilt, pfcCurve, pfcSimpRep, pfcSolidBody, pfcExplodedState, pfcTable, pfcNote, pfcDetailItem

Property Summary


`/* readonly */ number`	`Id`
	The identifier of the model item

`/* readonly */ pfcModelItemType`	`Type`
	The type of model item

Method Summary


`/* optional */ string`	`GetName ()`
	Gets the name of a model item.

`void`	`SetName (string Name)`
	Sets the item name.

Property Detail

/* readonly */ number Id

The identifier of the model item

/* readonly */ pfcModelItemType Type

The type of model item

Exceptions thrown (but not limited to):

pfcXInvalidModelItem - The model item is invalid.

Method Detail

/* optional */ string GetName ()

Gets the name of a model item.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified item does not have a name.

Returns:

void SetName (string Name)

Sets the item name.

Exceptions thrown (but not limited to):

pfcXToolkitLineTooLong - The string passed has exceeded the maximum size, that is, PRO_NAME_SIZE.

pfcXToolkitInvalidName - The name specified is not a valid name for a model item in Creo Parametric.

Parameters:

Name: The new item name.