DBObjectsBranch Members

  • Article

Include Protected Members
Include Inherited Members

Manages retrieving data for a row from the client through the IDBObjectInformation interface. This class also handles propagating the check state up and down the tree.

The DBObjectsBranch type exposes the following members.

Constructors

  Name Description
Public method DBObjectsBranch Initializes a new instance of the DBObjectsBranch class.

Top

Methods

  Name Description
Protected method AddChildBranch Adds a new child branch to this branch.
Protected method AddInfoObject Adds a new object that contains information about the database object to be displayed as part of the branch.
Public method BeginLabelEdit The default is to not support label editing. (Inherited from SingleColumnBranchBase.)
Protected method CalcParentCheckState Calculates the state based on the state of the items in this branch.
Public method ColumnStyles Returns simple style. (Inherited from MultiColumnBranchBase.)
Public method CommitLabelEdit The default is to cancel edits. (Inherited from SingleColumnBranchBase.)
Protected method CreateChildBranch Creates a new child branch of the given branch.
Protected method DoVisitAllDepthFirst Traverses the tree in a depth-first order, calling the given visitor delegate for each item in the tree.
Protected method DoVisitAllLevelFirst Traverses the tree in level order, calling the given visitor delegate for each item in the tree.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAccessibilityData Returns the default accessibility object for the tree grid. (Inherited from SingleColumnBranchBase.)
Public method GetDisplayData Using the info object for given row, fills in a VirtualTreeDisplayData object with image and check state information. (Overrides SingleColumnBranchBase.GetDisplayData(Int32, Int32, VirtualTreeDisplayDataMasks).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetInfoObject Returns the information object at a given row in the branch.
Public method GetJaggedColumnCount The default is to return 0. (Inherited from MultiColumnBranchBase.)
Public method GetObject If the style is ExpandedBranch, this method creates a new branch object and returns it. (Overrides SingleColumnBranchBase.GetObject(Int32, Int32, ObjectStyle, Int32%).)
Public method GetText Returns cell text by asking the information object for data. (Overrides SingleColumnBranchBase.GetText(Int32, Int32).)
Public method GetTipText The default is to return no text. (Inherited from SingleColumnBranchBase.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsExpandable Returns whether the item in the specified row is expandable. (Overrides SingleColumnBranchBase.IsExpandable(Int32, Int32).)
Public method LocateObject The default is to locate self. (Inherited from SingleColumnBranchBase.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodStatic member NextState Returns the next checked state, given a state.
Public method OnDragEvent The default is to show no drag effect. (Inherited from SingleColumnBranchBase.)
Public method OnGiveFeedback This method does nothing. (Inherited from SingleColumnBranchBase.)
Public method OnQueryContinueDrag The default is to cancel action. (Inherited from SingleColumnBranchBase.)
Public method OnStartDrag The default is to not allow the drag. (Inherited from SingleColumnBranchBase.)
Protected method PreloadObjects Preloads the information and child branch objects cache for a branch.
Protected method PropagateCheckState Propagates the checked state of the item in a given row throughout the tree.
Protected method SetBranchState Sets the state of all items in the branch.
Protected method SetState Sets the state of the item at the given row.
Public method SynchronizeState The default is to indicate that no synchronization needs to be done. (Inherited from SingleColumnBranchBase.)
Public method ToggleState Toggles the state of the item at the given row and then propagates that change up and down the tree if not disabled. (Overrides SingleColumnBranchBase.ToggleState(Int32, Int32).)
Public method ToString Returns a String that represents the current Object. (Inherited from Object.)
Protected method UpdateChildrenState Propagates a new check state to children of the branch.
Protected method UpdateParent Updates the check state of parents.
Public method VisitAll Visits all the information objects in the tree in either depth-first or branch level order.

Top

Properties

  Name Description
Public property ChildBranchCount Gets the count of child branches of this branch.
Public property ColumnCount Gets the column count from the producer object. (Overrides MultiColumnBranchBase.ColumnCount.)
Public property DBObjectInfoCount Gets the count of db info objects in this branch.
Public property Features Gets branch features. (Overrides SingleColumnBranchBase.Features.)
Protected property ForcedChildState Gets or sets the forced child state.
Protected property ForceSetChildState Gets or sets whether a branch item should have its state changed when it is created.
Public property UpdateCounter The default is to return 0. (Inherited from SingleColumnBranchBase.)
Public property VisibleItemCount Gets the number of items in this branch. (Overrides SingleColumnBranchBase.VisibleItemCount.)

Top

Events

  Name Description
Public event OnBranchModification The event handler that the tree and others can use for notifications. (Inherited from SingleColumnBranchBase.)

Top

See Also

Reference

DBObjectsBranch Class

Microsoft.VisualStudio.Data.Schema.Project.Common.UI.TreeGridSupport Namespace