SetActiveCategoryByIndex

Description

Sets the active category according to its index in the RibbonBar control.

Applies to

RibbonBar control

Syntax

controlname.SetActiveCategoryByIndex ( Long Index )

Argument

Description

controlname

The name of the RibbonBar control.

Index

The index number of the category that you want to set as 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" (whose index number is 2) 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.SetActiveCategoryByIndex(2)

See also

InsertCategory

InsertCategoryFirst

InsertCategoryLast

DeleteCategory

SetCategory

GetCategory

GetCategoryByIndex

GetCategoryCount

GetActiveCategory

SetActiveCategory