GetCategoryIndex

Description

Gets the index of the category in the RibbonBar control.

Applies to

RibbonBar control

Syntax

controlname.GetCategoryIndex ( Long ItemHandle )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle for the category you want to obtain the index.


Return value

Long.

Returns the index of the category if it succeeds and -1 if an error occurs. If any argument's value is null, returns null.

Examples

This example gets the index number of "MyCategory2".

Long ll_Return
Long ll_Handle, ll_Handle2
RibbonCategoryItem lr_Category

ll_Handle = rbb_1.InsertCategoryFirst("MyCategory1")
ll_Handle2 = rbb_1.InsertCategoryLast("MyCategory2")
ll_Return = rbb_1.GetCategoryIndex(ll_Handle2)

See also

InsertCategory

InsertCategoryFirst

InsertCategoryLast

DeleteCategory

SetCategory

GetCategory

GetCategoryByIndex

GetCategoryCount

SetActiveCategory

GetActiveCategory