SectionDefinition Object (ISectionDefinition Interface)

This object corresponds to a section of a Document Definition. A section of a Document Definition is a set of pages (or a single page) and fields on these pages, which corresponds to a logically complete part of a document. Pages are added to a single section if the document has blocks continuing or recurring on several pages or tables continuing on the following page. All fields in a flexible description belong to one section of a Document Definition. The SectionDefinition object can also be a link to another document definition in case of working with document sets.

All sections of a Document Definition are represented by a SectionDefinitions object.

Properties

Name Type Description
AllowFieldExtractionTraining Boolean Specifies if the fields with region can be trained inside the section.
Comment String Stores the text description of the section.
DocumentDefinition DocumentDefinition, read-only Provides access to the Document Definition containing the section.
Errors StringsCollection, read-only Returns a collection of error descriptions for the latest call of the Check method.
Fields FieldDefinitions, read-only Returns a collection of fields of the section.
FlexibleDescription FlexibleDescription, read-only Provides access to the flexible description of the section. If there is no flexible description in the section, the property returns 0.
Id Integer, read-only Returns the identifier of the section.
IsEnabled Boolean Specifies if the section is to be used for Document Definition matching. This property set to FALSE excludes the section from document processing.
IsFlexible Boolean, read-only Specifies if the section is defined in a flexible description. If the value of this property is TRUE, the name of the field cannot be changed.
IsRepeatable Boolean, read-only Indicates if the section can be repeated in the document, i.e. several corresponding field instances can appear in the document after the section definition is applied.
IsValid Boolean, read-only Specifies if the section is valid. The section is valid if there is no errors in it and it has not been changed since the latest call of the Check method.
LinkedDocumentDefinition DocumentDefinition, read-only Returns the corresponding document definition, if the Type property is set to TST_DocumentDefinitionLink. Otherwise returns NULL.
Name String Stores the name of the section.
NlpModels NlpModels, read-only Provides access to the NLP models.
Pages PageDefinitions, read-only Returns a collection of pages of the section.
TrainingFields FieldDefinitions, read-only

Allows you to get the collection of the field definitions which can be trained. Only the field definitions that can have regions may be trained (see the CanHaveRegion property of the FieldDefinition object).

For field definitions with children, only child field definitions that can have regions will be included in the collection and trained when you call the Train method of the FieldsExtractionTrainer object.
Type TemplateSectionTypeEnum, read-only Specifies if the object is a simple section or a link to a document definition.
UseOwnRecognitionParams Boolean

Specifies if the section should be recognized with the parameters of the Document Definition and not use the parameters loaded from a flexible description created in ABBYY FlexiLayout Studio.

The Document Definition parameters may override the flexible description settings for:
Warnings StringsCollection, read-only Returns a collection of warnings descriptions for the latest call of the Check method.

Methods

Name Description
Check Checks if section properties were configured correctly.
LoadFlexibleDescription Loads a flexible description from the specified ABBYY FlexiLayout Studio file.
LoadFlexibleDescriptionFromStream Loads a flexible description from stream.
LoadXFDDescription Loads a form from the specified XML Form Definition file.

Related objects

Output parameter

This object is the output parameter of the following methods:

Input parameter

This object is the input parameter of the following methods:

Samples

This object is used in the following code samples: Classification, Invoices Processing and Training.

See also

SectionDefinitions

Creating Document Definitions

Working with Properties

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.