Handling an Organization Chart control by programming (prefixed syntax)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Overview
Handling the Organization Chart control by programming
Adding a root element
Adding child elements
Deleting an element
Handling an element found in the Organization Chart control
Changing the orientation of an element
Properties specific to Organization Chart controls

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Handling an Organization Chart control by programming (prefixed syntax)

Overview

An Organization Chart control can be:

handled by programming.
linked to a data file.

To handle an Organization Chart control by programming, WINDEV proposes the Organization Chart functions.

This help page explains how to handle an Organizational Chart control by programming.

Handling the Organization Chart control by programming

Adding a root element

A root element of an organization chart is the element from which the entire tree structure is built. Adding a "root" element into an Organization Chart control is performed by <Organization Chart>.Add.

This function accepts two syntaxes:

syntax used to specify the element characteristics: title, image, ...
Example:

// Adds a root element
ORG_HR.Add("Emma Brown")

Remark: <Organization Chart>.Add is used to insert an image into the element (on the left of the text).
syntax that handles an OrgElement variable.

// Add elements into the Organization Chart control
// Root element
ElementCEO is OrgElement
ElementCEO..Title = "Big Boss"
ORG_EXECUTIVE.Add(ElementCEO)

Remark: The OrgElement type is used to configure several specific options:
- tooltip,
- background color of element,
- background image of element,
- font for title and content,
- orientation of element.

Adding child elements

Adding child elements into an Organization Chart control is performed by <Organization Chart>.AddChild. This function accepts two syntaxes:

syntax used to specify the element characteristics: title, content, ...

ORG_NoName1.Add("Emma")
ORG_NoName1.AddChild(1, "Paul Martin")
ORG_NoName1.AddChild(1, "Florence Mitchell")
ORG_NoName1.AddChild(3, "Gary Prince")
ORG_NoName1.AddChild(3, "Joey Moore")
syntax that handles an OrgElement variable.

// Add elements into the Organization Chart control
// Root element
ElementCEO is OrgElement
ElementCEO.Title = "Big Boss"
ORG_EXECUTIVE.Add(ElementCEO)

// Child elements
Element2 is OrgElement
Element2.Title = "Production"
ORG_EXECUTIVE.AddChild(1, Element2)

Element3 is OrgElement
Element3.Title = "Sales"
ORG_EXECUTIVE.AddChild(1, Element3)

The Property ColorFond of the Variable OrgElement allows to define a display Color for an element. If no background color is defined, the Organization Chart control will automatically use the default color.

Deleting an element

<Organization Chart>.Delete is used to delete an element (as well as its children) from an Organization Chart control.

// Deletes the element 15 and its children
ORG_MyOrganizationChart.Delete(15)

<Organization Chart>.DeleteAll is used to delete all elements found in an Organization Chart control.

Handling an element found in the Organization Chart control

The elements of an Organization Chart control are handled via their subscripts. Each element of the Organization Chart control is associated with an identifier (subscript). This subscript is returned:

This subscript is used by all functions for handling elements (selection, deletion, ...).

To handle or modify a specific element in the Organization Chart control, simply:

define an OrgElement variable.
assign the desired element of the Organizational Chart control to it.

Then, the element can be handled by the OrgElement properties.

For example:

MyElement is OrgElement
MyElement = ORG_MyOrganizationChart[2]

Trace(MyElement.Title)

Changing the orientation of an element

It is possible to change the orientation of an element of the Organization Chart control using the Property Orientation90 of the type OrgElement. Therefore, a child element can be displayed on the right of its parent.

For example:

The following code is used to change the orientation of the element that was clicked:

// Select an element of ORG_NoName1
MyElement is OrgElement
MyElement = ORGA_SansName1 [ORGA_SansName1]
MyOrientation90 = NOT MyOrientation90
ORGA_SansName1 [ORGA_SansName1] <-

Properties specific to Organization Chart controls

The following properties are used to manage an Organization Chart control by programming.


Count	The Property Occurrence makes it possible to know the number of elements present in a set.
ElementHeight	..ElementHeight is used to: Find out or modify the height of the elements in an Organization Chart control. Find out or modify the height of the cells in a Dashboard control.
ElementOrientation	The Property OrientationElement makes it possible to know and modify the orientation of an Organization Chart control.
ElementWidth	..ElementWidth is used to: Find out or modify the width of the elements in an Organization Chart control. Find out or modify the width of the cells in a Dashboard control.
MaxLeafPerRow	The Property MaxLineSheet allows to know and modify the maximum number of elements in row in an Organization Chart control.
Vertical	Vertical is used to: find out whether a control is oriented horizontally or vertically. modify the display direction of Table and Looper controls (switch from vertical to horizontal and conversely).
Zoom	The Property Zoom allows you to know or modify the zoom value used: in an Image control. in a Map control. in an Organization Chart control. in a Table, TreeView Table, Pivot Table, Spreadsheet or List Box control. in a Word Processing control. in a PDF Reader control. in a window.

To find out the entire list of WLanguage properties that can be used with an Organization Chart control, see Properties associated with the Organization Chart control.