GRAPHISOFT®

Python APIVersion: 0.23 Beta

CreateText

Creates an Text element.

def CreateText (element) -> String

 

Parameters

element
[in] An APIObject describing the Text element to create.

 

Return Values

This function returns the GUID of the created element.

 

Remarks

This function is analogous to the ACAPI_Element_Create function of the C++ API for Text elements. Undefined members will be set to the current defaults.

For information on how to fill the passed APIObject, visit the C++ documentation.

 

Example

def DrawText (x, y, text):
    element = APIObject ()
    element.head = APIObject ()
    element.head.typeID = API_TextID
    element.head.hasMemo = True
    element.loc = APIObject ()
    element.loc.x = x
    element.loc.y = y
    memo = APIObject ()
    memo.textContent = text
    return CreateText (element, memo)

DrawText (1, 1, "Hello, world!")

 

Requirements

Version: Python API 0.1 or Later
Module: GS

 

See Also

ChangeText, GetText

All functions