API_​ParagraphType

Describes a paragraph of a text.

    typedef struct {
        Int32           from;
        Int32           range;
        API_JustID      just;
        Int32           filler_1;
        double          firstIndent;
        double          indent;
        double          rightIndent;
        double          spacing;
        API_TabType     *tab;
        API_RunType     *run;
        Int32           *eolPos;
        Int32           filler_2;
        double          width;
        double          height;
        double          filler_3[2];
    } API_ParagraphType;

 

Members

from
The beginning byte offset of the paragraph in the content.
range
The range of the paragraph in byte offset.
just
Justification of the paragraph (see API_JustID).
firstIndent
First indent in mm.
indent
Indent in mm.
rightIndent
Right indent in mm.
spacing
Spacing factor between text lines (it should be between -10.0 and -1.0).
tab
Tabulator(s) of a paragraph (see API_TabType).
run
Run(s) of a paragraph (see API_RunType).
eolPos
Line end positions in byte offset.
width
Width of the paragraph in mm (output only).
height
Height of the paragraph in mm (output only).

 

Remarks

From Archicad 9 you are able to create multistyle text or textual label. API_ParagraphType structure contains all related informations for a paragraph. By text or textual label element creating you can pass the content as a UniCode string (set charCode field of API_TextType structure to CC_UniCode and cast textContent field of API_ElementMemo to (unsigned short*)). In this case all offsets (from, range...) are character offset instead of byte offset. For more details examine Element Manager example project.

 

Requirements

Version: API 6.1 or later
Header: APIdefs_Elements.h

 

See Also

API_TabID, API_TabType, API_RunType, API_TextType, API_LabelType, API_ElementMemo, API Types