GetActiveCategory

Description

Gets the active category in the RibbonBar control.

Applies to

RibbonBar controls

Syntax

controlname.GetActiveCategory ( ref RibbonCategoryItem Item )

Argument

Description

controlname

The name of the RibbonBar control.

Item

A RibbonCategoryItem variable in which you want to store the active category.


Return value

Integer.

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

Examples

The following code example gets a copy of the active category and stores it in the lr_Category variable.

Integer li_Return
Long ll_Handle
RibbonCategoryItem lr_Category

ll_Handle = rbb_1.InsertCategoryFirst("MyCategory")
li_Return = rbb_1.GetActiveCategory(lr_Category)

See also

InsertCategory

InsertCategoryFirst

InsertCategoryLast

DeleteCategory

SetCategory

GetCategory

GetCategoryByIndex

GetCategoryCount

SetActiveCategory