zaro

What is UI Format?

Published in UI Metadata 2 mins read

In specific data object contexts, the UI Format is a crucial element that dictates how a control linked to that data object will look and act. It essentially acts as the blueprint for the visual and interactive aspects of the control displayed to the user.

Purpose of UI Format

Based on the reference provided, the primary purpose of the UI Format column within data objects is to define the appearance and behavior of the created control. This means it controls things like:

  • How the control is displayed (e.g., its size, color, font).
  • How the control responds to user interactions (e.g., if it's editable, visible, enabled).

Structure of UI Format

The value assigned to the UI Format property is structured as a list of key-value attribute pairs. These pairs are separated by semi-colons (;).

  • Each key represents a specific attribute of the control you want to modify (like color, width, editable).
  • The corresponding value sets the desired setting for that attribute (like blue, 150px, true).

Think of it like setting properties for an object using a simple text string.

Here's a simplified example illustrating the structure (the specific keys and values depend on the system):

color: blue; font-weight: bold; width: 200px;

In this example:

  • color is a key, and blue is its value.
  • font-weight is a key, and bold is its value.
  • width is a key, and 200px is its value.

Each pair is separated by a semi-colon. This list of attributes is what tells the system how to render and manage the associated UI control.

Where is UI Format Found?

According to the reference, the UI Format is a specific column associated with data objects. This implies it's a property directly linked to the data itself, influencing how that data is presented visually in the user interface.

In summary, the UI Format, as described, is a string-based definition linked to data objects that uses semi-colon separated key-value pairs to control the look and feel (appearance) and the interactivity (behavior) of associated user interface controls.