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:
Direct Parent Classes:
User Guide References:
Detail Symbol Definitions:IpfcDetailSymbolDefInstructions, Instructions:IpfcDetailSymbolDefInstructions
Property Summary
Property | ||
Sequence of possible instance attachment points for the symbol definition. | ||
Property | as String | |
The full path to the symbol definition file. | ||
Property | as Boolean [optional] | |
null or true if the symbol definition includes an elbow, false if not. | ||
Property | as Double [optional] | |
The height value of the symbol definition. | ||
Property | as Boolean [optional] | |
null or true if the text angle is fixed, false if not. | ||
Property | as String | |
The name of the symbol defintion. | ||
Property | ||
The text reference information, or null if unused. | ||
Property | as Double | |
The symbol definition height in inches. | ||
Property | ||
The height type for the symbol definition. |
Method Summary
Function | |
Creates an instructions object used to create a symbol definition. Pass this object to IpfcDetailItemOwner.CreateDetailItem() and IpfcDetailSymbolDefItem.Modify(). |
Property Detail
Property | Attachments |
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 |
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 |
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.