get_text_blocks_in_view

The function get_text_blocks_in_view retrieves a list of Text Blocks in a View.

get_text_blocks_in_view (view; list)

The function get_text_blocks_in_view is of type NUMBER.

The function has two parameters:

1. The parameter view is of type TEXT. This is the name of the View whose Text Blocks are retrieved.
2. The parameter list: ARRAY is of type TEXT. This array will receive the list of Text Blocks.

Return values

The function get_text_blocks_in_view will return the number of Text Blocks found in the View. This can be 0 if the View is empty. The output array will receive the names of the Text Blocks in the format Project.TextBlock. The order of the names matches the order in the View. If the output array is larger than the number of Text Blocks, the elements outside the range are left unmodified.

Example

ARRAY TEXT list[0]
NUMBER i
NUMBER n := get_text_blocks_in_view ("My View"; list)
#
Found @(numerals(n)) Text Blocks:
#
FOR i FROM 1 UPTO n DO
#
@(i)	@(list[i])
#
OD