MKI_ObjectAddTextFrame (Entity Creation) Changed in Version 2015.0

C++ Syntax

MKI_XPROPERTY_PTR

MKI_ObjectAddTextFrame(

 MKI_CONST_TEXTFRAME_REF f_rData );

Adds a frame text parameter data block (MKI_DB_INFO_TEXTFRAME) to a previously opened temporary object (see MKI_ObjectOpen). This type of data block is usually used inside frame texts (MKI_OBJ_TEXTFRAME).

Parameters

Data

[MKI_CONST_TEXTFRAME_REF] Data to be stored in the frame text parameter data block. The TextXProperty component will be overwritten by the current default properties for that object. In case these properties are to be modified, use the address returned from this procedure to access them directly.

Return Value

Returns the address of the TextXProperty component of the created data block if the data block was added successfully. This address can be used to alter the default properties of the text. If nullptr is returned, this indicates that the object would be too large after adding this data block.