Skip to end of metadata
Go to start of metadata

WebTreeView.NET® 1.0 is Intersoft’s latest ASP.NET server control which enables you to easily create a hierarchical data presentation.

Definition

public class WebTreeView : ISNetControl,

INamingContainer, ITemplateSync, ICompositeControlDesignerAccessor, ICustomXmlSerializer,

ISDataSource, IDataSourceControlSupport, IPostBackEventHandler, IFlyPostBack,

IClientAction

Summary

The following table summarizes the members exposed in this class.

Public Constructors

WebTreeView Constructor() Initializes a new instance of the WebTreeView class.

Protected Constructors

Public Properties

ActionName
AllowAddNode Indicates whether to allow node adding or not.
AllowCollapseNodeOnSelect Indicates whether to collapse a parent node when it is selected.
AllowDeleteNode Indicates whether to allow node deleting or not.
AllowDragDrop Specifies whether to allow drag and drop of the tree nodes.
AllowDropFromOtherControls Indicates whether to allow dropping from other Intersoft's controls.
AllowEnterMenu
AllowExpandNodeOnSelect Indicates whether to expand a parent node when it is selected.
AllowExpandSinglePath Indicates whether to collapse the other paths when expanding a node, ensuring that only one path is expanded.
AllowKeyboardNavigation Indicates whether to allow keyboard navigation or not.
AllowMultipleSelect Specifies whether to allow multiple select on TreeView nodes.
AllowNodeEditing Indicates whether to allow node editing.
AutoCheckChildNodes Indicates whether to automatically check child nodes.
AutoGenerateDataBindings Specifies whether WebTreeView retrieves data from a datasource and bind it automatically.
AutoPostBackSettings Contains auto postback settings such as OnNodeMove, OnNodeExpand, OnNodeCollapse, etc.
AutoSelectOnNodeExpandCollapse Indicates whether to automatically select node when a node is expanded/collapsed.
CheckBoxType Gets or sets the type of node's checkbox, whether to use image or standard checkbox.
CheckedNodes Determines the collection of checked nodes.
ClientAction Returns ClientSideAction class.
ClientSideEvents Contains WebTreeView's JavaScript client-side event.
DataBindings A collection of properties available for data bound node.
DataMember Gets or sets the data member.
DataSource Specifies the type of WebTreeView's datasource.
DataSourceID Gets or sets the ID of the control which TreeView control retrieves its list.
DefaultAllowNodeEditing
DefaultImageHeight Gets or sets the default image height (in pixel) which will be used as an icon images.
DefaultImageWidth Gets or sets the default image width (in pixel) which will be used as an icon images.
DefaultPathSeparator Gets or sets the default path separator symbol.
DragDropSettings Contains drag and drop settings such as AllowRootDrop, AllowChildDrop, and AllowSiblingDrop.
EnableLoadOnDemand Indicates whether to allow LoadOnDemand or not.
EnableTriStateCheckBox Specifies whether to allow TriState checkbox or not.
EnableTriStateCheckBoxParentInIndeterminateState
ExpandCollapseImageHeight Gets or sets the default image height (in pixel) which will be used as an expand/collapse image.
ExpandCollapseImageWidth Gets or sets the default image width (in pixel) which will be used as an expand/collapse image.
ExpandedDepth Determines whether all specified nodes (based on their depth) are expanded (initially and on postback) or not
FlyPostBackSettings Configures the settings used by the control when performing OnTheFly postback.
Font Gets or sets the font of node's text.
FormKey
FrameStyle Style applied to the frame of the control.
ImagesDirectory Gets or sets the location of the images used for rendering the control.
ImagesSettings Contains image settings for WebTreeView.
IsDataBindingPerformed
IsFlyPostBack Returns whether the specified WebTreeView instance invokes OnTheFly postback.
LineImageHeight Gets or sets the height (in pixel) of the line images.
LineImageWidth Gets or sets the width (in pixel) of the line images.
LoadingStyle Gets or sets the style used when loading LoadOnDemand content.
LoadingText Gets or sets the text used when loading LoadOnDemand content.
MaxDataBindDepth Gets or sets the depth to which TreeView will be bound.
NodeIndent Gets or sets the width (in pixel) of indentation on each level of the node.
NodeIndex
Nodes Specifies a collection of WebTreeView's nodes.
NodeSettings Contains node settings such as TargetWindow and EnableAnimation.
NodeStyle Gets or sets the style of a node.
PathSeparator Specifies the character used to separate parts of the path.
PersistInfoDuringLoadOnDemand
PostBackData
PostBackModeType Gets or sets the type of postback mode, whether to use flypostback or fullpostback.
ScriptDirectory Gets or sets the location of the required scripts used by WebTreeView.
SelectedNode Specifies a selected node.
SelectedNodes Specifies a collection of the selected nodes.
SharedScriptDirectory Gets or sets the directory where all required framework scripts for the control are stored.
ShowCheckBoxes Gets or sets which node level will have checkbox shown on it.
ShowExpandCollapse Specifies whether to show the expand/collapse icon next to the nodes.
ShowLines Specifies whether to show lines connecting the tree nodes.
XPath Specifies an initial XPath that is applied to the XML data.

