GUIComponent variables

A variable of type GUIComponent provides access to data for a GUI component. It has the following variables:

Name Type Description
name String scalar The name of the GUI component.
type String scalar The type of the GUI component. A value from GUIComponentStatics.
entity Entity hash The entity for the GUI component.
category String scalar The categorisation of the category. A value from GUIComponentStatics.
isList method returning a Boolean scalar Returns true if this is a list GUI component.
isDetail method returning a Boolean scalar Returns true if this is a detail GUI component
pagingEnabled Boolean scalar Flag indicating whether paging is enabled for the list GUI component
pageSize Number scalar The page size for the list GUI component.
links Link sequence The links for the GUI component.
parentLink Link hash The link to the parent for the GUI component, if there is one.
parent GUIComponent hash The parent for the GUI component, if there is one.
externalParentLink Link hash The link to the external parent for the GUI component, if there is one.
externalParent GUIComponent hash The external parent for the GUI component, if there is one.
internalParentLink Link hash The link to the internal parent for the GUI component, if there is one.
internalParent GUIComponent hash The internal parent for the GUI component, if there is one.
children GUIComponent sequence The children GUI components for this.
internalChildren GUIComponent sequence The internal children GUI components for this.
externalChildren GUIComponent sequence The external children GUI components for this.
internalListChildren GUIComponent sequence The internal list children GUI components for this.
internalDetailChildren GUIComponent sequence The internal detail children GUI components for this.
externalDetailChildren GUIComponent sequence The external detail children GUI components for this.
allInternalDetailChildren GUIComponent sequence All internal detail children for this GUI component, and all their internal detail children.
hasInternalDetailDescendant method returning a Boolean scalar Returns true if any of the internal children for this GUI component is a detail GUI component or themselves have an internal detail descendant.
forSameEntity method returning a Boolean scalar, requiring parameter:
Entity entity - the entity in question
Returns true if the GUI component is for the specified entity.
isMultiDetail method returning a Boolean scalar Returns true if this detail GUI component will need to display multiple records because of the way it is linked.
topLevelAncestor GUIComponent hash Returns the closest ancestor GUI component (possibly the GUI component itself) that has no internal parent.
identifyingRelationshipWithAncestor Relationship hash Returns the identifying relationship between the entity for this GUI component and the entity for the closest ancestor GUI component of this whose entity is different from this GUI components entity.
listColumns Column sequence The columns for the list GUI component.
visibleListColumns Column sequence The columns that are visible for the list GUI component.
detailFields Field sequence The fields for the detail GUI component.
visibleDetailFields Field sequence The fields that are visible for the detail GUI component.
editableDetailFields Field sequence The fields that are editable for the detail GUI component.
visibleEditableDetailFields Field sequence The fields that are visible and editable for the detail GUI component.

Related concepts

Template data model
GUI component
GUIComponentStatics variables
Entity variables
Link variables
Column variables
Field variables

Related tasks

Customising a template