IRibbonPaletteButton

Assembly: Forms;

Namespace: Prognoz.Platform.Interop.Forms;

Description

The IRibbonPaletteButton interface contains properties of the Button ribbon control element for calling the combo box.

Inheritance hierarchy

          IComponent

          IBaseRibbonElement

          IRibbonButton

          IRibbonPaletteButton

Comments

The combo box can be divided into two groups:

Main graphic buttons use the images loaded from the resources or images of the component set in the Images property. If the main graphic buttons are used during the work, the OnChange event is generated for the parent control element. The SelectedItem property is intended to check which graphic button was used.

The list of additional controls is formed in the SubItems collection.

Properties

  Property name Brief description
The ButtonMode property determines mode of the button work.
The ColumnCount property determines the number of columns in which the set of main graphic buttons should be placed.
The Groups property returns collection of graphic buttons groups.
The IconWidth property determines the width in accordance with which the images are split and created for the main set of graphic buttons.
The Images property determines the component that contains the images that should be used in the main set of graphic buttons.
The ResizeList property determines the way of changing the parameters of the combined menu.
The SelectedItem property determines index of the last selected button from the main set of graphic buttons.

Properties inherited from IRibbonButton

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

Properties inherited from IBaseRibbonElement

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

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 child property, the index of which is passed by the input parameter.
Data The Data property is used to store any custom data.
Name The Name property specifies the component name.
Tag The compiler does not use the Tag property. A user can change the value of the Tag property and use it as he wishes.

See also:

Forms Assembly Interfaces