Controls

The Controls interface acts as a parent object for all controls on all pages within a form. Individual controls are accessed using their control name. When a control's name is not a valid Java identifier e.g. it begins with a numeric, the control can only be accessed using the #getControl(String) method.

When running an event that forms part of a deployed component, only controls from the component can be accessed.

All included controls can be iterated using the following code:

 for ( var control in Iterator(controls.iterator()) )
 {
    log(control.elementName);
 }   
 
Examples:
 controls.PANEL1.hide();
 controls.getControl("23BUTTON").backgroundColor = "Yellow";
 

Controls Functions

getControl Controls.getControl( controlName ) Returns the com.ebasetech.xi.api.controls.Control with name controlName.

Control Types

Controls is a collection. A Control can be one of these types:

ArticleControl
AsideControl
AudioControl
BarcodeControl
BasicBlockControl
BootstrapColumnControl
BootstrapContainerControl
BootstrapRowControl
ButtonColumnControl
ButtonControl
CanvasControl
ContainerControl
DynamicMenuItemControl
EbaseButtonControlProperties
FieldColumnControl
FieldControl
FileUploadControl
FileUploadTextControl
FinishButtonControl
FooterControl
GridCellControl
GridControl
GroupAndPagePanelProperties
GroupPanelControl
HeaderControl
HeadingControl
HorizontalLineControl
HorizontalMenuControl
HTMLControl
HyperlinkControl
IFrameControl
ImageColumnControl
ImageControl
IncludeControl
InitiateUploadControl
LayoutControl
ListControl
ListHyperlinkControl
ListItemControl
ListPanelControl
ListTextControl
MainControl
MenuControl
MenuItemControl
MessageControl
NavControl
NextPageButtonControl
PageBreakControl
PageControl
PageNavigationPanel
PagePanelControl
PanelControl
PrevPageButtonControl
RepeatingTableControl
RepeatingTableListControl
RepeatingTableListRowControl
RepeatingTableRowControl
RestoreButtonControl
SaveButtonControl
SectionControl
SpacerControl
StaticMenuItemControl
TabControl
TableControl
TablePageControl
TabSetControl
TextControl
TitlePanelControl
VerticalMenuControl
VideoControl