WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeNodeAdv - WindowsForms API Reference | Syncfusion MultiColumnTreeView. It contains information about the specific node like text, background style and other settings. ">

    Show / Hide Table of Contents

    Class TreeNodeAdv

    The TreeNodeAdv represents a node in a MultiColumnTreeView. It contains information about the specific node like text, background style and other settings.

    Inheritance
    System.Object
    System.MarshalByRefObject
    TreeNodeAdv
    Implements
    System.ICloneable
    System.IComparable
    System.ComponentModel.ISupportInitialize
    System.Runtime.Serialization.ISerializable
    Inherited Members
    System.MarshalByRefObject.MemberwiseClone(System.Boolean)
    System.MarshalByRefObject.GetLifetimeService()
    System.MarshalByRefObject.InitializeLifetimeService()
    System.MarshalByRefObject.CreateObjRef(System.Type)
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Tools.MultiColumnTreeView
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class TreeNodeAdv : MarshalByRefObject, ICloneable, IComparable, ISupportInitialize, ISerializable
    Remarks

    The Nodes collection holds all the child TreeNodeAdv objects assigned to the current TreeNodeAdv. You can add, remove or clone a TreeNodeAdv; when doing so, all child tree nodes are added, removed or cloned. Each TreeNodeAdv can contain a collection of other TreeNodeAdv objects. This can make it difficult to determine where you are in the MultiColumnTreeView when iterating through the collection. To determine your location in a tree structure, use the FullPath property. The FullPath string can be parsed using the PathSeparator string value to determine where a TreeNodeAdv label begins and ends.

    The TreeNodeAdv label is set by setting the Text property explicitly. The alternative is to create the tree node using one of the TreeNodeAdv constructors that has a string parameter that represents the Text property.

    You can specify images for the node using the LeftImageIndices, OpenImgIndex, ClosedImgIndex, NoChildrenImgIndex and RightImageIndices properties.

    The order in which the tree node's contents are drawn is as follows:

    1. Checkbox
    2. Option Buttons
    3. Left images
    4. State image
    5. Node Label
    6. Right images
    The "State image" will be one of OpenImgIndex, ClosedImgIndex and NoChildrenImgIndex.

    Selecting specific tree nodes and iterating through the Nodes collection can be achieved by using the following property values: FirstNode, LastNode, NextNode, PrevNode, NextVisibleNode, PrevVisibleNode. Assign the TreeNodeAdv object returned by one of the aforementioned properties to the SelectedNode property to select that tree node in the TreeViewAdv control.

    Tree nodes can be expanded to display the next level of child tree nodes. The user can expand the tree node by pressing the plus (+) button next to the TreeNodeAdv, if one is displayed or you can expand the TreeNodeAdv by calling the Expand() method. To expand all child tree node levels in the Nodes collection, call the ExpandAll() method. You can collapse the child TreeNodeAdv level by calling the CollapseAll() method or the user can press the minus (-) button next to the TreeNodeAdv, if one is displayed. You can also alternate the TreeNode between the expanded and collapsed states using the Expanded property.

    Examples

    The following example displays customer information in a MultiColumnTreeView control. The root tree nodes display customer names, and the child tree nodes display the order numbers assigned to each customer. In this example, 1,000 customers are displayed with 15 orders each. The repainting of the TreeViewAdv is suppressed by using the BeginUpdate() and EndUpdate() methods, and a wait Cursor is displayed while the TreeViewAdv creates and paints the TreeNodeAdv objects. This example assumes you have a Customer object that can hold a collection of Order objects. It also assumes that you have created an instance of a TreeViewAdv control on a Form.

    // Create a new ArrayList to hold the Customer objects.
    private ArrayList customerArray = new ArrayList(); 
    private void FillMyTreeView()
    {
      // Add customers to the ArrayList of Customer objects.
      for(int x=0; x!=1000; x++)
      {
        customerArray.Add(new Customer("Customer" + x.ToString()));
      } 
      // Add orders to each Customer object in the ArrayList.
      foreach(Customer customer1 in customerArray)
      {
        for(int y=0; y!=15; y++)
        {
          customer1.CustomerOrders.Add(new Order("Order" + y.ToString()));    
        }
      }
    

    // Display a wait cursor while the TreeNodeAdvs are being created. Cursor.Current = new Cursor("C:\Cursors\MyWait.cur"); // Clear the TreeViewAdv each time the method is called. treeViewAdv1.Nodes.Clear(); // Add a root TreeNodeAdv for each Customer object in the ArrayList. foreach(Customer customer2 in customerArray) { treeViewAdv1.Nodes.Add(new TreeNodeAdv(customer2.CustomerName)); // Add a child treenode for each Order object in the current Customer object. foreach(Order order1 in customer2.CustomerOrders) { treeViewAdv1.Nodes[customerArray.IndexOf(customer2)].Nodes.Add( new TreeNodeAdv(customer2.CustomerName + "." + order1.OrderID)); } } // Reset the cursor to the default for all controls. Cursor.Current = Cursors.Default; }

    ' Create a new ArrayList to hold the Customer objects.
    Private customerArray As New ArrayList()
    Private Sub FillMyTreeView()
    ' Add customers to the ArrayList of Customer objects.
    Dim x As Integer
    For x = 0 To 999
    customerArray.Add(New Customer("Customer" + x.ToString()))
    Next x

    ' Add orders to each Customer object in the ArrayList. Dim customer1 As Customer For Each customer1 In customerArray Dim y As Integer For y = 0 To 14 customer1.CustomerOrders.Add(New Order("Order" + y.ToString())) Next y Next customer1

    ' Display a wait cursor while the TreeNodeAdvs are being created. Cursor.Current = New Cursor("C:\Cursors\MyWait.cur")

    ' Clear the TreeViewAdv each time the method is called. treeViewAdv1.Nodes.Clear()

    ' Add a root TreeNodeAdv for each Customer object in the ArrayList. Dim customer2 As Customer For Each customer2 In customerArray treeViewAdv1.Nodes.Add(New TreeNodeAdv(customer2.CustomerName))

    ' Add a child TreeNodeAdv for each Order object in the current Customer object.
    Dim order1 As Order
    For Each order1 In customer2.CustomerOrders
      treeViewAdv1.Nodes(customerArray.IndexOf(customer2)).Nodes.Add( _
        New TreeNodeAdv(customer2.CustomerName + "." + order1.OrderID))
    Next order1
    

    Next customer2

    ' Reset the cursor to the default for all controls. Cursor.Current = System.Windows.Forms.Cursors.Default

    ' Begin repainting the TreeView. treeViewAdv1.EndUpdate() End Sub 'FillMyTreeView

    Constructors

    TreeNodeAdv()

    Initialize a new instance of the TreeNodeAdv class.

    Declaration
    public TreeNodeAdv()

    TreeNodeAdv(TreeNodeAdvSubItem[])

    Initialize a new instance of the TreeNodeAdv class.

    Declaration
    public TreeNodeAdv(TreeNodeAdvSubItem[] items)
    Parameters
    Type Name Description
    TreeNodeAdvSubItem[] items

    An items of treenode.

    TreeNodeAdv(String)

    Initialize a new instance of the TreeNodeAdv class with the specified label text.

    Declaration
    public TreeNodeAdv(string text)
    Parameters
    Type Name Description
    System.String text

    The text.

    TreeNodeAdv(String, TreeNodeAdv[])

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

    Declaration
    public TreeNodeAdv(string text, TreeNodeAdv[] nodes)
    Parameters
    Type Name Description
    System.String text

    The text.

    TreeNodeAdv[] nodes

    An array of nodes collection.

    TreeNodeAdv(String, TreeNodeAdvSubItem[])

    Initialize a new instance of the TreeNodeAdv class.

    Declaration
    public TreeNodeAdv(string text, TreeNodeAdvSubItem[] items)
    Parameters
    Type Name Description
    System.String text

    The text.

    TreeNodeAdvSubItem[] items

    An array of items collection.

    TreeNodeAdv(String[])

    Initialize a new instance of the TreeNodeAdv class.

    Declaration
    public TreeNodeAdv(string[] subitems)
    Parameters
    Type Name Description
    System.String[] subitems

    The subitems of treenode.

    Properties

    AccesibleObject

    Declaration
    protected TreeNodeAdvAccessibleObject AccesibleObject { get; }
    Property Value
    Type Description
    TreeNodeAdvAccessibleObject

    Background

    Gets or sets the background of the node.

    Declaration
    public BrushInfo Background { get; set; }
    Property Value
    Type Description
    BrushInfo

    BaseStyle

    Gets or sets the base style for the node from which to inherit.

    Declaration
    public string BaseStyle { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    The specified base style should be available in the BaseStyles collection.

    Border3DStyle

    Gets or sets the value specifies the border 3D style of TreeNodeAdv.

    Declaration
    public Border3DStyle Border3DStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Border3DStyle

    BorderColor

    Gets or sets the value specifies border color of TreeNodeAdv..

    Declaration
    public Color BorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    BorderSides

    Gets or sets the value specifies the border sides of TreeNodeAdv .

    Declaration
    public Border3DSide BorderSides { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Border3DSide

    BorderStyle

    Gets or sets the value specifies the border style of TreeNodeAdv.

    Declaration
    public BorderStyle BorderStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.BorderStyle

    Bounds

    Gets the bounds of the tree node.

    Declaration
    public Rectangle Bounds { get; }
    Property Value
    Type Description
    System.Drawing.Rectangle

    The System.Drawing.Rectangle that represents the bounds of the tree node.

    Remarks

    The coordinates are relative to the upper left corner of the MultiColumnTreeView control.

    CheckBox

    Gets a TreeNodeAdvPart corresponding to the checkbox of a tree node.

    Declaration
    public TreeNodeAdvPart CheckBox { get; }
    Property Value
    Type Description
    TreeNodeAdvPart

    CheckBoxBackGround

    Gets or sets the appearance of checkbox background.

    Declaration
    public Brush CheckBoxBackGround { get; set; }
    Property Value
    Type Description
    System.Drawing.Brush

    CheckBoxX

    Gets the horizontal distance between the tree border and the beginning of the node's checkbox.

    Declaration
    public int CheckBoxX { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This property returns a valid value only when queried from an owner draw paint event like AfterNodePaint.

    CheckColor

    Gets or sets the color of the Check mark.

    Declaration
    public Color CheckColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    Checked

    Gets or sets the node's checkbox is checked.

    Declaration
    public bool Checked { get; set; }
    Property Value
    Type Description
    System.Boolean

    CheckState

    Gets or sets the CheckState of the node.

    Declaration
    public CheckState CheckState { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.CheckState
    Remarks

    Note that setting this property will fire the BeforeCheck event. If you do not want this event to be fired, you can access the tree's internal data structure as follows:

                treeNodeAdv.NodeStyle.CheckState = CheckState.Checked;
    treeNodeAdv.NodeStyle.CheckState = CheckState.Checked

    ChildStyle

    Gets the information about the immediate child-nodes' appearance and state.

    Declaration
    public TreeNodeAdvStyleInfo ChildStyle { get; }
    Property Value
    Type Description
    TreeNodeAdvStyleInfo

    ClosedImage

    Gets or sets close state image for node.

    Declaration
    public Image ClosedImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    ClosedImgIndex

    Gets or sets the image index in the StateImageList where the node is not expanded.

    Declaration
    public int ClosedImgIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    CollapsedImage

    Gets or sets image for state button of collapsed node.

    Declaration
    public Image CollapsedImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    CollapseImageIndex

    Gets or sets image index of image for collapse button.

    Declaration
    public int CollapseImageIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    CompareOptions

    Gets or sets the compare options used in the sorting of the node.

    Declaration
    public CompareOptions CompareOptions { get; set; }
    Property Value
    Type Description
    System.Globalization.CompareOptions

    Comparer

    Gets or sets the System.Collections.IComparer object that compares two nodes.

    Declaration
    public IComparer Comparer { get; set; }
    Property Value
    Type Description
    System.Collections.IComparer

    Culture

    Gets or sets the culture of the node.

    Declaration
    public CultureInfo Culture { get; set; }
    Property Value
    Type Description
    System.Globalization.CultureInfo

    CurrentStyleInfo

    Return node style info. If Node has sub items then instead of tree node style will be returned first sub item style.

    Declaration
    protected ITreeNodeAdvSubItemStyle CurrentStyleInfo { get; }
    Property Value
    Type Description
    ITreeNodeAdvSubItemStyle

    CustomControl

    Gets or sets node custom control.

    Declaration
    public Control CustomControl { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Control

    DragCueBounds

    Gets the dragcuebounds of the tree node.

    Declaration
    public Rectangle DragCueBounds { get; }
    Property Value
    Type Description
    System.Drawing.Rectangle

    Enabled

    Gets or sets the node is enabled.

    Declaration
    public bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnabledButtons

    Gets or sets the buttons in the node are enabled.

    Declaration
    public bool EnabledButtons { get; set; }
    Property Value
    Type Description
    System.Boolean

    True to enable the buttons; False otherwise.

    Remarks

    The checkbox and option buttons can be disabled keeping the rest of the node enabled using this property.

    EnsureDefaultOptionedChild

    Gets or sets the first child should be marked as Optioned and this node's OptionedChild if none of the other children is Optioned in a parent node.

    Declaration
    public bool EnsureDefaultOptionedChild { get; set; }
    Property Value
    Type Description
    System.Boolean

    True to ensure a default optioned child; False otherwise.

    Expanded

    Gets or sets the expanded state of a tree node.

    Declaration
    public bool Expanded { get; set; }
    Property Value
    Type Description
    System.Boolean

    True if the tree node is in the expanded state; false otherwise.

    ExpandedImage

    Gets or sets image for state button of expanded node.

    Declaration
    public Image ExpandedImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    ExpandedOnce

    Gets or sets the node has been expanded at least once.

    Declaration
    public bool ExpandedOnce { get; set; }
    Property Value
    Type Description
    System.Boolean

    ExpandImageIndex

    Gets or sets image index of image for expand button.

    Declaration
    public int ExpandImageIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    FirstNode

    Gets the first child tree node in the tree node collection.

    Declaration
    public TreeNodeAdv FirstNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    The first child TreeNodeAdv in the Nodes collection.

    Remarks

    The FirstNode is the first child TreeNodeAdv in the TreeNodeAdvCollection stored in the Nodes property of the current tree node. If the System.Windows.Forms.TreeNode has no child tree node, the FirstNode property returns a null reference (Nothing in Visual Basic).

    Font

    Gets or sets the font of the node.

    Declaration
    public Font Font { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    FullPath

    Gets the path from the root tree node to the current tree node.

    Declaration
    public string FullPath { get; }
    Property Value
    Type Description
    System.String

    The path from the root tree node to the current tree node.

    Remarks

    You can also use the more flexible GetPath(String) method to get the path with a specific path separator.

    The path consists of the labels of all of the tree nodes that must be navigated to get to this tree node, starting at the root tree node. The node labels are separated by the delimiter character specified in the PathSeparator property of the TreeViewAdv control that contains this node. For example, if the delimiter character of the tree view control named "Location" is set to the backslash character, (\), the FullPath property value is "Country\Region\State".

    If node not a part of tree then will be used default OS Path separator System.IO.Path.PathSeparator.

    HasChildren

    Gets the node has child nodes.

    Declaration
    [Obsolete("Please replace all calls on HasNodes property calls.", true)]
    public bool HasChildren { get; }
    Property Value
    Type Description
    System.Boolean

    HasNodes

    Gets the node indicating whether the Nodes property has or not.

    Declaration
    public bool HasNodes { get; }
    Property Value
    Type Description
    System.Boolean

    HasPrimitives

    Declaration
    protected bool HasPrimitives { get; }
    Property Value
    Type Description
    System.Boolean

    HasSubItems

    Indicate has node subitems or not.

    Declaration
    protected bool HasSubItems { get; }
    Property Value
    Type Description
    System.Boolean

    Height

    Gets or sets the height of the node.

    Declaration
    public int Height { get; set; }
    Property Value
    Type Description
    System.Int32

    HelpText

    Gets or sets the help text of the node.

    Declaration
    public string HelpText { get; set; }
    Property Value
    Type Description
    System.String

    HistoryManager

    Returns the TreeView History manager this node belongs to.

    Declaration
    protected HistoryManager HistoryManager { get; }
    Property Value
    Type Description
    HistoryManager

    Index

    Gets the position of the tree node in the Parent's tree node collection.

    Declaration
    public int Index { get; }
    Property Value
    Type Description
    System.Int32

    InteractiveCheckBox

    Gets or sets the node will have an interactive checkbox.

    Declaration
    public bool InteractiveCheckBox { get; set; }
    Property Value
    Type Description
    System.Boolean

    IntermediateCheckBoxBackGround

    Gets or sets the appearance of checkbox background when the checkbox is in intermediate state.

    Declaration
    public Brush IntermediateCheckBoxBackGround { get; set; }
    Property Value
    Type Description
    System.Drawing.Brush

    IntermediateCheckColor

    Gets or sets the color of the check mark when it is in intermediate state.

    Declaration
    public Color IntermediateCheckColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    IsActiveNode

    Gets the node is the currently active node.

    Declaration
    public bool IsActiveNode { get; }
    Property Value
    Type Description
    System.Boolean

    IsEditing

    Gets the node is in editing state.

    Declaration
    public bool IsEditing { get; }
    Property Value
    Type Description
    System.Boolean

    IsSelected

    Gets the node is selected.

    Declaration
    public bool IsSelected { get; }
    Property Value
    Type Description
    System.Boolean

    IsUndoRedoPerforming

    Indicates whether the node is in UndoRedo state.

    Declaration
    protected bool IsUndoRedoPerforming { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsVisible

    Gets the tree node is visible.

    Declaration
    public bool IsVisible { get; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Return True only if node has property Visible set to True, and parent node Visible to user (expanded and visible).

    Item[Int32]

    Gets or sets the subitem by it order index.

    Declaration
    public TreeNodeAdvSubItem this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type Description
    TreeNodeAdvSubItem

    LastNode

    Gets the last child tree node in the tree node collection.

    Declaration
    public TreeNodeAdv LastNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    The last child TreeNodeAdv in the Nodes collection.

    Remarks

    The LastNode is the last child TreeNodeAdv in the TreeNodeAdvCollection stored in the Nodes property of the current tree node. If the TreeNodeAdv has no child tree node, the LastNode property returns a null reference (Nothing in Visual Basic).

    LastVisibleNode

    Gets the last visible child tree node in the tree node collection.

    Declaration
    public TreeNodeAdv LastVisibleNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    LeftImage

    Gets or sets left image for node

    Declaration
    public Image LeftImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    LeftImageIndices

    Gets or sets the image indices of the images to be drawn on the left of the node's text.

    Declaration
    public int[] LeftImageIndices { get; set; }
    Property Value
    Type Description
    System.Int32[]

    LeftImagePadding

    Gets or sets the space between images for LeftImageList.

    Declaration
    public int LeftImagePadding { get; set; }
    Property Value
    Type Description
    System.Int32

    LeftImagesX

    Gets the horizontal distance between the tree border and the beginning of the node's left images.

    Declaration
    public int LeftImagesX { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This property returns a valid value only when queried from an owner draw paint event like AfterNodePaint.

    LeftStateImagePadding

    Gets or sets the space before StateImage.

    Declaration
    public int LeftStateImagePadding { get; set; }
    Property Value
    Type Description
    System.Int32

    Level

    Gets the level of the node.

    Declaration
    public int Level { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    Specifies how deep a node is in the tree. The top-most visible nodes belong to level 1. The Root node is level 0.

    MaxX

    Gets / sets the maximum width of all the children and subchildren of this given node.

    Declaration
    protected int MaxX { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    Value does not include subitems.

    Multiline

    Gets or sets is node text should be drawn as multiline text or single line.

    Declaration
    public bool Multiline { get; set; }
    Property Value
    Type Description
    System.Boolean

    NextNode

    Gets the next sibling tree node.

    Declaration
    public TreeNodeAdv NextNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    A TreeNodeAdv that represents the next sibling tree node.

    Remarks

    The NextNode is the next sibling TreeNodeAdv in the System.Windows.Forms.TreeNodeCollection stored in the Nodes property of the tree node's parent TreeNodeAdv. If there is no next tree node, the NextNode property returns a null reference (Nothing in Visual Basic).

    NextSelectableNode

    Gets the next selectable tree node.

    Declaration
    public TreeNodeAdv NextSelectableNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    A TreeNodeAdv that represents the next selectable tree node.

    Remarks

    The NextSelectableNode can be a child, sibling or a tree node from another branch. If there is no next tree node, the NextSelectableNode property returns a null reference (Nothing in Visual Basic).

    NextSiblingNode

    Gets the next sibling tree node.

    Declaration
    public TreeNodeAdv NextSiblingNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    NextVisibleNode

    Gets the next visible tree node.

    Declaration
    public TreeNodeAdv NextVisibleNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    A TreeNodeAdv that represents the next visible tree node.

    Remarks

    The NextVisibleNode can be a child, sibling or a tree node from another branch. If there is no next tree node, the NextVisibleNode property returns a null reference (Nothing in Visual Basic).

    NoChildrenImage

    Gets or sets image for node that has no children.

    Declaration
    public Image NoChildrenImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    NoChildrenImgIndex

    Gets or sets the image index indicating the image in the StateImageList where the node has no children.

    Declaration
    public int NoChildrenImgIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    Nodes

    Gets or sets the collection of TreeNodeAdv objects assigned to the current tree node.

    Declaration
    public TreeNodeAdvCollection Nodes { get; set; }
    Property Value
    Type Description
    TreeNodeAdvCollection

    A TreeNodeAdvCollection that represents the tree nodes assigned to the current tree node.

    Remarks

    The Nodes property can hold a collection of other TreeNodeAdv objects. Each of the tree node in the collection has a Nodes property that can contain its own TreeNodeAdvCollection. This nesting of tree nodes can make it difficult to navigate a tree structure. The FullPath property makes it easier to determine your location in a tree.

    NodeStyle

    Gets the information about the node's appearance and state.

    Declaration
    public TreeNodeAdvStyleInfo NodeStyle { get; }
    Property Value
    Type Description
    TreeNodeAdvStyleInfo
    Remarks

    This property exposes the node's style information store.

    NodeX

    Gets the horizontal distance between the tree border and the beginning of the node's drawing bounds.

    Declaration
    public int NodeX { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This property returns a valid value only when queried from an owner draw paint event like AfterNodePaint.

    OpenImage

    Gets or sets open state image for node.

    Declaration
    public Image OpenImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    OpenImgIndex

    Gets or sets the image index in the StateImageList where the node is expanded.

    Declaration
    public int OpenImgIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    OptionButton

    Gets a TreeNodeAdvPart corresponding to the option button part of a tree node.

    Declaration
    public TreeNodeAdvPart OptionButton { get; }
    Property Value
    Type Description
    TreeNodeAdvPart

    OptionButtonColor

    Gets or sets the color of the Option button.

    Declaration
    public Color OptionButtonColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    OptionButtonX

    Gets the horizontal distance between the tree border and the beginning of the node's option button.

    Declaration
    public int OptionButtonX { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This property returns a valid value only when queried from an owner draw paint event like AfterNodePaint.

    Optioned

    Gets or sets the node's option button is checked.

    Declaration
    public bool Optioned { get; set; }
    Property Value
    Type Description
    System.Boolean

    OptionedChild

    Gets the child node who's option button is checked.

    Declaration
    public TreeNodeAdv OptionedChild { get; }
    Property Value
    Type Description
    TreeNodeAdv

    A TreeNodeAdv that represents the next visible tree node.

    Parent

    Gets the parent tree node of the current tree node, if there is any.

    Declaration
    public TreeNodeAdv Parent { get; }
    Property Value
    Type Description
    TreeNodeAdv

    A TreeNodeAdv that represents the parent of the current tree node.

    Remarks

    If this is the top most node in the tree, the Parent property returns the TreeViewAdv's Root node.

    PartsPadX

    Gets the horizontal padding used between the different parts of the tree node.

    Declaration
    public static int PartsPadX { get; }
    Property Value
    Type Description
    System.Int32

    PlusMinus

    Gets a TreeNodeAdvPart corresponding to the plus-minus part of a tree node.

    Declaration
    public TreeNodeAdvPart PlusMinus { get; }
    Property Value
    Type Description
    TreeNodeAdvPart

    PrevNode

    Gets the previous tree node.

    Declaration
    public TreeNodeAdv PrevNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    A TreeNodeAdv that represents the previous sibling tree node.

    Remarks

    The PrevNode is the previous sibling TreeNodeAdv in the TreeNodeAdvCollection stored in the Nodes property of the tree node's parent TreeNodeAdv. If there is no previous tree node, the PrevNode property returns a null reference (Nothing in Visual Basic).

    PrevSelectableNode

    Gets the previous selectable tree node.

    Declaration
    public TreeNodeAdv PrevSelectableNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    A TreeNodeAdv that represents the previous selectable tree node.

    Remarks

    The PrevSelectableNode can be a child, sibling or a tree node from another branch. If there is no previous tree node, the PrevSelectableNode property returns a null reference (Nothing in Visual Basic).

    PrevSiblingNode

    Gets the previous sibling tree node.

    Declaration
    public TreeNodeAdv PrevSiblingNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    PrevVisibleNode

    Declaration
    public TreeNodeAdv PrevVisibleNode { get; }
    Property Value
    Type Description
    TreeNodeAdv

    Primitives

    Gets collection of primitives assigned to node.

    Declaration
    public TreeNodePrimitivesCollection Primitives { get; }
    Property Value
    Type Description
    TreeNodePrimitivesCollection

    PrintTextBounds

    Get the textbounds value of the TreeNodeAdv.

    Declaration
    public Rectangle PrintTextBounds { get; }
    Property Value
    Type Description
    System.Drawing.Rectangle

    Right

    Declaration
    protected int Right { get; }
    Property Value
    Type Description
    System.Int32

    RightImage

    Gets or sets right image for node

    Declaration
    public Image RightImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    RightImageIndices

    Gets or sets the image indices of the images to be drawn on the right of the node's text.

    Declaration
    public int[] RightImageIndices { get; set; }
    Property Value
    Type Description
    System.Int32[]

    RightImagePadding

    Gets or sets the space between images for RightImageList.

    Declaration
    public int RightImagePadding { get; set; }
    Property Value
    Type Description
    System.Int32

    RightImagesX

    Gets the horizontal distance between the tree border and the beginning of the node's right images.

    Declaration
    public int RightImagesX { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This property returns a valid value only when queried from an owner draw paint event like AfterNodePaint.

    RightStateImagePadding

    Gets or sets the space after StateImage.

    Declaration
    public int RightStateImagePadding { get; set; }
    Property Value
    Type Description
    System.Int32

    RowBounds

    Return calculated row bounds. Bounds contains visible and not visible regions for user (scrolling in mind).

    Declaration
    protected Rectangle RowBounds { get; }
    Property Value
    Type Description
    System.Drawing.Rectangle

    SelectedOptionButtonColor

    Gets or sets the color of the Option button in selected state.

    Declaration
    public Color SelectedOptionButtonColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ShowCheckBox

    Gets or sets whether the checkbox of the node is visible.

    Declaration
    public bool ShowCheckBox { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowOptionButton

    Gets or sets whether the option button of the node is visible.

    Declaration
    public bool ShowOptionButton { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowPlusMinus

    Gets or sets whether the plus or minus of the node is visible.

    Declaration
    public bool ShowPlusMinus { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowPlusOnExpand

    Gets or sets show plus on expand. Use only on LoadOnDemand mode.

    Declaration
    public bool ShowPlusOnExpand { get; set; }
    Property Value
    Type Description
    System.Boolean

    SingleBorderStyle

    Gets or sets the value specifies the single line border style of TreeNodeAdv.

    Declaration
    public ButtonBorderStyle SingleBorderStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ButtonBorderStyle

    SortOrder

    Gets or sets the sort order of the node.

    Declaration
    public SortOrder SortOrder { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.SortOrder

    SortType

    Gets or sets the sort type of the node.

    Declaration
    public TreeNodeAdvSortType SortType { get; set; }
    Property Value
    Type Description
    TreeNodeAdvSortType

    StateImageX

    Gets the horizontal distance between the tree border and the beginning of the node's state image.

    Declaration
    public int StateImageX { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This property returns a valid value only when queried from an owner draw paint event like AfterNodePaint.

    SubItems

    Gets the subitem collection of particular node.

    Declaration
    public TreeNodeAdvSubItemCollection SubItems { get; }
    Property Value
    Type Description
    TreeNodeAdvSubItemCollection

    Tag

    Gets or sets the object that contains data about the tree node.

    Declaration
    public object Tag { get; set; }
    Property Value
    Type Description
    System.Object

    An System.Object that contains data about the tree node. The default is a null reference (Nothing in Visual Basic).

    Remarks

    Any Object derived type may be assigned to this property. If this property is being set through the Windows Forms designer, only text may be assigned.

    When the tree node is cloned, if this object is cloneable (implements ICloneable interface) then it will be.

    TagObject

    Gets or sets the object that contains data about the tree node.

    Declaration
    public object TagObject { get; set; }
    Property Value
    Type Description
    System.Object

    An System.Object that contains data about the tree node. The default is a null reference (Nothing in Visual Basic).

    Text

    Gets or sets the text of the node.

    Declaration
    public string Text { get; set; }
    Property Value
    Type Description
    System.String

    TextAndImageBounds

    Gets the bounds of the left images, state images, text area and the right images of the node.

    Declaration
    public Rectangle TextAndImageBounds { get; }
    Property Value
    Type Description
    System.Drawing.Rectangle

    TextBounds

    Gets the bounds of the text area of the node.

    Declaration
    public Rectangle TextBounds { get; }
    Property Value
    Type Description
    System.Drawing.Rectangle

    TextColor

    Gets or sets the color of the text.

    Declaration
    public Color TextColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ThemesEnabled

    Gets or sets the node's controls will be themed.

    Declaration
    public bool ThemesEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    TreeRowIndex

    Gets an absolute order index of tree node.

    Declaration
    public int TreeRowIndex { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    0 (zero) - mean first node in tree.

    TreeView

    Gets or sets the parent tree view that the tree node is assigned to.

    Declaration
    public MultiColumnTreeView TreeView { get; set; }
    Property Value
    Type Description
    MultiColumnTreeView

    A MultiColumnTreeView that represents the parent tree view that the tree node is assigned to.

    Visible

    Gets or sets the node will be visible or not.

    Declaration
    public bool Visible { get; set; }
    Property Value
    Type Description
    System.Boolean

    VisibleNodeCount

    Declaration
    protected int VisibleNodeCount { get; }
    Property Value
    Type Description
    System.Int32

    Width

    Declaration
    protected int Width { get; set; }
    Property Value
    Type Description
    System.Int32

    Methods

    BringIntoView()

    Expands parent nodes to make this node visible and also scrolls the tree such that this node is brought into view.

    Declaration
    public void BringIntoView()

    Clone()

    Creates a clone of this node.

    Declaration
    public TreeNodeAdv Clone()
    Returns
    Type Description
    TreeNodeAdv

    The clone of the node.

    CollapseAll()

    Collapses this node and all it's children.

    Declaration
    public void CollapseAll()

    CustomControlCollectionChanging(TreeNodeAdv, CollectionChangeAction)

    Custom control collection changing.

    Declaration
    protected virtual void CustomControlCollectionChanging(TreeNodeAdv node, CollectionChangeAction action)
    Parameters
    Type Name Description
    TreeNodeAdv node
    System.ComponentModel.CollectionChangeAction action

    Draw(ThemedControlDrawing, ThemedControlDrawing, Pen, Point, Boolean, TreeNodeAdvPaintEventArgs)

    Declaration
    protected void Draw(ThemedControlDrawing treeTD, ThemedControlDrawing buttonTD, Pen linePen, Point mousePos, bool mouseDown, TreeNodeAdvPaintEventArgs e)
    Parameters
    Type Name Description
    ThemedControlDrawing treeTD
    ThemedControlDrawing buttonTD
    System.Drawing.Pen linePen
    System.Drawing.Point mousePos
    System.Boolean mouseDown
    TreeNodeAdvPaintEventArgs e

    DrawFocusRect(Graphics)

    Draws dotted border around selected node. This will be used to fast drawing when TreeCtrl loses focus.

    Declaration
    protected void DrawFocusRect(Graphics g)
    Parameters
    Type Name Description
    System.Drawing.Graphics g

    Device context needed for drawing.

    Expand()

    Expands the node.

    Declaration
    public void Expand()

    ExpandAll()

    Expands this node and all the subnodes.

    Declaration
    public void ExpandAll()

    GetForeColor(Boolean, Boolean)

    Declaration
    protected Color GetForeColor(bool selected, bool hotTracked)
    Parameters
    Type Name Description
    System.Boolean selected
    System.Boolean hotTracked
    Returns
    Type Description
    System.Drawing.Color

    GetNodeAtAbsoluteRowIndex(Int32)

    Method search by binary search algorithm node that has specified unique row Index.

    Declaration
    public TreeNodeAdv GetNodeAtAbsoluteRowIndex(int rowIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    Unique row index. Valid values are higher 0 (zero).

    Returns
    Type Description
    TreeNodeAdv

    Null - if nothing found, otherwise reference on node.

    GetNodeAtRelativeRowIndex(Int32)

    Represents the search node by relative position from current node.

    Declaration
    public TreeNodeAdv GetNodeAtRelativeRowIndex(int rowIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    Relative diff number. Negative values mean Previous node logic, positive mean Next node logic.

    Returns
    Type Description
    TreeNodeAdv

    Found node, otherwise Null.

    GetNodeCount(Boolean)

    Returns the number of child tree nodes.

    Declaration
    public int GetNodeCount(bool includeSubTrees)
    Parameters
    Type Name Description
    System.Boolean includeSubTrees

    True if the resulting count includes all tree nodes indirectly rooted at this tree node; false otherwise.

    Returns
    Type Description
    System.Int32

    The number of child tree nodes assigned to the Nodes collection.

    GetObjectData(SerializationInfo, StreamingContext)

    Populates the provided SerializationInfo with the data needed to serialize the object .

    Declaration
    public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info
    System.Runtime.Serialization.StreamingContext context

    GetOptionedChild()

    Returns the child node who's option button is checked.

    Declaration
    protected TreeNodeAdv GetOptionedChild()
    Returns
    Type Description
    TreeNodeAdv

    GetPath(String)

    Returns the path of the node.

    Declaration
    public string GetPath(string separator)
    Parameters
    Type Name Description
    System.String separator

    The separator string.

    Returns
    Type Description
    System.String

    The path of the node.

    Remarks

    You can also use the FullPath property to get the full path with the path separator specified in the PathSeparator property.

    GetTreeRowIndexOfChild(TreeNodeAdv)

    Declaration
    protected int GetTreeRowIndexOfChild(TreeNodeAdv child)
    Parameters
    Type Name Description
    TreeNodeAdv child
    Returns
    Type Description
    System.Int32

    HasNode(TreeNodeAdv)

    Indicates whether node is contained in it's nodes collection or in it's subnodes nodes collection.

    Declaration
    public bool HasNode(TreeNodeAdv node)
    Parameters
    Type Name Description
    TreeNodeAdv node

    Node to look for.

    Returns
    Type Description
    System.Boolean

    True if node is contained.

    IsNodeRelative(TreeNodeAdv)

    If "adv" node is multiparent for current node than returns true, else returns false. Method uses recursion.

    Declaration
    public bool IsNodeRelative(TreeNodeAdv adv)
    Parameters
    Type Name Description
    TreeNodeAdv adv
    Returns
    Type Description
    System.Boolean

    IsParent(TreeNodeAdv)

    Indicates whether the current node is a direct or indirect child of the specified node.

    Declaration
    public bool IsParent(TreeNodeAdv targetNode)
    Parameters
    Type Name Description
    TreeNodeAdv targetNode

    The node that is to be tested for ancestry.

    Returns
    Type Description
    System.Boolean

    True if the targetNode is a parent of this node; False otherwise.

    Move(TreeNodeAdv, NodePositions)

    Moves the node to a specified position in relation to the specified "relative node".

    Declaration
    public void Move(TreeNodeAdv relativeNode, NodePositions nodePosition)
    Parameters
    Type Name Description
    TreeNodeAdv relativeNode

    The "relative node" that determines this node's new position.

    NodePositions nodePosition

    Specifies where this node will be moved in relation to the "relative node".

    Remarks

    A node can be positioned relative to any other node in the same tree or even a different TreeViewAdv Control.

    Move(TreeNodeAdvCollection)

    Moves the node to the end of the specified collection.

    Declaration
    public void Move(TreeNodeAdvCollection newNodesCollection)
    Parameters
    Type Name Description
    TreeNodeAdvCollection newNodesCollection

    A TreeNodeAdvCollection to which this node will move.

    Remarks

    A node can be positioned to any other TreeNodeAdvCollection in the same tree or in a different TreeViewAdv control.

    Note: All of the descendants of the node will move along with it.

    Note: A node cannot be moved to one of it's own Descendants.

    Move(TreeNodeAdvCollection, NodePositions)

    Moves the node to a specified position in relation to the specified column.

    Declaration
    public void Move(TreeNodeAdvCollection col, NodePositions nodePosition)
    Parameters
    Type Name Description
    TreeNodeAdvCollection col

    It determines the column position.

    NodePositions nodePosition

    Specifies where this node will be moved by the column value.

    Move(TreeNodeAdvCollection, Int32)

    Moves the node to a new collection at the specified index.

    Declaration
    public void Move(TreeNodeAdvCollection newNodesCollection, int index)
    Parameters
    Type Name Description
    TreeNodeAdvCollection newNodesCollection

    A TreeNodeAdvCollection to which this node will move.

    System.Int32 index

    The new index of the node in the new collection.

    Remarks

    Moving a node by index will ensure that the node ends up at the index specified. Note that the node will first be removed from its existing collection and then added to the specified collection at the specified index. If the source collection and destination collection are the same, make sure to take into account the above semantics while specifying the index, or use the Move override that lets you specify a relative position.

    OnBeforeChildRemove(CollectionChangeEventArgs)

    Declaration
    protected virtual void OnBeforeChildRemove(CollectionChangeEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CollectionChangeEventArgs e

    OnCheckStateChanged(EventArgs)

    Raises the CheckStateChanged event.

    Declaration
    protected virtual void OnCheckStateChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An EventArgs that contains the event data.

    Remarks

    The OnCheckStateChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnCheckStateChanged in a derived class, be sure to call the base class's OnCheckStateChanged method so that registered delegates receive the event.

    OnChildsCollectionChanged(CollectionChangeEventArgs)

    Declaration
    protected virtual void OnChildsCollectionChanged(CollectionChangeEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CollectionChangeEventArgs e

    OnPrimitivesCollectionChanged(CollectionChangeEventArgs)

    Called by primitives collection when collection detect changes.

    Declaration
    protected virtual void OnPrimitivesCollectionChanged(CollectionChangeEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CollectionChangeEventArgs e

    OnSubItemChanged(StyleChangedEventArgs)

    Declaration
    protected virtual void OnSubItemChanged(StyleChangedEventArgs e)
    Parameters
    Type Name Description
    StyleChangedEventArgs e

    RecalculateAllDimensions()

    Recalculates the dimensions of all the UI elements in this node and it's children.

    Declaration
    public void RecalculateAllDimensions()
    Remarks

    Method is call recalculation recursively. Please keep in mind that this can greatly reduce performance.

    Remove()

    Removes itself from the parent node, if there is any.

    Declaration
    public void Remove()

    ResetBackground()

    Reset the Background property value to default value.

    Declaration
    public void ResetBackground()

    ResetBaseStyle()

    Reset the BaseStyle property value to default value.

    Declaration
    public void ResetBaseStyle()

    ResetCheckState()

    Reset the CheckState property value to default value.

    Declaration
    public void ResetCheckState()

    ResetClosedImage()

    Reset the ClosedImage property value to default value.

    Declaration
    public void ResetClosedImage()

    ResetClosedImgIndex()

    Reset the ClosedImgIndex property value to default value.

    Declaration
    public void ResetClosedImgIndex()

    ResetCollapseImageIndex()

    Reset the CollapseImageIndex property value to default value.

    Declaration
    public void ResetCollapseImageIndex()

    ResetCompareOptions()

    Reset the CompareOptions property value to default value.

    Declaration
    public void ResetCompareOptions()

    ResetComparer()

    Reset the Comparer property value to default value.

    Declaration
    public void ResetComparer()

    ResetCulture()

    Reset the Culture property value to default value.

    Declaration
    public void ResetCulture()

    ResetEnabled()

    Reset an Enabled property value to default value.

    Declaration
    public void ResetEnabled()

    ResetEnabledButtons()

    Reset the EnabledButtons propety value to default value.

    Declaration
    public void ResetEnabledButtons()

    ResetEnsureDefaultOptinedChild()

    Reset the EnsureDefaultOptionedChild property to default value.

    Declaration
    [Obsolete("ResetEnsureDefaultOptinedChild is deprecated, please use ResetEnsureDefaultOptionedChild instead.")]
    public void ResetEnsureDefaultOptinedChild()

    ResetEnsureDefaultOptionedChild()

    Reset the EnsureDefaultOptionedChild property to default value.

    Declaration
    public void ResetEnsureDefaultOptionedChild()

    ResetExpandImageIndex()

    Reset the ExpandImageIndex property value to default value.

    Declaration
    public void ResetExpandImageIndex()

    ResetFont()

    Reset the Font property value to default value.

    Declaration
    public void ResetFont()

    ResetHeight()

    Reset the Height property value to default value.

    Declaration
    public void ResetHeight()

    ResetHelpText()

    Reset the HelpText property value to default value.

    Declaration
    public void ResetHelpText()

    ResetInteractiveCheckBox()

    Reset an InteractiveCheckBox property value to default value.

    Declaration
    public void ResetInteractiveCheckBox()

    ResetLeftImage()

    Reset the LeftImage property value to default value.

    Declaration
    public void ResetLeftImage()

    ResetLeftImageIndices()

    Reset the LeftImageIndices property value to default value.

    Declaration
    public void ResetLeftImageIndices()

    ResetMultiline()

    Reset the Multiline property value to default value.

    Declaration
    public virtual void ResetMultiline()

    ResetNoChildrenImgIndex()

    Reset the NoChildrenImgIndex property value to default value.

    Declaration
    public void ResetNoChildrenImgIndex()

    ResetOpenImage()

    Reset the OpenImage property value to default value.

    Declaration
    public void ResetOpenImage()

    ResetOpenImgIndex()

    Reset an OpenImgIndex property value to default value.

    Declaration
    public void ResetOpenImgIndex()

    ResetPrimitives()

    Reset the primitives property value to default value.

    Declaration
    public void ResetPrimitives()

    ResetRightImage()

    Reset the RightImage property value to default value.

    Declaration
    public void ResetRightImage()

    ResetRightImageIndices()

    Reset the RightImageIndices property value to default value.

    Declaration
    public void ResetRightImageIndices()

    ResetShowCheckBox()

    Reset the ShowCheckBox property value to default value.

    Declaration
    public void ResetShowCheckBox()

    ResetShowOptionButton()

    Reset the ShowOptionButton property value to default value.

    Declaration
    public void ResetShowOptionButton()

    ResetShowPlusMinus()

    Reset the ShowPlusMinus property value to default value.

    Declaration
    public void ResetShowPlusMinus()

    ResetSortOrder()

    Reset the SortOrder property value to default value.

    Declaration
    public void ResetSortOrder()

    ResetSortType()

    Reset the SortType property value to default value.

    Declaration
    public void ResetSortType()

    ResetTag()

    Reset the Tag property value to default value.

    Declaration
    public void ResetTag()

    ResetText()

    Reset the Text property value to default value.

    Declaration
    public void ResetText()

    ResetTextColor()

    Reset the TextColor property value to default value.

    Declaration
    public void ResetTextColor()

    ResetThemesEnabled()

    Reset the ThemesEnabled property value to default value.

    Declaration
    public void ResetThemesEnabled()

    SetBounds(Rectangle)

    Update node bounds.

    Declaration
    protected void SetBounds(Rectangle bounds)
    Parameters
    Type Name Description
    System.Drawing.Rectangle bounds

    New node bounds.

    SetPrimitives(TreeNodePrimitivesCollection)

    Method allow to replace Primitives collection if needed. Low level jobs with internal node data. Only for inheritors.

    Declaration
    protected void SetPrimitives(TreeNodePrimitivesCollection primitives)
    Parameters
    Type Name Description
    TreeNodePrimitivesCollection primitives

    SetSubItems(TreeNodeAdvSubItemCollection)

    Method allow to replace subitems collection if needed. Low level jobs with internal node data. Only for inheritors.

    Declaration
    protected void SetSubItems(TreeNodeAdvSubItemCollection collection)
    Parameters
    Type Name Description
    TreeNodeAdvSubItemCollection collection

    Collection that will replace current node Subitems collection.

    ShouldDrawPlusMinus()

    Declaration
    protected bool ShouldDrawPlusMinus()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBackground()

    Declaration
    protected bool ShouldSerializeBackground()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBaseStyle()

    Declaration
    protected bool ShouldSerializeBaseStyle()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeCheckState()

    Declaration
    protected bool ShouldSerializeCheckState()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeClosedImage()

    Declaration
    protected bool ShouldSerializeClosedImage()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeClosedImgIndex()

    Declaration
    protected bool ShouldSerializeClosedImgIndex()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeCollapseImageIndex()

    Declaration
    protected bool ShouldSerializeCollapseImageIndex()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeCompareOptions()

    Declaration
    protected bool ShouldSerializeCompareOptions()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeComparer()

    Declaration
    protected bool ShouldSerializeComparer()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeCulture()

    Declaration
    protected bool ShouldSerializeCulture()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeEnabled()

    Declaration
    protected bool ShouldSerializeEnabled()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeEnabledButtons()

    Declaration
    protected bool ShouldSerializeEnabledButtons()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeEnsureDefaultOptinedChild()

    Determines if the EnsureDefaultOptionedChild property was modified.

    Declaration
    protected bool ShouldSerializeEnsureDefaultOptinedChild()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeExpandImageIndex()

    Declaration
    protected bool ShouldSerializeExpandImageIndex()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeFont()

    Declaration
    protected bool ShouldSerializeFont()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeHeight()

    Declaration
    protected bool ShouldSerializeHeight()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeHelpText()

    Declaration
    protected bool ShouldSerializeHelpText()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeInteractiveCheckBox()

    Declaration
    protected bool ShouldSerializeInteractiveCheckBox()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeLeftImage()

    Declaration
    protected bool ShouldSerializeLeftImage()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeLeftImageIndices()

    Declaration
    protected bool ShouldSerializeLeftImageIndices()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeMultiline()

    Indicate should or not we serialize Multiline property value.

    Declaration
    protected virtual bool ShouldSerializeMultiline()
    Returns
    Type Description
    System.Boolean

    True - serialization required, otherwise False.

    ShouldSerializeNoChildrenImgIndex()

    Declaration
    protected bool ShouldSerializeNoChildrenImgIndex()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeOpenImage()

    Declaration
    protected bool ShouldSerializeOpenImage()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeOpenImgIndex()

    Declaration
    protected bool ShouldSerializeOpenImgIndex()
    Returns
    Type Description
    System.Boolean

    ShouldSerializePrimitives()

    Declaration
    protected bool ShouldSerializePrimitives()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeRightImage()

    Declaration
    protected bool ShouldSerializeRightImage()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeRightImageIndices()

    Declaration
    protected bool ShouldSerializeRightImageIndices()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeShowCheckBox()

    Declaration
    protected bool ShouldSerializeShowCheckBox()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeShowOptionButton()

    Declaration
    protected bool ShouldSerializeShowOptionButton()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeShowPlusMinus()

    Declaration
    protected bool ShouldSerializeShowPlusMinus()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeSortOrder()

    Declaration
    protected bool ShouldSerializeSortOrder()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeSortType()

    Declaration
    protected bool ShouldSerializeSortType()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeTag()

    Declaration
    protected bool ShouldSerializeTag()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeText()

    Declaration
    protected bool ShouldSerializeText()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeTextColor()

    Declaration
    protected bool ShouldSerializeTextColor()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeThemesEnabled()

    Declaration
    protected bool ShouldSerializeThemesEnabled()
    Returns
    Type Description
    System.Boolean

    Sort()

    Sorts the tree nodes with the current SortOrder and SortType.

    Declaration
    public void Sort()

    Sort(TreeNodeAdvSortType)

    Sorts the tree nodes with the specified sort type and the current NodeStyle.SortOrder.

    Declaration
    public void Sort(TreeNodeAdvSortType sortType)
    Parameters
    Type Name Description
    TreeNodeAdvSortType sortType

    One of the TreeNodeAdvSortType value.

    Remarks

    This will also set the value in the NodeStyle.SortOrder to the specified sort type.

    ToggleCheckState(Boolean)

    Declaration
    protected void ToggleCheckState(bool multiNodeToggle)
    Parameters
    Type Name Description
    System.Boolean multiNodeToggle

    Events

    CheckStateChanged

    Occurs when the check state of the node changes.

    Declaration
    public event EventHandler CheckStateChanged
    Event Type
    Type Description
    System.EventHandler
    Remarks

    This event will be fired when the CheckedState property of the node has changed or when a new node has been Optioned.

    You could alternatively listen to the AfterCheck event of the tree which will be called when the CheckState is changing for any node in the tree. If you want to cancel the check state change, then listen to BeforeCheck of the tree.

    Explicit Interface Implementations

    ICloneable.Clone()

    Simple memberwise clone.

    Declaration
    object ICloneable.Clone()
    Returns
    Type Description
    System.Object

    Reference on cloned object.

    IComparable.CompareTo(Object)

    Declaration
    int IComparable.CompareTo(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Int32

    Implements

    System.ICloneable
    System.IComparable
    System.ComponentModel.ISupportInitialize
    System.Runtime.Serialization.ISerializable
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved