IBaseRibbonElement

Assembly: Forms;

Namespace: Prognoz.Platform.Interop.Forms;

Description

The IBaseRibbonElement interface contains base properties of all controls that can be used during organization of the ribbon. All ribbon controls also implement the series of events, which description is represented in this section.

Inheritance Hierarchy

          IComponent

          IBaseRibbonElement

Comments

This interface is a base one for the following interfaces:

• IRibbonButton.

• IRibbonCheckBox.

• IRibbonColorButton.

• IRibbonComboBox.

• IRibbonEdit.

• IRibbonFloatEdit.

• IRibbonGroup.

• IRibbonIntegerEdit.

• IRibbonLabel.

• IRibbonMainButton.

• IRibbonPaletteButton.

• IRibbonProgressBar.

• IRibbonRadioButton.

• IRibbonSeparator.

• IRibbonSlider.

Properties

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

Events

	Event name	Brief description
	OnChange	The OnChange event occurs when the ribbon control element is used.
	OnUpdate	The OnUpdate event occurs when the ribbon control element is updated.

See also:

Forms Assembly Interfaces