Protected Properties

Static Methods

Public Methods

AddNode() Adds a new node to a WebTreeView instance with no parameter.
AddNode(string) Adds a new node to a WebTreeView instance (the new node will be a root node) with String parameter as its name.
CheckAll()
CheckConstrains()
CollapseAll()
DataBind()
ExpandAll()
FindNodeByPath(string)
GetClientAction()
GetObjectData(SerializationInfo, StreamingContext)
GetXMLData()
LoadNodesFromXml(string) Loads WebTreeView's node structure from an XML file based on the XML value.
LoadNodesFromXml(XmlDocument) Loads WebTreeView's node structure from an XML document with XMLDocument parameter.
LoadPostData(string, NameValueCollection)
OnRequest(object)
RaiseDragDropEvent(WebTreeViewNode, List<WebTreeViewNode>, NodeMoveType, NodeMoveInsertionMode)
RaiseInitializeChildNodesEvent(WebTreeViewNode)
RaiseInitializeNodeEvent(WebTreeViewNode)
RaiseNodeAddEvent(WebTreeViewNode)
RaiseNodeCheckChangedEvent(WebTreeViewNode)
RaiseNodeCollapseEvent(WebTreeViewNode)
RaiseNodeCopyEvent(WebTreeViewNode, WebTreeViewNode)
RaiseNodeDeleteEvent(WebTreeViewNode)
RaiseNodeEditEvent(WebTreeViewNode, string)
RaiseNodeExpandEvent(WebTreeViewNode)
RaiseNodeMoveEvent(WebTreeViewNode, WebTreeViewNode, NodeMoveType, NodeMoveInsertionMode)
RaiseNodeRenameEvent(string, WebTreeViewNode)
RaiseNodeSelectChangedEvent(WebTreeViewNode)
RaiseNodeUpdatedEvent(WebTreeViewNode, string, object, object)
RaisePostBackEvent(string)
RecreateChildControls()
RegisterScript()
RenderEndTag(HtmlTextWriter)
SaveNodesToXml(string) Saves WebTreeView's structure to an XML file with String parameter as the filename of XML.
SaveNodesToXml() Saves WebTreeView's structure to an XML file with no parameter.
SetDataSourceInternal(object)
SynchronizeTemplatesFrom(ISNetControl)
UnCheckAll()

Protected Methods

Events

DragDrop
InitializeChildNodes Fires when child nodes need to be initialized during databinding.
InitializeNode Fires when node is initialized and about to be rendered.
NodeAdd Fires when node is added successfully.
NodeCheckChanged Fires after a TreeView node is checked or unchecked.
NodeCollapse Fires after a TreeView node is collapsed.
NodeCopy Fires after a TreeView node is copied.
NodeDelete Fires when node is deleted successfully.
NodeEdit Fires when node is edited successfully.
NodeExpand Fires after a TreeView node is expanded.
NodeMove Fires after a TreeView node is moved.
NodeRename Fires after a TreeView node is renamed.
NodeSelectChanged Fires after the selected TreeView node has changed.
NodeUpdated Fires after the selected treeview nodes are changed.

