Class TreeNavigator

TreeNavigator control provides a unique interface that can expand a tree structure in-place without taking up more space on the screen.

Inheritance
System.Object
BaseControl
TreeNavigator
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class TreeNavigator : BaseControl, IThemeProvider, IVisualStyle, IDisposable

Constructors

TreeNavigator()

Constuctor of the TreeNavigator

Declaration
public TreeNavigator()

Properties

BackColor

Declaration
public override Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

BorderColor

Gets/Sets the BorderColor

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

BorderThickness

Gets/Sets the Border Width

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

Header

Declaration
public TreeNavigator.HeaderCollection Header { get; set; }
Property Value
Type
TreeNavigator.HeaderCollection

ItemBackColor

Gets or sets the Item BackColor

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

Items

Gets or sets the value to the items of the TreeNavigator.

Declaration
public TreeMenuItemCollection Items { get; set; }
Property Value
Type
TreeMenuItemCollection

NavigationMode

Gets/Sets the Navigation Modes

Declaration
public NavigationMode NavigationMode { get; set; }
Property Value
Type
NavigationMode

PadY

Gets/Sets the TreeMenuItem PadY

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

ParentPanel

Declaration
public Panel ParentPanel { get; }
Property Value
Type
System.Windows.Forms.Panel

ScrollersFrame

Declaration
public ScrollersFrame ScrollersFrame { get; }
Property Value
Type
ScrollersFrame

SelectedItem

Gets/sets the selected item

Declaration
public TreeMenuItem SelectedItem { get; set; }
Property Value
Type
TreeMenuItem

ShowHeader

Shows/Hide the Header in the Navigation panel

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

Style

Gets of sets the style of the TreeNavigator

Declaration
public TreeNavigatorStyle Style { get; set; }
Property Value
Type
TreeNavigatorStyle

TextAlign

Gets /Sets the TextAlign

Declaration
public TextAlignment TextAlign { get; set; }
Property Value
Type
TextAlignment

ThemeStyle

Gets or sets the TreeNavigatorVisualStyle value used to customize the appearance of the TreeNavigator.

Declaration
public TreeNavigatorVisualStyle ThemeStyle { get; set; }
Property Value
Type
TreeNavigatorVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

UseTouchScrollBehavior

Gets/Sets the ScrollBehavior

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

Methods

ApplySavedScrollPosition()

To re-apply scroll position

Declaration
public void ApplySavedScrollPosition()

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type
System.Windows.Forms.AccessibleObject

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.

DrawHeader(PaintEventArgs, Rectangle)

Header area paint

Declaration
protected void DrawHeader(PaintEventArgs e, Rectangle rect)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

PaintEventArgs
System.Drawing.Rectangle rect

Gives the bounds of the Header

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName
Returns
Type
System.String
Overrides

InvalidateItems()

Declaration
public void InvalidateItems()

IsInputKey(Keys)

To get the Keyboard navigation for the control using up and down key.

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
Type Name Description
System.Windows.Forms.Keys keyData

Key date
Returns
Type Description
System.Boolean

Returns true/false according to the key data

ItemBounds()

calculates the Treemenu item bounds

Declaration
public void ItemBounds()

OnBackColorChanged(EventArgs)

Declaration
protected override void OnBackColorChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyEventArgs e

OnLayout(LayoutEventArgs)

Layout changing override

Declaration
protected override void OnLayout(LayoutEventArgs levent)
Parameters
Type Name Description
System.Windows.Forms.LayoutEventArgs levent

LayoutEventArgs

OnMouseEnter(EventArgs)

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

OnPaint(PaintEventArgs)

Onpaint override

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

PaintEventArgs

OnRightToLeftChanged(EventArgs)

RTL override

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs

OnSizeChanged(EventArgs)

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnTextChanged(EventArgs)

Declaration
protected override void OnTextChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

ResetBorderColor()

Resets the BorderColor

Declaration
public void ResetBorderColor()

ResetBorderThickness()

Resets the HeaderColor

Declaration
public void ResetBorderThickness()

ResetItems()

Resets the Items

Declaration
public void ResetItems()

ResetNavigationMode()

Resets the NavigationMode

Declaration
public void ResetNavigationMode()

ResetPadY()

Resets the PadY

Declaration
public void ResetPadY()

ResetPrevSelectedItem()

Resets the PrevSelectedItem

Declaration
public void ResetPrevSelectedItem()

ResetSelectedItem()

Resets the selected item

Declaration
public void ResetSelectedItem()

ResetShowHeader()

Resets the ShowHeader

Declaration
public void ResetShowHeader()

ResetTextAlign()

Resets the TextAlign

Declaration
public void ResetTextAlign()

ResetUseTouchScrollBehavior()

Resets the UseTouchScrollBehavior

Declaration
public void ResetUseTouchScrollBehavior()

SerializeScrollPosition()

To serialize Vertical scroll value

Declaration
public void SerializeScrollPosition()

ShouldSerializeBorderColor()

Serialize the BorderColor

Declaration
public bool ShouldSerializeBorderColor()
Returns
Type Description
System.Boolean

Returns true if the BorderColor has default color

ShouldSerializeBorderThickness()

Serialize the HeaderColor

Declaration
public bool ShouldSerializeBorderThickness()
Returns
Type Description
System.Boolean

Returns true if the border thickness is 2

ShouldSerializeNavigationMode()

Serialize the NavigationModes

Declaration
public bool ShouldSerializeNavigationMode()
Returns
Type Description
System.Boolean

Returns true if NavigationMode is default

ShouldSerializePadY()

Serialize the PadY

Declaration
public bool ShouldSerializePadY()
Returns
Type Description
System.Boolean

Returns true if the PadY is 2

ShouldSerializePrevSelectedItem()

Serializes PrevSelectedItem

Declaration
public bool ShouldSerializePrevSelectedItem()
Returns
Type Description
System.Boolean

Returns true if the Selected Item is null

ShouldSerializeSelectedItem()

Serializes Selected items

Declaration
public bool ShouldSerializeSelectedItem()
Returns
Type Description
System.Boolean

Returns true if the Selected Item is null

ShouldSerializeShowHeader()

Serialize the ShowHeader

Declaration
public bool ShouldSerializeShowHeader()
Returns
Type Description
System.Boolean

Returns true if the ShowHeader is true

ShouldSerializeTextAlign()

Serialize the TextAlignt

Declaration
public bool ShouldSerializeTextAlign()
Returns
Type Description
System.Boolean

Returns true if the TextAlingment is Left

ShouldSerializeUseTouchScrollBehavior()

Serialize the UseTouchScrollBehavior

Declaration
public bool ShouldSerializeUseTouchScrollBehavior()
Returns
Type Description
System.Boolean

Returns true if the UseTouchScrollBehavior is true

UpdateVisibleItemBounds()

To update visible item bounds

Declaration
public void UpdateVisibleItemBounds()

Events

SelectionChanged

Occurs after the selection of the TreeMenuItem changes

Declaration
public event SelectionStateChangedEventHandler SelectionChanged
Event Type
Type
SelectionStateChangedEventHandler

SelectionChanging

Occurs before the selection of the TreeMenuItem changes

Declaration
public event SelectionStateChangingEventHandler SelectionChanging
Event Type
Type
SelectionStateChangingEventHandler

Implements

System.IDisposable