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

MetroDocumentWindowTabStripRenderer Class

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

Provides a base renderer for the TabStrip control that is similar to a Metro document window style.

public class MetroDocumentWindowTabStripRenderer : VisualStudioClassicToolWindowTabStripRenderer, IDisposable, IToolWindowTabStripRenderer, IDocumentWindowTabStripRenderer, ITabStripRenderer, IUIRenderer
Inheritance:
object MarshalByRefObject DisposableObject UIRenderer TabStripRenderer VisualStudioTabStripRendererBase VisualStudioClassicToolWindowTabStripRenderer object
Derived:
VisualStudioDocumentWindowTabStripRenderer
Implements:
IDisposable IToolWindowTabStripRenderer IDocumentWindowTabStripRenderer ITabStripRenderer IUIRenderer

Constructors

MetroDocumentWindowTabStripRenderer()

Initializes a new instance of the MetroDocumentWindowTabStripRenderer class.

public MetroDocumentWindowTabStripRenderer()

MetroDocumentWindowTabStripRenderer(IWindowsColorScheme)

Initializes a new instance of the MetroDocumentWindowTabStripRenderer class.

public MetroDocumentWindowTabStripRenderer(IWindowsColorScheme colorScheme)
Parameter Type Description
colorScheme IWindowsColorScheme

The IWindowsColorScheme to use as a base for the colors.

Remarks

The default constructor initializes all fields to their default values.

MetroDocumentWindowTabStripRenderer(WindowsColorSchemeType)

Initializes a new instance of the MetroDocumentWindowTabStripRenderer class.

public MetroDocumentWindowTabStripRenderer(WindowsColorSchemeType colorSchemeType)
Parameter Type Description
colorSchemeType WindowsColorSchemeType

The WindowsColorSchemeType to use as a base for the colors.

Properties

BaseColorSchemeType

Gets or sets the WindowsColorSchemeType to use as a base for the colors.

public virtual WindowsColorSchemeType BaseColorSchemeType { get; set; }

Property Value

WindowsColorSchemeType:

The WindowsColorSchemeType to use as a base for the colors.

TabStripTabHotBackgroundFill

Gets or sets the BackgroundFill for a hot TabStripTab.

public BackgroundFill TabStripTabHotBackgroundFill { get; set; }

Property Value

BackgroundFill:

The BackgroundFill for a hot TabStripTab.

TabStripTabSelectedUnfocusedBackgroundFill

Gets or sets the BackgroundFill for a selected unfocused TabStripTab.

public BackgroundFill TabStripTabSelectedUnfocusedBackgroundFill { get; set; }

Property Value

BackgroundFill:

The BackgroundFill for a selected unfocused TabStripTab.

Methods

Dispose(bool)

Disposes any resources used by the object.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing bool

Whether the object is being disposed.

ResetAll(bool)

Resets all property values to their defaults.

protected override void ResetAll(bool force)
Parameter Type Description
force bool

Whether to force resetting.

ResetTabStripTabHotBackgroundFill()

Resets the TabStripTabHotBackgroundFill property to its default value.

public virtual void ResetTabStripTabHotBackgroundFill()

ResetTabStripTabSelectedUnfocusedBackgroundFill()

Resets the TabStripTabSelectedUnfocusedBackgroundFill property to its default value.

public virtual void ResetTabStripTabSelectedUnfocusedBackgroundFill()

ResolveBackgroundFill(TabStripTab)

Gets the BackgroundFill to be used for the TabStripPage based on the current state.

protected override BackgroundFill ResolveBackgroundFill(TabStripTab tabStripTab)
Parameter Type Description
tabStripTab TabStripTab

The tab strip page to examine.

Returns

BackgroundFill:

A BackgroundFill, or null if a background should not be rendered.

ResolveForeColor(TabStripPage)

Gets the Color to be used for text on the TabStripPage based on the current state.

protected override Color ResolveForeColor(TabStripPage tabStripPage)
Parameter Type Description
tabStripPage TabStripPage

The tab strip page to examine.

Returns

Color:

A Color.

ShouldSerializeTabStripTabHotBackgroundFill()

Indicates whether the TabStripTabHotBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripTabHotBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripTabSelectedUnfocusedBackgroundFill()

Indicates whether the TabStripTabSelectedUnfocusedBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripTabSelectedUnfocusedBackgroundFill()

Returns

bool:

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

Inherited Members