MKI_TEXTFRAME (Entity Data Classes) Changed in Version 2022.1

C++ Syntax

class MKI_TEXTFRAME

{

  public:

  MKI_FONTDEF m_cTextFont;

  MKI_XPROPERTY m_cTextXProperty;

  MKI_UNIQUE_ID m_cLinkedID;

  double m_dTextSize,

         m_dCharDistance,

         m_dTabDistance,

         m_dLineDistance;

  __int32 m_nTextMode,

          m_nTextVertical,

          m_nTextOrder,

          m_nSystem,

          m_anUnused[2];

  void

  Init( void );

  bool

  IsIdentical( const MKI_TEXTFRAME& f_rData ) const; New in Version 2022.1

};

This structure contains settings for a frame text.

Element Description

TextFont

[MKI_FONTDEF] Description of the font to be used for this text.

TextXProperty

[MKI_XPROPERTY] Properties of the text. The properties of the entity itself are not used for texts.

LinkedID New in Version 2017.0

[MKI_UNIQUE_ID] Unique identifier of a entity to which this text is linked. This reference can be used to access the referenced entity's properties such as surface area, perimeter, layer, line styles, etc. This value may contain either a valid UUID (Universally Unique Identifier) or all 0 if unused.

TextSize

[double] Size of the font. This size is handled differently depending of the font's type. If the font is a TrueType or device font, this value determines the typographical font size, i.e. the minimum offset between two lines of texts.

If the font is internal, this value determines the actual character height. Usually, an internal font will be displayed about 25% larger with the same value of TextSize.

CharDistance

[double] Determines the gap between two characters. This gap is stated relative to the font size. A value of 0.1 at a font size of 10pt will result in a character gap of 1pt. Allowed values are -10.0 to +10.0. The default value for TrueType and device fonts should be 0.0, for internal fonts 0.125.

TabDistance

[double] Determines the distance between two tabulators. This distance is stated relative to the font size. A value of 4.0 at a font size of 5 mm will result in a tabulator distance of 20 mm. Allowed values are -100.0 to 100.0. The default value is 4.0.

LineDistance

[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.

TextMode

[__int32] States the position of the text relative to the surrounding frame (see MKI_TEXTMODE_*).

TextVertical New in Version 6.50

[__int32] States the vertical position of the text relative to the insertion point (see MKI_TEXTVERTICAL_*). Only the first 3 values are supported.

TextOrder

[__int32] Defines the reading order of the text, i.e. it determines the direction in which the characters are placed (see MKI_TEXTORDER_*).

System New in Version 2017.0

[__int32] Index of the coordinate system the text shall be based on.

Unused Changed in Version 6.50

[__int32[2]] Currently unused space for future extensions, must not be used!

MKD Syntax

A data block of type MKI_DB_INFO_TEXTFRAME (236) is used to store the parameters for frame texts.

TextFont,TextXProperty,LinkedID,TextSize,

CharDistance,TabDistance,LineDistance,

TextMode,TextVertical,TextOrder,System

Example

|TextFont|

0,1,400,"TIMES",

|TextXProperty|

64,0,1,0.0/0.0/0.0,0.0/0.0/0.0,0.0,0,0,1,

|LinkedID|

"",

|TextSize|

10.0,

|CharDistance,Tabdistance,LineDistance|

0.05,4.0,1.2,

|TextMode,TextVertical,TextOrder,System|

0,0,0,0

The text will be displayed using the font "TIMES" with a text size of 10 mm. The characters will be assigned to layer 1 (TextXProperty.Flag = MKI_USE_LAYER, TextXProperty.Layer = 1), they are drawn filled in black.

The character distance will be 0.5 mm (font size 10 mm × 0.05 = 0.5 mm), the tabulator distance will be 40 mm (font size 10 mm × 4.0 = 40 mm) and the line distance 12 mm (font size 10 mm × 1.2 = 12.0 mm).