SelectParentBlockType

Selects the parent of the current block of the type that is specified. If the currently selected block has multiple parent blocks of the same type, then the parent nearest to the current block would be selected. Uses the document block layout created by the DocumentAnalytics actions.

Important: This action is currently released as a preview. If you use this action in your application, you might need to make updates to your application if a new version of this action released.

Syntax

bool SelectParentBlockType (string  selectType)

Parameters

string selectType

selectType: The type of the parent block to select.
Smart parameters are supported.

Returns

True the specified parent block is found and selected. If the current block is of the specified type, then true will be returned. Otherwise, False.

Level

Page or field level.

Details

If the current block is of the specified type, then the action will return true and the selected block will remain at the current block. When starting a new search after performing previous searches, it may be useful to call this action with type Page to reset the selected block to the page block so the entire page block area can be searched again using the block actions.

Example

RegExFind_InBlock("Da.e")
SelectParentBlockType("Block")

In this example the selected block will be the one of type Block that is the nearest parent to the block containing the found word. The available block types are: Document, Page, Title, Block Table, Row, Cell, Paragraph, Header, and Footer. Consider a page that contains the following nested block layout:

[Page] 
[Block] 
[Block] 
[Line] 
[Word] "Date" [/Word] 
[/Line] 
[/Block] 
[/Block] 
[/Page]

In this example, the selected block would be the Block that is the parent to the Line block.

SelectParentBlockType("Page"): Specifying Page selects the page block as the currently selected block. When a previous Locate action has been run, reselecting the Page block will reset the block to the page so that the next action that searches within the selected block will search the entire page.