PC SOFT

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Overview
  • Creating a control template
  • Creating a control template from the window editor
  • Creating a control template from the page editor
  • Creating a control template from existing controls
  • Special cases
  • Running the test of a control template
  • Using a control template
  • Renaming a control template
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Overview
A control template is a set of controls that can be re-used in several windows or pages.
  • WINDEV and WINDEV Mobile allow you to create control templates that can be used in the windows.
  • WEBDEV allows you to create control templates that can be used in pages.
A control template can be edited or modified; when a template is modified, these modifications can be applied to all the windows or pages that use this template.
The control templates are used to:
  • group a set of controls for a specific purpose.
  • make the controls independent of the window that is hosting them.
Furthermore, the control templates are saved in a ".WDT" file that can be easily transferred from one project to another.
Benefit compared to supercontrols: The modifications made to the control templates can be automatically applied to all the windows (or pages) that use the control template.
Benefits compared to internal windows or pages: The control templates are directly inserted, visible and modifiable in the window or in the page. They can be directly overloaded in the window or page that is using the control template.
Creating a control template
WINDEVWINDEV Mobile

Creating a control template from the window editor

To create a control template from the window editor:
  1. From the window editor, create a new control template ("File .. New .. Window .. Control template"). You can:
    • Create a blank template (based or not on the skin template used by the project),
    • Create a blank template based on a skin template other than the one used by the project,
    • If your project is already using the control templates, create a control template based on another control template of the project. In this case, you will have the ability to perform cascading updates of control templates.
    From the window editor, create a new control template:
    • Click among the quick access buttons.
    • In the wheel that is displayed, hover "Window" and click "Control template". You can:The window for creating a new element is displayed: click "Window" then "Control template". You can:
      • Create a blank template (based or not on the skin template used by the project),
      • Create a blank template based on a skin template other than the one used by the project,
      • If your project is already using the control templates, create a control template based on another control template of the project. In this case, you will have the ability to perform cascading updates of control templates.
  2. The window editor displays a new area inside a green border named "Control template".
  3. Create all the necessary controls. These controls will be included in all the windows or pages that use the control template.
    Note: The control templates can be nested. A control template can use another control template.
  4. If necessary:
    • Enter the processes associated with the controls. These processes will be automatically imported into the window or into the page that is using the control template.
    • Anchor the controls in the template. These anchors will be automatically used in the window or in the page that is using the control template.
    • Resize the control template according to the controls found in the template ("Resize" from the popup menu).
  5. Give a name to your template ("General" tab in the description window).
    Note: If you are using the programming charter, the name of the control template is prefixed by "TPLC_".
  6. Save your control template ( ). The control template is available and it can be used in a "Control template" control. The created file is in ".WDT" format.
Limit: No style overload is supported by the templates.
WEBDEV - Server code

Creating a control template from the page editor

To create a control template from the page editor:
  1. From the page editor, create a new control template ("File .. New .. Page .. Control template"). You can:
    • Create a blank control template,
    • If your project is already using the control templates, create a control template based on another control template of the project. In this case, you will have the ability to perform cascading updates of control templates.
    From the page editor, create a new control template:
    • Click among the quick access buttons.
    • In the wheel that is displayed, hover "Page" and click "Control template". You can:The window for creating a new element is displayed: click "Page" then "Control template". You can:
      • Create a blank control template,
      • If your project is already using the control templates, create a control template based on another control template of the project. In this case, you will have the ability to perform cascading updates of control templates.
  2. Create all the necessary controls. These controls will be included in all the windows or pages that use the control template.
    Note: The control templates can be nested. A control template can use another control template.
  3. If necessary:
    • Enter the processes associated with the controls. These processes will be automatically imported into the window or into the page that is using the control template.
    • Anchor the controls in the template. These anchors will be automatically used in the window or in the page that is using the control template.
    • Resize the control template according to the controls found in the template ("Resize" from the popup menu).
  4. Give a name to your template ("General" tab in the description window).
    Note: If you are using the programming charter, the name of the control template is prefixed by "TPLC_".
  5. Save your control template ( ). The control template is available and it can be used in a "Control template" control. The created file is in ".WDT" format.
Limit: No style overload is supported by the templates.

Creating a control template from existing controls

To create a control template from existing controls:
  1. Select the controls that must be included in the control template.
  2. Select "Control .. Refactoring .. Create a control template from the selection".On the "Modification" pane, in the "Transformations" group, expand "Refactoring and swapping" and select "Create a control template from the selection".
Notes:
  • You can also select "Refactoring .. Create a control template from the selection" from the popup menu of selection.
  • You have the ability to create a template of a control template, which means a a control template based on another control template.

Special cases

  • The popup menus are available in the control templates:
    • If the window includes popup menus, the popup menus of the control template must have different names.
    • The popup menus of the control template are added to the popup menus of the window.
    • If two identical control templates with popup menus are found in a window, the overload of the popup menu of the control template is valid for both control templates.
  • If several control templates found in a window have the same source, updating a control template triggers the update of all the control templates that use the same source in the window.
Running the test of a control template
To run the test of a control template:
  1. Open the control template in the editor.
  2. Click the "Go" button ("Run the window test" or "Run the page test" icon).
Using a control template
To use a control template:
  1. Open the window or the page in which the control template must be included.
  2. Create a Control Template control (select "Insert .. Special .. Control Template control" or click ).Create a Control Template control: on the "Creation" pane, in the "Containers" group, click "Control template".
  3. Select the control template that will be included in the window or in the page.
    Caution: The control template is associated once and for all to the "Control Template" control. To change the association, you must delete the "Control Template" control and re-create it.
  4. Validate and position the control in the window or in the page.
Note: A control template created with WINDEV (for a window) cannot be used in a page and a control template created in WEBDEV (in a page) cannot be used in a window.

Renaming a control template

If a control template is renamed, the link with the elements that use this template is lost.
This link can be restored via the window that lists the templates ("Windows .. List of templates used").This link can be restored via the window that lists the templates: on the "Window" pane, in the "Templates" group, expand "Templates" and select "List of templates used".
Related Examples:
WD Pure Menu Training (WINDEV): WD Pure Menu
[ + ] The "WD Pure Menu" example proposes a menu that can be customized via a control template.
Each option is represented by an image and a button (that can be entirely configured) that scroll from bottom to top (and from top to bottom).
Several parameters can be defined:
- Image of the button in selection/outside selection,
- Font of the caption in selection/outside selection,
- Procedure to run when selecting an option or when clicking an option.
WW_Auto_Zoom Training (WEBDEV): WW_Auto_Zoom
[ + ] This example offers a control template based on an image that displays an image thumbnail and through a click, enlarges the image without disturbing the page's layout.
Limitatiosn:
- The images cannot be loaded from a database
- The control template cannot be included in a looper
WW_RSS_Stream Training (WEBDEV): WW_RSS_Stream
[ + ] This example explains how to read and display a RSS stream in a WEBDEV page via the RSS type and via the WLanguage functions for handling RSS.
A reusable control template is used to display the RSS data.
See also
Minimum version required
  • Version 11
This page is also available for…
Comments
Click [Add] to post a comment