Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the BeforeLabelEdit and AfterLabelEdit events.

public class NodeLabelEditEventArgs : EventArgs

Public Class NodeLabelEditEventArgs
    Inherits EventArgs

Constructors

NodeLabelEditEventArgs(node)

Initializes a new instance of the NodeLabelEditEventArgs class for the specified TreeNode.

NodeLabelEditEventArgs(node, label)

Initializes a new instance of the NodeLabelEditEventArgs class for the specified TreeNode and the specified text with which to update the tree node label.

NodeLabelEditEventArgs(args)

Initializes a new instance of the NodeLabelEditEventArgs class for the specified TreeNode.

Properties

Boolean: Returns or sets whether the edit has been canceled.

String: Returns the new text to associate with the tree node.

TreeNode: Returns the tree node containing the text to edit.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the BeforeLabelEdit and AfterLabelEdit events of a TreeView control.

public delegate void NodeLabelEditEventHandler(Object sender, NodeLabelEditEventArgs e)

Public Delegate Sub NodeLabelEditEventHandler(ByVal sender As [Object], ByVal e As NodeLabelEditEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • TreeView

Displays a hierarchical collection of labeled items, each represented by a TreeNode.

public class TreeView : Control

Public Class TreeView
    Inherits Control

Constructors

TreeView()

Initializes a new instance of the TreeView class.

Properties

BorderStyle

BorderStyle: Gets or sets the border style of the tree view control. (Default: Solid)

CheckBoxes

Boolean: Returns or sets whether check boxes are displayed next to the tree nodes in the tree view control. Tree nodes may override this property setting the CheckBox property. (Default: False)

Boolean: Returns or sets whether all the node images are hidden. Tree nodes may override this property setting the HideNodeImage property. (Default: False)

Int32: Returns or sets the image-list index value of the default image that is displayed by the tree nodes. (Default: -1)

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

String: Returns or sets the key of the default image for each node in the TreeView control when it is in an unselected state. (Default: "")

ImageList: Returns or sets the ImageList that contains the Image objects that are used by the tree nodes. (Default: null)

ImagePropertySettings: Creates the property manager for the Image properties on first use.

Int32: Returns or sets the distance in pixels to indent each child tree node level. (Default: -1)

Throws:

• ArgumentOutOfRangeException The assigned value is less than -1; or the assigned value is greater than 500.

Int32: Gets or sets the height of each tree node in the tree view control. When the value is -1, uses the value set in the theme. (Default: -1)

Throws:

• ArgumentOutOfRangeException The assigned value is less than -1; or the assigned value is greater than 500.

Boolean: Returns or sets whether the label text of the tree nodes can be edited. (Default: False)

TreeNodeCollection: Returns the collection of tree nodes that are assigned to the tree view control.

Int32: Returns or sets the image list index value of the image that is displayed when a TreeNode is expanded. (Default: -1)

Throws:

• ArgumentException The index assigned value is less than -1.

String: Returns or sets the key of the default image shown when a TreeNode is expanded. (Default: "")

ImagePropertySettings: Creates the property manager for the Image properties on first use.

String: Returns or sets the delimiter string that the tree node path uses. (Default: "\")

Int32: Returns or sets the number of items to prefetch outside of the visible area when VirtualScroll is set to true. The default is 0 (disabled). (Default: 0)

Boolean: Returns or sets whether the TreeNode under the pointer gets selected on a right click. (Default: False)

When the right click lands outside of a selected area the selection is not changed regardless of the value of RightClickSelection.

TreeNode: The root node.

Boolean: Returns or sets whether the tree view control displays scroll bars when they are needed. (Default: True)

Int32: Returns or sets the image list index value of the image that is displayed when a TreeNode is selected. (Default: -1)

Throws:

• ArgumentException The index assigned value is less than -1.

String: Returns or sets the key of the default image shown when a TreeNode is selected. (Default: "")

ImagePropertySettings: Creates the property manager for the Image properties on first use.

TreeNode: Returns or sets the tree node that is currently selected in the tree view control.

TreeNode[]: Returns or sets the tree nodes that are currently selected in the tree view control. Use this property when the SelectionMode is MultiSimple or MultiExtended.

SelectionMode: Returns or sets the method in which items are selected in the TreeView. (Default: One)

Boolean: Returns or sets a value indicating ToolTips are shown when the mouse pointer hovers over a TreeNode. (Default: False)

Boolean: Returns or sets whether plus-sign (+) and minus-sign (-) buttons are displayed next to tree nodes that contain child tree nodes. (Default: True)

Boolean: Returns or sets whether the expand/collapse icon is displayed for the root nodes (the firs level nodes). (Default: True)

The name of this property is kept as-is for compatibility reasons. When set to true (default) it doesn't show any line next to the root nodes or any other node. It shows or hide the expand/collapse icon next to the root nodes.

Boolean: Returns or sets whether the tree nodes in the tree view are sorted. (Default: False)

ImageList: Returns or sets the image list that is used to indicate the state of the TreeView and its nodes. (Default: null)

ImagePropertySettings: Creates the property manager for the Image properties on first use.

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

TreeNode: Returns or sets the first fully-visible tree node in the tree view control.

IComparer<TreeNode>: Returns or sets the implementation of IComparer to perform a custom sort of the TreeView nodes.

Boolean: Enables or disables virtual scrolling for the TreeView. When virtual scrolling is enabled, only the visible nodes are rendered in the browser allowing the TreeView to host virtually unlimited nodes without any performance loss. (Default: False)

When VirtualScroll is set to true, all the nodes must be of the same height, limiting the more flexible HTML rendering in the nodes available when VirtualScroll is off (default). Setting the property PrefetchItems to a value greater than 0 allows the virtual view to prefetch the specified number of items outside of the visible area to enable smoother scrolling.

Methods

This method has no effect on this control.

Unselects all nodes in the TreeView.

Collapses all the tree nodes.

Disposes the control.

This method has no effect on this control.

Expands all the tree nodes.

Retrieves the number of tree nodes, optionally including those in all subtrees, assigned to the tree view control.

Returns: Int32. The number of tree nodes, optionally including those in all subtrees, assigned to the tree view control.

Returns a value indicating whether the specified TreeNode is selected.

Returns: Boolean. true if the specified TreeNode is currently selected in the TreeView; otherwise, false.

Throws:

• ArgumentNullException The specified node is null.

• ArgumentException The specified node is currently assigned to another TreeView.

Returns a collection of referenced components or collection of components.

Fires the AfterCheck event.

Fires the AfterCollapse event.

Fires the AfterExpand event.

Fires the AfterLabelEdit event.

Fires the AfterSelect event.

Fires the BeforeCheck event.

Fires the BeforeCollapse event.

Fires the BeforeExpand event.

Fires the BeforeLabelEdit event.

Fires the BeforeSelect event.

Creates and register this control and all its children.

Fires the NodeDrag event.

Fires the NodeMouseClick event.

Fires the NodeMouseDoubleClick event.

Fires the NodeMouseHover event.

Fires the NodeMouseLeave event.

Fires the ToolClick event.

Processes the event from the client.

Renders the client component.

Updates the client component using the state information.

Selects or clears the selection for the specified TreeNode in a TreeView.

Throws:

• ArgumentNullException The specified node is null.

• ArgumentException The specified node is currently assigned to another TreeView.

• InvalidOperationException The SelectionMode property is set to None.

Sorts the items in TreeView control.

Events

TreeViewEventHandler Occurs after the tree node check box is checked.

TreeViewEventHandler Occurs after the tree node is collapsed.

TreeViewEventHandler Occurs after the tree node is expanded.

NodeLabelEditEventHandler Occurs after the tree node label text is edited.

TreeViewEventHandler Occurs after the tree node is selected.

TreeViewCancelEventHandler Occurs before the tree node check box is checked.

TreeViewCancelEventHandler Occurs before the tree node is collapsed.

TreeViewCancelEventHandler Occurs before the tree node is expanded.

NodeLabelEditEventHandler Occurs before the tree node label text is edited.

TreeViewCancelEventHandler Occurs before the tree node is selected.

TreeViewNodeDragEventHandler Fired when the user begins dragging a node.

TreeNodeMouseClickEventHandler Fired when the user clicks a TreeNode with the mouse.

TreeNodeMouseClickEventHandler Fired when the user double-clicks a TreeNode with the mouse.

TreeNodeMouseHoverEventHandler Fired when the mouse hovers over a TreeNode.

TreeNodeMouseHoverEventHandler Fired when the mouse leaves the TreeNode.

ToolClickEventHandler Fired when a ComponentTool is clicked.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the ItemDrag event of the TreeView controls.

public class ItemDragEventArgs : EventArgs

Public Class ItemDragEventArgs
    Inherits EventArgs

Constructors

ItemDragEventArgs(button)

Initializes a new instance of the ItemDragEventArgs class with a specified mouse button.

ItemDragEventArgs(button, node)

Initializes a new instance of the ItemDragEventArgs class with a specified mouse button and the TreeNode that is being dragged.

Properties

Button

MouseButtons: Returns a value that indicates which mouse buttons were pressed during the drag operation.

TreeNode: Returns the TreeNode that is being dragged.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the ItemDrag event of a TreeView control.

public delegate void ItemDragEventHandler(Object sender, ItemDragEventArgs e)

Public Delegate Sub ItemDragEventHandler(ByVal sender As [Object], ByVal e As ItemDragEventArgs)

Deprecated: This handler is deprecated. Use TreeViewNodeDragEventHandler.

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the NodeMouseHover event of a TreeView.

public delegate void TreeNodeMouseHoverEventHandler(Object sender, TreeNodeMouseHoverEventArgs e)

Public Delegate Sub TreeNodeMouseHoverEventHandler(ByVal sender As [Object], ByVal e As TreeNodeMouseHoverEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the NodeMouseHover event.

public class TreeNodeMouseHoverEventArgs : EventArgs

Public Class TreeNodeMouseHoverEventArgs
    Inherits EventArgs

Constructors

TreeNodeMouseHoverEventArgs(node)

Initializes a new instance of the TreeNodeMouseHoverEventArgs class.

Properties

Node

TreeNode: Returns the node the mouse pointer is currently resting on.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• MouseEventArgs

  • TreeNodeMouseClickEventArgs

Provides data for the NodeMouseClick and NodeMouseDoubleClick events.

public class TreeNodeMouseClickEventArgs : MouseEventArgs

Public Class TreeNodeMouseClickEventArgs
    Inherits MouseEventArgs

Constructors

TreeNodeMouseClickEventArgs(node, button, clicks, x, y)

Initializes a new instance of the TreeNodeMouseClickEventArgs class.

TreeNodeMouseClickEventArgs(node, button, clicks, x, y, role)

Initializes a new instance of the TreeNodeMouseClickEventArgs class.

Properties

TreeNode: Returns the tree node that has been clicked.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies the action that raised a TreeViewEventArgs event.

public enum TreeViewAction : Enum

Public Enum TreeViewAction As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the NodeMouseClick and NodeMouseDoubleClick events of a TreeView.

public delegate void TreeNodeMouseClickEventHandler(Object sender, TreeNodeMouseClickEventArgs e)

Public Delegate Sub TreeNodeMouseClickEventHandler(ByVal sender As [Object], ByVal e As TreeNodeMouseClickEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents a collection of objects.

public class TreeNodeCollection : IList, ICollection, IEnumerable, IList<TreeNode>, ICollection<TreeNode>, IEnumerable<TreeNode>

Public Class TreeNodeCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of TreeNode), ICollection(Of TreeNode), IEnumerable(Of TreeNode)

Properties

Count

: Returns the total number of objects in the collection.

IsReadOnly

: Returns a value indicating whether the collection is read-only.

Item(index)

: Returns or sets the at the specified index in the collection.

Throws:

• The being assigned is also a parent causing a circular reference.

• The value is null.

• The index value is less than 0 or is greater than the number of tree nodes in the collection.

Methods

Throws:

Throws:

Throws:

Removes all tree nodes from the collection.

Removes and disposes all tree nodes from the collection.

Copies the entire collection into an existing array at a specified location within the array.

Inserts an existing tree node into the tree node collection at the specified location.

Throws:

Creates a tree node with the specified text and key, and inserts it into the collection.

Throws:

Removes a tree node from the tree node collection at a specified index.

Sorts the nodes and updates the index.

Events

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the , , , and events of a control.

public class TreeViewCancelEventArgs : CancelEventArgs

Public Class TreeViewCancelEventArgs
    Inherits CancelEventArgs

Constructors

TreeViewCancelEventArgs(node, cancel, action)

Initializes a new instance of the class with the specified tree node, a value specifying whether the event is to be canceled, and the type of tree view action that raised the event.

TreeViewCancelEventArgs(nodes, cancel, action)

Initializes a new instance of the class with the specified tree node, a value specifying whether the event is to be canceled, and the type of tree view action that raised the event.

Properties

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the event of a control.

public delegate void TreeViewNodeDragEventHandler(Object sender, TreeViewNodeDragEventArgs e)

Public Delegate Sub TreeViewNodeDragEventHandler(ByVal sender As [Object], ByVal e As TreeViewNodeDragEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the , , , or events of a control.

public class TreeViewEventArgs : EventArgs

Public Class TreeViewEventArgs
    Inherits EventArgs

Constructors

TreeViewEventArgs(node)

Initializes a new instance of the class for the specified tree node.

TreeViewEventArgs(node, action)

Initializes a new instance of the class for the specified tree node and with the specified type of action that raised the event.

TreeViewEventArgs(nodes, action)

Initializes a new instance of the class for the specified tree node and with the specified type of action that raised the event.

Properties

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the , , , or event of a .

public delegate void TreeViewEventHandler(Object sender, TreeViewEventArgs e)

Public Delegate Sub TreeViewEventHandler(ByVal sender As [Object], ByVal e As TreeViewEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the , , , or event of a .

public delegate void TreeViewCancelEventHandler(Object sender, TreeViewCancelEventArgs e)

Public Delegate Sub TreeViewCancelEventHandler(ByVal sender As [Object], ByVal e As TreeViewCancelEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the event of the controls.

public class TreeViewNodeDragEventArgs : EventArgs

Public Class TreeViewNodeDragEventArgs
    Inherits EventArgs

Constructors

TreeViewNodeDragEventArgs(button)

Initializes a new instance of the class with a specified mouse button.

TreeViewNodeDragEventArgs(button, node)

Initializes a new instance of the class with a specified mouse button and the that is being dragged.

Properties

Button

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents a node of a .

public class TreeNode : Component, ICloneable, IHasPropertyStore, IImage

Public Class TreeNode
    Inherits Component
    Implements ICloneable, IHasPropertyStore, IImage

Constructors

TreeNode()

Initializes a new instance of the class.

TreeNode(text)

Initializes a new instance of the class with the specified label text.

TreeNode(text, children)

Initializes a new instance of the class with the specified label text and child tree nodes.

Properties

Throws:

Setting this property to true when the node doesn't have any children, will cause the node to expand anyway and request the child nodes from the server.

Throws:

Throws:

Throws:

When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<br/>".

Methods

Initiates the editing of the tree node label.

Throws:

Checks against circular parenting.

Copies the tree node and the entire subtree rooted at this tree node.

Collapses the tree node.

Collapses the tree node and optionally collapses its children.

Collapses the tree node and all its children.

Disposes the tree node.

Cancels the editing of the tree node label.

Ensures that the tree node is visible, expanding tree nodes and scrolling the tree view control as necessary.

Expands the tree node.

Expands all the child tree nodes.

Returns the number of child tree nodes.

Returns a collection of referenced components or collection of components.

Renders the client component.

Removes the current tree node from the tree view control.

Changes the selection state of this node.

Sorts all the child nodes recursively.

Toggles the tree node to either the expanded or collapsed state.

Updates the component on the client. Overridden to repaint the tree view in design mode.

Events

Implements