TabStrip Class

[ToolboxBitmap(typeof(TabStrip))]
public class TabStrip : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, ICommandTarget, IWeakEventListener, IOrientedElement

public TabStrip()

Remarks

The default constructor initializes all fields to their default values.

public bool AutoInternalDragDrop { get; set; }

Property Value

bool:

true if automatic internal reordering of tabs is allowed; otherwise, false.

Remarks

If this property is set to true, no TabStripPageTabDragStart event is raised when a drag begins since all drag-handling code is handled internally by the control.

public bool AutoSelectTabOnDragOver { get; set; }

Property Value

bool:

true if a page should be automatically selected when a drag operation is moved over the page's tab; otherwise, false.

public bool AutoSetFocusOnClick { get; set; }

Property Value

bool:

true if focus should be set when a page's tab is clicked; otherwise, false.

public Sides BorderSides { get; set; }

Property Value

Sides:

The Sides that the border appears on.

Remarks

This is used with the renderer's TabStripPageMargin to know which sides to indent client bounds.

public bool CloseButtonVisible { get; set; }

Property Value

bool:

true if a close button is visible; otherwise, false.

[Browsable(false)]
public static Command CloseCommand { get; }

Property Value

Command:

The Command that is used for a close button click.

[Browsable(false)]
public CommandLinkCollection CommandLinks { get; }

Property Value

CommandLinkCollection:

A CommandLinkCollection containing the command links associated with the object.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

public override Rectangle DisplayRectangle { get; }

Property Value

Rectangle:

A Rectangle that represents the display area of the control.

public bool ForceUnselectedFont { get; set; }

Property Value

bool:

true if the unselected Font should always be used; otherwise, false.

[Browsable(false)]
public ICommandTarget ForwardCommandsTo { get; set; }

Property Value

ICommandTarget:

The ICommandTarget to forward commands to.

public ImageList ImageList { get; set; }

Property Value

ImageList:

An ImageList. The default value is null.

public bool KeyboardNavigationEnabled { get; set; }

Property Value

bool:

true if Ctrl+Tab keyboard navigation is enabled for switching between pages; otherwise, false.

Remarks

If keyboard navigation is enabled, the Ctrl+Tab and Ctrl+Shift+Tab keys will switch between pages.

public int MaximumTabExtent { get; set; }

Property Value

int:

The maximum extent of a tab.

Remarks

Specify -1 to apply no maximum extent.

public int MinimumTabExtent { get; set; }

Property Value

int:

The minimum extent of a tab.

Remarks

Specify -1 to apply no minimum extent.

public bool OptionsButtonVisible { get; set; }

Property Value

bool:

true if a options button is visible; otherwise, false.

[Browsable(false)]
public static Command OptionsCommand { get; }

Property Value

Command:

The Command that is used for a options button click.

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

Property Value

Orientation:

A Orientation that specifies the orientation.

public bool PageValidationEnabled { get; set; }

Property Value

bool:

true if the SelectedPage is validated before allowing a page change to occur; otherwise, false.

public TabStripPageCollection Pages { get; }

Property Value

TabStripPageCollection:

The TabStripPageCollection containing the pages in the control.

public ITabStripRenderer Renderer { get; set; }

Property Value

ITabStripRenderer:

The control-specific ITabStripRenderer used to render the control.

Remarks

If this value is null, then the global renderer will be used instead.

[Browsable(false)]
public ITabStripRenderer RendererResolved { get; }

Property Value

ITabStripRenderer:

The ITabStripRenderer used to render the control.

Remarks

This property will return a global renderer if there is no control instance renderer override. The registered renderer type with the UIRendererManager for this property is ITabStripRenderer.

public bool RightClickSelectsTab { get; set; }

Property Value

bool:

true if a right-click on a tab selects the related page; otherwise, false.

[Browsable(false)]
public static Command ScrollBackwardCommand { get; }

Property Value

Command:

The Command that is used for a scroll backward button click.

public int ScrollDelta { get; set; }

Property Value

int:

The number of pixels to scroll per step when a scroll button is pressed.

Remarks

A higher number will scroll faster than a lower number.

[Browsable(false)]
public static Command ScrollForwardCommand { get; }

Property Value

Command:

The Command that is used for a scroll forward button click.

[Browsable(false)]
public int SelectedIndex { get; set; }

Property Value

int:

The index of the selected item. If there are no items in the control, this property returns -1.

Remarks

The index is zero-based.

[Browsable(false)]
public TabStripPage SelectedPage { get; set; }

Property Value

TabStripPage:

The TabStripPage that is currently selected.

public bool SingleTabVisible { get; set; }

Property Value

bool:

true if the tab should be visible; otherwise, false.

public TabStripTabAlignment TabAlignment { get; set; }

Property Value

TabStripTabAlignment:

A TabStripTabAlignment specifying the alignment of the tabs.

[Browsable(false)]
public int TabAscent { get; }

Property Value

int:

The ascent of a tab.

public TabStripTabOverflowStyle TabOverflowStyle { get; set; }

Property Value

TabStripTabOverflowStyle:

A TabStripTabOverflowStyle specifying how to handle tab overflow.

public bool TabsAlignNear { get; set; }

Property Value

bool:

true if the tabs should align on the near side of the tab container; otherwise, false.

protected override Size ArrangeOverride(Size finalSize)

Parameter	Type	Description
finalSize	Size	The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

Remarks

Element authors should override this method, call Arrange on each visible child element and position each child element. It is required that a parent element calls Arrange on each child or they won't be rendered.

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

protected override Control.ControlCollection CreateControlsInstance()

Returns

Control.ControlCollection:

A new instance of a Control.ControlCollection assigned to the control.

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	bool	Whether the object is being disposed.

public TabStripButton GetButtonForCommand(Command command)

Parameter	Type	Description
command	Command	The Command to search for.

Returns

TabStripButton:

The TabStripButton for the specified Command if the button exists and is visible; otherwise, null is returned.

public static Sides GetSidesFromTabStripTabAlignment(TabStripTabAlignment tabAlignment)

Parameter	Type	Description
tabAlignment	TabStripTabAlignment	The TabStripTabAlignment to examine.

Returns

Sides:

The Sides value that corresponds to the specified TabStripTabAlignment.

public TabStripPage HitTest(Point point)

Parameter	Type	Description
point	Point	The Point to test.

Returns

TabStripPage:

A TabStripPage whose tab contains the Point.

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.

protected virtual void OnCommand(CommandEventArgs e)

Parameter	Type	Description
e	CommandEventArgs	A CommandEventArgs that contains the event data.

protected override void OnDragLeave(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnDragOver(DragEventArgs e)

Parameter	Type	Description
e	DragEventArgs	A DragEventArgs that contains the event data.

protected override void OnEnter(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnLeave(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnMouseLeave(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnMouseMove(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected override void OnMouseUp(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected override void OnRender(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.

protected virtual void OnReselect(TabStripPageEventArgs e)

Parameter	Type	Description
e	TabStripPageEventArgs	A TabStripPageEventArgs that contains the event data.

protected virtual void OnSelectionChanged(TabStripPageEventArgs e)

Parameter	Type	Description
e	TabStripPageEventArgs	A TabStripPageEventArgs that contains the event data.

protected virtual void OnSelectionChanging(TabStripPageCancelEventArgs e)

Parameter	Type	Description
e	TabStripPageCancelEventArgs	A TabStripPageCancelEventArgs that contains the event data.

protected virtual void OnTabStripPageTabContextMenu(TabStripPageContextMenuEventArgs e)

Parameter	Type	Description
e	TabStripPageContextMenuEventArgs	A TabStripPageContextMenuEventArgs that contains the event data.

protected virtual void OnTabStripPageTabDoubleClick(TabStripPageEventArgs e)

Parameter	Type	Description
e	TabStripPageEventArgs	A TabStripPageEventArgs that contains the event data.

protected virtual void OnTabStripPageTabDragStart(TabStripPageEventArgs e)

Parameter	Type	Description
e	TabStripPageEventArgs	A TabStripPageEventArgs that contains the event data.

protected virtual void OnTabStripPageTabMoved(TabStripPageEventArgs e)

Parameter	Type	Description
e	TabStripPageEventArgs	A TabStripPageEventArgs that contains the event data.

protected virtual void OnTabStripPageTabToolTipDisplaying(TabStripPageEventArgs e)

Parameter	Type	Description
e	TabStripPageEventArgs	A TabStripPageEventArgs that contains the event data.

protected override bool ProcessCmdKey(ref Message m, Keys keyData)

Parameter	Type	Description
m	Message	The message to process.
keyData	Keys	One of the Keys values that represents the key to process.

Returns

bool:

true if the key was processed by the control; otherwise, false.

public virtual bool RaiseCommand(Command command)

Parameter	Type	Description
command	Command	The Command to raise.

Returns

bool:

true if the Command was handled; otherwise, false.

public virtual void ResetImageList()

public int SelectNext()

Returns

int:

The index of the new selected TabStripPage.

Remarks

If the last TabStripPage is selected when this method is called, the control will select the first TabStripPage.

public int SelectNext(bool wrap)

Parameter	Type	Description
wrap	bool	Indicates whether to wrap to the beginning if the last TabStripPage is selected.

Returns

int:

The index of the new selected TabStripPage.

Remarks

If the last TabStripPage is selected when this method is called, the control will select the first TabStripPage if the wrap parameter is set to true.

public int SelectPrevious()

Returns

int:

The index of the new selected TabStripPage.

Remarks

If the first TabStripPage is selected when this method is called, the control will select the last TabStripPage.

public int SelectPrevious(bool wrap)

Parameter	Type	Description
wrap	bool	Indicates whether to wrap to the end if the first TabStripPage is selected.

Returns

int:

The index of the new selected TabStripPage.

Remarks

If the first TabStripPage is selected when this method is called, the control will select the last TabStripPage if the wrap parameter is set to true.

public virtual bool ShouldSerializeImageList()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public event CommandEventHandler Command

Event Type

CommandEventHandler

Remarks

Each TabStripButton in the TabStrip is associated with a Command. Use this event to perform any processing that should occur when a TabStripButton click occurs.

public event TabStripPageEventHandler Reselect

Event Type

TabStripPageEventHandler

Remarks

Use this event to perform any processing that should occur after an TabStripPage is clicked after it has already been selected.

public event TabStripPageEventHandler SelectionChanged

Event Type

TabStripPageEventHandler

Remarks

Use this event to perform any processing that should occur after the selection changes.

public event TabStripPageCancelEventHandler SelectionChanging

Event Type

TabStripPageCancelEventHandler

Remarks

Use this event to perform any processing that should occur before selection changes. The TabStripPage property of the event arguments indicates the TabStripPage about to be selected. The selection change may be cancelled by setting the Cancel property of the event arguments to true.

public event TabStripPageContextMenuEventHandler TabStripPageTabContextMenu

Event Type

TabStripPageContextMenuEventHandler

public event TabStripPageEventHandler TabStripPageTabDoubleClick

Event Type

TabStripPageEventHandler

public event TabStripPageEventHandler TabStripPageTabDragStart

Event Type

TabStripPageEventHandler

public event TabStripPageEventHandler TabStripPageTabMoved

Event Type

TabStripPageEventHandler

public event TabStripPageEventHandler TabStripPageTabToolTipDisplaying

Event Type

TabStripPageEventHandler