CIP Visual Basic.NET documentation for interface "IpfcDetailSymbolDefInstructions"

Interface IpfcDetailSymbolDefInstructions

Description

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

See Also:: IpfcSymbolDefAttachment.Create(), IpfcTextReference.Create()

Direct Parent Classes:: IpfcDetailCreateInstructions

Property Summary


`Property`	`Attachments`	`as IpfcSymbolDefAttachments [optional]`
	Sequence of possible instance attachment points for the symbol definition.

`Property`	`FullPath`	`as String`
	The full path to the symbol definition file.

`Property`	`HasElbow`	`as Boolean [optional]`
	`null` or `true` if the symbol definition includes an elbow, `false` if not.

`Property`	`Height`	`as Double [optional]`
	The height value of the symbol definition.

`Property`	`IsTextAngleFixed`	`as Boolean [optional]`
	`null` or `true` if the text angle is fixed, `false` if not.

`Property`	`Name`	`as String`
	The name of the symbol defintion.

`Property`	`Reference`	`as IpfcTextReference [optional]`
	The text reference information, or `null` if unused.

`Property`	`ScaledHeight`	`as Double`
	The symbol definition height in inches.

`Property`	`SymbolHeight`	`as IpfcSymbolDefHeight [optional]`
	The height type for the symbol definition.

Method Summary


`Function`	`CCpfcDetailSymbolDefInstructions.Create (inFullPath as String) as IpfcDetailSymbolDefInstructions`
	Creates an instructions object used to create a symbol definition. Pass this object to `IpfcDetailItemOwner.CreateDetailItem()` and `IpfcDetailSymbolDefItem.Modify()`.

Property Detail

Property Attachments as IpfcSymbolDefAttachments [optional]

Sequence of possible instance attachment points for the symbol definition.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Number of attachments more than PRODTL_SYM_DEF_MAX_ATTACHES

IpfcXToolkitNotFound - No attachments were found.

Property FullPath as String

The full path to the symbol definition file.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - Symbol not found in session.

Property HasElbow as Boolean [optional]

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

Property Height as Double [optional]

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 IpfcDetailSymbolDefInstructions.ScaledHeight instead.

Property IsTextAngleFixed as Boolean [optional]

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

Property Name as String

The name of the symbol defintion.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - Symbol not found in session.

Property Reference as IpfcTextReference [optional]

The text reference information, or null if unused.

Property ScaledHeight as Double

The symbol definition height in inches.

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

Exceptions thrown (but not limited to):

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

Property SymbolHeight as IpfcSymbolDefHeight [optional]

The height type for the symbol definition.

Exceptions thrown (but not limited to):

IpfcXToolkitInvalidType - Invalid symbol definition height type.

Method Detail

Function CCpfcDetailSymbolDefInstructions.Create (inFullPath as String) as IpfcDetailSymbolDefInstructions

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

Parameters:

inFullPath: Path and name for the symbol definition.

Returns:: The instructions data object.