Handling an internal component

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Overview

Possible operations

See also

Handling an internal component

Overview

An internal component is a set of elements from a project. This grouping makes it possible to:

Organize a project: the internal components can be used to group the project elements, by feature for example.
Share the elements among several projects: The elements found in an internal component can be shared between several projects via the SCM. For more details, see Sharing an internal component.

The editor allows you to handle an internal component from the "Project explorer" pane. The elements of an internal component are viewed in a hierarchical structure in the project explorer: windows, reports, pages, ...

Possible operations

Displaying the description of an internal component

To display the description of an internal component:

Select the internal component in the "Project explorer" pane.
Select "Description" from the popup menu.

For more details on the different information displayed, see Description window of the internal component.

Adding an element into the internal component

An element can be added into an internal component:

via the description of the internal component ("Elements" tab).
via the "Project explorer" pane. To do so, Drag and Drop an element from the project to the internal component.

The corresponding file is physically moved to the directory of internal component. By default, the element included in the internal component is "Public". In order for this element to become "Private", select "Switch to private" from the popup menu of element.

Deleting an element from the internal component

An element can be deleted from the internal component:

via the description of the internal component ("Elements" tab).
via the "Project explorer" pane: a Drag and Drop operation performed on an element of the internal component to the corresponding project category allows you to "remove" the element from the internal component. The element becomes associated with the project.

Caution: If an element of an internal component is deleted via the Delete key in a project that does not use the SCM, this element will no longer be part of the project. To re-integrate this element of internal component in the project, this element will have to be opened and added to the project manually.

Modifying the public and private elements of an internal component

The modification of public and private elements found in an internal component can be performed:

In the "Project explorer" pane, select the element then select "Switch to private" or "Switch to public" from the popup menu. If the element is switched to private, a red square is displayed on the element in the "Project explorer" pane.
From the description of the internal component ("Elements" tab).

Deleting an internal component

An internal component can be deleted from the project using the Delete key.

Caution: If an internal component is deleted from a project that does not use the SCM, the elements of the internal component will not be part of the project anymore. To re-include the elements of the internal component in the project, the elements of the internal component will have to be opened and added to the project manually.

To reintegrate the internal component into the project, go to the "Project" pane, "Project" group, expand "Import" and select "An Internal component .. From a file".

Listing the internal components of project

To list the internal components of a project:

In the project explorer:
- Select the "Internal components" folder.
- Select "Manage the internal components of the project" from the popup menu.
The window that is displayed lists all the internal components used by the project. From this window, you can:
- Display the description of the selected internal component.
- Update the internal component (during a share via SCM).
- Delete an internal component.
- Import an internal component found in the SCM.
- Import the files of an internal component into the project. This option allows you to copy the files of an internal component into the current project. The files are copied and not shared. This option is useful when a component is deleted by mistake from the project.