Label control in DX API

The Label control helps users enter formatted text, such as the results of JSP tags or directives in layout cells and headers. The text in a Label cannot exceed 64 characters. Learn about the JSON structure and elements of a sample Label control, to understand how you can integrate it into your custom application.

The following JSON code is a sample API response for the Label control:

    "caption": {
        "columnImportance": "",
        "captionFor": "",
        "control": {
            "format": "Standard",
            "testID": "123"
        "value": "sample text"

The following examples show a sample configuration of the control with relevant JSON elements:

Cell properties - General tab
Cell properties - General tab
  • The JSON response does not contain the data in the Visibility field.
  • The data for the Value field can either be entered directly or obtained from the field value. However, the JSON response contains only the data that is entered directly.
  • For conditions, such as Visibility, for the Condition (when rule) option, negation with the logical operator (!) is supported. For example, !pzVisibleWhen.
Cell properties - Presentation tab
Cell properties - Presentation tab
Suggest Edit
Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.