Public Constructors

public WebTreeView()

Protected Constructors

protected WebTreeView(SerializationInfo info, StreamingContext context)

Parameters

info
context

Public Properties

public string ActionName { get; set; }

public bool AllowAddNode { get; set; }

Indicates whether to allow node adding or not.

public bool AllowCollapseNodeOnSelect { get; set; }

Indicates whether to collapse a parent node when it is selected.

public bool AllowDeleteNode { get; set; }

Indicates whether to allow node deleting or not.

public bool AllowDragDrop { get; set; }

Specifies whether to allow drag and drop of the tree nodes.

public bool AllowDropFromOtherControls { get; set; }

Indicates whether to allow dropping from other Intersoft's controls.

public bool AllowEnterMenu { get; set; }

public bool AllowExpandNodeOnSelect { get; set; }

Indicates whether to expand a parent node when it is selected.

public bool AllowExpandSinglePath { get; set; }

Indicates whether to collapse the other paths when expanding a node, ensuring that only one path is expanded.

public bool AllowKeyboardNavigation { get; set; }

Indicates whether to allow keyboard navigation or not.

public bool AllowMultipleSelect { get; set; }

Specifies whether to allow multiple select on TreeView nodes.

public AllowEditing AllowNodeEditing { get; set; }

Indicates whether to allow node editing.

public bool AutoCheckChildNodes { get; set; }

Indicates whether to automatically check child nodes.

public bool AutoGenerateDataBindings { get; set; }

Specifies whether WebTreeView retrieves data from a datasource and bind it automatically.

public WebTreeViewAutoPostBackSettings AutoPostBackSettings { get; set; }

Contains auto postback settings such as OnNodeMove, OnNodeExpand, OnNodeCollapse, etc.

public bool AutoSelectOnNodeExpandCollapse { get; set; }

Indicates whether to automatically select node when a node is expanded/collapsed.

public CheckBoxType CheckBoxType { get; set; }

Gets or sets the type of node's checkbox, whether to use image or standard checkbox.

public ArrayList CheckedNodes { get; }

Determines the collection of checked nodes.

public BaseClientSideAction ClientAction { get; }

Returns ClientSideAction class.

public WebTreeViewClientSideEvents ClientSideEvents { get; set; }

Contains WebTreeView's JavaScript client-side event.

public WebTreeViewNodeBindingCollection DataBindings { get; }

A collection of properties available for data bound node.

public string DataMember { get; set; }

Gets or sets the data member.

public object DataSource { get; set; }

Specifies the type of WebTreeView's datasource.

public string DataSourceID { get; set; }

Gets or sets the ID of the control which TreeView control retrieves its list.

public AllowEditing DefaultAllowNodeEditing { get; }

public int DefaultImageHeight { get; set; }

Gets or sets the default image height (in pixel) which will be used as an icon images.

public int DefaultImageWidth { get; set; }

Gets or sets the default image width (in pixel) which will be used as an icon images.

public string DefaultPathSeparator { get; }

Gets or sets the default path separator symbol.

public WebTreeViewDragDropSettings DragDropSettings { get; set; }

Contains drag and drop settings such as AllowRootDrop, AllowChildDrop, and AllowSiblingDrop.

public bool EnableLoadOnDemand { get; set; }

Indicates whether to allow LoadOnDemand or not.

public bool EnableTriStateCheckBox { get; set; }

Specifies whether to allow TriState checkbox or not.

public bool EnableTriStateCheckBoxParentInIndeterminateState { get; set; }

public int ExpandCollapseImageHeight { get; set; }

Gets or sets the default image height (in pixel) which will be used as an expand/collapse image.

public int ExpandCollapseImageWidth { get; set; }

Gets or sets the default image width (in pixel) which will be used as an expand/collapse image.

public int ExpandedDepth { get; set; }

Determines whether all specified nodes (based on their depth) are expanded (initially and on postback) or not

public FlyPostBackSettings FlyPostBackSettings { get; }

