Groupdocs API References – groupdocs.parser.templates

Python-Net: Template class

Mon, 01 Jan 0001 00:00:00 +0000

Template class

Provides the document page template. It consists of TemplateItem objects which represent the items of the template such as text field and table definitions.

The Template type exposes the following members:

Constructors

Constructor	Description
init	Constructs a new instance of Template
init	Constructs a new instance of Template

Properties

Property	Description
is_ocr_compatible	Gets the value that indicates whether the template is compatible with OCR.
count	Gets the total number of template items.
options	Gets the template options.

Gets the template item by an index.

Indexer

Name	Description
[index]	The zero-based index of the template item.

Methods

Method	Description
load	Loads a template from a file.
load	Loads a template from a stream.
save	Saves a template to a file.
save	Saves a template to a stream.

Remarks

Learn more: | | |

Python-Net: TemplateBarcode class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateBarcode class

Provides the template barcode field.

Inheritance: TemplateBarcode → TemplateItem

The TemplateBarcode type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateBarcode` class.
init	Constructs a new instance of TemplateBarcode
init	Constructs a new instance of TemplateBarcode

Properties

Property	Description
name	Gets the name of the template item.
page_width	Gets the width of the page that was used to create the template item.
use_upper_case_name	Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.
rectangle	Gets the rectangular area that contains the template barcode field.

Methods

Method	Description
scale	Scales this template item by a given factor.

Python-Net: TemplateCollection class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateCollection class

Represents a collection of document parsing templates.

The TemplateCollection type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateCollection` class.
init	Constructs a new instance of TemplateCollection

Properties

Property	Description
count	Gets the number of templates contained in the `TemplateCollection`.

Methods

Method	Description
get	Gets the template at the specified index.
add	Adds a template to the end of the `TemplateCollection`.
remove_at	Removes the template at the specified index of the `TemplateCollection`.
remove	Removes the first occurrence of a specific template from the `TemplateCollection`.
clear	Removes all elements from the `TemplateCollection`.

Python-Net: TemplateField class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateField class

Provides the template text field.

Inheritance: TemplateField → TemplateItem

The TemplateField type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateField` class.
init	Constructs a new instance of TemplateField
init	Constructs a new instance of TemplateField

Properties

Property	Description
name	Gets the name of the template item.
page_width	Gets the width of the page that was used to create the template item.
use_upper_case_name	Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.
position	Gets the value that describes how to find the template field on the document page.
is_hidden	Gets or sets the hidden template field flag.
value	Gets or sets the value of the template field.

Methods

Method	Description
scale	Scales this template item by a given factor.

Remarks

Text fields are defined by its position on the page. There are three ways to define a text field:

| | | | |

Python-Net: TemplateFixedPosition class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateFixedPosition class

Provides a template field position which is defined by the rectangular area.

Inheritance: TemplateFixedPosition → TemplatePosition

The TemplateFixedPosition type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateFixedPosition` class.

Properties

Property	Description
rectangle	Gets the rectangular area that contains the template field.

Example

This is simplest way to define the field position. It requires to set a rectangular area on the page that bounds the field value. All the text that is contained (even partially) into the rectangular area will be extracted as a value:

Python-Net: TemplateItem class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateItem class

Provides a base abstract class for template items.

The TemplateItem type exposes the following members:

Properties

Property	Description
name	Gets the name of the template item.
page_width	Gets the width of the page that was used to create the template item.
use_upper_case_name	Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.

Methods

Method	Description
scale	Scales this template item by a given factor.

Remarks

The inheritors of TemplateItem class are used in Template collection.

Python-Net: TemplateLinkedPosition class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateLinkedPosition class

Provides a template field position which uses the linked field.

Inheritance: TemplateLinkedPosition → TemplatePosition

The TemplateLinkedPosition type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateLinkedPosition` class.
init	Initializes a new instance of the `TemplateLinkedPosition` class with UPPER CASE linked field name.
init	Initializes a new instance of the `TemplateLinkedPosition` class.

Properties

Property	Description
linked_field_name	Gets the linked field name.
search_area	Gets the size of the area where a field is searched.
edges	Gets the edges of the linked field where a field is searched.
auto_scale	Gets the value that indicates whether `TemplateLinkedPosition.search_area` is scaled by the linked field size.

Example

The following example shows the code for the situation if it’s known that the field with an invoice number is placed on the right of “Invoice number” string the following code is used:

Python-Net: TemplateLinkedPositionEdges class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateLinkedPositionEdges class

Provides the edges of the linked field where the text field is seached. TemplateLinkedPositionEdges is used in TemplateLinkedPosition class.

The TemplateLinkedPositionEdges type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateLinkedPositionEdges` class.

Properties

Property	Description
is_empty	Gets the value that indicates whether the instance is empty.
left	Gets the value that indicates whether a field is searched by the left from the linked field.
top	Gets the value that indicates whether a field is searched by the top from the linked field.
right	Gets the value that indicates whether a field is searched by the right from the linked field.
bottom	Gets the value that indicates whether a field is searched by the bottom from the linked field.

