MergeLayoutByType

This action merges the layout files (*layout.xml) associated with Page objects of the Document Hierarchy.

Syntax

bool MergeLayoutByType (string PageTypesToMerge)

Parameters

TypesToMerge: String

Comma-separated string values indicating the Page Types of the Document Hierarchy objects to be merged.

Smart parameters are supported.

Returns

False, if a layout file (*layout.xml) for one of the Page Types is not available or if the merged layout cannot be created. Otherwise, True.

Level

Document level only.

Details

The layout.xml for the first page that is merged becomes the new merged layout.xml. The merged layout.xml can be then loaded to create a merged CCO for the merged pages. The layout file for the first merged page is updated to contain the recognition results from the layout block information for all of the merged pages.

Only pages that are contained in the current document object are merged. A layout file must exist for each of the pages to be merged. Only page types that are indicated by the parameter are included in the merged file.

This action can only be attached to a document node so a document structure must exist. The document node's child pages will be merged if the page type matches one of the types provided as a parameter.

Example

MergeLayoutByType("Main_Page,Trailing_Page")

The MergeLayoutByType action combines all of the text of the pages in the current DCO document of type Main_Page and Trailing_Page into a single, searchable layout file.