Class Form

The class is the top level element in the form instance hierachy.

Property Summary 

PropertyDescription
secureKeyHtmlName: String (read-only)Returns the secure key html name to be used for the hidden input field that will contain the secure key value.
secureKeyValue: String (read-only)Returns the secure key value that is generated for the form to use in a hidden input field for authentication.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getSecureKeyHtmlName()Returns the secure key html name to be used for the hidden input field that will contain the secure key value.
getSecureKeyValue()Returns the secure key value that is generated for the form to use in a hidden input field for authentication.

Methods inherited from class FormGroup 

accept, copyFrom, copyTo, getChildCount, getError, getObject, getSubmittedAction, getTriggeredAction

Methods inherited from class FormElement 

clearFormElement, getDynamicHtmlName, getFormId, getHtmlName, getParent, getValidationResult, invalidateFormElement, invalidateFormElement, isValid

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

secureKeyHtmlName 

secureKeyHtmlName: String (read-only)

Returns the secure key html name to be used for the hidden input field that will contain the secure key value.


secureKeyValue 

secureKeyValue: String (read-only)

Returns the secure key value that is generated for the form to use in a hidden input field for authentication.


Method Details 

getSecureKeyHtmlName() 

getSecureKeyHtmlName(): String

Returns the secure key html name to be used for the hidden input field that will contain the secure key value.

Returns:

  • the secure key html name

getSecureKeyValue() 

getSecureKeyValue(): String

Returns the secure key value that is generated for the form to use in a hidden input field for authentication.

Returns:

  • the secure key value