TemplateField
Contents
[
Hide
]
Inheritance: java.lang.Object, com.groupdocs.parser.templates.TemplateItem
public class TemplateField extends TemplateItem
Provides the template text field.
Text fields are defined by its position on the page. There are three ways to define a text field:
- Using the rectangular area: TemplateFixedPosition
- Using the regular expression: TemplateRegexPosition
- Using the linked field: TemplateLinkedPosition
Constructors
| Constructor | Description |
|---|---|
| TemplateField(TemplatePosition position, String name) | Initializes a new instance of the TemplateField class. |
| TemplateField(TemplatePosition position, String name, Integer pageIndex) | Initializes a new instance of the TemplateField class with the UPPER CASE name. |
| TemplateField(TemplatePosition position, String name, Integer pageIndex, boolean useUpperCaseName) | Initializes a new instance of the TemplateField class. |
Methods
| Method | Description |
|---|---|
| getPosition() | Gets the value that describes how to find the template field on the document page. |
TemplateField(TemplatePosition position, String name)
public TemplateField(TemplatePosition position, String name)
Initializes a new instance of the TemplateField class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| position | TemplatePosition | The field position. |
| name | java.lang.String | The field name. |
TemplateField(TemplatePosition position, String name, Integer pageIndex)
public TemplateField(TemplatePosition position, String name, Integer pageIndex)
Initializes a new instance of the TemplateField class with the UPPER CASE name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| position | TemplatePosition | The field position. |
| name | java.lang.String | The field name. |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located; null if the template item is located on any page. |
TemplateField(TemplatePosition position, String name, Integer pageIndex, boolean useUpperCaseName)
public TemplateField(TemplatePosition position, String name, Integer pageIndex, boolean useUpperCaseName)
Initializes a new instance of the TemplateField class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| position | TemplatePosition | The field position. |
| name | java.lang.String | The field name. |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located; null if the template item is located on any page. |
| useUpperCaseName | boolean | The value that indicates whether a name is converted to UPPER CASE. |
getPosition()
public TemplatePosition getPosition()
Gets the value that describes how to find the template field on the document page.
Returns: TemplatePosition - An instance of TemplatePosition descendant class.