__VSHPROPID Enumeration
Specifies property settings for a hierarchy. Extended by __VSHPROPID2.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Public Enumeration __VSHPROPID
public enum __VSHPROPID
public enum class __VSHPROPID
type __VSHPROPID
public enum __VSHPROPID
Members
| Member name | Description | |
|---|---|---|
| VSHPROPID_AllowEditInRunMode | 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 | UNK. [optional] Returns an IVsHierarchy for SVsTrackSelectionEx. | |
| VSHPROPID_AltItemid | I4. [optional] Returns an itemid for SVsTrackSelectionEx. | |
| VSHPROPID_BrowseObject | DISP. [optional] Returns an IDispatch for property browsing. | |
| VSHPROPID_CanBuildFromMemory | BOOL. [optional] If true, do not prompt to save before building. | |
| VSHPROPID_Caption | BSTR. Required so the the environment (project window) can display UI. | |
| VSHPROPID_CmdUIGuid | GUID for command bars (for root only). | |
| VSHPROPID_ConfigurationProvider | OBSOLETE. Use IVsGetCfgProvider instead. | |
| VSHPROPID_DefaultEnableBuildProjectCfg | 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 | 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 | BSTR. [optional] String that represents the item's folder-based namespace: rootnamespace.folder.subfolder. | |
| VSHPROPID_DesignerFunctionVisibility | I4. [optional] Value from the VSDESIGNER_FUNCTIONVISIBILITY enumeration. | |
| VSHPROPID_DesignerVariableNaming | I4. [optional] Value from the VSDESIGNER_VARIABLENAMING enumeration. | |
| VSHPROPID_EditLabel | BSTR. [optional] String displayed for the in-place editing node caption. | |
| VSHPROPID_Expandable | BOOL. Specifies whether the environment should display the "open-this-folder" plus sign. | |
| VSHPROPID_ExpandByDefault | BOOL. Specifies whether the environment should expand this item. | |
| VSHPROPID_Expanded | BOOL. Specifies whether the node is currently expanded in the UIHierarchyWindow. Starts as false. | |
| VSHPROPID_ExtObject | DISP. [optional] For ITEMID_ROOT, this is the ext.object of the project (Project). | |
| VSHPROPID_ExtSelectedItem | DISP. [optional] Returns a custom SelectedItem object for the given itemid. | |
| VSHPROPID_FIRST | INT_PTR. Specifies the first property ID. | |
| VSHPROPID_FirstChild | Itemid of first child node. (VSITEMID_NIL if no children.) | |
| VSHPROPID_FirstVisibleChild | 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 | BOOL. [optional] Project handles unload/reload itself. (Otherwise, the environment handles it.) | |
| VSHPROPID_HasEnumerationSideEffects | 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 | I4. Handle to an icon; UIHierarchyWindow will not call DestroyIcon on it. | |
| VSHPROPID_IconImgList | I4. Handle to an imagelist. (Only for itemid==VSITEMID_ROOT.) | |
| VSHPROPID_IconIndex | I4. If Expandable=true, then IconIndex+1 is used for the open icon. | |
| VSHPROPID_ImplantHierarchy | UNK. [optional] IVsHierarchy implant for this hierarchy. | |
| VSHPROPID_IsFindInFilesForegroundOnly | BOOL. [optional] If true, FindInFiles runs in the main thread. | |
| VSHPROPID_IsHiddenItem | 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 | 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 | 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 | 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 | 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. | |
| VSHPROPID_ItemDocCookie | INT_PTR. [optional] The document cookie (an abstract value) of the hierarchy item. | |
| VSHPROPID_ItemSubType | 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 | INT_PTR. Specifies the last property ID. | |
| VSHPROPID_Name | BSTR. Name for project (VSITEMID_ROOT) or item. | |
| VSHPROPID_NextSibling | INT_PTR. Itemid of next sibling node. (VSITEMID_NIL if no more siblings.) | |
| VSHPROPID_NextVisibleSibling | 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 | NIL. -1 | |
| VSHPROPID_OpenFolderIconHandle | I4. [optional] Handle of an icon for an open folder. UIHierarchyWindow will not call DestroyIcon on it. | |
| VSHPROPID_OpenFolderIconIndex | I4. [optional] Index for OpenFolder icon. | |
| VSHPROPID_OverlayIconIndex | I4. [optional] Use the VSOVERLAYICON enumeration. Overlay for the item's main icon. | |
| VSHPROPID_OwnerKey | BSTR. [optional] Owner key string that identifies the GUID of the owning project. | |
| VSHPROPID_Parent | I4. Itemid of the parent node. (VSITEMID_NIL if no parent.) | |
| VSHPROPID_ParentHierarchy | UNK. IVsHierarchy that owns this hierarchy. | |
| VSHPROPID_ParentHierarchyItemid | INT_PTR. The itemid of this hierarchy in its parent hierarchy. | |
| VSHPROPID_PreferredLanguageSID | GUID. [optional] Preferred SID of the (text editor) language service for the project. | |
| VSHPROPID_ProjectDir | BSTR. [optional] Full path of the project directory (for VSITEMID_ROOT only). | |
| VSHPROPID_ProjectIDGuid | GUID. [optional] Identifies a project across solutions. Generated and set when the project is created. Retrieved when the project is opened. | |
| VSHPROPID_ProjectName | [obsolete] Use VSHPROPID_Name. | |
| VSHPROPID_ProjectType | [obsolete] Use VSHPROPID_TypeName. | |
| VSHPROPID_ReloadableProjectFile | [obsolete] Use VSHPROPID_HandlesOwnReload. | |
| VSHPROPID_Root | [obsolete] Itemid of Root must be VSITEMID_ROOT. | |
| VSHPROPID_SaveName | BSTR. File name specified on the FileSave menu. | |
| VSHPROPID_SelContainer | UNK. [optional] Returns an ISelectionContainer for use with property browsing. | |
| VSHPROPID_ShowOnlyItemCaption | BOOL. [optional] If true, only the caption is shown in the UI instead of the full moniker. | |
| VSHPROPID_ShowProjInSolutionPage | 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 | I4. [optional] Sort priority in UIHierarchyWindow. By default, standard projects have priority zero. | |
| VSHPROPID_StartupServices | UNK. [optional] Returns an IVsProjectStartupServices* to add services to be started on next project load (for VSITEMID_ROOT only). | |
| VSHPROPID_StateIconIndex | I4. State icon index. Use VsStateIcon enumeration. | |
| VSHPROPID_StorageType | 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 | GUID to identify the type of node/hierarchy; searches on GUID_ItemType. | |
| VSHPROPID_TypeName | BSTR. Displays a name to identify the type of node/hierarchy. (Used in the title bar.) | |
| VSHPROPID_UserContext | 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.