Description
Gets the category according to its index in the RibbonBar control.
Applies to
RibbonBar controls
Syntax
controlname.GetCategoryByIndex ( Long Index, ref RibbonCategoryItem Item )
|
Argument |
Description |
|---|---|
|
controlname |
The name of the RibbonBar control. |
|
Index |
The index of the category which you want to obtain. |
|
Item |
A RibbonCategoryItem variable in which you want to store the category identified by the index. |
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 get the category according to its handle by using the GetCategory function or the GetItem function.
Examples
The following code example gets a copy of the category whose index
number is 1 and stores the copy in the lr_Category
variable.
Integer li_Return
Long ll_Handle
RibbonCategoryItem lr_Category
ll_Handle = rbb_1.InsertCategoryLast ("MyCategory")
li_Return = rbb_1.GetCategoryByIndex (1, lr_Category)
See also
