Object PmfTree

Description:

This object represents one form item of the type: Tree.

Properties and methods of this object:

BgColor	The property returns or sets the background color of the tree
TextColor	The property returns or sets the text color of the tree items
TreeRoot	The property returns the PmfTreeItem object, that represents the root item of the tree
TreeRootVisible	Setting the visibility of the root tree item

Related objects:

PmfTreeItem	(*Tree item*) The object represents a tree item

Properties and methods that are common to all objects of the PmfObject type:

AddEvent()	Registers a function into the specified event
BodyFont	Font of the Body area of the Pmf object
BodyHeightIni	Initial height of the Body area
BodyHeightMode	The way of changing the Body area height
BodyWidthIni	Initial width of the Body area
BodyWidthMode	The way of changing the Body area width
Enabled	Enable/disable editing of values
Form	Returns PmForm object
Id	Pmf object identifier
Parent	Returns reference to the parent Pmf object
PrivateData	Private value of the object
RemoveEvent()	Unregisters the function in the specified event
Title	Displayed name of the Pmf object
TitleFont	Font of the Title area of the Pmf object
TitlePos	Position of the Title area of the Pmf object
Type	Pmf object type
Visible	The property returns or sets the visibility/invisibility of Pmf object

Events:

onAction	Is triggered when an important logical action happens over the object
onExpand	Is triggered when expanding or collapsing the tree item
onFocus	Is triggered if the Pmf object gets or loses focus
onItemRequest	Is triggered with request to create subitems for dynamic tree item
onSelChange	Is triggered when tree item selection changes

Note:

- The object can be created by method PmForm.CreateItem("tree", ...).

- This object is functional also in Web panels.

Tree items:

root - root tree item: The root tree item is created automatically when of the PmfTree object is created. This item cannot be removed or its identifier changed.

item - tree item: internal tree item that has both parent item and subitems

leaf - terminal tree item: tree item that has no subitems

branch - tree branch: the set of items consisting of the given item and all its subitems up to the last level

- Individual tree items can be created by the PmfTreeItem.CreateItem method.

- The item can be accessed by by the PmfTreeItem.GetItem method.

- Not all tree items need to be created at the start of the viewing process. They can be filled dynamically when the item is expanded. See the PmfTreeItem.RequestType property.

- Each tree item can be assigned a private value (see the PmfTreeItem.PrivateData property), which can then be used for example in the onSelChange event.