Skip to main content
This object is used for setting up the parameters of the document structure detection during document synthesis. This object is passed as a subobject of SynthesisParamsForDocument object to recognition and synthesis methods. By default, all the Boolean properties of this object are set to TRUE. You may turn off some of the properties, if your document does not contain any elements of this type (e.g., it does not have footnotes or table of contents) which may speed up processing. The DocumentStructureDetectionParams object is a persistent object. This means that the object’s current state can be written to persistent storage. Later, the object can be re-created by reading the object’s state from the persistent storage. The following methods provide persistence of the object: Linux: SaveToFile, and LoadFromFile Windows SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.

​
Properties

NameTypeDescription
ApplicationEngine, read-onlyReturns the Engine object.
ClassifySeparatorsVARIANT\_BOOLIf this property is set to TRUE, additional properties of separators (such as their type and role) are detected during document synthesis. This property is set to TRUE by default.
DetectCaptionsVARIANT\_BOOLIf this property is set to TRUE, the captions are detected during document synthesis. This property is set to TRUE by default.
DetectColumnsVARIANT\_BOOLIf this property is set to TRUE, the columns are detected during document synthesis. This property is set to TRUE by default.
DetectFootnotesVARIANT\_BOOLIf this property is set to TRUE, the footnotes are detected during document synthesis. This property is set to TRUE by default.
DetectHeadlinesVARIANT\_BOOLIf this property is set to TRUE, the headlines are detected during document synthesis. This property is set to TRUE by default.
DetectListsVARIANT\_BOOLIf this property is set to TRUE, the lists are detected during document document synthesis. This property is set to TRUE by default.
DetectOverflowingParagraphsVARIANT\_BOOLIf this property is set to TRUE, the overflowing paragraphs are detected during document synthesis. The overflowing paragraph is the one which starts from one page and ends on another page. If the property is set to FALSE, the program presumes that there are no overflowing paragraphs in the document. This property is set to TRUE by default.
DetectRunningTitlesVARIANT\_BOOLIf this property is set to TRUE, the running titles are detected during document synthesis. This property is set to TRUE by default.
DetectTableOfContentsVARIANT\_BOOLIf this property is set to TRUE, the table of contents is detected during document synthesis. This property is set to TRUE by default.

​
Methods

NameDescription
CopyFromInitializes properties of the current object with values of similar properties of another object.
LoadFromFileRestores the object contents from a file on disk.
LoadFromMemory <Note> : Windows only. </Note>Restores the object contents from the global memory.
SaveToFileSaves the object contents into a file on disk.
SaveToMemory <Note> : Windows only. </Note>Saves the object contents into the global memory.
DocumentStructureDetectionParams Object Diagram

​
See also

Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis SynthesisParamsForDocument Working with Properties