CIP JavaScript documentation for class " pfcDetailSymbolDefInstructions"

Class pfcDetailSymbolDefInstructions

Description

This interface contains information used to describe a symbol definition. It may be used when creating symbol definition (pfcDetailItemOwner.CreateDetailItem()), or accessing existing entities (pfcDetailSymbolDefItem.Modify() and pfcDetailSymbolDefItem.GetInstructions()).

See Also:: pfcSymbolDefAttachment.Create(), pfcTextReference.Create()

Direct Parent Classes:: pfcDetailCreateInstructions

Property Summary


`/* optional */ pfcSymbolDefAttachments`	`Attachments`
	Sequence of possible instance attachment points for the symbol definition.

`string`	`FullPath`
	The full path to the symbol definition file.

`/* optional */ boolean`	`HasElbow`
	`null` or `true` if the symbol definition includes an elbow, `false` if not.

`/* optional */ number`	`Height`
	The height value of the symbol definition.

`/* optional */ boolean`	`IsTextAngleFixed`
	`null` or `true` if the text angle is fixed, `false` if not.

`/* readonly */ string`	`Name`
	The name of the symbol defintion.

`/* optional */ pfcTextReference`	`Reference`
	The text reference information, or `null` if unused.

`/* readonly */ number`	`ScaledHeight`
	The symbol definition height in inches.

`/* optional */ pfcSymbolDefHeight`	`SymbolHeight`
	The height type for the symbol definition.

Method Summary


`static pfcDetailSymbolDefInstructions`	`Create (string inFullPath)`
	Creates an instructions object used to create a symbol definition. Pass this object to `pfcDetailItemOwner.CreateDetailItem()` and `pfcDetailSymbolDefItem.Modify()`.

Property Detail

/* optional */ pfcSymbolDefAttachments Attachments

Sequence of possible instance attachment points for the symbol definition.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Number of attachments more than PRODTL_SYM_DEF_MAX_ATTACHES

pfcXToolkitNotFound - No attachments were found.

string FullPath

The full path to the symbol definition file.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Symbol not found in session.

/* optional */ boolean HasElbow

null or true if the symbol definition includes an elbow, false if not.

/* optional */ number Height

The height value of the symbol definition.

This property does not consistently contain a value capable of being related mathematically to the symbol definition height in inches. Use pfcDetailSymbolDefInstructions.ScaledHeight instead.

/* optional */ boolean IsTextAngleFixed

null or true if the text angle is fixed, false if not.

/* readonly */ string Name

The name of the symbol defintion.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Symbol not found in session.

/* optional */ pfcTextReference Reference

The text reference information, or null if unused.

/* readonly */ number ScaledHeight

The symbol definition height in inches.

(Inches are always used for the units in the symbol definition).

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The symbol definition assigned to this data was not yet initialized so the scaled value cannot be accurately retrieved.

/* optional */ pfcSymbolDefHeight SymbolHeight

The height type for the symbol definition.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Invalid symbol definition height type.

Method Detail

static pfcDetailSymbolDefInstructions Create (string inFullPath)

Creates an instructions object used to create a symbol definition. Pass this object to pfcDetailItemOwner.CreateDetailItem() and pfcDetailSymbolDefItem.Modify().

Parameters:

inFullPath: Path and name for the symbol definition.

Returns:: The instructions data object.