InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

ClearFormBehavior

A behavior object that clears the form fields in the document.

Behavior ›ClearFormBehavior
Hierarchy

Button | CheckBox | ComboBox | ListBox | RadioButton | SignatureField | TextBox

ClearFormBehavior

Properties

NameType AccessDescription
BehaviorEvents
 read/write The event which triggers the behavior.
Boolean read/write If true, the behavior is enabled.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the ClearFormBehavior.
Number readonly The index of the ClearFormBehavior within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String readonly The name of the ClearFormBehavior.
CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField readonly The parent of the ClearFormBehavior (a Button, CheckBox, ComboBox, ListBox, RadioButton, TextBox or SignatureField).
Object read/write A property that allows setting of several properties at the same time.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Gets the label value associated with the specified key.

key String The key.
→ ClearFormBehavior[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the ClearFormBehavior.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Generates a string which, if executed, will return the ClearFormBehavior.

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a ClearFormBehavior.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a ClearFormBehavior.

ClearFormBehaviors.itemByRange(from)ClearFormBehaviors.nextItem(obj)ClearFormBehaviors.previousItem(obj)

Return 14

Methods that return a ClearFormBehavior.

ClearFormBehavior.getElements()ClearFormBehaviors.[]()ClearFormBehaviors.add()ClearFormBehaviors.anyItem()ClearFormBehaviors.everyItem()ClearFormBehaviors.firstItem()ClearFormBehaviors.item()ClearFormBehaviors.itemByID()ClearFormBehaviors.itemByName()ClearFormBehaviors.itemByRange()ClearFormBehaviors.lastItem()ClearFormBehaviors.middleItem()ClearFormBehaviors.nextItem()ClearFormBehaviors.previousItem()