Apex Designer Documentation
What's New
Getting Started
Business Objects
User Interfaces
App Behaviors
Project Settings
Patterns and Best Practices
App Showcase
Frequently Asked Questions

User Interface Properties

Managing the client-side information that drives your user experience.

Blank Profile Image
Written by David Knapp
Updated 2 years ago
2 min read

User interfaces present information to the and gather input from the user. An Apex Designer user interface (pages and components) manage this information as properties. The properties section is on the top left of the User Interface page:

User Interface page

Adding a Properties

You can add a property by entering the name:

Add property to a user interface

The picture above shows the default of string. You can click the type or press enter to create the property. If you want something besides a string, you can enter a space followed by part of the type name:

Enter property type

If you want an array of values, you can select the desired type with "[]" after it:

Make property an array

Setting Defaults

You can click on the property to open the Property Dialog and enter the default:

Property Dialog

You can also check/uncheck the "Array" checkbox to change it to/from a list.

Displaying a Property

You can display a property by binding it to the attribute of a user interface element with "is evaluated from":

Display a property by evaluating it

You can also combine text and properties in the attribute value using double curly braces with "is" binding:

Display a property value by using double curly braces

The example above will display "Just wanted to say Hello!" because the default on message is "Hello!".

Managing Properties

You can reorder properties using drag and drop. To delete a property, click on it to open the property dialog and click the Delete icon button.

Component Inputs and Outputs

If you are working on a user interface that is a component, a property can be an input, an output, both or neither. To make a property an input, open the property dialog and check the input checkbox:

Set input in the Property dialog

The radio buttons are shown for inputs:

  • Required - when the component is used, the attribute will automatically be added and cannot be removed
  • Suggested - when the component is used, the attribute will automatically be added but the user can remove it
  • Optional - when the component is used, the attribute is not added but the user can add it using the typeahead

Icons on the property indicate whether it is an input, and input/output, or just an output:

Property icons

Page Path Properties

If you are working on a user interface that is a page, you can set property values from portions of the url. Consider this example:

User interface path

Notice that the path for the page includes ":teamId" and ":memberId". If the user opens the url "/teams/47/member/74", teamId will be set to 47 and memberId will be set to 74.

Dig Deeper

You now have a basic understanding of user interface properties. You can dig deeper with the following topics:

This page does not have any child pages.

Powered by Apex Designer
Terms of ServicePrivacy Policy
© 2017-2024 Apex Process Consultants