FlattenFormFieldTagged

Form fields, Tagged PDF, page content

« Back to documentation index

Bakes a field appearance into static page content while retaining accessible form semantics in the structure tree

Syntax

function FlattenFormFieldTagged(Index,
  UpdateAppearance: Integer): Integer;

Parameters

ParameterDescription
Index1-based form field index
UpdateAppearanceNonzero rebuilds the normal appearance before flattening, while zero uses the current appearance

Return values

Returns 1 when the appearance was drawn, tagged, and the live field removed, or 0 when the field, appearance, page, or required existing tag association is unavailable

Remarks

For an untagged document the method creates a Form structure element and derives alternate and actual text from the field description, title, and value

For an existing Tagged PDF the Widget must have a StructParent entry whose ParentTree value identifies a structure element containing an OBJR for that Widget; the method converts that association to page marked content without replacing unrelated structure

A failed conservative conversion leaves the live field in place

See also

FlattenFormFieldsTaggedOnPageRange, FlattenFormField, GetStructTreeItemText