Skip to content

Commit

Permalink
Rename Common Properties doc and review page properties
Browse files Browse the repository at this point in the history
  • Loading branch information
MariaShaposhnikova committed Dec 16, 2019
1 parent 4ce233c commit 77d8448
Show file tree
Hide file tree
Showing 36 changed files with 95 additions and 82 deletions.
2 changes: 1 addition & 1 deletion content/developerportal/app-store/app-store-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ To delete a theme, remove the ZIP file from your project's **theme** folder.
* [App Store Overview](app-store-overview)
* [How to Share App Store Content](share-app-store-content)
* [App Store Content Support](app-store-content-support)
* [Properties Common for Widgets](/refguide/common-widget-properties)
* [Properties Common in the Page Editor](/refguide/common-widget-properties)
* [How to Install the SMTP Email Module](/howto/integration/install-and-configure-the-smtp-module)
* [My Top 5 Mendix Widgets for Speeding Up Application Development](http://www.mendix.com/blog/top-5-mendix-widgets-speeding-application-development/)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/refguide/button-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ To add items to a drop-down buttons, do the following:

* [Page](page)
* [Button Widgets](button-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
* [On Click Event & Events Section](on-click-event)


2 changes: 1 addition & 1 deletion content/refguide/charts-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ See the following link for more information about plotly.js and the options: htt

#### 2.1.5 Common

These are properties which are common to many widgets. For information see [Properties Common for Widgets](common-widget-properties#common-properties).
These are properties which are common to many widgets. For information see [Properties Common in the Page Editor](common-widget-properties#common-properties).

## 3 Configuration by Chart Type {#configuration-by-chart-type}

Expand Down
4 changes: 2 additions & 2 deletions content/refguide/common-widget-properties.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Properties Common for Widgets"
title: "Properties Common in the Page Editor"
parent: "pages"
menu_order: 120
tags: ["studio pro", "widget properties", "properties", "common", "widget"]
Expand All @@ -8,7 +8,7 @@ tags: ["studio pro", "widget properties", "properties", "common", "widget"]

## 1 Introduction

These are properties that are shared by many widgets. For a complete list of properties, take a look at the relevant widget.
These are properties that are shared by many elements in the page editor, such as a page or widgets. For a complete list of properties, take a look at the relevant element.

## 2 Common Section {#common-properties}

Expand Down
2 changes: 1 addition & 1 deletion content/refguide/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ The **On-click** property specifies the action that will be executed when the us

* [Page](page)
* [Container Widgets](container-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/data-grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,5 +145,5 @@ To perform actions on a data grid, select it on a page and right-click it. The l
* [Page](page)
* [Data Widgets](data-widgets)
* [Data Sources](data-sources)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
* [Grid Columns](columns)
2 changes: 1 addition & 1 deletion content/refguide/data-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ To perform actions on a data view, select it on a page and right-click it. The l
* [Page](page)
* [Data Widgets](data-widgets)
* [Data Sources](data-sources)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/file-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ Default: *False*

* [Page](page)
* [File Widgets](file-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
* [System Texts](system-texts)
2 changes: 1 addition & 1 deletion content/refguide/grids.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Grids have the following components in common:
* [Data Grid](data-grid)
* [Template Grid](template-grid)
* [Data Widgets](data-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/group-box.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ Possible values of this property are the following:

* [Page](page)
* [Container Widgets](container-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)


2 changes: 1 addition & 1 deletion content/refguide/image-uploader.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ If a file with an extension that is not allowed is selected, a [system text](sys

* [Page](page)
* [File Widgets](file-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/image-viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ Default: *Thumbnail*

* [Page](page)
* [File Widgets](file-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,6 @@ The image widget is converted to the image viewer and you can configure it.

* [Page](page)
* [Common Widgets](common-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)


2 changes: 1 addition & 1 deletion content/refguide/label.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ The **General** section contains the **Caption** property. **Caption** defines t

* [Page](page)
* [Common Widgets](common-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
8 changes: 4 additions & 4 deletions content/refguide/layout-grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ A row has the following properties:
{{% image_container width="300" %}}![Row Properties](attachments/container-widgets/row-properties.png)
{{% /image_container %}}

For more information on properties listed above, see [Properties Common for Widgets](common-widget-properties).
For more information on properties listed above, see [Properties Common in the Page Editor](common-widget-properties).

### 2.2 Columns {#columns}

A row in a layout grid can contain one or more columns.

A column has the following properties:

* **Class** – allows you to specify one or more cascading style sheet (CSS) classes (for more information on this property, see [Properties Common for Widgets](common-widget-properties))
* **Style** – allows you to specify additional CSS styling (for more information on this property, see [Properties Common for Widgets](common-widget-properties))
* **Class** – allows you to specify one or more cascading style sheet (CSS) classes (for more information on this property, see [Properties Common in the Page Editor](common-widget-properties))
* **Style** – allows you to specify additional CSS styling (for more information on this property, see [Properties Common in the Page Editor](common-widget-properties))
* **Weight** – determines how wide the column is, weight of all columns in a row must add up to 12. Examples of rows with valid column width are the following ones:
* One column with weight 12
* Two columns with weight 6 each
Expand Down Expand Up @@ -141,4 +141,4 @@ As the layout grid responds to the viewport width, and not to the width of its c

* [Page](page)
* [Container Widgets](container-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/list-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ To perform actions on a list view, select it on a page and right-click it. The l
* [Page](page)
* [Data Widgets](data-widgets)
* [Data Sources](data-sources)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/menu-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ Only available when the [menu source](#menu-source) is set to **Menu document**.

* [Page](page)
* [Menu Widgets](menu-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/navigation-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ Microflows set as an on click event for a navigation list item have no **Executi

* [Page](page)
* [Container Widgets](container-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/navigation-tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ Only available when the [menu source](#menu-source) is set to **Menu document**.

* [Page](page)
* [Menu Widgets](menu-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
95 changes: 54 additions & 41 deletions content/refguide/page-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,51 +9,62 @@ tags: ["studio pro", "page", "properties"]

This document describes page properties. For details on what pages are for and what kind of widgets can be placed on them, see [Pages](pages).

## 2 Common Section
## 2 Properties

### 2.1 Name
An example of page properties is represented in the image below:

The internal name of the widget. You can use this to give sensible names to widgets. The name property also appears in the generated HTML: the widget DOM element automatically includes the class `mx-name-{NAME}`, which can be useful for [Selenium testing](/howto7/integration/selenium-support).
{{% image_container width="250" %}}![Page Properties](attachments/page/page-properties.png)
{{% /image_container %}}

### 2.2 Documentation
Page properties consist of the following sections:

This property can be used to store developer documentation. End-users will never see this documentation.
* [Common](#common)
* [Designer](#designer)
* [General](#general)
* [Navigation](#navigation)
* [Pop-up](#pop-up)
* [Usage](#usage)

### 2.3 Class
### 2.1 Common Section {#common}

The class property allows you to specify one or more cascading style sheet (CSS) classes for the widget. The classes should be separated by a space. The classes will be applied to the widget in the browser and the widget will get the corresponding styling. The classes should be classes in the theme that is used in the project. It overrules the default styling of the widget.
{{% snippet file="refguide/common-section-link.md" %}}

Styling is applied in the following order:
### 2.2 Designer Section {#designer}

1. The default styling defined by the theme the project uses.
2. The `Class` property.
3. The `Style` property.
{{% snippet file="refguide/designer-properties.md" %}}

You can see which widgets in a page have styling applied via the class or style property by clicking the <strong>Show styles</strong> button in **Structure mode**.
### 2.3 General Section {#general}

![](attachments/common-widget-properties/show-styles.png)
#### 2.3.1 Platform

### 2.4 Style
The values for the **Platform** property are:

The style property allows you to specify additional CSS styling. If a class is also specified, this styling is applied *after* the class.
* Web *(default)* – pages which are going to be displayed in a browser or hybrid mobile app
* Native – pages which are going to be displayed in a native mobile app

You can see which widgets in a page have styling applied via the style or class property by clicking the <strong>Show styles</strong> button in **Structure mode**.
#### 2.3.2 Layout Type {#layout-type}

## 3 Designer Section
The **Layout type**, determines the purpose of the page and how it is opened.

{{% snippet file="refguide/designer-properties.md" %}}
| Layout Type | Description |
| ------------------- | ------------------------------------------------------------ |
| **Responsive** | Pages that will work fine on all types of devices. |
| **Tablet specific** | Pages to be displayed on a tablet because the responsive option does not provide a good user interface on a tablet. |
| **Phone specific** | Pages to be displayed on a phone because the responsive option does not provide a good user interface on a phone. |
| **Modal pop-up** | Pages that appear as [modal pop-up windows](https://www.wikiwand.com/en/Modal_window). |
| **Pop-up** | Pages that appear as *modeless* pop-up windows. |

## 4 General Section
#### 2.3.3 Layout

### 4.1 Title {#title}
The [layout](layout) on which this page is based.

The title of the page that is shown using the [page title widget](page-title). If the page is shown in a pop-up window, the title appears in the title bar of the pop-up. The title can be overridden from places where forms are opened to make it possible to reuse a page for different purposes. For example, the [*Create* button](control-bar) and the [*Edit* button](control-bar) of a data grid can refer to the same page, but they override the titles to **New** and **Edit**, respectively.
#### 2.3.4 Title {#title}

### 4.2 Layout
The title of the page that is shown using the [page title widget](page-title). If the page is shown in a pop-up window, the title appears in the title bar of the pop-up.

This is the [layout](layout) on which this page is based.
The title can be overridden. For example, the [Create button](control-bar) and the [Edit button](control-bar) of a data grid can refer to the same page, but they override the titles to **New** and **Edit**, respectively.

### 4.3 URL
#### 2.3.6 URL

The URL of the page can be used to directly navigate to the page (for example, from external links or bookmarks). It will be shown in the address bar of the browser when you visit the page. When navigating to a page without a URL configured, the last visited URL is shown. Note that the full URL of the page will be the base URL of your application followed by `/p` and then by the configured URL of the page (for example, `http://example.mendixcloud.com/p/home_page`).

Expand All @@ -63,50 +74,52 @@ In simple e-commerce applications, the URLs can be configured as follows:

* */orders/* – the URL for a page with a data grid for `Orders` (in a browser, the URL will look like `http://example.mendixcloud.com/p/orders/`)

* */order/{Id}* – the URL for a page with data from a particular `Order` (actual URLs in a browser will look like `http://example.mendixcloud.com/p/order/3212449487634321`, wherein `3212449487634321` is the unique identifier of the `Order`)
* */order/{Id}* – the URL for a page with data from a particular `Order` (in a browser, the URL will look like `http://example.mendixcloud.com/p/order/3212449487634321`, wherein `3212449487634321` is the unique identifier of the `Order`)

## 5 Navigation Section
### 2.4 Navigation Section {#navogation}

### 5.1 Visible For
#### 2.4.1 Visible For

These are the module roles for which the page is visible. This has an effect on [menu widgets](menu-widgets) and on buttons that are visible only if allowed (for example, an [action button](button-widgets) for editing).
This property defines for what module roles the page is visible. This has an effect on [menu widgets](menu-widgets) and on buttons that are visible only if allowed (for example, an [action button](button-widgets) for editing).

For more information, see [Module Security](module-security).

## 6 Pop-Up Section
### 2.5 Pop-Up Section {#pop-up}

The pop-up properties are only relevant for pop-up pages (as opposed to content pages).
The **Pop-up** section is only displayed for pop-up pages. For more information on what pop-up pages are, see the [Layout Type](#layout-type) section.

### 6.1 Width (Pixels)
#### 2.5.1 Width (in Pixels)

This specifies the pop-up width in pixels. When set to 0, the width is determined automatically.
This property specifies the pop-up page width in pixels. When set to 0, the width is determined automatically.

Default: *0*

### 6.2 Height (Pixels)
#### 2.5.2 Height (in Pixels)

Specifies the pop-up height in pixels. When set to 0, the height is determined automatically.
This property specifies the pop-up page height in pixels. When set to 0, the height is determined automatically.

Default: *0*

### 6.3 Resizable
#### 2.5.3 Resizable

Specifies whether the pop-up is resizable (Yes) or fixed-size (No).
This property specifies whether the end-user can resize the pop-up or not.

Default: *Yes*

### 6.4 Close Action
#### 2.5.4 Close Action

Configures the behavior of a button that closes the pop-up page. The default behavior of the pop-up close button is to rollback any changes and close the pop-up window.

Configures the behavior of the popup close button (the little cross in the top-right corner). The default behavior of the popup close button is to rollback any changes and close the popup. If you want to customize the behavior of the popup close button, you can point to a button on the page. When the popup close button is clicked, it will then act as if the selected button is clicked. If the selected button is not available the popup close button will revert back to the default behavior.
If you want to customize the behavior of the pop-up close button, you can point to a button on the page. When the pop-up close button is clicked, it will then act as if the selected button is clicked. If the selected button is not available the pop-up close button will revert back to the default behavior.

Default: *Default (cancel)*

## 7 Usage Section
### 2.6 Usage Section {#usage}

### 7.1 Mark as Used
#### 2.6.1 Mark as Used

You can search for unused items in Studio Pro by pressing <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>F</kbd>. Pages that are only used from Java code will be listed as unused, because Studio Pro cannot look inside Java source code.

By setting the propery **Mark as used** to **Yes**, you specify that the document is used implicitly and Studio Pro will no longer list it when searching for unused items.
By setting the property **Mark as used** to *Yes*, you specify that the document is used implicitly and Studio Pro will no longer list it when searching for unused items.

*Default value*: No
2 changes: 1 addition & 1 deletion content/refguide/page-title.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ Page title properties consist of the following sections:

* [Page](page)
* [Common Widgets](common-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/scroll-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,4 @@ One (left or right) scroll container region within a layout can be set to toggle

* [Page](page)
* [Container Widgets](container-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/simple-menu-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ This property determines how the simple menu bar is laid out.

* [Page](page)
* [Menu Widgets](menu-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/snippet-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ To perform actions on a snippet call, select it on a page and right-click it. Th

* [Page](page)
* [Common Widgets](common-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)
2 changes: 1 addition & 1 deletion content/refguide/tab-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Default: *True*

* [Page](page)
* [Container Widgets](container-widgets)
* [Properties Common for Widgets](common-widget-properties)
* [Properties Common in the Page Editor](common-widget-properties)



Loading

0 comments on commit 77d8448

Please sign in to comment.