CIP Visual Basic.NET documentation for interface "IpfcDetailSymbolInstInstructions"

Interface IpfcDetailSymbolInstInstructions

Description

This interface contains information used to describe a symbol instance. It may be used when creating symbol instances (IpfcDetailItemOwner.CreateDetailItem()), or accessing existing groups (IpfcDetailSymbolInstItem.Modify() and IpfcDetailSymbolInstItem.GetInstructions()).

See Also:: IpfcDetailItemOwner.CreateDetailItem(), IpfcDetailItemOwner.GetDetailItem(), IpfcDetailItemOwner.ListDetailItems(), IpfcDetailItemOwner.RetrieveSymbolDefinition(), IpfcSymbolDefAttachment.Create(), IpfcDetailLeaders.Create(), IpfcDetailVariantText.Create()

Direct Parent Classes:: IpfcDetailCreateInstructions

Property Summary


`Property`	`Angle`	`as Double [optional]`
	The angle at which the instance was placed. `null` represents a 0.0 degree angle.

`Property`	`AttachOnDefType`	`as IpfcSymbolDefAttachmentType [optional]`
	The instance attachment type. `null` represents a free attachment.

`Property`	`Color`	`as IpfcColorRGB [optional]`
	The color of the detail item. If `null`, the default drawing color is used.

`Property`	`CurrentTransform`	`as IpfcTransform3D`
	The coordinate transformation matrix for the symbol instance placement.

`Property`	`DefAttachment`	`as IpfcSymbolDefAttachment [optional]`
	The attachment on the symbol definition.

`Property`	`Height`	`as Double [optional]`
	The symbol instance height.

`Property`	`InstAttachment`	`as IpfcDetailLeaders [optional]`
	The attachment of the instance, including leader information.

`Property`	`IsDisplayed`	`as Boolean [optional]`
	Whether or not the symbol instance is displayed.

`Property`	`ScaledHeight`	`as Double [optional]`
	The symbol instance height in the units of the drawing or model, consistent with the values shown in the Properties dialog for the symbol instance.

`Property`	`SymbolDef`	`as IpfcDetailSymbolDefItem`
	The symbol definition used for the instance.

`Property`	`TextValues`	`as IpfcDetailVariantTexts [optional]`
	Sequence of variant text values used while placing the symbol instance.

Method Summary


`Function`	`CCpfcDetailSymbolInstInstructions.Create (inSymbolDef as IpfcDetailSymbolDefItem) as IpfcDetailSymbolInstInstructions`
	Creates a data object containing information about a symbol instance placement. Pass this object to `IpfcDetailItemOwner.CreateDetailItem()` and `IpfcDetailSymbolInstItem.Modify()`.

`Sub`	`SetGroups (option as IpfcDetailSymbolGroupOption, groups as IpfcDetailSymbolGroups [optional])`
	Sets the option for displaying groups in the symbol instance.

Property Detail

Property Angle as Double [optional]

The angle at which the instance was placed. null represents a 0.0 degree angle.

Property AttachOnDefType as IpfcSymbolDefAttachmentType [optional]

The instance attachment type. null represents a free attachment.

Property Color as IpfcColorRGB [optional]

The color of the detail item. If null, the default drawing color is used.

Property CurrentTransform as IpfcTransform3D

The coordinate transformation matrix for the symbol instance placement.

Property DefAttachment as IpfcSymbolDefAttachment [optional]

The attachment on the symbol definition.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - No symbol definition for the specified symbol instance.

Property Height as Double [optional]

The symbol instance height.

This function does not consistently return a value capable of being related mathematically to the symbol height in drawing or model coordinates. Use IpfcDetailSymbolInstInstructions.ScaledHeight instead.

Property InstAttachment as IpfcDetailLeaders [optional]

The attachment of the instance, including leader information.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - No leaders were found.

Property IsDisplayed as Boolean [optional]

Whether or not the symbol instance is displayed.

Property ScaledHeight as Double [optional]

The symbol instance height in the units of the drawing or model, consistent with the values shown in the Properties dialog for the symbol instance.

The scaled height is partially determined based on the properties of the symbol definition (see IpfcDetailSymbolInstInstructions.SymbolDef). Changing the symbol definition may change how Creo Parametric calculates the symbol height based on the scaled height.

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 assigned or retrieved.

Property SymbolDef as IpfcDetailSymbolDefItem

The symbol definition used for the instance.

Property TextValues as IpfcDetailVariantTexts [optional]

Sequence of variant text values used while placing the symbol instance.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - No variant text values were found.

Method Detail

Function CCpfcDetailSymbolInstInstructions.Create (inSymbolDef as IpfcDetailSymbolDefItem) as IpfcDetailSymbolInstInstructions

Creates a data object containing information about a symbol instance placement. Pass this object to IpfcDetailItemOwner.CreateDetailItem() and IpfcDetailSymbolInstItem.Modify().

Parameters:

inSymbolDef: The symbol definition.

Returns:: The instructions data object.

Sub SetGroups (option as IpfcDetailSymbolGroupOption, groups as IpfcDetailSymbolGroups [optional])

Sets the option for displaying groups in the symbol instance.

Parameters:

option
groups