Configures the settings used by the control when performing OnTheFly postback.

public FontInfo Font { get; }

Gets or sets the font of node's text.

public string FormKey { get; }

public WebStyle FrameStyle { get; set; }

Style applied to the frame of the control.

public string ImagesDirectory { get; set; }

Gets or sets the location of the images used for rendering the control.

public WebTreeViewImagesSettings ImagesSettings { get; set; }

Contains image settings for WebTreeView.

public bool IsDataBindingPerformed { get; set; }

public bool IsFlyPostBack { get; set; }

Returns whether the specified WebTreeView instance invokes OnTheFly postback.

public int LineImageHeight { get; set; }

Gets or sets the height (in pixel) of the line images.

public int LineImageWidth { get; set; }

Gets or sets the width (in pixel) of the line images.

public WebStyle LoadingStyle { get; set; }

Gets or sets the style used when loading LoadOnDemand content.

public string LoadingText { get; set; }

Gets or sets the text used when loading LoadOnDemand content.

public int MaxDataBindDepth { get; set; }

Gets or sets the depth to which TreeView will be bound.

public int NodeIndent { get; set; }

Gets or sets the width (in pixel) of indentation on each level of the node.

public int NodeIndex { get; set; }

public WebTreeViewNodeCollection Nodes { get; }

Specifies a collection of WebTreeView's nodes.

public WebTreeViewNodeSettings NodeSettings { get; set; }

Contains node settings such as TargetWindow and EnableAnimation.

public DynamicStyle NodeStyle { get; set; }

Gets or sets the style of a node.

public string PathSeparator { get; set; }

Specifies the character used to separate parts of the path.

public bool PersistInfoDuringLoadOnDemand { get; set; }

public string PostBackData { get; set; }

public PostBackMode PostBackModeType { get; set; }

Gets or sets the type of postback mode, whether to use flypostback or fullpostback.

public string ScriptDirectory { get; set; }

Gets or sets the location of the required scripts used by WebTreeView.

public WebTreeViewNode SelectedNode { get; }

Specifies a selected node.

public ArrayList SelectedNodes { get; }

Specifies a collection of the selected nodes.

public string SharedScriptDirectory { get; set; }

Gets or sets the directory where all required framework scripts for the control are stored.

public CheckBoxLocation ShowCheckBoxes { get; set; }

Gets or sets which node level will have checkbox shown on it.

public bool ShowExpandCollapse { get; set; }

Specifies whether to show the expand/collapse icon next to the nodes.

public bool ShowLines { get; set; }

Specifies whether to show lines connecting the tree nodes.

public string XPath { get; set; }

Specifies an initial XPath that is applied to the XML data.

Protected Properties

protected string DefaultImagesFolder { get; }

protected LicType LicenseType { get; set; }

protected ProductInfo Product { get; }

protected Icon ProductIcon { get; }

protected Image ProductImage { get; }

protected bool SupportDataSourceControl { get; }

Static Methods

public static XmlNode CreateNode(XmlDocument x, string tagName, string sValue)

Parameters

x
tagName
sValue

Public Methods

public WebTreeViewNode AddNode()

Adds a new node to a WebTreeView instance with no parameter.

public WebTreeViewNode AddNode(string name)

Adds a new node to a WebTreeView instance (the new node will be a root node) with String parameter as its name.

Parameters

name

public void CheckAll()

public void CheckConstrains()

public void CollapseAll()

public void DataBind()

public void ExpandAll()

public WebTreeViewNode FindNodeByPath(string path)

Parameters

path

public BaseClientSideAction GetClientAction()

public void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

info
context

public string GetXMLData()

public void LoadNodesFromXml(string fileName)

Loads WebTreeView's node structure from an XML file based on the XML value.

Parameters

fileName

public void LoadNodesFromXml(XmlDocument doc)

Loads WebTreeView's node structure from an XML document with XMLDocument parameter.

Parameters

doc

public bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters

postDataKey
postCollection

public void OnRequest(object requestObject)

Parameters

requestObject

public void RaiseDragDropEvent(WebTreeViewNode node, List<WebTreeViewNode> draggedNodesCol, NodeMoveType moveType, NodeMoveInsertionMode insertionMode)

