comp • gb.web.gui • webtree

WebTree (gb.web.gui)

This control implements a tree view of selectable text items with icons.

Tree view items are indexed by a key. They display a string and an icon for each item.

This control has an internal cursor used for accessing its items. Use the MoveFirst, MoveNext, MoveTo... methods to move the internal cursor, and the Item property to get the item it points at.

This class inherits WebControl.
This class is
Create a new WebTree control.
creatable
.
This class acts like a
Return an item from its key.
read-only
array.

Static methods

Return a WebControl from its identifier.
FromId  
Return a WebControl from its name.
FromName  

Properties

Methods Events
Return if the Item property is valid.
Available  
Return or set the background color of the control.
Background  
Return or set if the control has a border.
Border  
Return or set the specific CSS classes added to the control.
Class  
Return a virtual collection of the columns of the view.
Columns  
Compare  
Returns the number of items in the view.
Count  
Return the current item, i.e. the item is selected in single selection mode.
Current  
Return or set if the control is enabled.
Enabled  
Return or set if the control should expand its size according to its parent arrangement mode.
Expand  
Return or set the specific font of the control.
Font  
Return or set the foreground color of the control.
Foreground  
Return the web form that control belongs to.
Form  
Return or set the explicit height of the control.
H  
Return or set the explicit height of the control.
Height  
Return the server control identifier.
Id  
Return or set if the control must be ignored by its parent container in automatic arrangement mode.
Ignore  
Return the item pointed by the internal cursor, or NULL if the internal cursor is not available.
Item  
Return the key of the Current item.
Key  
Return a list of all items keys
Keys  
Returns or sets the selection mode.
Mode  
Return or set the name of the control, used as an identifier on the client side.
Name  
Return the parent container of the control.
Parent  
Return or set the horizontal scrolling position.
ScrollX  
Return or set the vertical scrolling position.
ScrollY  
Return the keys of the selected items as as string array.
Selection  
Return or set if selection is indicated by check boxes and radio buttons, or by highlighting the items.
ShowCheck  
Return or set if the header is visible.
ShowHeader  
Return a virtual object that allows to define specific style sheet elements of the control.
Style  
Returns or sets the control tag.
Tag  
Return or set the tooltip displayed when the mouse cursor hovers the control.
Tooltip  
Return or set if the control is visible.
Visible  
Return or set the explicit width of the control.
W  
Return or set the explicit width of the control.
Width  
Add an item to the view.
Add  
Add a specific class to the Class property.
AddClass  
Add a new column to the view.
AddColumn  
Clear the view.
Clear  
Delete the control
Delete  
Return if an item exists with the Key key.
Exist  
Hide the control.
Hide  
Return if the control or one of its parent is hidden.
IsHidden  
Lower the control.
Lower  
Move the internal cursor one visible item above.
MoveAbove  
When one of the other Move... methods has failed, you can use this one to move the internal cursor back to its position before the move.
MoveBack  
Move the internal cursor one visible item below.
MoveBelow  
Move the internal cursor to the first child item of the item currently pointed by the internal cursor.
MoveChild  
Move the internal cursor to the first item of the view.
MoveFirst  
Move the internal cursor to the last item of the view.
MoveLast  
Move the internal cursor to the next child item.
MoveNext  
Move the internal cursor to the parent item of the item currently pointed by the internal cursor.
MoveParent  
Move the internal cursor to the previous child item.
MovePrevious  
Move the internal cursor to a specified item.
MoveTo  
Raise the control.
Raise  
Refresh the control.
Refresh  
Remove an item from the view.
Remove  
Remove a specific class from the Class property.
RemoveClass  
Select all items in the view.
SelectAll  
Set the focus on the control.
SetFocus  
Show the control.
Show  
ToHTML  
Unselect all items in the view.
UnSelectAll  
This event is raised when an item is double-clicked.
Activate  
This event is raised when a control embedded in a cell raises its Click event.
Click  
This event is raised when an item is collapsed.
Collapse  
Compare  
This event is raised when the contents of a specific item is needed (usually to draw it).
Data  
This event is raised when an item is expanded.
Expand  
This event is raised when a keyboard key is pressed while the control has the focus.
KeyPress  
This event is raised just after the rendering of the control, so that you can add your own HTML contents.
Render  
This event is raised when the selection changes.
Select