GH_RibbonTab

public sealed class GH_RibbonTab : GH_RibbonContentBase, IGH_RibbonInteractiveObject

Constructors

GH_RibbonTab

public GH_RibbonTab(GH_Ribbon owner, string name)

Default constructor.

Parameters:

owner (GH_Ribbon)	Owner control, can be NULL, but you must set it prior to calling any UI methods.
name (string)	Name of the tab.

Fields

Region

public Rectangle Region

Represents the entire region taken up by this object.

inherited fromGH_RibbonContentBase

Properties

ClientRegion

public Rectangle ClientRegion { get; set; }

Gets the Client region of the layout. The client region as defined as the entire region minus the margin and the padding.

inherited fromGH_RibbonContentBase

ContentRegion

public Rectangle ContentRegion { get; set; }

Gets or sets the Content region of the layout. The content region as defined as the entire region minus the margin.

inherited fromGH_RibbonContentBase

DisplayStyle

public GH_TabDisplay DisplayStyle { get; set; }

Gets or sets the display style of a tab. This style is set by the ribbon control during layout, do not set it yourself.

Grip

public Rectangle Grip { get; set; }

Gets or sets the grip region for this tab.

Remarks: The grip region is the clickable region around the name.

HasIcon

public bool HasIcon { get; }

Gets whether this tab has an icon associated with it.

Icon

public Bitmap Icon { get; }

Gets the tab icon (might not exist)

Margin

public Padding Margin { get; set; }

inherited fromGH_RibbonContentBase

NameFull

public string NameFull { get; }

Gets the full name of the tab.

NameShort

public string NameShort { get; }

Gets the abbreviated name of the tab.

NameSymbol

public string NameSymbol { get; }

Gets the single char name of the tab.

Owner

public GH_Ribbon Owner { get; }

Gets the owner control for this tab.

Remarks: If you supply a NULL value, you cannot call any interface methods

Value: The GH_RibbonControl owner

Padding

public Padding Padding { get; set; }

inherited fromGH_RibbonContentBase

Panels

public List<GH_RibbonPanel> Panels { get; }

Gets the internal collection of panels.

Visible

public bool Visible { get; set; }

Gets or sets visibility of this control. Typically visibility affects drawing and mouse interaction

inherited fromGH_RibbonContentBase

Methods

Contains

public virtual bool Contains(Point pt)

Tests to see if the given point is considered to be 'on' the control. By default, the content region of the control is tested, but derived classes can override this behaviour.

inherited fromGH_RibbonContentBase

Parameters:

pt (Point)

Point to test for

DisplayTooltip

public void DisplayTooltip(GH_TooltipDisplayEventArgs e)

Parameters:

e (GH_TooltipDisplayEventArgs)

Implements: DisplayTooltip

EnsurePanel

public GH_RibbonPanel EnsurePanel(string name)

Ensures a panel with a certain name exists.

Parameters:

name (string)

MouseClick

public GH_RibbonMouseEvent MouseClick(GH_Ribbon sender, GH_RibbonMouseEventArgs e)

Parameters:

sender (GH_Ribbon)
e (GH_RibbonMouseEventArgs)

Implements: MouseClick

MouseDoubleClick

public GH_RibbonMouseEvent MouseDoubleClick(GH_Ribbon sender, GH_RibbonMouseEventArgs e)

Parameters:

sender (GH_Ribbon)
e (GH_RibbonMouseEventArgs)

Implements: MouseDoubleClick

MouseDown

public GH_RibbonMouseEvent MouseDown(GH_Ribbon sender, GH_RibbonMouseEventArgs e)

Parameters:

sender (GH_Ribbon)
e (GH_RibbonMouseEventArgs)

Implements: MouseDown

MouseMove

public GH_RibbonMouseEvent MouseMove(GH_Ribbon sender, GH_RibbonMouseEventArgs e)

Parameters:

sender (GH_Ribbon)
e (GH_RibbonMouseEventArgs)

Implements: MouseMove

MouseUp

public GH_RibbonMouseEvent MouseUp(GH_Ribbon sender, GH_RibbonMouseEventArgs e)

Parameters:

sender (GH_Ribbon)
e (GH_RibbonMouseEventArgs)

Implements: MouseUp

PerformLayout

public override void PerformLayout()

Performs layout logic of all panels

Overrides: GH_RibbonContentBase.PerformLayout

RenderTab

public void RenderTab(Graphics g)

Parameters:

g (Graphics)