C++ Syntax

MKI_XPROPERTY_PTR

MKI_EntityText(

const LPCWSTR f_pszText,

double f_dX,

double f_dY,

double f_dSize,

double f_dRotation,

double f_dLineDistance,

__int32 f_nTextMode,

__int32 f_nTextVertical,

MKI_CONST_FONTDEF_REF f_rFont );

A macro-style command that creates a standard text and inserts it to a currently open provisional clipping surface, extended object, group, block, or to the current drawing (in that order).

Parameters

f_pszText

[const LPCWSTR] Text to be stored in the entity. The maximum length is MKI_LENGTH_TEXT_LONG. In order to achieve a tabulator, use the character ¬ (Unicode 172). For a line feed, use the character ¶ (Unicode 182). All other characters will be displayed using the given font. Characters below Unicode 32 will be ignored. See also Advanced Text Capabilities.

f_dX

f_dY

[double] Coordinates of the insertion point in internal [mm] (relative to the internal origin, scale-independent). Valid range: MKI_COORD_MIN <= Value <= MKI_COORD_MAX.

f_dSize

[double] Text size in internal [mm] (scale-independent).

f_dRotation

[double] Rotation angle of the text in [rad]. Multiply with MKI_MATH_DEG_RAD constant (pi/180) to convert [deg] values to [rad].

f_dLineDistance

[double] Determines the offset between two lines of text, measured from baseline to baseline. This offset is stated relative to the font size. A value of 1.2 at a font size of 10pt will lead to a line offset of 12pt. Allowed values are -10.0 to 10.0. The default value is 1.0.

f_nTextMode

[__int32] States the horizontal position of the text relative to the insertion point (see MKI_TEXTMODE_*). Block mode is not supported.

f_nTextVertical

[__int32] States the vertical position of the text relative to the insertion point (see MKI_TEXTVERTICAL_*).

f_rFont

[MKI_CONST_FONTDEF_REF] Font to be used for the text.

Return Value

Returns the address of the newly created entity's text property set is successful, else nullptr.