Methods

Method	Description
parse	Converts the string representation of edges to its class equivalent.
try_parse	Converts the string representation of edges to its class equivalent. A return value indicates whether the conversion is succeeded or failed.

Python-Net: TemplateOptions class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateOptions class

Provides the options which are used for parsing by template functionality.

The TemplateOptions type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateOptions` class.

Properties

Property	Description
rectangle_tolerance	Gets the size of the border that is ignored when captured by the rectangular area. It’s measured by the fraction of a text item height.

Python-Net: TemplatePosition class

Mon, 01 Jan 0001 00:00:00 +0000

TemplatePosition class

Provides a base abstract class for template positions.

The TemplatePosition type exposes the following members:

Python-Net: TemplateRegexPosition class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateRegexPosition class

Provides a template field position which uses the regular expression.

Inheritance: TemplateRegexPosition → TemplatePosition

The TemplateRegexPosition type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateRegexPosition` class.
init	Initializes a new instance of the `TemplateRegexPosition` class.

Properties

Property	Description
expression	Gets the regular expression.
match_case	Gets the value that indicates whether a text case isn’t ignored.

Example

The following example shows the situation if the document contains “Invoice Number INV-12345” then template field can be defined in the following way:

In this case as a value the entire string is extracted. To extract only a part of the string the regular expression group “value” is used:

In this case as a value “INV-3337” string is extracted.

Python-Net: TemplateTable class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateTable class

Provides the template table.

Inheritance: TemplateTable → TemplateItem

The TemplateTable type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `TemplateTable` class with the UPPER CASE name.
init	Constructs a new instance of TemplateTable
init	Constructs a new instance of TemplateTable
init	Initializes a new instance of the `TemplateTable` class.
init	Constructs a new instance of TemplateTable
init	Constructs a new instance of TemplateTable

Properties

Property	Description
name	Gets the name of the template item.
page_width	Gets the width of the page that was used to create the template item.
use_upper_case_name	Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.
layout	Gets the table layout.
parameters	Gets the parameters to detect the table in the automatic mode.

Methods

Method	Description
scale	Scales this template item by a given factor.

Remarks

There are two ways to define a table:

| | | |

Python-Net: TemplateTableLayout class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateTableLayout class

Provides the template table layout which is used by TemplateTable class to define table position.

The TemplateTableLayout type exposes the following members:

Constructors

Constructor	Description
init	Constructs a new instance of TemplateTableLayout

Properties

Property	Description
rectangle	Gets the rectangular area that contains the table.
vertical_separators	Gets the table columns separators.
horizontal_separators	Gets the table rows separators.

Methods

Method	Description
move_to	Creates a new layout with the same size, separators and position in the `point`.

Python-Net: TemplateTableParameters class

Mon, 01 Jan 0001 00:00:00 +0000

TemplateTableParameters class

Provides parameters for the table detection algorithms.

The TemplateTableParameters type exposes the following members:

Constructors

Constructor	Description
init	Constructs a new instance of TemplateTableParameters
init	Constructs a new instance of TemplateTableParameters

Properties

Property	Description
rectangle	Gets the rectangular area that contains the table.
has_merged_cells	Gets the value that indicates whether the table has merged cells.
min_row_count	Gets the minimum number of the table rows.
min_column_count	Gets the minimum number of the table columns.
min_vertical_space	Gets the minumum space between the table columns.
vertical_separators	Gets the table columns separators.

Remarks

There are two algorithms to detect a table:

| | | |

In some cases when algorithms can’t detect a table or do it in non-accurate way TemplateTableLayout class is used.

Groupdocs API References – groupdocs.parser.templates

Python-Net: Template class

Template class

Constructors

Properties

Indexer

Methods

Remarks

See Also

Python-Net: TemplateBarcode class

TemplateBarcode class

Constructors

Properties

Methods

See Also

Python-Net: TemplateCollection class

TemplateCollection class

Constructors

Properties

Methods

See Also

Python-Net: TemplateField class

TemplateField class

Constructors

Properties

Methods

Remarks

See Also

Python-Net: TemplateFixedPosition class

TemplateFixedPosition class

Constructors

Properties

Example

See Also

Python-Net: TemplateItem class

TemplateItem class

Properties

Methods

Remarks

See Also

Python-Net: TemplateLinkedPosition class

TemplateLinkedPosition class

Constructors

Properties

Example

See Also

Python-Net: TemplateLinkedPositionEdges class

TemplateLinkedPositionEdges class

Constructors

Properties

Methods

See Also

Python-Net: TemplateOptions class

TemplateOptions class

Constructors

Properties

See Also

Python-Net: TemplatePosition class

TemplatePosition class

See Also

Python-Net: TemplateRegexPosition class

TemplateRegexPosition class

Constructors

Properties

Example

See Also

Python-Net: TemplateTable class

TemplateTable class

Constructors

Properties

Methods

Remarks

See Also

Python-Net: TemplateTableLayout class

TemplateTableLayout class

Constructors

Properties

Methods

See Also

Python-Net: TemplateTableParameters class