get_field_names_for_region method

get_field_names_for_region(region_name)

Returns a collection of mail merge field names available in the region.

def get_field_names_for_region(self, region_name: str):
    ...
ParameterTypeDescription
region_namestrRegion name (case-insensitive).

Remarks

Returns full merge field names including optional prefix. Does not eliminate duplicate field names.

If document contains multiple regions with the same name the very first region is processed.

A new string array is created on every call.

get_field_names_for_region(region_name, region_index)

Returns a collection of mail merge field names available in the region.

def get_field_names_for_region(self, region_name: str, region_index: int):
    ...
ParameterTypeDescription
region_namestrRegion name (case-insensitive).
region_indexintRegion index (zero-based).

Remarks

Returns full merge field names including optional prefix. Does not eliminate duplicate field names.

If document contains multiple regions with the same name the Nth region (zero-based) is processed.

A new string array is created on every call.

See Also