SetActiveCategory

Description

Sets the active category in the RibbonBar control.

Applies to

RibbonBar controls

Syntax

controlname.SetActiveCategory ( Long ItemHandle )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the category that you will set to active.


Return value

Integer.

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

Examples

This example inserts two categories "MyCategory1" and "MyCategory2" and sets "MyCategory2" as the active category.

Integer li_Return
Long ll_Handle, ll_Handle2

ll_Handle = rbb_1.InsertCategoryFirst("MyCategory1")
ll_Handle2 = rbb_1.InsertCategoryLast("MyCategory2")
li_Return = rbb_1.SetActiveCategory(ll_Handle2)

See also

InsertCategory

InsertCategoryFirst

InsertCategoryLast

DeleteCategory

SetCategory

GetCategory

GetCategoryByIndex

GetCategoryCount

GetActiveCategory

SetActiveCategoryByIndex