In This Article

VisualStudioTabStripRendererBase Class

Provides a base renderer for the TabStrip control that is similar to a Visual Studio tool window style.

public abstract class VisualStudioTabStripRendererBase : TabStripRenderer, IDisposable, IToolWindowTabStripRenderer, ITabStripRenderer, IUIRenderer
Inheritance:
object DisposableObjectBase UIRenderer TabStripRenderer object
Derived:
VisualStudioClassicToolWindowTabStripRenderer WindowsClassicToolWindowTabStripRenderer
Implements:
IDisposable IToolWindowTabStripRenderer ITabStripRenderer IUIRenderer

Constructors

VisualStudioTabStripRendererBase(IWindowsColorScheme)

Provides a base renderer for the TabStrip control that is similar to a Visual Studio tool window style.

protected VisualStudioTabStripRendererBase(IWindowsColorScheme colorScheme)
Parameter Type Description
colorScheme IWindowsColorScheme

The IWindowsColorScheme to use as a base for the colors.

Properties

MatchBackgroundToParentForm

Indicates whether to match certain backgrounds to the parent form's client rectangle.

public virtual bool MatchBackgroundToParentForm { get; set; }

Property Value

bool:

true if certain backgrounds should be matched to the parent form's client rectangle; otherwise, false.

TabStripBackgroundFill

public BackgroundFill? TabStripBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripButtonGlyphColor

The glyph color of a TabStripButton.

public Color TabStripButtonGlyphColor { get; set; }

Property Value

Color

TabStripButtonHotBackgroundFill

The BackgroundFill for a TabStripButton in a hot state.

public BackgroundFill? TabStripButtonHotBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripButtonHotBorder

The Border for a TabStripButton in a hot state.

public Border? TabStripButtonHotBorder { get; set; }

Property Value

Border

TabStripButtonHotPressedBackgroundFill

The BackgroundFill for a TabStripButton in a hot/pressed state.

public BackgroundFill? TabStripButtonHotPressedBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripButtonHotPressedBorder

The Border for a TabStripButton in a hot/pressed state.

public Border? TabStripButtonHotPressedBorder { get; set; }

Property Value

Border

TabStripButtonHotPressedOffset

The offset to apply to a TabStripButton in a hot/pressed state.

public virtual int TabStripButtonHotPressedOffset { get; set; }

Property Value

int

TabStripButtonNormalBackgroundFill

The BackgroundFill for a TabStripButton in a normal state.

public BackgroundFill? TabStripButtonNormalBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripButtonNormalBorder

The Border for a TabStripButton in a normal state.

public Border? TabStripButtonNormalBorder { get; set; }

Property Value

Border

TabStripHighContrastBackgroundFill

The BackgroundFill for a TabStrip in high contrast themes.

public BackgroundFill? TabStripHighContrastBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripPageDefaultBackgroundFill

public BackgroundFill? TabStripPageDefaultBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripTabContainerBackgroundFill

The BackgroundFill for a TabStrip tab container.

public BackgroundFill? TabStripTabContainerBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripTabContainerBorderVisible

Indicates whether to draw the tab container border.

public virtual bool TabStripTabContainerBorderVisible { get; set; }

Property Value

bool:

true if the tab container border should be drawn; otherwise, false.

TabStripTabDisabledForeColor

The foreground color of a disabled TabStripTab.

public Color TabStripTabDisabledForeColor { get; set; }

Property Value

Color

TabStripTabSelectedBackgroundFill

The BackgroundFill for a selected TabStripTab.

public BackgroundFill? TabStripTabSelectedBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripTabSelectedForeColor

The foreground color of a selected TabStripTab.

public Color TabStripTabSelectedForeColor { get; set; }

Property Value

Color

TabStripTabTextStringTrimming

The StringTrimming to use when drawing text.

public virtual StringTrimming TabStripTabTextStringTrimming { get; set; }

Property Value

StringTrimming

TabStripTabUnselectedBackgroundFill

The BackgroundFill for a unselected TabStripTab.

public BackgroundFill? TabStripTabUnselectedBackgroundFill { get; set; }

Property Value

BackgroundFill

TabStripTabUnselectedForeColor

The foreground color of a unselected TabStripTab.

public Color TabStripTabUnselectedForeColor { get; set; }

Property Value

Color

Methods

Dispose(bool)

Releases the unmanaged resources used by the object and optionally releases the managed resources.

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

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose() method and the Finalize method. Dispose invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

DrawTabStripBackground(PaintEventArgs, Rectangle, TabStrip)

Draws the background of a TabStrip control.

