TXTextControl.TXTextControl.TextFrameInsertAsChar Method

This method inserts a new text frame, which is then handled as a single character in the text.

Introduced: 12.0.

Syntax

TXTextControl.TextFrameInsertAsChar TextPos, Width, Height
Parameter Description
TextPos

Specifies a text position where the text frame should be inserted. If TextPos is -1, the text frame is inserted at the current input position.

Width

Specifies the width of the text frame in twips. If this parameter is set to zero, a built-in mouse interface is started which enables the end-user to define the size of the text frame through a rectangle, drawn with the mouse.

Height

Specifies the height of the text frame in twips. If this parameter is set to zero, a built-in mouse interface is started which enables the end-user to define the size of the text frame through a rectangle, drawn with the mouse.

Return Value

The method returns the text frame's identifier, if a new text frame could be inserted. Otherwise, it returns zero. The text frame's identifier can also be obtained with the ObjectCurrent property.

Data Types

TextPos:    Long
Width:    Integer
Height:    Integer
Return value:    Integer

See Also