Class TreeViewProperties
Represents the TreeView properties
Inheritance
System.Object
TreeViewProperties
Inherited Members
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()
Assembly: Syncfusion.EJ.dll
Syntax
public class TreeViewProperties : EJTagHelper
Constructors
TreeViewProperties()
Declaration
public TreeViewProperties()
Properties
AllowDragAndDrop
Gets or sets a value that indicates whether to enable drag and drop a node within the same tree.
Declaration
[JsonProperty("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowDragAndDropAcrossControl
Gets or sets a value that indicates whether to enable drag and drop a node in inter ej.TreeView.
Declaration
[JsonProperty("allowDragAndDropAcrossControl")]
public bool AllowDragAndDropAcrossControl { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowDropChild
Gets or sets a value that indicates whether to drop a node to a child of particular node.
Declaration
[JsonProperty("allowDropChild")]
public bool AllowDropChild { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowDropSibling
Gets or sets a value that indicates whether to drop a node to a sibling of particular node.
Declaration
[JsonProperty("allowDropSibling")]
public bool AllowDropSibling { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowEditing
Gets or sets a value that indicates whether to enable node editing support for TreeView.
Declaration
[JsonProperty("allowEditing")]
public bool AllowEditing { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowKeyboardNavigation
Gets or sets a value that indicates whether to enable keyboard support for TreeView actions like nodeSelection, nodeEditing, nodeExpand, nodeCollapse, nodeCut and Paste.
Declaration
[JsonProperty("allowKeyboardNavigation")]
public bool AllowKeyboardNavigation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowMultiSelection
Gets or sets a value that indicates whether to enable or disable the multi selection in TreeView.
Declaration
[JsonProperty("allowMultiSelection")]
public bool AllowMultiSelection { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AutoCheck
Allow us to specify the parent and child nodes to get auto check while we check or uncheck a node.
Declaration
[JsonProperty("autoCheck")]
public bool AutoCheck { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AutoCheckParentNode
Allow us to specify the parent node to be retain in checked or unchecked state instead of going for indeterminate state.
Declaration
[JsonProperty("autoCheckParentNode")]
public bool AutoCheckParentNode { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
BeforeAdd
Fires before adding node to TreeView.
Declaration
[JsonProperty("beforeAdd")]
public string BeforeAdd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforeCollapse
Fires before collapse a node.
Declaration
[JsonProperty("beforeCollapse")]
public string BeforeCollapse { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforeCut
Fires before cut node in TreeView.
Declaration
[JsonProperty("beforeCut")]
public string BeforeCut { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforeDelete
Fires before deleting node in TreeView.
Declaration
[JsonProperty("beforeDelete")]
public string BeforeDelete { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforeEdit
Fires before editing the node in TreeView.
Declaration
[JsonProperty("beforeEdit")]
public string BeforeEdit { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforeExpand
Fires before expanding the node.
Declaration
[JsonProperty("beforeExpand")]
public string BeforeExpand { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforeLoad
Fires before loading nodes to TreeView.
Declaration
[JsonProperty("beforeLoad")]
public string BeforeLoad { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforePaste
Fires before paste node in TreeView.
Declaration
[JsonProperty("beforePaste")]
public string BeforePaste { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BeforeSelect
Fires before selecting node in TreeView.
Declaration
[JsonProperty("beforeSelect")]
public string BeforeSelect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CheckedNodes
Gets or sets a value that indicates the checkedNodes index collection as an array. The given array index position denotes the nodes, that are checked while rendering TreeView.
Declaration
[JsonProperty("checkedNodes")]
public List<int> CheckedNodes { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.List<System.Int32> |
|
Create
Fires when TreeView created successfully.
Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CssClass
Sets the root CSS class for TreeView which allow us to customize the appearance.
Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Destroy
Fires when TreeView destroyed successfully.
Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
| Type |
Description |
| System.String |
|
EmptyDataText
Declaration
public string EmptyDataText { get; set; }
Property Value
| Type |
Description |
| System.String |
|
EnableAnimation
Gets or sets a value that indicates whether to enable or disable the animation effect while expanding or collapsing a node.
Declaration
[JsonProperty("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Enabled
Gets or sets a value that indicates whether a TreeView can be enabled or disabled. No actions can be performed while this property is set as false.
Declaration
[JsonProperty("enabled")]
public bool Enabled { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableMultipleExpand
Allow us to prevent multiple nodes to be in expanded state. If it set to false, previously expanded sibling node will be collapsed automatically, while we expand a node.
Declaration
[JsonProperty("enableMultipleExpand")]
public bool EnableMultipleExpand { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnablePersistence
Sets a value that indicates whether to persist the TreeView model state in page using applicable medium i.e., HTML5 localStorage or cookies.
Declaration
[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableRTL
Gets or sets a value that indicates to align content in the TreeView control from right to left by setting the property as true.
Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
ExpandedNodes
Gets or sets a array of value that indicates the expandedNodes index collection as an array. The given array index position denotes the nodes, that are expanded while rendering TreeView.
Declaration
[JsonProperty("expandedNodes")]
public List<int> ExpandedNodes { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.List<System.Int32> |
|
ExpandOn
Gets or sets a value that indicates the TreeView node can be expand or collapse by using the specified action.
Declaration
[JsonProperty("expandOn")]
public string ExpandOn { get; set; }
Property Value
| Type |
Description |
| System.String |
|
FullRowSelect
Gets or sets a value that indicates whether to enable or disable the full row selection in TreeView.
Declaration
[JsonProperty("fullRowSelect")]
public bool FullRowSelect { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Height
Defines the height of the TreeView.
Declaration
[JsonProperty("height")]
public string Height { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HtmlAttributes
Specified the custom attributes will be added to TreeView control.
Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.IDictionary<System.String, System.Object> |
|
InlineEditValidation
Fires before nodeEdit Successful.
Declaration
[JsonProperty("inlineEditValidation")]
public string InlineEditValidation { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Items
Declaration
[JsonIgnore]
public List<TreeViewBaseItem> Items { get; set; }
Property Value
KeyPress
Fires when key pressed successfully.
Declaration
[JsonProperty("keyPress")]
public string KeyPress { get; set; }
Property Value
| Type |
Description |
| System.String |
|
LoadError
Fires when data load fails.
Declaration
[JsonProperty("loadError")]
public string LoadError { get; set; }
Property Value
| Type |
Description |
| System.String |
|
LoadOnDemand
Specifies the child nodes to be loaded on demand.
Declaration
[JsonProperty("loadOnDemand")]
public bool LoadOnDemand { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
LoadSuccess
Fires when data loaded successfully.
Declaration
[JsonProperty("loadSuccess")]
public string LoadSuccess { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeAdd
Fires once node added successfully.
Declaration
[JsonProperty("nodeAdd")]
public string NodeAdd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeCheck
Fires once node checked successfully.
Declaration
[JsonProperty("nodeCheck")]
public string NodeCheck { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeClick
Fires when node clicked successfully.
Declaration
[JsonProperty("nodeClick")]
public string NodeClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeCollapse
Fires when node collapsed successfully.
Declaration
[JsonProperty("nodeCollapse")]
public string NodeCollapse { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeCut
Fires when node cut successfully.
Declaration
[JsonProperty("nodeCut")]
public string NodeCut { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeDelete
Fires when node deleted successfully.
Declaration
[JsonProperty("nodeDelete")]
public string NodeDelete { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeDrag
Fires when node dragging.
Declaration
[JsonProperty("nodeDrag")]
public string NodeDrag { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeDragStart
Fires once node drag start successfully.
Declaration
[JsonProperty("nodeDragStart")]
public string NodeDragStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeDragStop
Fires before the dragged node to be dropped.
Declaration
[JsonProperty("nodeDragStop")]
public string NodeDragStop { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeDropped
Fires once node dropped successfully.
Declaration
[JsonProperty("nodeDropped")]
public string NodeDropped { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeEdit
Fires once node edited successfully.
Declaration
[JsonProperty("nodeEdit")]
public string NodeEdit { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeExpand
Fires once node expanded successfully.
Declaration
[JsonProperty("nodeExpand")]
public string NodeExpand { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodePaste
Fires once node pasted successfully.
Declaration
[JsonProperty("nodePaste")]
public string NodePaste { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeSelect
Fires when node selected successfully.
Declaration
[JsonProperty("nodeSelect")]
public string NodeSelect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeUncheck
Fires once node unchecked successfully.
Declaration
[JsonProperty("nodeUncheck")]
public string NodeUncheck { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NodeUnselect
Fires when node is unselected successfully.
Declaration
[JsonProperty("nodeUnselect")]
public string NodeUnselect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Ready
Fires when TreeView nodes are loaded successfully.
Declaration
[JsonProperty("ready")]
public string Ready { get; set; }
Property Value
| Type |
Description |
| System.String |
|
SelectedNode
Gets or Sets a value that indicates the index position of a tree node. The particular index tree node will be selected while rendering the TreeView.
Declaration
[JsonProperty("selectedNode")]
public int SelectedNode { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
SelectedNodes
Gets or sets a value that indicates the selectedNodes index collection as an array. The given array index position denotes the nodes, that are selectedNodes while rendering TreeView.
Declaration
[JsonProperty("selectedNodes")]
public List<int> SelectedNodes { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.List<System.Int32> |
|
ShowCheckbox
Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes.
Declaration
[JsonProperty("showCheckbox")]
public bool ShowCheckbox { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
SortSettings
By using sortSettings property, you can customize the sorting option in TreeView control.
Declaration
[JsonProperty("sortSettings")]
public object SortSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
Template
Allow us to use custom template in order to create TreeView.
Declaration
[JsonProperty("template")]
public string Template { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TreeViewFields
Gets or sets a fields object that allow us to map the data members with field properties in order to make the data binding easier.
Declaration
[JsonProperty("fields")]
public TreeViewFields TreeViewFields { get; set; }
Property Value
Width
Defines the width of the TreeView.
Declaration
[JsonProperty("width")]
public string Width { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Methods
GetControlDetails()
Declaration
protected override object GetControlDetails()
Returns
| Type |
Description |
| System.Object |
|
Overrides
ShouldSerializeExpandedNodes()
ShouldSerialize method for ExpandedNodes.
Declaration
public bool ShouldSerializeExpandedNodes()
Returns
| Type |
Description |
| System.Boolean |
|
ShouldSerializeTreeViewBaseItem()
ShouldSerialize method for TreeViewBaseItem.
Declaration
public bool ShouldSerializeTreeViewBaseItem()
Returns
| Type |
Description |
| System.Boolean |
|
ShouldSerializeTreeViewFields()
ShouldSerialize method for TreeViewFields.
Declaration
public bool ShouldSerializeTreeViewFields()
Returns
| Type |
Description |
| System.Boolean |
|