Parameters

node
draggedNodesCol
moveType
insertionMode

public void RaiseInitializeChildNodesEvent(WebTreeViewNode node)

Parameters

node

public void RaiseInitializeNodeEvent(WebTreeViewNode node)

Parameters

node

public void RaiseNodeAddEvent(WebTreeViewNode node)

Parameters

node

public void RaiseNodeCheckChangedEvent(WebTreeViewNode node)

Parameters

node

public void RaiseNodeCollapseEvent(WebTreeViewNode node)

Parameters

node

public void RaiseNodeCopyEvent(WebTreeViewNode copiedFrom, WebTreeViewNode node)

Parameters

copiedFrom
node

public void RaiseNodeDeleteEvent(WebTreeViewNode node)

Parameters

node

public void RaiseNodeEditEvent(WebTreeViewNode node, string oldText)

Parameters

node
oldText

public void RaiseNodeExpandEvent(WebTreeViewNode node)

Parameters

node

public void RaiseNodeMoveEvent(WebTreeViewNode sourceNode, WebTreeViewNode targetNode, NodeMoveType moveType, NodeMoveInsertionMode insertionMode)

Parameters

sourceNode
targetNode
moveType
insertionMode

public void RaiseNodeRenameEvent(string oldText, WebTreeViewNode node)

Parameters

oldText
node

public void RaiseNodeSelectChangedEvent(WebTreeViewNode node)

Parameters

node

public void RaiseNodeUpdatedEvent(WebTreeViewNode node, string propertyName, object value, object oldValue)

Parameters

node
propertyName
value
oldValue

public void RaisePostBackEvent(string eventArgument)

Parameters

eventArgument

public void RecreateChildControls()

public void RegisterScript()

public void RenderEndTag(HtmlTextWriter writer)

Parameters

writer

public void SaveNodesToXml(string fileName)

Saves WebTreeView's structure to an XML file with String parameter as the filename of XML.

Parameters

fileName

public XmlDocument SaveNodesToXml()

Saves WebTreeView's structure to an XML file with no parameter.

public void SetDataSourceInternal(object dataSource)

Parameters

dataSource

public void SynchronizeTemplatesFrom(ISNetControl control)

Parameters

control

public void UnCheckAll()

Protected Methods

protected void CreateChildControls()

protected RenderDHTML GetDHTMLRenderer()

protected void InitializeDefaultStyles()

protected void LoadViewState(object savedState)

Parameters

savedState

protected void OnInit(EventArgs e)

Parameters

e

protected void OnPreRender(EventArgs e)

Parameters

e

protected void RenderContents(HtmlTextWriter writer)

Parameters

writer

protected object SaveViewState()

Events

public event EventHandler<WebTreeViewDragDropEventArgs> DragDrop

public event InitializeChildNodesEventHandler InitializeChildNodes

Fires when child nodes need to be initialized during databinding.

public event InitializeNodeEventHandler InitializeNode

Fires when node is initialized and about to be rendered.

public event NodeAddEventHandler NodeAdd

Fires when node is added successfully.

public event NodeCheckChangedEventHandler NodeCheckChanged

Fires after a TreeView node is checked or unchecked.

public event NodeCollapseEventHandler NodeCollapse

Fires after a TreeView node is collapsed.

public event NodeCopyEventHandler NodeCopy

Fires after a TreeView node is copied.

public event NodeDeleteEventHandler NodeDelete

Fires when node is deleted successfully.

public event NodeEditEventHandler NodeEdit

Fires when node is edited successfully.

public event NodeExpandEventHandler NodeExpand

Fires after a TreeView node is expanded.

public event NodeMoveEventHandler NodeMove

Fires after a TreeView node is moved.

public event NodeRenameEventHandler NodeRename

Fires after a TreeView node is renamed.

public event NodeSelectChangedEventHandler NodeSelectChanged

Fires after the selected TreeView node has changed.

public event NodeUpdatedEventHandler NodeUpdated

Fires after the selected treeview nodes are changed.

  • No labels