CIP Visual Basic.NET documentation for interface "IpfcDetailEntityInstructions"

Interface IpfcDetailEntityInstructions

Description

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

See Also:: IpfcLineDescriptor.Create(), IpfcArcDescriptor.Create(), IpfcArrowDescriptor.Create(), IpfcCircleDescriptor.Create(), IpfcSplineDescriptor.Create(), IpfcBSplineDescriptor.Create(), IpfcEllipseDescriptor.Create(), IpfcPolygonDescriptor.Create(), IpfcCompositeCurveDescriptor.Create(), IpfcModel2D.List2DViews(), IpfcSheetOwner.GetSheetBackgroundView()

Direct Parent Classes:: IpfcDetailCreateInstructions

Property Summary


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

`Property`	`FontName`	`as String [optional]`
	The name of the linestyle. If `null`, the default linestyle is used.

`Property`	`Geometry`	`as IpfcCurveDescriptor`
	The geometry of the detail entity.

`Property`	`IsConstruction`	`as Boolean [optional]`
	Whether or not the entity is construction. If `null`, the entity is not a construction entity.

`Property`	`View`	`as IpfcView2D [optional]`
	The drawing view associated with the entity. This can be a view of a drawing model, or a drawing sheet background view.

`Property`	`Width`	`as Double [optional]`
	The width of the entity line. If `null`, the default width is used.

Method Summary


`Function`	`CCpfcDetailEntityInstructions.Create (inGeometry as IpfcCurveDescriptor, inView as IpfcView2D [optional]) as IpfcDetailEntityInstructions`
	Creates an instructions object describing how to construct a detail entity, for use in the methods `IpfcDetailItemOwner.CreateDetailItem()`, `IpfcDetailSymbolDefItem.CreateDetailItem()` and `IpfcDetailEntityItem.Modify()`.

Property Detail

Property Color as IpfcColorRGB [optional]

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

Property FontName as String [optional]

The name of the linestyle. If null, the default linestyle is used.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - No font name is specified.

Property Geometry as IpfcCurveDescriptor

The geometry of the detail entity.

When creating a "circle" detail entity, use an arc with a start angle of 0 and an end angle of 2*PI. Creo Parametric represents circle detail entities with the IpfcArcDescriptor object.

Property IsConstruction as Boolean [optional]

Whether or not the entity is construction. If null, the entity is not a construction entity.

Property View as IpfcView2D [optional]

The drawing view associated with the entity. This can be a view of a drawing model, or a drawing sheet background view.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The entity is not attached to a drawing view.

Property Width as Double [optional]

The width of the entity line. If null, the default width is used.

Method Detail

Function CCpfcDetailEntityInstructions.Create (inGeometry as IpfcCurveDescriptor, inView as IpfcView2D [optional]) as IpfcDetailEntityInstructions

Creates an instructions object describing how to construct a detail entity, for use in the methods IpfcDetailItemOwner.CreateDetailItem(), IpfcDetailSymbolDefItem.CreateDetailItem() and IpfcDetailEntityItem.Modify().

When creating a "circle" detail entity, use an arc with a start angle of 0 and an end angle of 2*PI. Creo Parametric represents circle detail entities with the IpfcArcDescriptor object.

Parameters:

inGeometry: The curve geometry describing the trajectory of the detail entity (in screen coordinates).
inView: The drawing view associated with the entity. This can be a model view obtained from IpfcModel2D.List2DViews(), or a drawing sheet background view obtained from IpfcSheetOwner.GetSheetBackgroundView().

Returns:: The created instructions object.