IRibbonButton

Assembly: Forms;

Namespace: Prognoz.Platform.Interop.Forms;

Description

The IRibbonButton interface contains properties of the Button ribbon control.

Inheritance Hierarchy

          IComponent

          IBaseRibbonElement

          IRibbonButton

Comments

This interface describes different ribbon buttons: ordinary buttons with text header, graphic buttons, buttons with drop-down menu.

Properties

  Property name Brief description
The Action property determines an action that is associated with the ribbon button.
The Down property determines a state of the control.
The ImageIndex property determines index of the small image that is displayed on the button near the text.
The LargeImageIndex property determines index of the large image that is displayed on the button near the text.
The SplitButton property determines whether the button is divided if there are subelements.
The SubItems property returns the collection of controls that form the drop-down menu of the button.

Properties inherited from IBaseRibbonElement

  Property name Brief description
The Category property returns a tab, in area of which a control is placed.
The Description property determines description of a control.
The Enabled property determines whether a control is available for the user.
The Height returns height of a control.
The Highlighted property returns whether the current control is highlighted.
The Hint property determines text of the tooltip for a control.
The Id property returns identifier of a control.
The Keys property determines a hot key that is used for quick access to a control.
The Left property returns distance from the left border of the parent component to the left border of the current control.
The ParentElement property returns parent control.
The ParentGroup property returns the group, in which this control is included.
The ParentPanel property returns the panel, on which a control is placed.
The Text property determines the text that is displayed in the control area.
The Top property returns the distance from the top border of the parent component to the top border of the current control.
The Visible property determines whether a control is visible.
The Width property returns width of the control.

Properties inherited from IComponent

  Property name Brief description
ComponentCount The ComponentCount property returns the number of child components located on the parent component.
Components The Components property returns the child component, which index is passed by the input parameter.
Data The Data property is used to store any custom data.
Name The Name property determines a component name.
Tag The compiler does not use the Tag property. The user can change the value of the Tag property and use it as he wishes.

See also:

Forms Assembly Interfaces