GetDimension Method, SftTree Class

Returns the location and size of a cell, row header or item.

Class: SftTree
Namespace: Softelvdm.SftTreeNET
Assembly: Softelvdm.SftTreeNET

Syntax

public Rectangle GetDimension( CellBaseClass Cell );
public Rectangle GetDimension( ItemClass item );

Public Function GetDimension( ByVal Cell As CellBaseClass ) As Rectangle
Public Function GetDimension( ByVal item As ItemClass ) As Rectangle

Parameters

Cell

The cell or row header for which the location and size is requested.

item

The item, header row or footer row for which the location and size is requested.

Return Value

The location and size, relative to the top, left corner of the control.

Comments

Returns the location and size of a cell, row header or item.

The rectangle of an item covers the complete row, including the row header and both panes of a split tree control. The last row in the display area may extend beyond the bottom of the display area.

If the cell, row header or item is not displayed, an empty rectangle is returned.

Examples

C#

                        "To end this demo, please close this window.", ArrowLocationEnum.TopLeft, null, null);

            InfoTip.Add(5, new Point(xcenter / 2, ybottom / 4), "", "From simple tree control...", ArrowLocationEnum.TopLeft, SimpleTree, null);
            InfoTip.Add(5, new Point(xcenter / 2, ybottom / 4), "", "...back to a grid-like hierarchical tree control", ArrowLocationEnum.TopLeft, ComplexTree, null);

            InfoTip.Add(new Point(xcenter, 0 + sftTree1.Headers.Height / 2), "Optional headers with one or multiple rows");
            InfoTip.Add(new Point(xcenter, ybottom - sftTree1.Footers.Height / 2), "Optional footers with one or multiple rows");

            r = sftTree1.GetDimension(sftTree1.ItemCollection[0].Children[0].Children[5].RowHeader);
            InfoTip.Add(new Point(0 + sftTree1.RowHeaders.Width / 2, r.Y), "", "Optional row headers for items, headers and footers", ArrowLocationEnum.LeftTop, null, RowHeadersOff);
            InfoTip.Add(new Point(0 + sftTree1.RowHeaders.Width / 2, r.Y), "", "Without row headers", ArrowLocationEnum.LeftTop, null, RowHeadersOn);

            Point pt = new Point(sftTree1.Splitter.Area.Location.X + sftTree1.Splitter.Area.Width / 2, ybottom / 2);
            InfoTip.Add(pt, "Optional splitter bar", ArrowLocationEnum.TopLeft);
            InfoTip.Add(pt, "", "Without splitter bar", ArrowLocationEnum.TopLeft, SplitterOff, SplitterOn);

View Entire Sample Code

VB.NET

                "To end this demo, please close this window.", ArrowLocationEnum.TopLeft, Nothing, Nothing)

    InfoTip.Add(5, New Point(xcenter / 2, ybottom / 4), "", "From simple tree control...", ArrowLocationEnum.TopLeft, AddressOf SimpleTree, Nothing)
    InfoTip.Add(5, New Point(xcenter / 2, ybottom / 4), "", "...back to a grid-like hierarchical tree control", ArrowLocationEnum.TopLeft, AddressOf ComplexTree, Nothing)

    InfoTip.Add(New Point(xcenter, 0 + sftTree1.Headers.Height / 2), "Optional headers with one or multiple rows")
    InfoTip.Add(New Point(xcenter, ybottom - sftTree1.Footers.Height / 2), "Optional footers with one or multiple rows")

    r = sftTree1.GetDimension(sftTree1.ItemCollection(0).Children(0).Children(5).RowHeader)
    InfoTip.Add(New Point(0 + sftTree1.RowHeaders.Width / 2, r.Y), "", "Optional row headers for items, headers and footers", ArrowLocationEnum.LeftTop, Nothing, AddressOf RowHeadersOff)
    InfoTip.Add(New Point(0 + sftTree1.RowHeaders.Width / 2, r.Y), "", "Without row headers", ArrowLocationEnum.LeftTop, Nothing, AddressOf RowHeadersOn)

    Dim pt As New Point(sftTree1.Splitter.Area.Location.X + sftTree1.Splitter.Area.Width / 2, ybottom / 2)
    InfoTip.Add(pt, "Optional splitter bar", ArrowLocationEnum.TopLeft)
    InfoTip.Add(pt, "", "Without splitter bar", ArrowLocationEnum.TopLeft, AddressOf SplitterOff, AddressOf SplitterOn)

View Entire Sample Code

See Also SftTree Class | Classes | SftTree/NET 3.0