You are here:
Welcome Control
The Welcome element defines special welcome message UI control that consists of a welcome message, user name and image.
Required Editions
| Available in: Enterprise, Performance, and Unlimited Editions |
The table lists the Welcome element attributes.
| Attribute | Description | Value or Pattern | Required? |
|---|---|---|---|
| name | Identification of this welcome message. | Any string | yes |
Welcome Bindings
The Bindings element consists of the Resource and Binding elements. The table lists the targets that are supported for the Resource and Binding elements in the Welcome element.
| Attribute | Description | Type | Binding Source | Required |
|---|---|---|---|---|
| Welcome | The welcome message to display | Label | Any label resource available in the project or an arbitrary string. | yes |
| User | The name to display. | Text | Any string. | yes |
| ImagePath | path definition to related image | Text | Any string | no |
The Welcome Resource node consists of resource elements that can be used in the Welcome control element. The table list the attributes of the Welcome Items node
| Attribute | Description | Value or Pattern |
|---|---|---|
| target | Defines the path of the Welcome control. | string [Welcome; User] |
| type | Defines how the resource is shown. | string [Label; Text] |
| binding | Source of the binding. | string |
| bindingMode | Binding mode is used to control the updating process. | string [ONE_WAY] |
| toggleId | Refers to the identifier of a domain. | string |
| defaultLabel | Default Welcome value can be set, depending on the type, that is, defaultText, defaultLabel, and defaultImage. | string |
| labelId | The Welcome ID that is used for mapping the localized resource and the actual element in the UI. | string |
Sample XML Code
<Welcome name="WelcomeCtrl">
<Bindings>
<Resource target="Welcome" type="Label" id="welcomeLableId" defaultLabel="welcomeDefaultLabel" />
<Binding target="User" type="Text" binding="userBinding" bindingMode="ONE_WAY" />
<Binding target="ImagePath" type="Text" binding="ApplicationContext::User.ImagePath" bindingMode="ONE_WAY" />
</Bindings>
</Welcome>Did this article solve your issue?
Let us know so we can improve!
