Utils.TabDisplayItem

Back to home | Back to Reference | View raw text

TabDisplayItem class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SolidShineUi.Utils
  SolidShineUi.Utils.TabDisplayItem[[TabDisplayItem]]
  end
  subgraph System.Windows.Markup
System.Windows.Markup.IComponentConnector[[IComponentConnector]]
  end
  subgraph System.Windows.Controls
System.Windows.Controls.UserControl[[UserControl]]
  end
System.Windows.Markup.IComponentConnector --> SolidShineUi.Utils.TabDisplayItem
System.Windows.Controls.UserControl --> SolidShineUi.Utils.TabDisplayItem

Loading

Members

Properties

Public properties

Type	Name	Methods
bool	AllowDataDragDrop Get or set if data can be dropped onto this TabDisplayItem.	get, set
bool	AllowDragDrop Get or set if the tab can be dragged and dropped.	get, set
Brush	BorderBrush Get or set the brush for the border of this control.	get, set
Brush	BorderHighlightBrush Get or set the brush for the border while this TabDisplayItem is highlighted (i.e. the mouse is over it, or it had keyboard focus).	get, set
bool	CanSelect Get or set if the tab can be selected.	get, set
ColorScheme	ColorScheme Get or set the color scheme to apply to the window.	get, set
Brush	HighlightBrush Get or set the brush for the background while this TabDisplayItem is highlighted (i.e. the mouse is over it, or it has keyboard focus).	get, set
bool	IsDirty Get or set if this tab is dirty. This can be used to visually indicate, for example, unsaved changes in the tab's contents.	get, set
bool	IsSelected Get or set if this tab is selected. A selected tab will have visual differences to show that it is selected.	get, set
TabControl	ParentTabControl Get or set the parent TabControl item that holds this tab item.	get, set
bool	ShowTabsOnBottom Get or set if the parent tab control has its ShowTabsOnBottom property set.	get, set
Brush	TabBackground Get or set the brush used for the custom background of this tab. Taken from TabItem.TabBackground .	get, set
TabItem	TabItem The TabItem that this TabDisplayItem is representing. It is not advisable to change this property after the control is loaded; instead, just create a new TabDisplayItem.	get, set

Methods

Public Static methods

Returns	Name
void	OnColorSchemeChanged(DependencyObject d, DependencyPropertyChangedEventArgs e) Perform an action when the ColorScheme property has changed. Primarily used internally.

Public methods

Returns	Name
void	ApplyColorScheme(ColorScheme cs) Apply a color scheme to this control. The color scheme can quickly apply a whole visual style to the control.
void	InitializeComponent() InitializeComponent

Internal methods

Returns	Name
Delegate	_CreateDelegate(Type delegateType, string handler)

Details

Inheritance

• IComponentConnector
• UserControl

Constructors

TabDisplayItem [1/2]

public TabDisplayItem()

Summary

Create a TabDisplayItem.

TabDisplayItem [2/2]

public TabDisplayItem(TabItem tab)

Arguments

Type	Name	Description
TabItem	tab	The base TabItem that this TabDisplayItem represents.

Summary

Create a TabDisplayItem.

Methods

OnColorSchemeChanged

public static void OnColorSchemeChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)

Arguments

Type	Name	Description
DependencyObject	d	The object containing the property that changed.
DependencyPropertyChangedEventArgs	e	Event arguments about the property change.

Summary

Perform an action when the ColorScheme property has changed. Primarily used internally.

ApplyColorScheme

public void ApplyColorScheme(ColorScheme cs)

Arguments

Type	Name	Description
ColorScheme	cs	The color scheme to apply.

Summary

Apply a color scheme to this control. The color scheme can quickly apply a whole visual style to the control.

InitializeComponent

public virtual void InitializeComponent()

Summary

InitializeComponent

_CreateDelegate

internal Delegate _CreateDelegate(Type delegateType, string handler)

