IRibbonColorButton

Assembly: Forms;

Namespace: Prognoz.Platform.Interop.Forms;

Description

The IRibbonColorButton interface contains properties of the Button for Color Selection ribbon control.

Inheritance Hierarchy

          IComponent

          IBaseRibbonElement

          IRibbonButton

          IRibbonPaletteButton

          IRibbonColorButton

Comments

The button for color selection is based on the button for opening the combobox. The main menu elements are the buttons for selection one of the available colors. Colors are divided into three groups: common, additional, and standard. The menu also includes:

• The Auto button that enables the user to select the default color.

• The Other button that enables the user to open the dialog box of additional color selection.

The Auto and Other buttons are displayed if any header is set for them.

Properties

	Property name	Brief description
	AutoButtonBorder	The AutoButtonBorder property determines whether the frame is displayed around the color image if the color was selected using the Auto button.
	AutoButtonCaption	The AutoButtonCaption property determines the header of the Auto button that is used to select the default color.
	AutoButtonColor	The AutoButtonColor property determines the color that is selected on pressing the Auto button.
	AutoButtonOnTop	The AutoButtonOnTop property determines a location of the Auto button.
	AutoButtonTooltip	The AutoButtonTooltip property determines a tooltip for the Auto button.
	Color	The Color property determines the color selected in the dialog box.
	ColorVisible	The ColorVisible property determines whether the selected color is displayed under the icon displayed near the control.
	OtherButtonCaption	The OtherButtonCaption property determines a header of the button that is used to open the dialog box offor additional color selection.
	OtherButtonTooltip	The OtherButtonTooltip property determines a tooltip for the button that is used to open the dialog box for additional color selection.

Properties inherited from IRibbonPaletteButton

	Property name	Brief description
	ButtonMode	The ButtonMode property determines a mode of button work.
	ColumnCount	The ColumnCount property determines the number of columns, in which the set of main graphic buttons is placed.
	Groups	The Groups property returns the collection of graphic buttons groups.
	IconWidth	The IconWidth property determines the width, in accordance with which images are split and created for the main set of graphic buttons.
	Images	The Images property determines the component that contains the images that will be used in the main set of graphic buttons.
	ResizeList	The ResizeList property determines how parameters of the combined menu are changed.
	SelectedItem	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
	Action	The Action property determines an action that is associated with the ribbon button.
	Down	The Down property determines a state of the control.
	ImageIndex	The ImageIndex property determines index of the small image that is displayed on the button near the text.
	LargeImageIndex	The LargeImageIndex property determines index of the large image that is displayed on the button near the text.
	SplitButton	The SplitButton property determines whether the button is divided if there are subelements.
	SubItems	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
	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.

See also:

Forms Assembly Interfaces