Description
Inserts a new text frame at a fixed geometrical position. The text flows around the text frame.
Applies to
Syntax
integer rtename.TextFrameInsertFixed(long pageNo, long posX, long PosY, integer width, integer height, integer textFlow, integer distanceL, integer distanceT, integer distanceR, integer distanceB)
|
Argument |
Description |
|---|---|
|
pageNo |
Specifies the number of the page where the text frame is inserted, beginning with number 1. |
| posX | The text frame's horizontal position in twips relative to the left border of the paragraph. This value is used if the Alignment parameter has been set to 0. Twip is a fabricated word meaning twentieth of a point (pt). |
| posY | The text frame's vertical position in twips relative to the top border of the paragraph. Twip is a fabricated word meaning twentieth of a point (pt). The value cannot be set to a value smaller than 0. |
| 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). |
| textFlow |
Specifies how text flows around the text frame. Values are:
|
| distanceL | Specifies the left distances, in twips, between the text frame and the document's text. Twip is a fabricated word meaning twentieth of a point (pt). |
| distanceT | Specifies the top distances, in twips, between the text frame and the document's text. Twip is a fabricated word meaning twentieth of a point (pt). |
| distanceR | Specifies the right distances, in twips, between the text frame and the document's text. Twip is a fabricated word meaning twentieth of a point (pt). |
| distanceB | Specifies the bottom distances, in twips, between the text frame and the document's text. 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 to the first page.
integer li_rtn li_rtn = rte_1.TextFrameInsertFixed(1,100,1000,5000,100,2,0,0,0,0)
