An event or user action enacted on the button in a PDF form.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| active | bool | r/w | If true, the state is the active–or front-most–state in the UI. |
| enabled | bool | r/w | If true, objects that use the state appear in PDF documents. If false, objects that use the state do not appear in the document when the event that activates the state, such as a mouseover, occurs. Note: Valid only when visibility in PDF is visible in the PDF. |
| epss | EPSs | readonly | A collection of EPS files. |
| graphicLines | GraphicLines | readonly | A collection of graphic lines. |
| graphics | Graphics | readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
| groups | Groups | readonly | A collection of groups. |
| id | number | readonly | The unique ID of the State. |
| images | Images | readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
| index | number | readonly | The index of the State within its containing object. |
| name | string | readonly | The name of the State. |
| ovals | Ovals | readonly | A collection of ellipses. |
| pageItems | PageItems | readonly | The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
| parent | Button | readonly | The parent of the State (a Button). |
| pdfs | PDFs | readonly | A collection of PDF files. |
| picts | PICTs | readonly | A collection of PICT graphics. |
| polygons | Polygons | readonly | A collection of polygons. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rectangles | Rectangles | readonly | A collection of rectangles. |
| statetype | StateTypes : UP ROLLOVER DOWN |
r/w | The type of user action that dictates the button’s appearance. |
| textFrames | TextFrames | readonly | A collection of text frames. |
| wmfs | WMFs | readonly | A collection of WMF graphics. |
Methods
Array of StategetElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the State.
string toSource ()
Generates a string which, if executed, will return the State.
string toSpecifier ()
Retrieves the object specifier.
Used in:
States.previousItem (
obj:
State )
States.nextItem (
obj:
State )
Returned by:
Array of State State .getElements (
)
State States.add (
[withProperties:
Object]
)
State States.anyItem (
)
Array of State States.everyItem (
)
State States.firstItem (
)
State States.item (
index:
any
)
State States.itemByID (
id:
number
)
State States.itemByName (
name:
string
)
Array of State States.itemByRange (
from:
any, to:
any
)
State States.lastItem (
)
State States.middleItem (
)
State States.nextItem (
obj:
State
)
State States.previousItem (
obj:
State
)