SetMinimized

Description

Sets the RibbonBar control to be minimized.

Applies to

RibbonBar control

Syntax

controlname.SetMinimized ( Boolean Minimized )

Argument

Description

controlname

The name of the RibbonBar control.

Minimized

A boolean indicating whether to set the RibbonBar control to be minimized.


Return value

Integer.

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

Usage

When the RibbonBar control is minimized, only the application button title, the category title, and the tab header will be displayed.

If the HideTabHeader property is set to TRUE (which means the application button title, category title, and the tab header are invisible), the SetMinimized function will not take effect.

Examples

This example sets the ribbon bar to be minimized.

Integer li_Return
li_Return = rbb_1.SetMinimized (True)

See also

IsMinimized