Creating a MessageBox Using Messages

Note: Except for confirmation message boxes, a message box data can be automatically configured from a messageData object. See the documentation for the MessageData class to learn about configuring a data object.

To create a messageBox:

In the Design Structure Window of the desired file, expand the pageLayout node to locate the pageLayout named child node messages.
If the pageLayout node is not visible, expand page | content | dataScope | document | body | form. The messages node is under pageLayout Named Children in pageLayout.
Right-click the messages node and choose Insert inside messages | messageBox.
The new messageBox node is inserted and highlighted in the Structure Window. The Property Inspector displays the properties of the messageBox component.
In the Property Inspector, set the following attributes for the messageBox component:
- automatic - Set to true if you want to automatically configure the message box using a messageData object.
- dataName -Specify the name of the data object from which to gather message data, if using automatic configuration.
- dataNamespace - Specify the namespace of the data object from which to gather message data, if using automatic configuration.
- message - Enter the main message text to display in the box. You still need to set this attribute if using automatic configuration.
- messageType - Enter the type of message box. The options are: error, info, warning, or confirmation. The appropriate message title and icon will be automatically inserted.
- text - To override the default message title, enter the title text.
In the Design Structure Window, right-click the messageBox node and choose Insert inside messageBox | link.
The link node is inserted and highlighted in the Structure Window. The Property Inspector displays the properties of the link component.
In the Property Inspector, set the following attributes for the link component:
- text - Enter the label text for the link.
- longDesc - Enter the descriptive text to display after the link label.
- destination - Enter the URI that the link references.
Repeat steps 4 and 5 to add the desired number of links (or individual messages).

Note: To use data binding, see Data Binding a Component Attribute.

Examples (UIX XML)


...
<pageLayout>
  
  <!-- Message box component without data -->
  
  <contents>
    <messageBox message="This is the main message." messageType="warning">
      <contents>
        <link text="label1" longDesc="message1" destination="destination1" />
        <link text="label2" longDesc="message2" destination="destination2" /> 
        <link text="label3" longDesc="message3" destination="destination3" /> 
      </contents>
    </messageBox>
  </contents>
  
  <!-- REST OF PAGE LAYOUT -->
  
</pageLayout>
...

This is a databound "warning" message box with a message and a few linked children:


...
<messageBox message="This is the Message"
            messageType="warning">
  <contents childData="${MyMessageData.warnings}">
    <link text="${uix.current.label}" 
          longDesc="${uix.current.message}"
          destination="${uix.current.destination}" /> 
  </contents>
</messageBox>
...