Markups based on simple text

Types

	A3DMDTextPositionData
	A3DMarkupTextData
	A3DMarkupCoordinateData
	`EA3DMarkupFrameType`
	`EA3DLeaderAlignmentType`

Fields

	`KA3DMarkupFrameNone`
	`KA3DMarkupFrameRectangle`
	`KA3DMarkupFrameSquare`
	`KA3DMarkupFrameCircle`
	`KA3DMarkupFrameScoredCircle`
	`KA3DMarkupFrameDiamond`
	`KA3DMarkupFrameTriangle`
	`KA3DMarkupFrameRightFlag`
	`KA3DMarkupFrameLeftFlag`
	`KA3DMarkupFrameBothFlag`
	`KA3DMarkupFrameOblong`
	`KA3DMarkupFrameEllipse`
	`KA3DMarkupFrameFixRectangle`
	`KA3DMarkupFrameFixSquare`
	`KA3DMarkupFrameFixCircle`
	`KA3DMarkupFrameFixScoredCircle`
	`KA3DMarkupFrameFixDiamond`
	`KA3DMarkupFrameFixTriangle`
	`KA3DMarkupFrameFixRightFlag`
	`KA3DMarkupFrameFixLeftFlag`
	`KA3DMarkupFrameFixBothFlag`
	`KA3DMarkupFrameFixOblong`
	`KA3DMarkupFrameFixEllipse`
	`KA3DMarkupFrameCustom`
	`KA3DLeaderAlignment_Simple`
	`KA3DLeaderAlignment_Below`
	`KA3DLeaderAlignment_Underline`
	`KA3DLeaderAlignment_ExtToMax`
	`KA3DLeaderAlignment_OnBoxPoint`
	`KA3DLeaderAlignment_SimpleOnBoxPoint`
	`KA3DLeaderAlignment_Maximal_Underline`
	`KA3DLeaderAlignment_Simple_OppositeAnchor`

Functions

`A3DStatus`	`A3DMDTextPositionGet`
`A3DStatus`	`A3DMarkupCoordinateGet`
`A3DStatus`	`A3DMarkupCoordinateCreate`
`A3DStatus`	`A3DMarkupTextGet`
`A3DStatus`	`A3DMarkupTextSet`
`A3DStatus`	`A3DMarkupTextCreate`

Detailed Description

group a3d_markuptext

Version: 4.0

Type Documentation

enum EA3DMarkupFrameType

Markup frame identifiers for markup text, datum, ….

Version: 4.0

Values:

enumerator KA3DMarkupFrameNone: No Frame.

enumerator KA3DMarkupFrameRectangle: Rectangle Frame.

enumerator KA3DMarkupFrameSquare: Square Frame.

enumerator KA3DMarkupFrameCircle: Circle Frame.

enumerator KA3DMarkupFrameScoredCircle: Scored Circle.

enumerator KA3DMarkupFrameDiamond: Diamond Frame.

enumerator KA3DMarkupFrameTriangle: Triangle Frame.

enumerator KA3DMarkupFrameRightFlag: Right Flag Frame.

enumerator KA3DMarkupFrameLeftFlag: Left Flag Frame.

enumerator KA3DMarkupFrameBothFlag: Both Flag Frame.

enumerator KA3DMarkupFrameOblong: Oblong Frame.

enumerator KA3DMarkupFrameEllipse: Ellipse Frame.

enumerator KA3DMarkupFrameFixRectangle: Fixed Rectangle Frame.

enumerator KA3DMarkupFrameFixSquare: Fixed Square Frame.

enumerator KA3DMarkupFrameFixCircle: Fixed Circle Frame.

enumerator KA3DMarkupFrameFixScoredCircle: Fixed Scored Circle Frame.

enumerator KA3DMarkupFrameFixDiamond: Fixed Diamond Frame.

enumerator KA3DMarkupFrameFixTriangle: Fixed Triangle Frame.

enumerator KA3DMarkupFrameFixRightFlag: Fixed Right Flag Frame.

enumerator KA3DMarkupFrameFixLeftFlag: Fixed Left Flag Frame.

enumerator KA3DMarkupFrameFixBothFlag: Fixed Both Flag Frame.

enumerator KA3DMarkupFrameFixOblong: Fixed Oblong Frame.

enumerator KA3DMarkupFrameFixEllipse: Fixed Ellipse Frame.

enumerator KA3DMarkupFrameCustom: Custom Frame.

enum EA3DLeaderAlignmentType

Enumerations for Leader alignment type This enumeration defines the way the leader anchors on markup.

Version: 4.0

Values:

enumerator KA3DLeaderAlignment_Simple: No alignment.

enumerator KA3DLeaderAlignment_Below: For a text note, the leader underlines the first text line.

enumerator KA3DLeaderAlignment_Underline: The leader underlines all lines.

enumerator KA3DLeaderAlignment_ExtToMax: The leader underlines all lines with the maximum line length.

enumerator KA3DLeaderAlignment_OnBoxPoint: The leader anchors to the markup bounding box.

enumerator KA3DLeaderAlignment_SimpleOnBoxPoint: The leader anchors to the markup bounding box, and in the middle of the line.

enumerator KA3DLeaderAlignment_Maximal_Underline

enumerator KA3DLeaderAlignment_Simple_OppositeAnchor

Function Documentation

A3DStatus A3DMDTextPositionGet(const A3DMDTextPosition *pTextPosition, A3DMDTextPositionData *pData)

Populates the A3DMDTextPositionData structure.

Version: 4.0

Return values

A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMarkupCoordinateGet(const A3DMarkupCoordinate *pMarkupCoordinate, A3DMarkupCoordinateData *pData)

Populates the A3DMarkupCoordinateData structure.

Version: 4.0

Return values

A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMarkupCoordinateCreate(const A3DMarkupCoordinateData *pData, A3DMarkupCoordinate **ppMarkupCoordinate)

Creates an A3DMarkupCoordinate from an A3DMarkupCoordinateData structure.

Version: 4.0

Return values

A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMarkupTextGet(const A3DMarkupText *pMarkupText, A3DMarkupTextData *pData)

Populates the A3DMarkupTextData structure.

Version: 4.0

Return values

A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMarkupTextSet(const A3DMarkupTextData *pData, A3DMarkupText *pMarkupText)

Set an A3DMarkupText from an A3DMarkupTextData structure.

Version: 4.0

Return values

A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMarkupTextCreate(const A3DMarkupTextData *pData, A3DMarkupText **ppMarkupText)

Creates an A3DMarkupText from an A3DMarkupTextData structure.

Version: 4.0

Return values

A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code