|
|
- Overview
- Characteristics of external components
- What is an external component composed of?
- What elements are included in an external component?
WINDEV, WEBDEV, Android or iOS external component
An external component is a set of WINDEV, WEBDEV or WINDEV Mobile elements: windows, pages, reports, analysis, etc. This set of elements performs a specific operation. For example, a component can correspond to one of the following features: - Sending faxes,
- Sending emails,
- ...
An external component can be redistributed to other WINDEV, WEBDEV or WINDEV Mobile developers (free of charge or not). These developers will be able to easily integrate the feature included in the component into their application (or site). The component will therefore be integrated into and distributed with the application (or site). For multilingual applications, a distributed external component can be translated via WDMSG from the project that uses the component. Remark: To optimize the organization of your projects, you can use internal components. Internal components can be used to group resources based on specific topics. Characteristics of external components When creating the external component, the author specifies: - which elements in the component are visible to the user. Visible elements will be accessible programmatically, or via the "Project explorer" pane.
- how to use the component (use mode, the parameters used to access the component functionalities, etc.). A short documentation (to be completed) is automatically generated and associated with the component.
Caution: A component is not a supercontrol. Supercontrols can only contain controls whereas components can contain windows, pages, reports, etc. In most cases, the component expects parameters, processes them and returns a result to the application that uses it. Furthermore, unlike a supercontrol, a component has a specific setup. What is an external component composed of? An external component can be: - defined and generated from an existing WINDEV, WEBDEV or WINDEV Mobile project. A "Component" project configuration will allow you to select the elements of the existing project to be integrated into the component.
- created from an "External component" project. By default, this project is composed of an "External component" platform which will contain the elements required to create and generate the component.
This external component can then be integrated into other WINDEV, WEBDEV or WINDEV Mobile projects. All the elements of the component are totally independent of the project in which it is integrated. The external component can have its own analysis, windows, reports, data files, etc. When generating the external component, simply specify if the project that uses the component will access these elements. The project will not be able to read or manipulate elements that are not accessible. The external component consists of several files: | | | <Component name>.WDK | Component file. Contains all the elements of the external component.
This file is required to include the external component in a project.
This file must also be provided in the client version of the application that uses the external component. | | <Component name>.WDI | Component description (when developing applications only).
This file is required to include the external component in a project.
This file must not be provided in the client version of the application that uses the external component. | | <Component name>.WDZ | File with the dependencies of the WDK file (only for WEBDEV and WINDEV Mobile components)
File containing the dependencies of the WDK file. This information is extracted in the project in which the component is integrated. - For a WEBDEV component, this file contains the generated WEBDEV pages, images, etc.
- For a Mobile component (iOS or Android), this file contains the Android generation files, etc.
| | <Component name>.WDO | Optional file
Text file containing the list of the additional elements provided with the external component (data files, .INI files, etc.). This file can be created manually or generated automatically from the items specified in the "Other" folder of the "Project explorer" pane. For more details, see WDO file. |
What elements are included in an external component? An external component contains: - the elements to be distributed (windows, reports, etc.). These elements can be accessible (or not) when importing the component into a WINDEV, WEBDEV or WINDEV Mobile project. These elements cannot be modified from the project that uses the component.
- a short description of the component.
- a help text to reuse the component. This help is generated from the code comments.
Remark: By default, if an external component uses an analysis and data files, the HFSQL functions will handle these elements in an independent HFSQL context. These parameters can be changed in the advanced options of the component. For more details, see Advanced options of an external component.
This page is also available for…
|
|
|
|
|
|
|