2.9.78 FFData

The FFData structure specifies form field data for a text box, check box, or drop-down list box.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

version

bits

cch

hps

xstzName (variable)

...

xstzTextDef (variable)

...

wDef (optional)

xstzTextFormat (variable)

...

xstzHelpText (variable)

...

xstzStatText (variable)

...

xstzEntryMcr (variable)

...

xstzExitMcr (variable)

...

hsttbDropList (variable)

...

version (4 bytes): An unsigned integer that MUST be 0xFFFFFFFF.

bits (2 bytes): An FFDataBits that specifies the type and state of this form field.

cch (2 bytes): An unsigned integer that specifies the maximum length, in characters, of the value of the textbox. This value MUST NOT exceed 32767. A value of 0 means there is no maximum length of the value of the textbox. If bits.iType is not iTypeText (0), this value MUST be 0.

hps (2 bytes): An unsigned integer. If bits.iType is iTypeChck (1), hps specifies the size, in half-points, of the checkbox and MUST be between 2 and 3168, inclusive. If bits.iType is not iTypeChck (1), hps is undefined and MUST be ignored.

xstzName (variable): An Xstz that specifies the name of this form field. xstzName.cch MUST NOT exceed 20.

xstzTextDef (variable): An optional Xstz that specifies the default text of this textbox. This structure MUST exist if and only if bits.iType is iTypeTxt (0). xstzTextDef.cch MUST NOT exceed 255. If bits.iTypeTxt is either iTypeTxtCurDate (3) or iTypeTxtCurTime (4), xstzTextDef MUST be an empty string. If bits.iTypeTxt is iTypeTxtCalc (5), xstzTextDef specifies an expression to calculate.

wDef (2 bytes): An optional unsigned integer that specifies the default state of the checkbox or dropdown list box. This value MUST exist if and only if bits.iType is iTypeChck (1) or iTypeDrop (2). If bits.iType is iTypeChck (1), wDef MUST be 0 or 1 and specify the default state of the checkbox as unchecked or checked, respectively. If bits.iType is iTypeDrop (2), wDef MUST be less than the number of items in the dropdown list box and specify the default item selected (zero-based index).

xstzTextFormat (variable): An Xstz that specifies the string format of the textbox. xstzTextFormat MUST be an empty string if bits.iType is not iTypeTxt (0). xstzTextFormat.cch MUST NOT exceed 64. Valid formatting strings are specified in [ECMA-376] part 4, section 2.16.22 format (Text Box Form Field Formatting).

xstzHelpText (variable): An Xstz that specifies the help text for the form field. The value of xstzHelpText.cch MUST NOT exceed 255.

xstzStatText (variable): An Xstz that specifies the status bar text for the form field. The value of xstzStatText.cch MUST NOT exceed 138.

xstzEntryMcr (variable): An Xstz that specifies a macro to run on entry of the form field. The value of xstzEntryMcr.cch MUST NOT exceed 32.

xstzExitMcr (variable): An Xstz that specifies a macro to run after the value of the form field changes. The value of xstzExitMcr.cch MUST NOT exceed 32.

hsttbDropList (variable): An optional STTB that specifies the entries in the dropdown list box. This MUST exist if and only if bits.iType is iTypeDrop (2). The entries are Unicode strings and do not have extra data. This MUST NOT exceed 25 elements.