IVsPackage.GetPropertyPage Method

Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.

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

Syntax

'Declaration
Function GetPropertyPage ( _
    ByRef rguidPage As Guid, _
    <OutAttribute> ppage As VSPROPSHEETPAGE() _
) As Integer
int GetPropertyPage(
    ref Guid rguidPage,
    VSPROPSHEETPAGE[] ppage
)
int GetPropertyPage(
    [InAttribute] Guid% rguidPage, 
    [InAttribute] [OutAttribute] array<VSPROPSHEETPAGE>^ ppage
)
abstract GetPropertyPage : 
        rguidPage:Guid byref * 
        ppage:VSPROPSHEETPAGE[] byref -> int
function GetPropertyPage(
    rguidPage : Guid, 
    ppage : VSPROPSHEETPAGE[]
) : int

Parameters

  • rguidPage
    Type: Guid%

    [in] Unique identifier of the requested property page.

Return Value

Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsPackage::GetPropertyPage(
   [in] REFGUID rguidPage,
   [in, out] VSPROPSHEETPAGE *ppage
);

Pages used in the ppage parameter are not IPropertyPage property pages, but Microsoft Windows API PROPSHEETPAGE pages, which are used for Options and Customize Toolbox pages.

This method is called by the environment to display property pages when implementing custom Tools Options pages or adding a new pages to the Customize Toolbox dialog. For more information on implementing custom Tools Options pages and new Customize Toolbox dialogs, see Options Pages and Toolbox (Visual Studio SDK).

.NET Framework Security

See Also

Reference

IVsPackage Interface

Microsoft.VisualStudio.Shell.Interop Namespace