IRibbon

Assembly: Forms;

Namespace: Prognoz.Platform.Interop.Forms;

Description

The IRibbon interface contains properties and methods of the Ribbon development environment component.

Inheritance Hierarchy

          IComponent

          IControl

          IRibbon

Properties

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

Properties inherited from IControl

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

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.

Methods

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

Methods inherited from IControl

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

See also:

Forms Assembly Interfaces