Description
Inserts a new text frame, which is then handled as a single character in the text.
Applies to
Syntax
integer rtename.TextFrameInsertAsChar(long textPos, integer width, integer height)
|
Argument |
Description |
|---|---|
|
textPos |
The text position in the paragraph where to insert the text frame. If TextPos is -1, the text frame is anchored to the paragraph at the current input position. |
| width | 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. Twip is a fabricated word meaning twentieth of a point (pt). |
| height | 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. Twip is a fabricated word meaning twentieth of a point (pt). |
Return value
Integer.
Returns the unique ID that identifies the newly-inserted text frame. Returns 0 if it fails. Returns null if any argument is null.
Examples
The following example inserts a text frame at the current position.
integer li_rtn li_rtn = rte_1.TextFrameInsertAsChar(-1,5000,1000)
