SetCategory

Description

Sets the category for the RibbonBar control.

Applies to

RibbonBar controls

Syntax

controlname.SetCategory ( Long ItemHandle, RibbonCategoryItem Item )

Argument

Description

controlname

The name of the RibbonBar control.

ItemHandle

The handle of the category you want to set.

Item

A category item that will be set.


Return value

Integer.

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

Usage

You can also use the SetItem function to set the category. Refer to SetItem for the difference between SetItem and SetCategory.

Examples

This example changes the value of the Text property of the category from "MyCategory" to "MyCategory1".

Integer li_Return
Long ll_Handle
RibbonCategoryItem lr_Category

ll_Handle = rbb_1.InsertCategoryLast ("MyCategory")
lr_Category.Text = "MyCategory1"
li_Return = rbb_1.SetCategory (ll_Handle, lr_Category)

See also

InsertCategory

InsertCategoryFirst

InsertCategoryLast

DeleteCategory

GetCategory

GetCategoryByIndex

GetCategoryCount

SetActiveCategory

GetActiveCategory