get_text_blocks_in_view

The function get_text_blocks_in_view retrieves a list of Text Blocks in a Text Block List.

 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 Text Block List with Text Blocks to be retrieved.
2. The parameter list: ARRAY is of type TEXT. This array receives the list of Text Blocks.

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

An example is provided here.

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