Version

UltraTreeNode Class Members

The following tables list the members exposed by UltraTreeNode.

Public Constructors
 NameDescription
Public ConstructorUltraTreeNode ConstructorOverloaded.   
Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAccessibilityObjectReturns the accesible object representing the data area of the grid.  
Public PropertyAllowAutoDragExpandResolvedThe resolved Override.AllowAutoDragExpand of the node. If a Override.AllowAutoDragExpand has been specified, it is returned. Otherwise the default is returned.  
Public PropertyAllowCellEditGets/sets whether cells contained by this UltraTreeNode can be edited by the end user.  
Public PropertyAllowCopyResolvedThe resolved Override.AllowCopy of the node. If a Override.AllowCopy has been specified, it is returned. Otherwise the default is returned.  
Public PropertyAllowCutResolvedThe resolved Override.AllowCut of the node. If a Override.AllowCut has been specified, it is returned. Otherwise the default is returned.  
Public PropertyAllowDeleteResolvedThe resolved Override.AllowDelete of the node. If a Override.AllowDelete has been specified, it is returned. Otherwise the default is returned.  
Public PropertyAllowPasteResolvedThe resolved Override.AllowPaste of the node. If a Override.AllowPaste has been specified, it is returned. Otherwise the default is returned.  
Public PropertyBandNameGets the name of the band in the underlying data source to which node belongs.  
Public PropertyBorderStyleNodeResolvedThe resolved Override.BorderStyleNode of the node. If a Override.BorderStyleNode has been specified, it is returned. Otherwise the default is returned.  
Public PropertyBoundsReturns the bounding rectangle of the UltraTreeNode.  
Public PropertyCellsReturns the TreeNodeCellsCollection which contains the cells for this UltraTreeNode.  
Public PropertyCheckedStateGets/sets a value indicating the checked state of the UltraTreeNode.  
Public PropertyControlReturns the control that the UltraTreeNode is owned by (read-only)  
Public PropertyDataColumnSetResolvedReturns the UltraTreeColumnSet instance which defines the cell data for this node.  
Public PropertyDataKeyGets/sets a value that is used to store a dataset key or other information.  
Public PropertyDisplayColumnSetResolvedReturns the UltraTreeColumnSet instance which defines the column structure for this node.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyDrawImageBackgroundResolvedThe resolved value of the DrawImageBackground property. Otherwise the default is returned.  
Public PropertyEditorResolvedReturns the resolved value of the associated Override object's Editor property.  
Public PropertyEnabledGets/sets a value indicating whether the tree node responds to activation, selection, etc.  
Public PropertyEnabledResolved(Read-only) Returns true only if this UltraTreeNode, all of its ancestor nodes, and the UltraTree control to which it belongs, is Enabled.  
Public PropertyExpandedGets/Sets whether or not the node is Expanded.  
Public PropertyFullPathReturns a string describing the path from the root UltraTreeNode to the current UltraTreeNode.  
Public PropertyGlyphPaddingResolvedReturns the resolved value of the GlyphPadding property.  
Public PropertyHandleGets the handle of the tree node. If a handle is not already assigned when the Handle property is referenced, it is assigned at that time.  
Public PropertyHasExpansionIndicatorReturns whether the node is displaying an expansion indicator.  
Public PropertyHasLeftImagesIndicates if there are any images in the LeftImages collection.  
Public PropertyHasNodesReturns true if there is a least 1 child node in this node's Nodes collection. Please see the remarks below for important details regarding data binding situations.  
Public PropertyHasOverrideReturns true if an Override object has been created.  
Public PropertyHasRightImagesIndicates if there are any images in the RightImages collection.  
Public PropertyHasVisibleNodesReturns true if there is a least 1 visible child node in this node's Nodes collection.  
Public PropertyHotTrackingResolvedThe resolved Override.HotTracking of the node. If a Override.HotTracking has been specified, it is returned. Otherwise the default is returned.  
Public PropertyImageSizeResolvedGets the resolved image size  
Public PropertyIndexReturns the ordinal position of this node in its TreeNodesCollection.  
Public PropertyIsActiveReturns whether or not this is the ActiveNode.  
Public PropertyIsBandNodeReturns whether or not this node is a band node.  
Public PropertyIsDraggableReturns true only if the node it draggable  
Public PropertyIsEditingReturns whether or not the UltraTreeNode it in Override.LabelEdit mode.  
Public PropertyIsHotTrackingReturns whether or not the node is the UltraTree.HotTrackingNode node.  
Public PropertyIsInViewReturns whether or not the UltraTreeNode is in view.  
Public PropertyIsRootLevelNodeReturns whether the node is a root level node.  
Public PropertyIsSelectableReturns whether the node is selectable.  
Public PropertyItemHeightResolvedThe resolved item height.  
Public PropertyKeyOverridden. The Key of the node.  
Public PropertyLabelEditResolvedThe resolved Override.LabelEdit of the node. If a Override.LabelEdit has been specified, it is returned. Otherwise the default is returned.  
Public PropertyLeftImagesReturns the LeftImages collection.  
Public PropertyLeftImagesAlignmentGets/sets the vertical alignment for the LeftImages.  
Public PropertyLevelGets the node level.  
Public PropertyListIndexReturns the index corresponding to this row from the IList that the control is bound to. Return value of -1 indicates that a row has been deleted or doesn't exist anymore.  
Public PropertyListObjectReturns the object corresponding to this row from the IList that the control is bound to. Returns Null if this is an UltraGridGroupByRow.  
Public PropertyMaxLabelHeightResolvedReturns the resolved value of the associated Override object's MaxLabelHeight property.  
Public PropertyMaxLabelWidthResolvedReturns the resolved value of the associated Override object's MaxLabelWidth property.  
Public PropertyMultilineResolvedReturns the resolved value of the associated Override object's Multiline property.  
Public PropertyNextVisibleNodeGets the next visible tree node.  
Public PropertyNodeDoubleClickActionResolvedThe resolved Override.NodeDoubleClickAction of the node. If a Override.NodeDoubleClickAction has been specified, it is returned. Otherwise the default is returned.  
Public PropertyNodesCollection of child nodes. This could be the children of a parent node or the children of the UltraTree (root nodes).  
Public PropertyNodeSpacingAfterResolvedReturns the resolved value of the associated Override object's NodeSpacingAfter property.  
Public PropertyNodeSpacingBeforeResolvedReturns the resolved value of the associated Override object's NodeSpacingBefore property.  
Public PropertyNodeStyleResolvedThe resolved NodeStyle of the node. If a NodeStyle has been specified, it is returned. Otherwise the default is 'Standard'.  
Public PropertyNotificationBadgeTextGets or sets the notification badge text.  
Public PropertyOverrideThe Override of a node has properties which can be overriden on different levels of the tree.  
Public PropertyParentGets the parent UltraTreeNode of the node.  
Public PropertyParentNodesCollectionGets the TreeNodesCollection of the nodes parent.  
Public PropertyPrevVisibleNodeGets the previous visible UltraTreeNode.  
Public PropertyReserveCheckBoxSpaceResolvedThe resolved ReserveCheckBoxSpace value. If none is specified, defaults to false.  
Public PropertyReserveImageSpaceResolvedThe resolved ReserveImageSpace value. If none is specified, defaults to false.  
Public PropertyRightImagesReturns the RightImages collection.  
Public PropertyRightImagesAlignmentGets/sets the Vertical alignment for the RightImages.  
Public PropertyRootNodeReturns the root node of this node.  
Public PropertySelectedGets/sets a value indicating whether the tree node is in the selected state.  
Public PropertyShowColumnsResolvedReturns the resolved value of the associated Override object's ShowColumns property.  
Public PropertyShowEditorButtonsResolvedReturns the resolved value of the associated Override object's ShowEditorButtons property.  
Public PropertyShowExpansionIndicatorResolvedThe resolved Override.ShowExpansionIndicator of the node. If a Override.ShowExpansionIndicator has been specified, it is returned. Otherwise the default is returned.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTextGets/sets the caption text for this UltraTreeNode.  
Public PropertyTextWidthReturns the width of the node's Text.  
Public PropertyTipStyleNodeResolvedThe resolved TipStyleNode of the node. If a TipStyleNode has been specified, it is returned. Otherwise the default is returned.  
Public PropertyUIElementReturns the TreeNodeUIElement associated with this UltraTreeNode, or null if the node is not currently in view.  
Public PropertyUseEditorResolvedReturns the resolved value of the associated Override object's UseEditor property.  
Public PropertyVisibleGets/sets whether the node is visible.  
Protected Properties
 NameDescription
Protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodActivateCellActivates the cell that corresponds to the specified UltraTreeNodeColumn. If the cell was successfully activated, true is returned; false is returned otherwise.  
Public MethodBeginCellEditActivates the cell that corresponds to the specified UltraTreeNodeColumn, and begins an edit mode session on the cell.  
Public MethodBeginEditPuts the node into edit mode.  
Public MethodBringCellIntoViewBrings the cell corresponding to the specified UltraTreeNodeColumn into view for this UltraTreeNode.  
Public MethodBringIntoViewOverloaded. Ensures that the tree node is in the viewable area of the control. This method will expand parent nodes and scroll the UltraTree control as necessary to bring the node into view.  
Public MethodBringLabelIntoViewBrings the label (header) corresponding to the specified UltraTreeNodeColumn into view for this UltraTreeNode.  
Public MethodCancelUpdateCancels pending changes to cell values.  
Public MethodCloneCopies the tree node and the entire subtree rooted at this tree node.  
Public MethodCollapseAllExpands this node and all of its descendants.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodEndCellEditEnds the current edit mode session on the ActiveCell  
Public MethodEndEditTakes the node out of edit mode.  
Public MethodExpandAllOverloaded. Expands this node and all of its descendants.  
Public MethodGetCellTextReturns the string representation of the value of the cell which corresponds to the specified UltraTreeNodeColumn for this UltraTreeNode.  
Public MethodGetCellValueReturns the value of the cell which corresponds to the specified UltraTreeNodeColumn for this UltraTreeNode.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetNodeCountReturns the number of child nodes.  
Public MethodGetSiblingGets the specified sibling of the UltraTreeNode.  
Public MethodHasSiblingReturns true if the UltraTreeNode has the specified sibling.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIsAncestorOfReturns whether or not the specified node is an Ancestor of this node.  
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodRemoveRemoves the current tree node from the tree view control.  
Public MethodRepositionOverloaded. Repositions the node to a specified position in relation to the passed-in RelativeNode.  
Public MethodResetAllowCellEditResets the value of the UltraTreeNodeColumn.AllowCellEdit property to its default.  
Public MethodResetCheckedStateResets CheckedState to the default.  
Public MethodResetEnabledResets the Enabled property to the default.  
Public MethodResetKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Public MethodResetLeftImagesResets the LeftImages collection, removing all items.  
Public MethodResetLeftImagesAlignmentResets LeftImagesAlignment to the default.  
Public MethodResetNotificationBadgeTextResets the NotificationBadgeText property to its default value.  
Public MethodResetOverrideResets the Override to default values.  
Public MethodResetRightImagesResets the RightImages collection, removing all items.  
Public MethodResetRightImagesAlignmentResets RightImagesAlignment to the default. ///  
Public MethodResetSelectedResets the Selected property to the default.  
Public MethodResetTextResets the value of the Text property to its default.  
Public MethodResetVisibleResets the Visible property to the default.  
Public MethodResolveAppearanceResolves the appearance for the UltraTreeNode object.  
Public MethodResolveLabelEditAppearanceResolves the appearance used during a label edit for the UltraTreeNode object.  
Public MethodSetCellValueSets the value on the UltraTreeNodeCell object which corresponds to the specified UltraTreeNodeColumn.  
Public MethodShouldSerializeCheckedStateReturn true if the CheckedState property should be serialized.  
Public MethodShouldSerializeDataKeyReturns true if the DataKey value is not null.  
Public MethodShouldSerializeEnabledReturns true if the Enabled property should be serialized.  
Public MethodShouldSerializeKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Public MethodShouldSerializeLeftImagesReturns true if LeftImages needs to be serialized.  
Public MethodShouldSerializeLeftImagesAlignmentReturns true if LeftImagesAlignment should be serialized.  
Public MethodShouldSerializeRightImagesReturns true if RightImages should be serialized.  
Public MethodShouldSerializeRightImagesAlignmentReturns true if RightImagesAlignment should be serialized  
Public MethodShouldSerializeSelectedReturns true if the Selected property should be serialized.  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodShouldSerializeTextReturns true if the Text property needs to be serialized.  
Public MethodShouldSerializeVisibleReturns true if the Visible property should be serialized.  
Public MethodToggleToggles the Expanded property of the node.  
Public MethodToStringReturns the Text property of the UltraTreeNode.  
Public MethodUpdateCommits pending changes to cell values to the underlying data source.  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodGetNotificationBadgeBoundsDetermines the rectangle area of the NotificationUIElement. In this area the tools will display the element will be positioned based on its size and position  
Protected MethodGetObjectDataGetObjectData serialization helper.  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnAddedToCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodOnDeserializationCalled after the node has been de-serialized.  
Protected MethodOnDisposeOverridden. Called when the group is disposed  
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnRemovedFromCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodOnSubObjectPropChangedOverridden. Called when another sub object that we are listening to notifies us that one of its properties has changed.  
Protected MethodResetDataKeySets the DataKey value to null.  
Protected MethodResetInternedKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeAllowCellEditReturns whether the value of the AllowCellEdit property has been changed from its default.  
Protected MethodShouldSerializeOverrideReturns true if this property is not set to its default value.  
Public Events
 NameDescription
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
See Also