CIP Visual Basic.NET documentation for interface "IpfcFamilyTableRow"

Interface IpfcFamilyTableRow

Description

This class specifies a row in a family table.

Property Summary


`Property`	`InstanceName`	`as String`
	The name of the instance.

`Property`	`IsExtLocked`	`as Boolean`
	If this is `true`, the instance is locked by external application.

`Property`	`IsLocked`	`as Boolean`
	If this is `true`, the model is locked for modification. If this is `false`, the model is unlocked.

`Property`	`IsVerified`	`as IpfcFaminstanceVerifyStatus`
	Specifies the verification status of the instance.

Method Summary


`Function`	`CreateInstance () as IpfcModel`
	Regenerates and adds the instance model to memory.

`Sub`	`Erase ()`
	Erases the specified instance model from memory.

Property Detail

Property InstanceName as String

The name of the instance.

Property IsExtLocked as Boolean

If this is true, the instance is locked by external application.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified instance does not exist in the family table.

Property IsLocked as Boolean

If this is true, the model is locked for modification. If this is false, the model is unlocked.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified instance does not exist in the family table.

Property IsVerified as IpfcFaminstanceVerifyStatus

Specifies the verification status of the instance.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified instance does not exist in the family table.

Method Detail

Function CreateInstance () as IpfcModel

Regenerates and adds the instance model to memory.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.

IpfcXToolkitCantOpen - Creo Parametric cannot regenerate the instance. The instance has been created but the failed features have been suppressed.

Sub Erase ()

Erases the specified instance model from memory.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified instance model is not in session.