TXTextControl.TXTextControl.TextFrameInsertFixed Method

This method inserts a new text frame at a fixed geometrical position. The text flows around the text frame.

Introduced: 12.0.

Syntax

TXTextControl.TextFrameInsertFixed PageNo, PosX, PosY, Width, Height, TextFlow, DistanceL, DistanceT, DistanceR, DistanceB
Parameter Description
PageNo

Specifies the number of the page where the text frame is inserted, beginning with number 1. If the ViewMode property has not been set to Page View, this parameter must be set to zero. In this case, the PosY parameter specifies the position relative to the top of the control.

PosX

Specifies the text frame's horizontal position in twips relative to the left border of the page.

PosY

Specifies the text frame's vertical position in twips relative to the top border of the page or control.

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.

TextFlow

Specifies how text flows around the text frame. It can be one of the following values:


Value Description
2 The text stops at the top and continues at the bottom of the text frame.
3 The text flows around the text frame. Empty areas at the left and right side are filled.
DistanceL, DistanceT, DistanceR, DistanceB

Specifies distances, in twips, between the text frame and the document's text.

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

PageNo:    Long
PosX:    Long
PosY:    Long
Width:    Integer
Height:    Integer
TextFlow:    Integer
DistanceL:    Integer
DistanceT:    Integer
DistanceR:    Integer
DistanceB:    Integer
Return value:    Integer

See Also