Arguments

Type	Name	Description
Type	delegateType
string	handler

Properties

HighlightBrush

public Brush HighlightBrush { get; set; }

Summary

Get or set the brush for the background while this TabDisplayItem is highlighted (i.e. the mouse is over it, or it has keyboard focus).

BorderHighlightBrush

public Brush BorderHighlightBrush { get; set; }

Summary

Get or set the brush for the border while this TabDisplayItem is highlighted (i.e. the mouse is over it, or it had keyboard focus).

BorderBrush

public Brush BorderBrush { get; set; }

Summary

Get or set the brush for the border of this control.

TabBackground

public Brush TabBackground { get; set; }

Summary

Get or set the brush used for the custom background of this tab. Taken from TabItem.TabBackground .

CanSelect

public bool CanSelect { get; set; }

Summary

Get or set if the tab can be selected.

IsDirty

public bool IsDirty { get; set; }

Summary

Get or set if this tab is dirty. This can be used to visually indicate, for example, unsaved changes in the tab's contents.

IsSelected

public bool IsSelected { get; set; }

Summary

Get or set if this tab is selected. A selected tab will have visual differences to show that it is selected.

TabItem

public TabItem TabItem { get; set; }

Summary

The TabItem that this TabDisplayItem is representing. It is not advisable to change this property after the control is loaded; instead, just create a new TabDisplayItem.

ShowTabsOnBottom

public bool ShowTabsOnBottom { get; set; }

Summary

Get or set if the parent tab control has its ShowTabsOnBottom property set.

Remarks

This setting is used as there are some visual differences, depending upon if the tab list is on the top or bottom of the tab control.

ParentTabControl

public TabControl ParentTabControl { get; set; }

Summary

Get or set the parent TabControl item that holds this tab item.

ColorScheme

public ColorScheme ColorScheme { get; set; }

Summary

Get or set the color scheme to apply to the window.

AllowDragDrop

public bool AllowDragDrop { get; set; }

Summary

Get or set if the tab can be dragged and dropped.

AllowDataDragDrop

public bool AllowDataDragDrop { get; set; }

Summary

Get or set if data can be dropped onto this TabDisplayItem.

Events

RequestClose

public event EventHandler RequestClose

Summary

Raised when the Close button is clicked, and this tab wants to be closed.

RightClick

public event EventHandler RightClick

Summary

Raised when the control is right-clicked.

Click

public event EventHandler Click

Summary

Raised when the control is clicked.

TabItemDrop

public event TabItemDropEventHandler TabItemDrop

Summary

Raised when a TabItem is dropped onto this TabDisplayItem. Used as part of the TabControl's drag-and-drop system.

InternalTabBackgroundChanged

protected event DependencyPropertyChangedEventHandler InternalTabBackgroundChanged

Summary

Internal event for handling a property changed. Please view the event that is not prefixed as "Internal".

InternalIsSelectedChanged

protected event DependencyPropertyChangedEventHandler InternalIsSelectedChanged

Summary

Internal event for handling a property changed. Please view the event that is not prefixed as "Internal".

InternalTabItemChanged

protected event DependencyPropertyChangedEventHandler InternalTabItemChanged

Summary

Internal event for handling a property changed. Please view the event that is not prefixed as "Internal".

InternalShowTabsOnBottomChanged

protected event DependencyPropertyChangedEventHandler InternalShowTabsOnBottomChanged

Summary

Internal event for handling a property changed. Please view the event that is not prefixed as "Internal".

InternalParentChanged

protected event DependencyPropertyChangedEventHandler InternalParentChanged

Summary

Internal event for handling a property changed. Please view the event that is not prefixed as "Internal".

Delegates

TabItemDropEventHandler

public delegate void TabItemDropEventHandler(object sender, TabItemDropEventArgs e)

Arguments

Type	Name	Description
object	sender
TabItemDropEventArgs	e

Generated with ModularDoc