Version

DataTreeNode Class Members

The following tables list the members exposed by DataTreeNode.

Public Constructors
 NameDescription
Public ConstructorDataTreeNode Constructor  
Public Properties
 NameDescription
Public PropertyActiveCssClassCustom class which is merged with default CSS class to be applied to this node in its active state.  
Public PropertyAttributesAttributeCollection property that can be used to add Html markup attributes to the UIObject which will be rendered to the Html stream during the rendering phase. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public PropertyCheckStateSets or gets the current CheckBoxState of the Node.  
Public PropertyCssClassCustom class which is merged with default CSS class to be applied to this node in its normal state.  
Public PropertyDataItemSets or gets an object value that contains a reference to the object in the data source that supplied the data for this item. (Inherited from Infragistics.Web.UI.Framework.CollectionUIObject)
Public PropertyDataPathSets or gets a string value representing the datapath into the data source used to popuplate the children of this item (if any). (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyDataTreeGets a reference to the DataTree to which this DataTreeNode belongs.  
Public PropertyDisabledCssClassCustom class which is merged with default CSS class to be applied to this node in its disabled state.  
Public PropertyDraggableSets or gets a bool value that indicates whether this node is draggable.  
Public PropertyDroppableSets or gets a bool value that indicates whether this node can accept other nodes.  
Public PropertyEditableSets or gets a bool value that indicates whether this node is editable.  
Public PropertyEnabledGets/sets whether this item is enabled (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyExpandedSets or gets a bool value that indicates if this Node is expanded or not. When true, any children of this node will be visibly rendered to the client so that the user can click on the Expand/Collapse image to toggle the expanded state.  
Public PropertyHasAttributesReturns a boolean value which indicates if the UIObject currently has any Attributes. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public PropertyHasChildrenReturns a boolean value that indicates if this object has children within the tree hierarchy. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyHoverCssClassCustom class which is merged with default CSS class to be applied to this node in its hover state.  
Public PropertyImageToolTipGets/sets the tooltip for this item's image (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyImageUrlGets/sets a url to be used for the source of this item's image (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyIndexReturns the index of this collection object within its owning collection. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyIsEmptyChecks if ViewState has any property with not a default value. This property should be overriden by extended class when additional subobjects are supported. IsEmpty will then check each subobject and return a value based on the check of those objects plus itself. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public PropertyIsEmptyParentSets or gets a boolean value that indicates whether or not this item is a parent that has yet to be populated from an Ajax request to expand the node. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyKeySet or gets a string value that can be used to uniquely identify a node, independant of its Text or Value properties. The Key property can be bound to a DataSource field using the NodeBinding.KeyField property setting. (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyLevelReturns the hierarchical level of this collection object within the tree structure. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyNavigateUrlGets/sets a string to be used as the navigate url for this item (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyNextNodeGets the next sibling node to this node within the parent Nodes collection. If this Node is the last node in the collection, then null is returned.  
Public PropertyNodesReturns a reference to the children Nodes collection of this node.  
Public PropertyOwnerReturns a reference to the collection that owns this object (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyParentItemReturns a reference to the Parent of this item. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyParentNodeReturns the parent node of this node within the tree node hierarchy.  
Public PropertyPopulatedSets or gets a boolean value that indicates whether or not this item has been populated with children. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public PropertyPreviousNodeGets the previous sibling node to this node within the parent Nodes collection. If this Node is the first node in the collection, then null is returned.  
Public PropertySelectedSets or gets a bool value that indicates if this Node is selected or not. When true, the node is highlighted in the SelectedCssClass style on the client.  
Public PropertySelectedCssClassCustom class which is merged with default CSS class to be applied to this node in its selected state.  
Public PropertyTargetSets or gets a string value that specifies an Html Frame to be used as the Target of the NavigateUrl property. When the DataTreeNode is clicked, the NavigateUrl string will be used to navigate to the specified web page and the page will be displayed in the Frame of the browser specified by this property. (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyTemplate (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public PropertyTemplateIdID of Template within the TemplateCollection. Identifies the template to use for this NavItem. (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyTextGets/sets a string to be used for the text of this item (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyToolTipGets/sets the tooltip for the item (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyValueGets/sets a string to be used for the value of this item (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public PropertyVisibleGets/sets whether this item is visible. (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyDelayLoadingClientCollectionsCustomizes the client collections loading. If true the collections will be loaded after view state has been loaded. If false the collections will be loaded in RunBot.HandleOnInit. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyFlagsStores all the ClientUIFlags into one integer, that will be passed down to the client in the Client Property Array. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected PropertyInnerItemsInitializedReturns a boolean value that indicates if the inner items collection has been initialized. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Protected PropertyIsTrackingViewStateThis method returns a boolean value which indicates whether ViewState is being tracked for the object. Once viewstate is being tracked, all property changes are roundtripped from server to client and back within the ViewState hidden field. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyPropCountOverridden. Returns the number of positional properties that are managed for Client State by this Node.  
Protected PropertyTransactionLists (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyViewStateProperty to return the ViewState bag for the object. If none exist, then one is created. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Methods
 NameDescription
Public MethodCloneOverloaded. Overridden. Creates a copy of the existing node  
Public MethodCollapseAncestorsThis method collapses all anscestor parents of this Node  
Public MethodCollapseChildrenThis method collapses all children of this Node  
Public MethodEnsureTemplateOverloaded. Instantiates this item's templates in the NavControl (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public MethodExpandAnscestorsThis method expands all anscestor parents of this Node  
Public MethodExpandChildrenThis method expands all children of this Node  
Public MethodFindControlThis method searches for a locates control objects within the TemplateContainer associated with this UIObject by using the Id parameter to match against control Ids. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public MethodGetFullPathReturns a string that identifies this nav item (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Public MethodIsAncestorOfThis method returns a boolean value that indicates if the object is an ancestor of the item passed in. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public MethodIsDescendantOfThis method returns a boolean value that indicates if the object is a descendant of the item passed in. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Public MethodIsDirtyOverloaded. Public shortcut to check if object has had data changes Derived classes must override this method if they conain subobjects in addition to Style or Attributes so that the item will be saved to ViewState if the subobject is dirty. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public MethodRemoveThis method removes this Node from the Nodes collection of its ParentNode.  
Protected Methods
 NameDescription
Protected MethodCreateNewInstanceCreates a new instance of the current type using the default constructor. Derived classes may override the method if there is no parameterless constructor or any other custom logic applies. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodEnsureFlagTo be used in EnsureFlags. This method stores the ClientUIFlag in the private flags Hashtable. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodEnsureFlagsOverridden.   
Protected MethodFlushEmpties the positional and occasional property stringBuffers and converts them to a string representation that can be written to the response stream. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetClientPropertiesArray (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodInitializeReferencesUsed by Control Developers only Allows external assemblies to access the internal initializer for objects that have child collections. (Inherited from Infragistics.Web.UI.Framework.HierarchicalUIObject)
Protected MethodLoadAdditionalClientStateThis method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsLoads the Collections that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsLoads the Objects that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsTransactionListReads the Transaction List and repopulates the objects of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientPropsTransactionListReads the Transaction List and repopulates the properties of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateThis method takes the state from the client and loads the control's Properties, Objects, and Collections, that were sent down to the client on the last post. It also stores the TransactionLists for the Properties, Objects, and Collections. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateFromViewStateChecks to see if ClientState was saved into Viewstate, if so, then it loads. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadCollectionsStateFromViewStateLoads the saved into view state client collections and deserializes the string as it came from the client side. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperty (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertiesLoads client state properties from the client (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertyLoad positional property at index (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadTransactionListLoads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadViewStateThis method overrides the base LoadViewState implementation to add LoadViewState processing for the ControlStyle and Attributes collections. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodOnPropertyChangeOverloaded. Virtual method that is called whenever a server state property within the object has been changed. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodResetClientStateResets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientCollectionsSaves all Collections that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientObjectsSaves all objects that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientPropertiesOverloaded. Overrides the SaveClientProperties method to add the UI Flags to the ClientState properties. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodSaveClientStateToViewStateIf the control is not visible, we don't want to loose our ClientState during the next postback, so lets store it in ViewState. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveCollectionsStateToViewStateSaves the client collections state as string into the view state. This way we can skip the expensive serialization on the client side and not send them at all. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveViewStateSaves this objects objects into an array for the view state (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Protected MethodTrackViewStateEnables view state tracking for sub objects (Inherited from Infragistics.Web.UI.NavigationControls.NavItem)
Protected MethodWriteAdditionalClientPropertiesIf an object needs to render additional information that needs to be accessed on the client, this is where they can add this information. Note that each object that they need to render should be prefixed with a Comma because the information is being rendered inside of a javascript array. This method is called by WriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientCollections (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientObjects (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientOnlyPropertyStores the property in hashtable, that will be rendered down to the client. Client only properties only get sent down to the client, they do not get sent back to the server. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientStateResponsible for rendering javascript array of all client properties, events, objects and collections Calls helper methods to render each in turn. That method is called to render parameter for initialization (constructor) java-script function. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWritePositionalPropertyWrites the passed in property value at the current position of the ClientState serialization. The property is serialized to the positional properties string of the ClientState string. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
See Also