HtmlElement - SuperOffice

Represents HTML elements in the SuperOffice UI.

Constructors

HtmlElement()

HtmlElement

Initializes a new instance of the HtmlElement class.

Methods

clearValue()

Clears any selected values from elements that support this property.

Void clearValue()

Returns: CRMScript.Global.Void

getFieldValue(String)

Returns the value of a specific field.

String getFieldValue(String field)

Returns: CRMScript.Global.String - The value of field.

getNextTabIndex()

Increments the index counter and returns.

Integer getNextTabIndex()

Returns: CRMScript.Global.Integer - The next valid tab index number.

The HTML tabindex attribute specifies the tab order of an element. It determines the sequence of entering fields with Tab or Shift+Tab.

getTabIndexString()

Retrieves the tabulator index string of the element A variant of <code>getTabIndexString()</code> that omits element ID if it is the 1st element.

String getTabIndexString()

Returns: CRMScript.Global.String - The tabulator index string of the element.

The HTML tabindex attribute specifies the tab order of an element. It determines the sequence of entering fields with Tab or Shift+Tab.

getTabIndexString(Bool)

Retrieves the tabulator index string of the element and omits element ID if it is the 1st element.

String getTabIndexString(Bool noId)

Returns: CRMScript.Global.String - The tabulator index string of the element.

The HTML tabindex attribute specifies the tab order of an element. It determines the sequence of entering fields with Tab or Shift+Tab.

getTypeName()

Returns the element type. For example, HtmlAnchorLine or HtmlGrid.

String getTypeName()

Returns: CRMScript.Global.String - The element type.

Look up specific elements in the bLogic screen element reference.

isEmpty()

Returns true if the HtmlElement says it is empty.

Bool isEmpty()

Returns: CRMScript.Global.Bool - True if the HtmlElement says it is empty; otherwise, false.

That an element is empty means different things depending on the element type. For example, a list element should be empty if it has no rows, but a code element should be empty if it contains no text.

setDisabled(Bool)

Toggles whether the element is visible or invisible.

Void setDisabled(Bool invisible)

Returns: CRMScript.Global.Void

Commonly used in combination with role-based access.

setErrorMessage(String)

Sets an error message above the element if the form is posted.

Void setErrorMessage(String errorMessage)

Returns: CRMScript.Global.Void

Used to inform users that something went wrong and attempt to help them out.

Example:

HtmlElement page = getHtmlElement("HtmlPage");
page.setErrorMessage("This page contains an error");

setFieldValue(String,Map)

Sets one or more field values on an element.

Void setFieldValue(String name, Map values)

Returns: CRMScript.Global.Void Example:

HtmlElement formPage;
Map m;
m.insert("name", "superButton");
m.insert("label", "Click me!");
m.insert("style", "StyleGreen");
formPage.setFieldValue("addButton", m);

setFromCgi()

Called when the element should find its values from the CGI variables.

Void setFromCgi()

Returns: CRMScript.Global.Void

Commonly used for screens containing forms.

setInfoMessage(String)

Sets an info message above the element if the form is posted.

Void setInfoMessage(String infoMessage)

Returns: CRMScript.Global.Void

Used to display the text of a purely informative nature.

setNotEditable(Bool)

Toggles whether the element can be edited (for those elements that support this property).

Void setNotEditable(Bool canEdit)

Returns: CRMScript.Global.Void

Commonly used in combination with role-based access.Available from 3.1.8.36

setValue(String)

Sets the value of a specific element.

Void setValue(String value)

Returns: CRMScript.Global.Void Example:

HtmlElement selectDate;
selectDate.setValue("2020.09.10");

toBool()

Returns the value of the element as a Bool.

Bool toBool()

Returns: CRMScript.Global.Bool - The boolean representation of the element.

toInteger()

Returns the element value as an integer.

Integer toInteger()

Returns: CRMScript.Global.Integer - The numeric representation of the element.

toString()

Returns the value of the element as a String.

String toString()

Returns: CRMScript.Global.String - The string representation of the element.

​Constructors

​HtmlElement()

​Methods

​clearValue()

​getFieldValue(String)

​getNextTabIndex()

​getTabIndexString()

​getTabIndexString(Bool)

​getTypeName()

​isEmpty()

​setDisabled(Bool)

​setErrorMessage(String)

​setFieldValue(String,Map)

​setFromCgi()

​setInfoMessage(String)

​setNotEditable(Bool)

​setValue(String)

​toBool()

​toInteger()

​toString()

Constructors

HtmlElement()

Methods

clearValue()

getFieldValue(String)

getNextTabIndex()

getTabIndexString()

getTabIndexString(Bool)

getTypeName()

isEmpty()

setDisabled(Bool)

setErrorMessage(String)

setFieldValue(String,Map)

setFromCgi()

setInfoMessage(String)

setNotEditable(Bool)

setValue(String)

toBool()

toInteger()

toString()