__VSHPROPID Enum

Definition

Specifies property settings for a hierarchy. Extended by __VSHPROPID2.

public enum class __VSHPROPID
public enum class __VSHPROPID
enum __VSHPROPID
public enum __VSHPROPID
type __VSHPROPID = 
Public Enum __VSHPROPID
Inheritance
__VSHPROPID

Fields

VSHPROPID_AllowEditInRunMode -2056

BOOL. [optional] If this is false or E_NOTIMPL, the compiler disables modifications during run mode. (This is the most common expected behavior.) true enables edits. This property enables VSA scenarios.

VSHPROPID_AltHierarchy -2019

UNK. [optional] Returns an IVsHierarchy for SVsTrackSelectionEx.

VSHPROPID_AltItemid -2020

I4. [optional] Returns an itemid for SVsTrackSelectionEx.

VSHPROPID_BrowseObject -2018

DISP. [optional] Returns an IDispatch for property browsing.

VSHPROPID_CanBuildFromMemory -2053

BOOL. [optional] If true, do not prompt to save before building.

VSHPROPID_Caption -2003

BSTR. Required so the the environment (project window) can display UI.

VSHPROPID_CmdUIGuid -2016

GUID for command bars (for root only).

VSHPROPID_ConfigurationProvider -2036

OBSOLETE. Use IVsGetCfgProvider instead.

VSHPROPID_DefaultEnableBuildProjectCfg -2063

BOOL. [optional] By default, specifies whether "Build" should be initially selected in the solution cfg. Typically, "Build" is selected if the project supports IVsBuildableProjectCfg.

VSHPROPID_DefaultEnableDeployProjectCfg -2064

BOOL. [optional] By default, specifies whether "Deploy" should be initially selected in the solution cfg. Typically, "Deploy" is selected by if the project supports IVsDeployableProjectCfg.

VSHPROPID_DefaultNamespace -2049

BSTR. [optional] String that represents the item's folder-based namespace: rootnamespace.folder.subfolder.

VSHPROPID_DesignerFunctionVisibility -2061

I4. [optional] Value from the VSDESIGNER_FUNCTIONVISIBILITY enumeration.

VSHPROPID_DesignerVariableNaming -2060

I4. [optional] Value from the VSDESIGNER_VARIABLENAMING enumeration.

VSHPROPID_EditLabel -2026

BSTR. [optional] String displayed for the in-place editing node caption.

VSHPROPID_Expandable -2006

BOOL. Specifies whether the environment should display the "open-this-folder" plus sign.

VSHPROPID_ExpandByDefault -2011

BOOL. Specifies whether the environment should expand this item.

VSHPROPID_Expanded -2035

BOOL. Specifies whether the node is currently expanded in the UIHierarchyWindow. Starts as false.

VSHPROPID_ExtObject -2027

DISP. [optional] For ITEMID_ROOT, this is the ext.object of the project (Project).

VSHPROPID_ExtSelectedItem -2028

DISP. [optional] Returns a custom SelectedItem object for the given itemid.

VSHPROPID_FIRST -2064

INT_PTR. Specifies the first property ID.

VSHPROPID_FirstChild -1001

Itemid of first child node. (VSITEMID_NIL if no children.)

VSHPROPID_FirstVisibleChild -2041

INT_PTR. [optional] Similar to FirstChild but only walks items to be displayed in UIHierarchyWindow. Required if the hierarchy supports multiple (subsetted or supersetted) views of its contents.

VSHPROPID_HandlesOwnReload -2031

BOOL. [optional] Project handles unload/reload itself. (Otherwise, the environment handles it.)

VSHPROPID_HasEnumerationSideEffects -2062

BOOL. [optional] If true, then this hierarchy is not enumerated for FindInFiles and similar hierarchy enumerations. (Useful if enumerating is unacceptably slow or could cause a login dialog box to appear.)

VSHPROPID_IconHandle -2013

I4. Handle to an icon; UIHierarchyWindow will not call DestroyIcon on it.

VSHPROPID_IconImgList -2004

I4. Handle to an imagelist. (Only for itemid==VSITEMID_ROOT.)

VSHPROPID_IconIndex -2005

I4. If Expandable=true, then IconIndex+1 is used for the open icon.

VSHPROPID_ImplantHierarchy -2037

UNK. [optional] IVsHierarchy implant for this hierarchy.

VSHPROPID_IsFindInFilesForegroundOnly -2052

BOOL. [optional] If true, FindInFiles runs in the main thread.

VSHPROPID_IsHiddenItem -2043

BOOL. [optional] Specifies that an item is not displayed in current UIHierarchyWindow view. Required if the hierarchy supports multiple (subsetted) views of its contents.

VSHPROPID_IsNewUnsavedItem -2057

BOOL. [optional] If true, this is a new, unsaved item (as obtained from File.New.File) and therefore, the moniker is a temporary name and the caption should be used in the UI instead.

VSHPROPID_IsNonLocalStorage -2045

BOOL. [optional] Specifies whether project storage is local. IPersistFileFormat is used for saving the project whether it is a local "file" or not.