public override void DrawTabStripBackground(PaintEventArgs e, Rectangle bounds, TabStrip tabStrip)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

bounds Rectangle

The bounds in which to draw.

tabStrip TabStrip

The TabStrip being painted.

DrawTabStripButton(PaintEventArgs, Rectangle, TabStripButton)

Draws a TabStripButton.

public override void DrawTabStripButton(PaintEventArgs e, Rectangle bounds, TabStripButton button)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

bounds Rectangle

The bounds in which to draw.

button TabStripButton

The TabStripButton that is being painted.

DrawTabStripPageBackground(PaintEventArgs, Rectangle, TabStripPage)

Draws the background of a TabStripPage control.

public override void DrawTabStripPageBackground(PaintEventArgs e, Rectangle bounds, TabStripPage tabStripPage)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

bounds Rectangle

The bounds in which to draw.

tabStripPage TabStripPage

The TabStripPage being painted.

DrawTabStripTab(PaintEventArgs, Rectangle, TabStripTab)

Draws a TabStripTab.

public override void DrawTabStripTab(PaintEventArgs e, Rectangle bounds, TabStripTab tabStripTab)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

bounds Rectangle

The bounds in which to draw.

tabStripTab TabStripTab

The TabStripTab that is being painted.

ResetAll(bool)

Resets all property values to their defaults.

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

Whether to force resetting.

ResetMatchBackgroundToParentForm()

Resets the MatchBackgroundToParentForm property to its default value.

public virtual void ResetMatchBackgroundToParentForm()

ResetTabStripBackgroundFill()

Resets the TabStripBackgroundFill property to its default value.

public virtual void ResetTabStripBackgroundFill()

ResetTabStripButtonGlyphColor()

Resets the TabStripButtonGlyphColor property to its default value.

public virtual void ResetTabStripButtonGlyphColor()

ResetTabStripButtonHotBackgroundFill()

Resets the TabStripButtonHotBackgroundFill property to its default value.

public virtual void ResetTabStripButtonHotBackgroundFill()

ResetTabStripButtonHotBorder()

Resets the TabStripButtonHotBorder property to its default value.

public virtual void ResetTabStripButtonHotBorder()

ResetTabStripButtonHotPressedBackgroundFill()

Resets the TabStripButtonHotPressedBackgroundFill property to its default value.

public virtual void ResetTabStripButtonHotPressedBackgroundFill()

ResetTabStripButtonHotPressedBorder()

Resets the TabStripButtonHotPressedBorder property to its default value.

public virtual void ResetTabStripButtonHotPressedBorder()

ResetTabStripButtonHotPressedOffset()

Resets the TabStripButtonHotPressedOffset property to its default value.

public virtual void ResetTabStripButtonHotPressedOffset()

ResetTabStripButtonNormalBackgroundFill()

Resets the TabStripButtonNormalBackgroundFill property to its default value.

public virtual void ResetTabStripButtonNormalBackgroundFill()

ResetTabStripButtonNormalBorder()

Resets the TabStripButtonNormalBorder property to its default value.

public virtual void ResetTabStripButtonNormalBorder()

ResetTabStripHighContrastBackgroundFill()

Resets the TabStripHighContrastBackgroundFill property to its default value.

public virtual void ResetTabStripHighContrastBackgroundFill()

ResetTabStripPageDefaultBackgroundFill()

Resets the TabStripPageDefaultBackgroundFill property to its default value.

public virtual void ResetTabStripPageDefaultBackgroundFill()

ResetTabStripTabContainerBackgroundFill()

Resets the TabStripTabContainerBackgroundFill property to its default value.

public virtual void ResetTabStripTabContainerBackgroundFill()

ResetTabStripTabContainerBorderVisible()

Resets the TabStripTabContainerBorderVisible property to its default value.

public virtual void ResetTabStripTabContainerBorderVisible()

ResetTabStripTabDisabledForeColor()

Resets the TabStripTabDisabledForeColor property to its default value.

public virtual void ResetTabStripTabDisabledForeColor()

ResetTabStripTabSelectedBackgroundFill()

Resets the TabStripTabSelectedBackgroundFill property to its default value.

public virtual void ResetTabStripTabSelectedBackgroundFill()

ResetTabStripTabSelectedForeColor()

Resets the TabStripTabSelectedForeColor property to its default value.

public virtual void ResetTabStripTabSelectedForeColor()

ResetTabStripTabTextStringTrimming()

Resets the TabStripTabTextStringTrimming property to its default value.

public virtual void ResetTabStripTabTextStringTrimming()

ResetTabStripTabUnselectedBackgroundFill()

