IVsPropertyPage Interface

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Implemented by VSPackages on IPropertyPage objects to show categorized property pages in the property frame.

public interface class IVsPropertyPage

public interface class IVsPropertyPage

__interface IVsPropertyPage

[System.Runtime.InteropServices.Guid("237ABD5F-9537-4AEE-A893-72AB9A0EA8E8")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsPropertyPage

[System.Runtime.InteropServices.Guid("237ABD5F-9537-4AEE-A893-72AB9A0EA8E8")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsPropertyPage

[<System.Runtime.InteropServices.Guid("237ABD5F-9537-4AEE-A893-72AB9A0EA8E8")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsPropertyPage = interface

[<System.Runtime.InteropServices.Guid("237ABD5F-9537-4AEE-A893-72AB9A0EA8E8")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsPropertyPage = interface

Public Interface IVsPropertyPage

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

The tree structure in the Property Pages dialog is created with information provided by the interfaces IVsPropertyPage and ISpecifyPropertyPages. ISpecifyPropertyPages provides the actual page, while IVsPropertyPage provides the level name.

There are only two top-level categories available on Visual Studio Property Pages:

Term	Definition
Common Properties	Displays configuration-independent information for the selected object or objects. As a result, when one of the Common Properties subcategories is selected, the Configuration, Platform, and Configuration Manager options across the top of the dialog are not available.
Configuration Properties	Contains configuration-dependent information relating to Debugging, Optimization, and Build parameters for the solution or project.

Your page is automatically put under one of those top-level categories based on whether the page is configuration specific regardless of whether or not you implement IVsPropertyPage or what you return in the CategoryTitle method. Configuration specific pages come from objects obtained from the main object through IVsCfgProvider2.

Notes to Implementers

When adding a new project type that support configuration options through property pages.

Methods

CategoryTitle(UInt32, String)

Returns the category under which your property pages should be displayed in the tree view.

Applies to

Share via