PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Overview
  • Characteristics of an external component
  • What is an external component made of?
  • What is an external component made of?
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Overview
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 the 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 have the ability to use the internal components. The internal components allow you to group your resources according to specific topics.
Characteristics of an external component
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.
  • the mode for using the component (how to use the component, the parameters used to access the component features, ...). A short documentation (to be completed) is automatically generated and associated with the component.
Caution: A component differs from a supercontrol. The supercontrol can only be made of controls while a component is made of windows, pages, reports, ... 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.
WINDEV Remark: WINDEV includes several examples of components. These components are accessible from the "Project" pane of the editor: on the "Project" tab, in the "Project" group, expand "Import" and select "An External component .. Utility component or example". You can open the corresponding projects from the WINDEV home page (Ctrl + <).

What is an external component made 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, its windows, its reports, its files, ...
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:
<ComponentName>.WDKComponent 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 supplied in the client version of the application that uses the external component.
<ComponentName>.WDIComponent description (when developing applications only).
This file is required to include the external component in a project.
This file must not be supplied in the client version of the application that uses the external component.
<ComponentName>.WDZFile 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 when the component is
  • For a WEBDEV component, this file contains the generated WEBDEV pages, images, ...
  • For a Mobile component (iOS or Android), this file contains the Android generation files, etc.
<ComponentName>.WDOOptional file
File in text format containing the list of additional elements supplied with the external component (data files, .INI files, ...). 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 is an external component made of?
An external component contains:
  • the different elements to distribute (windows, reports, ...). 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 component description.
  • a help allowing you to reuse this component. This help is generated from the code comments.
Remark: By default, if an external component uses an analysis, data files, ... the HFSQL functions will handle these elements in an independent HFSQL context. These parameters can be changed in the advanced component options. For more details, see Advanced options of an external component.
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment