Share via


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)

Syntax

'Declaration
Function MapPropertyToCategory ( _
    dispid As Integer, _
    <OutAttribute> ByRef ppropcat As Integer _
) As Integer
int MapPropertyToCategory(
    int dispid,
    out int ppropcat
)
int MapPropertyToCategory(
    [InAttribute] int dispid, 
    [OutAttribute] int% ppropcat
)
abstract MapPropertyToCategory : 
        dispid:int * 
        ppropcat:int byref -> int
function MapPropertyToCategory(
    dispid : int, 
    ppropcat : int
) : int

Parameters

  • dispid
    Type: System.Int32

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

  • ppropcat
    Type: System.Int32%

    [out] Specifies a pointer to the property category.

Return Value

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

Remarks

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

.NET Framework Security

See Also

Reference

ICategorizeProperties Interface

Microsoft.VisualStudio.Shell.Interop Namespace