Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

TabStripButton Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Docking
Assembly:
ActiproSoftware.Docking.WinForms.dll

Represents a button for a TabStripPage control.

public class TabStripButton : UIElement, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable
Inheritance:
object MarshalByRefObject DisposableObject LogicalTreeNodeBase UIElement object
Implements:
IInputElement IUIElement ILogicalTreeNode IDpiAwareElement IDisposable

Constructors

TabStripButton(CommandLink)

Initializes a new instance of the TabStripButton class.

public TabStripButton(CommandLink commandLink)
Parameter Type Description
commandLink CommandLink

The CommandLink for the button.

Properties

CaptureMouseWhenPressed

Indicates whether to automatically capture the mouse when the element is pressed.

protected override bool CaptureMouseWhenPressed { get; }

Property Value

bool:

true if the mouse should automatically be captured when the element is pressed; otherwise, false.

Gets the CommandLink for the button.

public CommandLink CommandLink { get; }

Property Value

CommandLink:

The CommandLink for the button.

InvalidateOnMouseEvents

Gets whether to invalidate the element when mouse events occur.

protected override bool InvalidateOnMouseEvents { get; }

Property Value

bool:

true if the element should be invalidated when mouse events occur.

TabStrip

Gets the TabStrip that contains the element.

[Browsable(false)]
public TabStrip TabStrip { get; }

Property Value

TabStrip:

The TabStrip that contains the element.

Methods

GetDrawState()

Gets the UIElementDrawState for the element.

public UIElementDrawState GetDrawState()

Returns

UIElementDrawState:

The UIElementDrawState for the element.

Remarks

The default implementation of this method returns UIElementDrawState.None.

MeasureOverride(Graphics, Size)

Measures the size in layout required for child elements and determines a size for the element itself.

protected override Size MeasureOverride(Graphics g, Size availableSize)
Parameter Type Description
g Graphics

The Graphics object to use for measurement.
availableSize Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure on each visible child element and determine the total size required.

OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

protected override void OnMouseUp(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

OnRender(PaintEventArgs)

Renders the element.

protected override void OnRender(PaintEventArgs e)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

Inherited Members