add method

This method adds a field for the document.

Defined in

TextFields

Syntax

public TextField add(TextRange position,String type,String name ) throws SymphonyException

Parameters

TextRange position

Specifies the position of the new field.

String type

Specifies the type of the new field. The value of this parameter can only be "User" or "PageNumber", which means it is a user field or a page number field. If other filed types is used, this method throws an exception.

String name

Specifies the name of the user field. This parameter is only available when add a user field. If a user field with the same name already exist, it inserts the existing user field into the specified position.

Return Value

field

A TextField object that represents a field.

See examples

Example: add method