Skip to content

Commit f67262c

Browse files
committed
Update Label common props
1 parent f88bb1e commit f67262c

File tree

6 files changed

+66
-57
lines changed

6 files changed

+66
-57
lines changed

content/en/docs/marketplace/platform-supported-content/modules/data-widgets/data-grid-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Here is an example of custom content using new Badge widget in **Structure mode*
150150

151151
{{< figure src="/attachments/appstore/platform-supported-content/modules/data-widgets/data-grid-2/column-custom-content.png" alt="Example of custom content using new Badge widget in Structure mode" class="no-border" >}}
152152

153-
For more information on configuring various widget properties, see [Common Widget Properties](/refguide/common-widget-properties/).
153+
For more information on configuring various widget properties, see [Properties Common in the Page Editor](/refguide/common-widget-properties/).
154154

155155
### Column Width
156156

content/en/docs/refguide/modeling/pages/common-widget-properties.md

Lines changed: 61 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,54 @@ The attribute can be of one of the following [data types](/refguide/data-types/)
149149
* Long
150150
* String
151151

152+
## Label Section {#label}
153+
154+
{{< figure src="/attachments/refguide/modeling/pages/common-widget-properties/label-section.png" alt="Label Section" class="no-border" >}}
155+
156+
A label can be used to described the purpose of the widget to the user. The label is shown next to the widget in the user interface. If a label is configured, the widget will be rendered in the browser wrapped in a form group. See [Bootstrap documentation](https://getbootstrap.com/css/#forms).
157+
158+
{{% alert color="info" %}}
159+
The position of the label in relation to the widget is configured in the **Form orientation** and **Label width (weight)** properties of the data container.
160+
{{% /alert %}}
161+
162+
### Show Label
163+
164+
This property determines whether the label is rendered and the widget is wrapped in a form group.
165+
166+
### Label Caption
167+
168+
This property is shown only when Show label is Yes. It specifies what text is rendered within a label.
169+
170+
#### Text Template
171+
172+
The template for the label can contain parameters that are written as a number between braces (for example, `{1}`). The first parameter has the number `1`, the second `2`, etc. Note that to use template parameters, the widget must be placed in the context of an entity (for example, inside a data container).
173+
174+
#### Parameters
175+
176+
For each parameter in the template, you define a source for the value. The value of the parameter will be inserted at the position of the parameter placeholder.
177+
178+
##### Value Parameter Type
179+
180+
When selected, the chosen value is used as the value of the parameter. The source of the value can be an attribute of an enclosing data container. Number and date value types offer formatting options.
181+
182+
##### Expression Parameter Type
183+
184+
When selected, the result of the given [expression](/refguide/expressions/) is used as the value of the parameter. The expression may use the variables listed in the expression editor, including:
185+
186+
* `$currentObject`, representing the object of the closest enclosing data container.
187+
* The objects of any enclosing data container, available under the name of the widget that exposes them (for example `$dataView1`).
188+
* [Parameters](/refguide/page-properties/#parameters) and [variables](/refguide/page-properties/#variables) defined on the page or snippet.
189+
190+
The expression provided is evaluated in the browser and, currently, does not support all the functions that are available in microflows. The autocomplete function will only list those functions which are supported.
191+
192+
### Label Position
193+
194+
This property can be configured in the following ways:
195+
196+
* **Default** — The position of the label is determined by the read-only style configuration. In the control case, the label is positioned after the control; in the text case, it is positioned before the control.
197+
* **Before control** — The label is placed before the check box.
198+
* **After control** — The label is placed after the check box.
199+
152200
## Editability Section{#editability}
153201

154202
{{< figure src="/attachments/refguide/modeling/pages/common-widget-properties/editability-section.png" alt="Common Section" class="no-border" >}}
@@ -202,49 +250,10 @@ This property determines how the widget is rendered if it is read-only.
202250
| Inherited from snippet call | Set to `Control` or `Text` by the containing data container of the snippet call, or `Text` when the snippet call is not enclosed by a data container. *(Default value for widgets outside a data container inside a snippet)* |
203251
| Control | Widget is displayed but disabled so the value cannot be modified. |
204252
| Text | Widget is replaced by a textual representation of the value. |
205-
206-
{{% alert color="info" %}}Read-only style is not supported on native mobile pages.{{% /alert %}}
207-
208-
## Label Section {#label}
209-
210-
{{< figure src="/attachments/refguide/modeling/pages/common-widget-properties/label-section.png" alt="Label Section" class="no-border" >}}
211-
212-
A label can be used to described the purpose of the widget to the user. The label is shown next to the widget in the user interface. If a label is configured, the widget will be rendered in the browser wrapped in a form group. See [Bootstrap documentation](https://getbootstrap.com/css/#forms).
213-
214253
{{% alert color="info" %}}
215-
The position of the label in relation to the widget is configured in the **Form orientation** and **Label width (weight)** properties of the data container.
254+
Read-only style is not supported on native mobile pages.
216255
{{% /alert %}}
217256

218-
### Show Label
219-
220-
This property determines whether the label is rendered and the widget is wrapped in a form group.
221-
222-
### Label Caption
223-
224-
This property is shown only when Show label is Yes. It specifies what text is rendered within a label.
225-
226-
#### Text Template
227-
228-
The template for the label can contain parameters that are written as a number between braces (for example, `{1}`). The first parameter has the number `1`, the second `2`, etc. Note that to use template parameters, the widget must be placed in the context of an entity (for example, inside a data container).
229-
230-
#### Parameters
231-
232-
For each parameter in the template, you define a source for the value. The value of the parameter will be inserted at the position of the parameter placeholder.
233-
234-
##### Value Parameter Type
235-
236-
When selected, the chosen value is used as the value of the parameter. The source of the value can be an attribute of an enclosing data container. Number and date value types offer formatting options.
237-
238-
##### Expression Parameter Type
239-
240-
When selected, the result of the given [expression](/refguide/expressions/) is used as the value of the parameter. The expression may use the variables listed in the expression editor, including:
241-
242-
* `$currentObject`, representing the object of the closest enclosing data container.
243-
* The objects of any enclosing data container, available under the name of the widget that exposes them (for example `$dataView1`).
244-
* [Parameters](/refguide/page-properties/#parameters) and [variables](/refguide/page-properties/#variables) defined on the page or snippet.
245-
246-
The expression provided is evaluated in the browser and, currently, does not support all the functions that are available in microflows. The autocomplete function will only list those functions which are supported.
247-
248257
## Formatting Section{#numeric-formatting}
249258

250259
{{< figure src="/attachments/refguide/modeling/pages/common-widget-properties/numeric-formatting-section.png" alt="Numeric Formatting Section" class="no-border" >}}
@@ -328,36 +337,36 @@ There are two settings in the validation section which are described below:
328337

329338
This property indicates whether this widget value should be validated and, if so, how. These are the possible options:
330339

331-
* No validation – the data has to be the correct [data type](/refguide/data-types/) for the widget, but otherwise there is no further validation
332-
* A [predefined validation](#predefined-validation)see description below
333-
* A [custom validation](#custom-validation)see description below
340+
* No validation – The data has to be the correct [data type](/refguide/data-types/) for the widget, but otherwise there is no further validation.
341+
* A [predefined validation](#predefined-validation)See description below.
342+
* A [custom validation](#custom-validation)See description below.
334343

335344
#### Predefined Validation{#predefined-validation}
336345

337346
The possible values of a predefined validation are the following:
338347

339-
* **Required**can be used for values of *all* data types
340-
* **E-mail**applies to *String* values
341-
* **Positive number**applies to *Decimal*, *Integer*, and *Long* values
342-
* **Date in the future**applies to *Date and time* values — compares the date *and time* to `[%CurrentDateTime%]`
343-
* **Date in the past**applies to *Date and time* values — compares the date *and time* to `[%CurrentDateTime%]`
348+
* **Required**Can be used for values of *all* data types.
349+
* **E-mail**Applies to *String* values.
350+
* **Positive number**Applies to *Decimal*, *Integer*, and *Long* values.
351+
* **Date in the future**Applies to *Date and time* values — compares the date *and time* to `[%CurrentDateTime%]`.
352+
* **Date in the past**Applies to *Date and time* values — compares the date *and time* to `[%CurrentDateTime%]`.
344353

345354
#### Custom Validation{#custom-validation}
346355

347356
Custom validation is an expression that follows the [Microflow expression](/refguide/expressions/) syntax.
348357

349358
There are a number of variables you can use in your expression:
350359

351-
* `$currentObject`the current object
352-
* `$value`variable or the current member (attribute or association) value
360+
* `$currentObject`The current object.
361+
* `$value`Variable or the current member (attribute or association) value.
353362

354363
{{% alert color="info" %}}
355364
The expression can access objects of **all** the data containers enclosing the input widget and variables defined on the page or snippet. The objects are given the name of the widget they originate from (for example, `$dataView1`).
356365
{{% /alert %}}
357366

358-
When a validation is set and it fails for this widget, the message you specify will be shown before the user can use the value in the app.
367+
When a validation is set and it fails for this widget, the message you specify will be shown before the user can use the value in the app:
359368

360-
Default: *(none)*
369+
* Default validation message: *(none)*
361370

362371
### Message
363372

content/en/docs/refguide/modeling/security/module-security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For each combination you can indicate whether or not the page is visible for the
3737

3838
A page that is not visible for a specific role will not show up in navigation structures, and **Open Page** buttons leading to that page will not be rendered by default.
3939

40-
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Common Widget Properties](/refguide/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
40+
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Properties Common in the Page Editor](/refguide/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
4141

4242
## Microflow Access
4343

content/en/docs/refguide10/modeling/security/module-security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For each combination you can indicate whether or not the page is visible for the
3737

3838
A page that is not visible for a specific role will not show up in navigation structures, and **Open Page** buttons leading to that page will not be rendered by default.
3939

40-
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Common Widget Properties](/refguide10/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
40+
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Properties Common in the Page Editor](/refguide10/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
4141

4242
## Microflow Access
4343

content/en/docs/refguide8/modeling/menus/view-menu/project-explorer/security/module-security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For each combination you can indicate whether or not the page is visible for the
3737

3838
A page that is not visible for a specific role will not show up in navigation structures, and **Open Page** buttons leading to that page will not be rendered by default.
3939

40-
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Common Widget Properties](/refguide8/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
40+
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Properties Common in the Page Editor](/refguide8/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
4141

4242
## Microflow Access
4343

content/en/docs/refguide9/modeling/app-explorer/security/module-security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For each combination you can indicate whether or not the page is visible for the
3737

3838
A page that is not visible for a specific role will not show up in navigation structures, and **Open Page** buttons leading to that page will not be rendered by default.
3939

40-
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Common Widget Properties](/refguide9/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
40+
Page access settings do not restrict users from navigating to a page through other means, for example through a deeplink or through a button that is forced to be visible (for more information, see [Properties Common in the Page Editor](/refguide9/common-widget-properties/)). If you want to ensure that specific roles cannot access parts of your data or logic, than this must be expressed through **entity access** and **microflow access** constraints.
4141

4242
## Microflow Access
4343

0 commit comments

Comments
 (0)