Resets the TabStripTabUnselectedBackgroundFill property to its default value.

public virtual void ResetTabStripTabUnselectedBackgroundFill()

ResetTabStripTabUnselectedForeColor()

Resets the TabStripTabUnselectedForeColor property to its default value.

public virtual void ResetTabStripTabUnselectedForeColor()

ResolveBackgroundFill(TabStripTab)

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

protected virtual BackgroundFill? ResolveBackgroundFill(TabStripTab tabStripTab)
Parameter Type Description
tabStripTab TabStripTab

The tab strip page to examine.

Returns

BackgroundFill

ResolveForeColor(TabStripPage)

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

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

The tab strip page to examine.

Returns

Color

ResolveSeparatorColor()

Resolves the color to be used when drawing a separator between tabs.

protected abstract Color ResolveSeparatorColor()

Returns

Color

ShouldSerializeMatchBackgroundToParentForm()

Indicates whether the MatchBackgroundToParentForm property should be persisted.

public virtual bool ShouldSerializeMatchBackgroundToParentForm()

Returns

bool:

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

ShouldSerializeTabStripBackgroundFill()

Indicates whether the TabStripBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripButtonGlyphColor()

Indicates whether the TabStripButtonGlyphColor property should be persisted.

public virtual bool ShouldSerializeTabStripButtonGlyphColor()

Returns

bool:

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

ShouldSerializeTabStripButtonHotBackgroundFill()

Indicates whether the TabStripButtonHotBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripButtonHotBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripButtonHotBorder()

Indicates whether the TabStripButtonHotBorder property should be persisted.

public virtual bool ShouldSerializeTabStripButtonHotBorder()

Returns

bool:

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

ShouldSerializeTabStripButtonHotPressedBackgroundFill()

Indicates whether the TabStripButtonHotPressedBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripButtonHotPressedBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripButtonHotPressedBorder()

Indicates whether the TabStripButtonHotPressedBorder property should be persisted.

public virtual bool ShouldSerializeTabStripButtonHotPressedBorder()

Returns

bool:

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

ShouldSerializeTabStripButtonHotPressedOffset()

Indicates whether the TabStripButtonHotPressedOffset property should be persisted.

public virtual bool ShouldSerializeTabStripButtonHotPressedOffset()

Returns

bool:

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

ShouldSerializeTabStripButtonNormalBackgroundFill()

Indicates whether the TabStripButtonNormalBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripButtonNormalBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripButtonNormalBorder()

Indicates whether the TabStripButtonNormalBorder property should be persisted.

public virtual bool ShouldSerializeTabStripButtonNormalBorder()

Returns

bool:

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

ShouldSerializeTabStripHighContrastBackgroundFill()

Indicates whether the TabStripHighContrastBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripHighContrastBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripPageDefaultBackgroundFill()

Indicates whether the TabStripPageDefaultBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripPageDefaultBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripTabContainerBackgroundFill()

Indicates whether the TabStripTabContainerBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripTabContainerBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripTabContainerBorderVisible()

Indicates whether the TabStripTabContainerBorderVisible property should be persisted.

public virtual bool ShouldSerializeTabStripTabContainerBorderVisible()

Returns

bool:

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

ShouldSerializeTabStripTabDisabledForeColor()

Indicates whether the TabStripTabDisabledForeColor property should be persisted.

public virtual bool ShouldSerializeTabStripTabDisabledForeColor()

Returns

bool:

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

ShouldSerializeTabStripTabSelectedBackgroundFill()

Indicates whether the TabStripTabSelectedBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripTabSelectedBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripTabSelectedForeColor()

Indicates whether the TabStripTabSelectedForeColor property should be persisted.

public virtual bool ShouldSerializeTabStripTabSelectedForeColor()

Returns

bool:

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

ShouldSerializeTabStripTabTextStringTrimming()

Indicates whether the TabStripTabTextStringTrimming property should be persisted.

public virtual bool ShouldSerializeTabStripTabTextStringTrimming()

Returns

bool:

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

ShouldSerializeTabStripTabUnselectedBackgroundFill()

Indicates whether the TabStripTabUnselectedBackgroundFill property should be persisted.

public virtual bool ShouldSerializeTabStripTabUnselectedBackgroundFill()

Returns

bool:

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

ShouldSerializeTabStripTabUnselectedForeColor()

Indicates whether the TabStripTabUnselectedForeColor property should be persisted.

public virtual bool ShouldSerializeTabStripTabUnselectedForeColor()

Returns

bool:

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

Inherited Members

Extension Methods