GH_Ribbon

UserControlContainerControlScrollableControlControlComponentMarshalByRefObjectReferences

[DesignerGenerated] public class GH_Ribbon : UserControl, IGH_FixedSizeControl

Fields

m_focus_item

protected GH_RibbonItem m_focus_item

Properties

ActiveObject

public IGH_RibbonInteractiveObject ActiveObject { get; set; }

Gets or sets the Active object. The active object can be any class which implements the IGH_RibbonInteractiveObject interface. Under normal circumstances it will most likely be a RibbonItem or a class derived from RibbonItem.

ActiveTab

public GH_RibbonTab ActiveTab { get; set; }

Getsor sets the first active tab or Null is no active tab is defined

ActiveTabIndex

public int ActiveTabIndex { get; set; }

Gets or sets the current tab index.

Remarks: Invalid indices will result in exceptions

Returns: The index of the first active tab or -1 if no active tab can be found

ActiveTabName

public string ActiveTabName { get; set; }

Gets or sets the active tab by name.

IsActiveObject

public bool IsActiveObject { get; }

Tabs

public List<GH_RibbonTab> Tabs { get; }

Gets the tabs collection.

Remarks: Do not modify this collection, use AddTab, RemoveTab... methods instead

TooltipDelay

public int TooltipDelay { get; set; }

Methods

AmIFocused

public bool AmIFocused(GH_RibbonItem item)

Parameters:

item (GH_RibbonItem)

CreateRibbonLayoutMenu

public ToolStripDropDown CreateRibbonLayoutMenu()

DetermineFocusItem

protected GH_Ribbon.GH_RibbonControlFocusResult DetermineFocusItem(MouseEventArgs e)

Parameters:

e (MouseEventArgs)

Dispose

protected override void Dispose(bool disposing)

Parameters:

disposing (bool)

Overrides: ContainerControl.Dispose

FindAndDisplayProxy

public bool FindAndDisplayProxy(Guid id, ref Rectangle tabBox, ref Rectangle iconbox, ref GH_RibbonDropdown dropdown)

Iterates over all tabs and panels to try and find the icon with the associated proxy id.

Parameters:

id (Guid)	ID of proxy to search for.
tabBox (ref Rectangle)	The tab rectangle (in screen space).
iconbox (ref Rectangle)	The icon rectangle (in screen space).
dropdown (ref GH_RibbonDropdown)	The dropdown window if shown.

Returns: Rectangle of proxy icon or Rectangle.Empty if the icon could not be found. Rectangle is defined in screen coordinates, not control coordinates.