Difference between revisions of "TTreeView"

From Lazarus wiki
m (Added to tutorials)
Line 1: Line 1:
==Adding a new item in code==
==Adding a new item in code==

Revision as of 16:16, 10 January 2014

English (en) español (es) suomi (fi) français (fr) magyar (hu) русский (ru)

Adding a new item in code

Use TTreeView.Items.AddChild or AddChildObject.

Creating a TreeView which loads items only when expansing

To add the expansion symbol to a node without subitems use:

MyNode.HasChildren := True;

And then set an event handler for the OnExpanding event. In this even you should return if the expansion can actually be made or not and when yes, you should add subitems to the node. If the expansion cannot be done, the expansion symbol will be automatically removed even if you have previously set HasChildren to true.

A Short example of using TTreeview

Here is a quick & dirty example - I tested on Windows Lazarus 0.9.26:

Create a new application. On Form1 add an empty treeview, a button1 with caption "Add Child" and a button2 with caption "Delete"

For the buttons' OnClick events, assign the following code, compile & run.


procedure TForm1.Button1Click(Sender: TObject);
  i: integer;
  s: string;
  // if there is no nodes, create a root node with a parent of Nil
  if TreeView1.Items.Count = 0 then
      Treeview1.Items.Add (nil,'Root Node');
  // Set up a simple text for each new node - Node1 , Node2 etc
  i := treeview1.Items.Count;
  s := 'Node ' + inttostr(i);
  //Add a new node to the currently selected node
  if TreeView1.Selected <> nil then
    Treeview1.Items.AddChild(Treeview1.Selected ,s);
procedure TForm1.Button2Click(Sender: TObject);
  //A procedure to recursively delete nodes
  Procedure DeleteNode(Node:TTreeNode);
    while Node.HasChildren do DeleteNode(node.GetLastChild);
    TreeView1.Items.Delete(Node) ;
  if TreeView1.Selected = nil then exit;
  //If selected node has child nodes, first ask for confirmation
  If treeview1.Selected.HasChildren then
    if messagedlg('Delete node and all children ?',mtConfirmation,
                 [mbYes,mbNo],0) <> mrYes then exit;

When running, the treeview is empty. If you click "Add Child", a root node is created. After that a child will be added to any selected node by clicking "Add Child"

Delete will delete the currently selected node. If it doesn't have children, it will delete it immediately, but if it has children, it will first ask.

Freeing TreeNode Data

Use the TreeView's OnDeletion event to free your object.

procedure TForm1.TreeView1Deletion(Sender: TObject; Node: TTreeNode);

Using Drag and Drop in a TreeView

If you want to allow a drag and drop function in your treeview, you need to :

  1. Set to DmAutomatic, the property "Drag Mode" of your treeview
  2. Create an event for "OndragOver":
procedure TForm1.TreeView1DragOver(Sender, Source: TObject; X, Y: Integer;  State: TDragState; var Accept: Boolean);
  Accept := true;

hope this helps