VSHPROPID_IsNonMemberItem -2044

BOOL. [optional] Specifies that the item is not considered a member of the hierarchy. Required if the hierarchy supports (supersetted) views of its contents—that is, if ShowAllFiles displays files in directories that are not members of the project.

VSHPROPID_IsNonSearchable -2051

BOOL. [optional] Specifies that the item is not subject to search-and-replace through Find/Replace in Files. Should be true for the project file itself and for project references.

VSHPROPID_ItemDocCookie -2034

INT_PTR. [optional] The document cookie (an abstract value) of the hierarchy item.

VSHPROPID_ItemSubType -2047

BSTR. [optional] Non-localize string that represents the subtype of the item. It is up to each package to agree on the meaning of this string.

VSHPROPID_LAST -1000

INT_PTR. Specifies the last property ID.

VSHPROPID_Name -2012

BSTR. Name for project (VSITEMID_ROOT) or item.

VSHPROPID_NextSibling -1002

INT_PTR. Itemid of next sibling node. (VSITEMID_NIL if no more siblings.)

VSHPROPID_NextVisibleSibling -2042

INT_PTR. [optional] Similar to NextSibling but only walks items to be displayed in UIHierarchyWindow. Required if the hierarchy supports multiple (subsetted or supersetted) views of its contents.

VSHPROPID_NIL -1

NIL. -1

VSHPROPID_OpenFolderIconHandle -2014

I4. [optional] Handle of an icon for an open folder. UIHierarchyWindow will not call DestroyIcon on it.

VSHPROPID_OpenFolderIconIndex -2015

I4. [optional] Index for Open Folder icon.

VSHPROPID_OverlayIconIndex -2048

I4. [optional] Use the VSOVERLAYICON enumeration. Overlay for the item's main icon.

VSHPROPID_OwnerKey -2038

BSTR. [optional] Owner key string that identifies the GUID of the owning project.

VSHPROPID_Parent -1000

I4. Itemid of the parent node. (VSITEMID_NIL if no parent.)

VSHPROPID_ParentHierarchy -2032

UNK. IVsHierarchy that owns this hierarchy.

VSHPROPID_ParentHierarchyItemid -2033

INT_PTR. The itemid of this hierarchy in its parent hierarchy.

VSHPROPID_PreferredLanguageSID -2054

GUID. [optional] Preferred SID of the (text editor) language service for the project.

VSHPROPID_ProjectDir -2021

BSTR. [optional] Full path of the project directory (for VSITEMID_ROOT only).

VSHPROPID_ProjectIDGuid -2059

GUID. [optional] Identifies a project across solutions. Generated and set when the project is created. Retrieved when the project is opened.

VSHPROPID_ProjectName -2012

[obsolete] Use VSHPROPID_Name.

VSHPROPID_ProjectType -2030

[obsolete] Use VSHPROPID_TypeName.

VSHPROPID_ReloadableProjectFile -2031

[obsolete] Use VSHPROPID_HandlesOwnReload.

VSHPROPID_Root -1003

[obsolete] Itemid of Root must be VSITEMID_ROOT.

VSHPROPID_SaveName -2002

BSTR. File name specified on the File Save menu.

VSHPROPID_SelContainer -2017

UNK. [optional] Returns an ISelectionContainer for use with property browsing.

VSHPROPID_ShowOnlyItemCaption -2058

BOOL. [optional] If true, only the caption is shown in the UI instead of the full moniker.

VSHPROPID_ShowProjInSolutionPage -2055

BOOL. [optional] Used to filter the project when Visual Basic or C# calls the component picker for add-reference. Returns VARIANT_TRUE to show that the project is in the list.

VSHPROPID_SortPriority -2022

I4. [optional] Sort priority in UIHierarchyWindow. By default, standard projects have priority zero.

VSHPROPID_StartupServices -2040

UNK. [optional] Returns an IVsProjectStartupServices* to add services to be started on next project load (for VSITEMID_ROOT only).

VSHPROPID_StateIconIndex -2029

I4. State icon index. Use VsStateIcon enumeration.

VSHPROPID_StorageType -2046

BSTR. [optional] Non-localize string that represents storage type. Same as the string that's used in the VSDIR file to differentiate between different location MRU lists.

VSHPROPID_TypeGuid -1004

GUID to identify the type of node/hierarchy; searches on GUID_ItemType.

VSHPROPID_TypeName -2030

BSTR. Displays a name to identify the type of node/hierarchy. (Used in the title bar.)

VSHPROPID_UserContext -2023

UNK. [optional] IVsUserContext for the project or item.

Remarks

Each __VSHPROPID must return a VARIANT structure filled in with the correct VT_ type. The caller may assume the VT_ type is correct—that is, you don't have to call VariantChangeType(), or verify the type, beyond an ASSERT() to make sure that there were no header file mismatches, and so on.

Important

__VSHPROPID values must not overlap any other *PROPID group values.

This same logic applies to the caller when it sets a property—the hierarchy assumes that the caller has passed a VARIANT already converted to the correct VT_ type.

Applies to