VSPROPSHEETPAGE Structure

 

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

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

[ComConversionLossAttribute]
public struct VSPROPSHEETPAGE

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from ValueType.)

System_CAPS_pubmethodGetHashCode()

(Inherited from ValueType.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from ValueType.)

NameDescription
System_CAPS_pubfielddwFlags

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

System_CAPS_pubfielddwReserved

Reserved for future use.

System_CAPS_pubfielddwSize

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

System_CAPS_pubfielddwTemplateSize

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

System_CAPS_pubfieldHINSTANCE

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

System_CAPS_pubfieldhwndDlg

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.

System_CAPS_pubfieldlParam

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.

System_CAPS_pubfieldpcRefParent

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

System_CAPS_pubfieldpfnCallback

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.

System_CAPS_pubfieldpfnDlgProc

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.

System_CAPS_pubfieldpTemplate

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.

System_CAPS_pubfieldwTemplateId

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: