|
<< Click to Display Table of Contents >> Navigation: »No topics above this level« TOC : OZ e-Form Extension > OZ e-Form JavaScript API > ReportTemplate > Method >GetInputComponents |
Gets the FormID of Component, Label, and FixedTableLabel added in report templates.
Prototype :
string GetInputComponents
(
[ string InputType ],
[ string ExceptInputType ],
[ string Status ]
)
Arguments :
InputType |
Component type that gets the name. Refer to InputTypeConst For multiple options, use comma(,) as the separator. |
ExceptInputType |
Component type that does not get the name. Refer to InputTypeConst For multiple options, use comma(,) as the separator. |
Status |
Component status For multiple options, use comma(,) as the separator. |
Reference :
If Input Component has no FormID, name of component is applied as FormID and Label and FixedTableLabel must set FormID.
The following table shows the values that can be set in the Status argument.
Value |
Description |
Disable |
Disabled. Component whose Enable property value is false. |
Empty |
Allows empty value. Component whose Allow Empty Value property value is true. |
Enable |
Enabled. Component whose Enable property value is true. |
Nonempty |
Does not allow empty value. Component whose Allow Empty Value property value is true. |
Optional |
Optional. Component whose Required property value is false. |
Required |
Required. Component whose Required property value is true. |
If a component does not support the Status argument, the value set in the argument will not be applied to the component. For example, a TextBox that does not support the Allow Empty Value property will not be applied regardless of whether the Status argument value is set to Empty or Nonempty.
Example :
//Only gets components (excluding Buttons) that are enabled and require values to be entered.
var objComp = ReportTemplate.GetInputComponents("", "Button", "Required,Enable");
var compNames = JSON.parse(objComp);
for(i=0; i <compNames.length; i++) {
_TraceLn("Component Name: " + compNames[i]);
Available Events :
OnAddToPage, OnCheckValidity, OnClick, OnEndBind, OnExternalEvent, OnFocus, OnKillFocus, OnLocationUpdated, OnResponse, OnValueChanged
See also :