DynaPDF Manual - Page 400

Previous Page 399   Index   Next Page 401

Function Reference
Page 400 of 839
The member GroupType specifies the subtype of a field group. A field group is a set of fields which
have the same name and type. Such fields contain always the same value with exception of check
boxes. If a field group consists of check boxes the export value is also taken into account.
However, a set of fields with identical names are internally stored in a group field. The group type
specifies the field type of the group, e.g. ftText if text fields are stored in the group. A field group
cannot contain different field types. An indication whether a field is a child of a field group is an
empty field name because the field name is taken from the parent group field. Radio buttons are
identically organized, but the field type is set to ftRadioBtn in this case.
The page number is not set for group fields and radio button fields because these field types are not
directly used on a page. The children of such fields appear in a page but not the corresponding
group fields. This behaviour must be taken into account when enumerating fields with
GetPageFieldEx() since these field types do never occur when enumerating fields on a per page
basis. However, the parent handle is always set if a field is a child of another field.
Inherited attributes of a field group are automatically set to the children of the group. So, there is no
need to merge the values of the parent group field with the ones of its children.
The background and border color can be set to the special value NO_COLOR which means the
background or border is transparent. The color space is set to DeviceRGB in this case.
String values can be either in Unicode or Ansi format but only one format is set at time.
The parent field and the children of a field (member Kids) can be accessed with GetFieldEx2().
Radio Buttons
Radio buttons can define export values for their check boxes. Because the radio button holds these
values, they are not returned when calling GetFieldEx() for a check box of a radio button. These
export values can be accessed with GetFieldChoiceValue(). The export values are stored in the same
order as the Kids array. This makes it easy to access the values, just call GetFieldChoiceValue() right
after GetFieldEx2() for every child. The parameter AField must be set to the handle of the radio
button and Index to the array index.
If a radio button contains no export values, GetFieldChoiceValue() returns just the export value of
the check box. So, there is no need to further validate the result of the function.
Formatted Text Field Value
The member FmtTextColor, FmtTextA or FmtTextW are set for text fields only. If set, this value
represents the formatted text that was created by a Javascript action in the field's OnFormat event.
At time of publication the Javascript functions AFNumber_Format() and AFSpecial_Format() are
supported only.

Previous topic: GetFieldCount, GetFieldEx

Next topic: Optional Content, GetFieldEx2