VSPROPSHEETPAGE 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

Sets the characteristics of a properties page. Similar to the Win32 PROPSHEETPAGE structure.

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

Fields

dwFlags

Flags that indicate which options to use when creating the property sheet page.
dwReserved

Reserved for future use.
dwSize

Specifies the size, in bytes, of the structure. The size includes any extra application-defined data at the end of the structure.
dwTemplateSize

Use dwTemplateSize when PSP_DLGINDIRECT is specified in dwFlags. Specifies the size of the template specified in the pTemplate field.
HINSTANCE

Handle to the instance from which to load a dialog template resource.
hwndDlg

If you cannot pass a dialog template, set the HINSTANCE field to a null value and fill in this field instead. A page will then be created, and your hwnd will be attached to it. If you do this, do not use lParam for anything.
lParam

When the page is created, a copy of the page's VSPROPSHEETPAGE structure is passed to the dialog box procedure with a WM_INITDIALOG message. The lParam member is provided to allow you to pass application-specific information to the dialog box procedure. It has no effect on the page itself.
pcRefParent

Address of the reference count value. To use this member, you must set the PSP_USEREFPARENT flag in the dwFlags member.
pfnCallback

Address of an application-defined callback function that is called when the page is created and when it is about to be destroyed. To use this member, you must set the PSP_USECALLBACK flag in the dwFlags member.
pfnDlgProc

Address of the dialog box procedure for the page. Because the pages are created as modeless dialog boxes, the dialog box procedure must not call the EndDialog function.
pTemplate

Dialog box template in memory to use to create the page. If the PSP_DLGINDIRECT flag in the dwFlags member is set, then pTemplate is used.
wTemplateId

Used to specify the resource identifier of your dialog template in the module identified by the handle in the HINSTANCE field when PSP_DLGINDIRECT is not specified in dwFlags.

Applies to