PageTextArea class

PageTextArea class

Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality.

An instance of PageTextArea class is used as return value of the following methods:

  • Parser.get_text_areas
  • Parser.get_text_areas(PageTextAreaOptions)
  • Parser.get_text_areas(int)
  • Parser.get_text_areas(int, PageTextAreaOptions)

Also an instance of PageTextArea class is used as value of FieldData.page_area property.

See the usage examples there.

The text area can be single or composite. In the first case it contains a text which is bounded by a rectangular area. In the second case it contains other text areas; text and table properties are calculated by child text areas.

The PageTextArea type exposes the following members:

Constructors

Constructor Description
init Initializes a new PageTextArea instance.
init Initializes a new PageTextArea.
init Initializes a new PageTextArea instance.

Methods

Method Description
to_string Converts the value of this instance to a string.

Properties

Property Description
areas The collection of child text page areas.
base_line The base line of the page text area.
text The text of the page area as a string.
text_style The text style of the page area, such as font size, font name, and so on.
page The document page information such as page index and page size. (inherited from PageArea)
rectangle The rectangular area of the page as a Rectangle. (inherited from PageArea)

See Also