LinkedIn
Copied!

Display text control in DX API

The Display text control (pxDisplayText) helps users understand the structure of a layout and get a general idea of what the content groupings within the layout include, and describe the content and the purpose of layout elements by including formatted text in cells and headers in a layout. Learn about the JSON structure and elements of a sample Display text control, to understand how you can integrate the element into your custom application.

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

{
  "view": {
    "reference": "",
    "validationMessages": "",
    "viewID": "GetInfo",
    "visible": true,
    "name": "Get info",
    "appliesTo": "OU1F1E-CodeNinjas-Work-NoCase",
    "groups": [
      {
        "field": {
          "validationMessages": "",
          "visible": true,
          "labelReserveSpace": true,
          "readOnly": true,
          "control": {
            "modes": [
              {
                "modeType": "ignore",
                "controlFormat": "Assignment title",
                "tooltip": ""
              },
              {
                "modeType": "readOnly",
                "controlFormat": "Assignment title",
                "tooltip": "",
                "showReadOnlyValidation": "false",
                "formatType": "advancedtext"
              }
            ],
            "actionSets": [],
            "type": "pxDisplayText"
          },
          "label": "Text Label",
          "type": "Text",
          "required": false,
          "validateAs": "",
          "reference": "Name",
          "labelFormat": "Announcement",
          "disabled": false,
          "testID": "20200812123901049697",
          "value": "testConstant",
          "maxLength": 256,
          "expectedLength": "",
          "fieldID": "Name"
        }
      }
    ]
  },
  "caseID": "OU1F1E-CODENINJAS-WORK N-123002",
  "name": "Get info",
  "actionID": "GetInfo"
}

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

Cell properties - General tab
Cell properties - General tab
  • For conditions, such as Visibility or Disable, only the Always and Condition (when rule) options are supported.
  • The JSON response does not contain the data for the Value field.
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.