GetSelectedBlockType

Obtains the type of the currently selected block and stores it in the DCO location indicated by the target parameter. This action uses the document block layout that is 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 GetSelectedBlockType (string varTarget)

Parameters

string varTarget

Target: A smart parameter that defines the target variable to store the type of the currently selected block.

Returns

True if the type was successfully stored, otherwise False.

Level

Page or field.

Details

Obtains the type of the currently selected block and stores it in the DCO location indicated by the target parameter. This action uses the document block layout created by the DocumentAnalytics actions.

Example

RegExFind_InBlock("Da.e")
GetSelectedBlockType("@X.SelectedBlock")

Finds the block that contains the matching expression and then stores the name of the currently selected block in a variable called SelectedBlock on the current DCO object.

If the variable does not exist, it will be created. In this example, the name of the stored block would be Word because the currently selected block is the found word block.