TXTextControl.SignatureFieldInsert Method

This method inserts a new signature field anchored to a paragraph. The text flows around the signature field.

Introduced: 31.0.

Syntax

TXTextControl.SignatureFieldInsert TextPos, Alignment, PosX, PosY, Width, Height, TextFlow, DistanceL, DistanceT, DistanceR, DistanceB
Parameter Description
TextPos

Specifies a text position in the paragraph where to insert the signature field. If TextPos is -1, the signature field is anchored to the paragraph at the current input position.
Alignment

Specifies the signature field's horizontal alignment. It can be one of the following values:


Value Description
0 The horizontal position is given through the PosX parameter.
1 The signature field is left aligned relative to the paragraph to which it is anchored.
2 The signature field is right aligned relative to the paragraph to which it is anchored.
3 The signature field is centered relative to the paragraph to which it is anchored.
PosX

Specifies the signature field'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.
PosY

Specifies the signature field's vertical position in twips relative to the top border of the paragraph.
Width

Specifies the width of the signature field 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 signature field through a rectangle, drawn with the mouse.
Height

Specifies the height of the signature field 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 signature field through a rectangle, drawn with the mouse.
TextFlow

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


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

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

Return Value

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

Data Types

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

See Also

<<  TXTextControl.ZoomFactor Property | >>  TXTextControl.SignatureFieldInsertAsChar Method