com.groupdocs.parser

Interfaces

Classes

Exceptions

com.groupdocs.parser

Class TemplateField



  • public final class TemplateField
    extends Object

    Provides a template field.

    • Constructor Detail

      • TemplateField

        public TemplateField(String fieldName,
                     TemplateFieldPosition fieldPosition)

        Initializes a new instance of the TemplateField class.

        Parameters:
        fieldName - A name of the field.
        fieldPosition - A field position on the page.
      • TemplateField

        public TemplateField(String fieldName,
                     int pageIndex,
                     TemplateFieldPosition fieldPosition)

        Initializes a new instance of the TemplateField class.

        Parameters:
        fieldName - A name of the field.
        pageIndex - A zero-based page index.
        fieldPosition - A field position on the page.
    • Method Detail

      • getFieldName

        public String getFieldName()

        Gets a name of the template field.

        Returns:
        An uppercase string that represents the name of the template field.
      • getPageIndex

        public Integer getPageIndex()

        Gets a zero-based page index.

        Returns:
        A zero-based index of the page where the field is placed; null if the field is placed on any page.
      • getFieldPosition

        public TemplateFieldPosition getFieldPosition()

        Gets a field position on the page.

        Returns:
        An instance of TemplateFieldPosition.