VSTREEDISPLAYDATA Structure

Holds values used to retrieve display data for an item in a tree list.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Public Structure VSTREEDISPLAYDATA
public struct VSTREEDISPLAYDATA
public value class VSTREEDISPLAYDATA
[<Sealed>]
type VSTREEDISPLAYDATA =  struct end
JScript supports the use of structures, but not the declaration of new ones.

The VSTREEDISPLAYDATA type exposes the following members.

Methods

  Name Description
Public method Equals Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from ValueType.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Fields

  Name Description
Public field ForceSelectLength Length of forced selection.
Public field ForceSelectStart Start of the part of the item to always select (for showing search hits).
Public field hImageList Handle to an image list. If hImageList is set to zero, the tool's default image list will be used. Indices for glyphs in the default image list are in omglyphs.h.
Public field Image Specifies an index into an image list indicating which glyph is to be displayed. Return Image when TDM_IMAGE is set.
Public field Mask Specifies which fields in the structure are of interest. Values are taken from the _VSTREEDISPLAYMASK enumeration.
Public field SelectedImage Specifies an index into an image list indicating which glyph is to be displayed when the item is selected. Return SelectedImage when TDM_SELECTEDIMAGE is set. If not set, the selected image used will be the same as the non-selected image.
Public field State Specifies display state. Values are taken from the _VSTREEDISPLAYSTATE enumeration.
Public field StateMask Specifies which bit fields in State are of interest. Values are taken from the _VSTREEDISPLAYSTATE enumeration.

Top

Remarks

When calling GetDisplayData the tree view will set Mask and StateMask to indicate which display or state data fields are of interest, so only the fields identified by those masks need to be returned. If State is set, it indicates that StateMask specifies the state data that is being requested. Typically GetDisplayData is called separately for display data and state data.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace