Instance Method

setOnStateValue:

Sets the string that is associated with the on state of a radio button or checkbox control.

Declaration

- (void)setOnStateValue:(NSString *)name;

Discussion

Required for controls of types PDFAnnotationButtonWidget and PDFAnnotationButtonWidget, the value of name describes the on state of the control (the off state is always labeled “Off”). Although “On” is an acceptable string for the on state of a single checkbox, a group of two or more radio buttons should have a unique string associated with each control.

For example, a form might display a group of 3 radio buttons that allow users to indicate an account type, such as savings, checking, or investment. The strings associated with the on states of these buttons could be “Savings,“ “Checking,“ and “Investment.“ In this example, these 3 radio buttons also would share a field name string, such as “AccountType.“

See Also

Managing Control State Values and Form Fields

- onStateValue

Returns the string associated with the on state of a radio button or checkbox control.

Deprecated
- fieldName

Returns the internal name of a field (used for reset-form actions).

Deprecated
- setFieldName:

Sets the internal name of a field (used for reset-form actions).

Deprecated