This documentation is archived and is not being maintained.

ICategorizeProperties.MapPropertyToCategory Method

Returns the property category value for the specified property.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int MapPropertyToCategory (
	[InAttribute] int dispid,
	out int ppropcat
)
int MapPropertyToCategory (
	/** @attribute InAttribute() */ int dispid, 
	/** @attribute OutAttribute() */ /** @ref */ int ppropcat
)
JScript does not support passing value-type arguments by reference.

Parameters

dispid

[in] Specifies the dispatch ID of the property to be displayed.

ppropcat

[out] Specifies a pointer to the property category.

Return Value

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

COM Signature

From objext.idl:

HRESULT ICategorizeProperties::MapPropertyToCategory(
   [in] DISPID dispid, 
   [out] PROPCAT* ppropcat
);

The MapPropertyToCategory method returns the appropriate property category value for the specified property. There are 11 predefined property categories with negative values. You can define your own custom categories, but you must assign them positive values. The predefined categories are:

Category

Value

PROPCAT_Nil

-1

PROPCAT_Misc

-2

PROPCAT_Font

-3

PROPCAT_Position

-4

PROPCAT_Appearance

-5

PROPCAT_Behavior

-6

PROPCAT_Data

-7

PROPCAT_List

-8

PROPCAT_Text

-9

PROPCAT_Scale

-10

PROPCAT_DDE

-11

Show: