Multi-Text Entities

autocad_entity: autocad_multi_text

Features with autocad_entity set to autocad_multi_text are stored in and read from drawing files as text entities. A text entity is represented by a single coordinate and the following attributes.

Attribute Name

Contents

autocad_text_string

The text string.

Range: char[1024]

Default: No default

autocad_rotation

The rotation of the text for this entity.

Range: -360.0..360.0

Default: 0
autocad_original_rotation

The rotation of the text of an entity before a potential transformation, such as a User Coordinate System, is applied by the AutoCAD reader.

This value is used preferentially to set the text rotation when writing a text entity.

Range: -360.0..360.0

Default: 0

autocad_text_size

The text height. When reading, this value is calculated using the height of the bounding box of the feature and the estimated number of lines.

Range: 64-bit floating point number

Default: 10

autocad_mtext_string

The original formatted mtext string. Writer will use this attribute’s value to set the destination mtext entity.

When performing an AutoCAD-to-AutoCAD translation, this attribute will ensure that the exact formatting is carried over to the destination.

Range: char[1024]

Default: None

autocad_mtext_text_height

The starting text size of the multi-text feature. This attribute is useful mainly for AutoCAD-to-AutoCAD translations.

If this attribute does not exist when writing, then a value is calculated for it using the autocad_text_size.

Range: 64-bit floating point number

Default: None

autocad_true_type_font

The name of the TrueType font used to display the text string. This is extracted from the formatted contents, as opposed to the text style.

If this attribute is not specified when writing, the text will still be written, but not using a TrueType font.

Default: No default

autocad_linespace_factor

The percentage of default line spacing used.

Range: 0.25..4.0

Default: 1

autocad_mtext_ref_rect_width

The width of the reference rectangle in which the text is contained. This width is the maximum length of any line on the mtext before it will wrap. If not specified when writing, this will be calculated based on the text length. To disable this with and the related word wrapping, set this value to 0.

Range: A positive 64-bit floating point number

autocad_attach_point

The attach point for the multi-text. Use this attribute to set the justification of Multi-Text entities.

Note that there is no autocad_justification attribute for this type of entity.

Range:

  • autocad_top_left
  • autocad_top_center
  • autocad_top_right
  • autocad_middle_left
  • autocad_middle_center
  • autocad_middle_right
  • autocad_bottom_left
    autocad_bottom_center
  • autocad_bottom_right

autocad_draw_direction

The direction the text is drawn.

Range:

  • autocad_draw_left_to_right
  • autocad_draw_right_to_left
  • autocad_draw_top_to_bottom
  • autocad_draw_bottom_to_top

autocad_box_width

The width of the box which the multi-text is located.

Range: 64-bit floating point number > 0

autocad_box_height

The height of the box which the multi-text is located.

Range: 64-bit floating point number > 0

autocad_big_fontname

The name of the file which contains fonts for large character sets.

Range: char[65]

Default: No default
autocad_font_bold

Indicates whether the True Type font related to the text style has bold formatting.

Range: Yes | No

Default: No

autocad_font_charset

The Windows True Type font character set identifier for the related text style.

  • UndefinedCharset = -1
  • AnsiCharset = 0
  • UnicodeCharset = 1
  • SymbolCharset = 2
  • JapaneseCharset = 128
  • KoreanCharset = 129
  • ChineseSimpCharset = 134
  • ChineseTradCharset = 136
  • JohabCharset = 130
  • HebrewCharset = 177
  • ArabicCharset = 178
  • GreekCharset = 161
  • TurkishCharset = 162
  • VietnameseCharset = 163
  • ThaiCharset = 222
  • EastEuropeCharset = 238
  • RussianCharset = 204
  • BalticCharset = 186
  • INTERNALCHARSET = 256

Range: Integer, as above

Default: 0
autocad_font_italic

Indicates whether the True Type font related to the text style has italic formatting.

Range: Yes | No

Default: No
autocad_font_pitch_family

The Windows font pitch and family identifier for the related text style.

Not for RealDWG.

Range: Integer

Default: 0
autocad_font_pitch

The Windows font pitch identifier for the related text style.

RealDWG only.

Range: default | fixed | variable

Default: default

autocad_font_family

The Windows font family identifier for the related text style.

RealDWG only.

Range:

  • roman
  • swiss
  • modern
  • script
  • decorative
  • do_not_care

Range: do_not_care

autocad_font_typeface

The Windows True Type font character set identifier for the related text style.

Range: char[50]

Default: No default

autocad_shape_name

The name of the shape which contains the text font definition.

Range: char[33]

Default: STANDARD

autocad_shape_filename

The name of the file that contains the text font definition.

Note: AutoCAD shape files should not be confused with Esri Shapefiles. AutoCAD shape files hold font and symbol definitions; Esri Shapefiles hold spatial features.

Range: char[65];

Default: txt

autocad_shape_rotation

The angle for the text as defined in the shape file.

Range: 64-bit floating point number

Default: 0

autocad_shape_height

The height of the text as defined in the shape file.

Range: 64-bit floating point number

Default: 0

autocad_shape_width

The width of the text as defined in the shape file.

Range: 64-bit floating point number

Default: 1
autocad_shape_vertical

Indicates if the shape text, as defined in the shape file, is vertical or horizontal.

Range: yes | no

Default: None

autocad_generation

The generation of the text entry.

Range:

  • autocad_normal
  • autocad_upside_down
  • autocad_backwards
  • autocad_upsidedown_backwards

Default: autocad_normal

autocad_estimated_num_lines

(used by the reader only)

The estimated number of lines in the multi-text feature. This is a calculated value that uses the starting height of the multi-text feature, the height of the bounding box of the feature, and the linespacing factor.

Range: Any integer

Default: Not applicable since this is a reader-only attribute
autocad_anno_scale{}.name

The name of an annotation scale, used to represent a reference by an annotation object, to an annotation scale definition in a drawing.

Default: No default
autocad_anno_scale{}.paper_units

The paper units part of an annotation scale definition in a drawing, defined as a scale from paper units to drawing units.

Default: 1
autocad_anno_scale{}.drawing_units

The drawing units part of an annotation scale definition in a drawing, defined as a scale from paper units to drawing units.

Default: 1
autocad_anno_force_visible

This indicates the value of an option to override the ANNOALLVISIBLE system variable for an annotative object, forcing it to display in Autodesk applications, regardless of the current scale.

Used in combination with annotation scales.

Default: No default