Ribbon

Assembly: Forms;

Namespace: Prognoz.Platform.Interop.Forms;

Description

The Ribbon class implements the Ribbon development environment component that is used to create a module ribbon.

Comments

A module ribbon is a modern interface that includes main menu and toolbars of the form.

Class object properties inherited from IRibbon

	Property name	Brief description
	ActiveCategory	The ActiveCategory property determines an active ribbon tab.
	Categories	The Categories property returns the collection of tabs that are available on the ribbon.
	Contexts	The Contexts property returns the collection of context tabs.
	CustomDefaultMenuItem	The CustomDefaultMenuItem property returns name of the new context menu command of the ribbon.
	Elements	The Elements property returns the collection of controls located on all ribbon tabs.
	Hidden	The Hidden property determines whether ribbon is hidden.
	Images	The Images property determines the component that contains images that will be used on the ribbon.
	MainButton	The MainButton property returns parameters of the application button that is used to open the main menu.
	MainCategory	The MainCategory property returns parameters of the main menu of the ribbon.
	QuickAccessToolbar	The QuickAccessToolbar property returns parameters of the quick access toolbar.
	Resources	The Resources property determines the repository object - Resources, which images will be used in controls of the ribbon.
	TabElements	The TabElements property returns the collection of common controls of the ribbon.

Class object properties inherited from IControl

	Property name	Brief description
	Align	The Align property determines component alignment within its parent component.
	AllowDrag	The AllowDrag property determines whether an object can be dragged from a component.
	AllowDrop	The AllowDrop property determines whether a component can accept a dragged object.
	Anchors	The Anchors property returns settings determining % of the resize for the current component when the parent component is resized.
	Brush	The Brush property determines the brush that is used to fill the component area.
	ClientHeight	The ClientHeight property determines the height of the client component area.
	ClientWidth	The ClientWidth property determines the width of the client component area.
	Color	The Color property determines a component background color.
	Cursor	The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.
	Enabled	The Enabled property determines whether a component is available for the user.
	Focused	The Focused property returns True if the focus is set to the component.
	Font	The Font property determines parameters of the font that is used to display text in a component.
	Height	The Height property determines component height in pixels.
	HelpContext	The HelpContext property determines a unique index for a section of a context help for this component.
	Hint	The Hint property determines a tooltip text displayed on hovering over a component.
	HintTimeout	The HintTimeout property determines for how long a tooltip is displayed.
	Left	The Left property determines a coordinate of the component left edge in pixels.
	Parent	The Parent property determines a parent component.
	ParentColor	The ParentColor property determines whether a component inherits the color of the parent component.
	ParentFont	The ParentFont property determines whether a component uses the font of the parent component.
	ParentShowHint	The ParentShowHint property determines when a tooltip is displayed.
	PopupMenu	The PopupMenu property determines the context menu displayed when a component is clicked with the right mouse button.
	Scrolls	The Scrolls property returns parameters of component's scrollbars.
	ShowHint	The ShowHint property determines whether a tooltip is displayed when a component is hovered.
	TabOrder	The TabOrder property determines a component position in a tab order.
	TabStop	The TabStop property determines whether the component must be focused when the Tab button is pressed.
	Text	The Text property determines a row identifying a component for the user.
	Top	The Top property determines a coordinate of the component top edge in pixels.
	Visible	The Visible property determines whether the component is displayed when a form is executed.
	Width	The Width property determines horizontal size of a component in pixels.

Class object 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.

Class object methods inherited from IRibbon

	Method name	Brief description
	FindById	The FindById method searches for the control by the numeric identifier.
	LoadFromXML	The LoadFromXML method loads and creates the visual ribbon.
	SaveToXML	The SaveToXML method saves the ribbon structure in the XML format and returns the received XML string.

Class object methods inherited from IControl

	Method name	Brief description
	BringToFront	Outdated.The BringToFront method brings the component to front.
	ClientToScreen	The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
	DoDragDrop	The DoDragDrop method enables the user to start dragging operation.
	GetImage	The GetImage method returns a graphic presentation of a component together with all child components.
	ScreenToClient	The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
	SendToBack	Outdated. The SendToBack method sends the component to back.
	SetFocus	The SetFocus method sets focus to this component.

Events of the Ribbon class object

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

Events inherited from IControl

	Event name	Brief description
	OnBeginDrag	The OnBeginDrag event occurs for a component, when the user starts to drag an object from the component.
	OnClick	The OnClick event occurs if the user clicks a component area with the main mouse button.
	OnControlMove	The OnControlMove event occurs when the component is moved.
	OnControlResize	The OnControlResize event occurs when the component is resized.
	OnDblClick	The OnDblClick event occurs if the user double-clicks the component area with the mouse button.
	OnDragDrop	The OnDragDrop event occurs for the component if the user drops a dragged object over it.
	OnDragEnter	The OnDragEnter event occurs when a dragged object enters the component area.
	OnDragLeave	The OnDragLeave event occurs when a dragged object leaves component borders.
	OnDragOver	The OnDragOver event occurs for the component when the user drags an object over it.
	OnEnter	The OnEnter event occurs when the component receives focus.
	OnExit	The OnExit event occurs when the component loses focus.
	OnHScroll	The OnHScroll event occurs when horizontal scrollbar slider changes its position.
	OnKeyDown	The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
	OnKeyPress	The OnKeyPress event occurs if the component is focused when the user presses a character key.
	OnKeyPreview	The OnKeyPreview event occurs prior to each event related to key pressing.
	OnKeyUp	The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
	OnMouseDown	The OnMouseDown event occurs if the pointer is in the component area and a mouse key is pressed.
	OnMouseEnter	The OnMouseEnter event occurs when the mouse cursor enters the component area.
	OnMouseHover	The OnMouseHover event occurs when the mouse cursor is held in the component area.
	OnMouseLeave	The OnMouseLeave event occurs when the mouse cursor leaves the component area.
	OnMouseMove	The OnMouseMove event occurs when the mouse cursor moves over a component.
	OnMouseUp	The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.
	OnMouseWheel	The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel.
	OnVScroll	The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

Forms Assembly Classes