Share via

VSTREEDISPLAYDATA Struct

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

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

public value class VSTREEDISPLAYDATA
struct VSTREEDISPLAYDATA
[System.Runtime.InteropServices.ComConversionLoss]
public struct VSTREEDISPLAYDATA
[<System.Runtime.InteropServices.ComConversionLoss>]
type VSTREEDISPLAYDATA = struct
Public Structure VSTREEDISPLAYDATA
Inheritance
ValueType
VSTREEDISPLAYDATA
Attributes
ComConversionLossAttribute

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.

Fields

ForceSelectLength

Length of forced selection.
ForceSelectStart

Start of the part of the item to always select (for showing search hits).
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.
Image

Specifies an index into an image list indicating which glyph is to be displayed. Return Image when TDM_IMAGE is set.
Mask

Specifies which fields in the structure are of interest. Values are taken from the _VSTREEDISPLAYMASK enumeration.
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.
State

Specifies display state. Values are taken from the _VSTREEDISPLAYSTATE enumeration.
StateMask

Specifies which bit fields in State are of interest. Values are taken from the _VSTREEDISPLAYSTATE enumeration.

Applies to