Class RadTabbedWindow

A Window component which hosts RadTabControl and simulates browser behavior. Tabs can be selected, pinned, unpinned, closed, reordered.

Inheritance
System.Object
WindowBase
RadWindow
RadTabbedWindow
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadTabbedWindow : RadWindow, INotifyLayoutChange, IWindowDragAware, IDragAware, IClickAware, IThemable

Constructors

RadTabbedWindow()

Initializes a new instance of the RadTabbedWindow class.

Declaration
public RadTabbedWindow()
Remarks

Use this constructor to create an instance of the RadTabbedWindow. In order for the RadTabbedWindow to be displayed, it is not necessary to add it to the visual tree.

Fields

AddButtonStyleProperty

Identifies the AddButtonStyle property.

Declaration
public static readonly DependencyProperty AddButtonStyleProperty
Field Value
System.Windows.DependencyProperty

AddButtonVisibilityProperty

Identifies the AddButtonVisibility dependency property.

Declaration
public static readonly DependencyProperty AddButtonVisibilityProperty
Field Value
System.Windows.DependencyProperty

DisplayMemberPathProperty

Registers the DisplayMemberPath property.

Declaration
public static readonly DependencyProperty DisplayMemberPathProperty
Field Value
System.Windows.DependencyProperty

DragDropModeProperty

Registers the DragDropMode property.

Declaration
public static readonly DependencyProperty DragDropModeProperty
Field Value
System.Windows.DependencyProperty

IsContentPreservedProperty

Identifies the IsContentPreserved property.

Declaration
public static readonly DependencyProperty IsContentPreservedProperty
Field Value
System.Windows.DependencyProperty

ItemContainerStyleProperty

Identifies the ItemContainerStyle dependency property.

Declaration
public static readonly DependencyProperty ItemContainerStyleProperty
Field Value
System.Windows.DependencyProperty

ItemContainerStyleSelectorProperty

Identifies the ItemContainerStyleSelector dependency property.

Declaration
public static readonly DependencyProperty ItemContainerStyleSelectorProperty
Field Value
System.Windows.DependencyProperty

ItemMinWidthProperty

Registers the ItemMinWidth property.

Declaration
public static readonly DependencyProperty ItemMinWidthProperty
Field Value
System.Windows.DependencyProperty

ItemsPanelProperty

Identifies the ItemsPanel dependency property.

Declaration
public static readonly DependencyProperty ItemsPanelProperty
Field Value
System.Windows.DependencyProperty

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
System.Windows.DependencyProperty

ItemTemplateProperty

Identifies the ItemTemplate dependency property.

Declaration
public static readonly DependencyProperty ItemTemplateProperty
Field Value
System.Windows.DependencyProperty

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty ItemTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

ItemWidthProperty

Registers the ItemWidth property.

Declaration
public static readonly DependencyProperty ItemWidthProperty
Field Value
System.Windows.DependencyProperty

ScrollModeProperty

Identifies the ScrollModeProperty property.

Declaration
public static readonly DependencyProperty ScrollModeProperty
Field Value
System.Windows.DependencyProperty

SelectedIndexProperty

Identifies the SelectedIndex dependency property.

Declaration
public static readonly DependencyProperty SelectedIndexProperty
Field Value
System.Windows.DependencyProperty

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
System.Windows.DependencyProperty

SelectedItemRemoveBehaviourProperty

Identifies the SelectedItemRemoveBehaviour property.

Declaration
public static readonly DependencyProperty SelectedItemRemoveBehaviourProperty
Field Value
System.Windows.DependencyProperty

TabbedWindowCreatingEvent

Registers the TabbedWindowCreating routed event.

Declaration
public static readonly RoutedEvent TabbedWindowCreatingEvent
Field Value
System.Windows.RoutedEvent

Properties

AddButtonStyle

Gets or sets the style of the add tabs button.

Declaration
public Style AddButtonStyle { get; set; }
Property Value
System.Windows.Style

AddButtonVisibility

Gets or sets the AddButtonVisibility.

Declaration
public Visibility AddButtonVisibility { get; set; }
Property Value
System.Windows.Visibility

Content

This property does not apply to RadTabbedWindow.

Declaration
public object Content { get; set; }
Property Value
System.Object

DisplayMemberPath

Gets or sets the DisplayMemberPath of the TabControl.

Declaration
public string DisplayMemberPath { get; set; }
Property Value
System.String

DragDropMode

Gets or sets a value indicating the current drag drop mode.

Declaration
public DragDropMode DragDropMode { get; set; }
Property Value
DragDropMode

IsContentPreserved

Gets or sets a value indicating whether the state of the content will be preserved when selection is changed.

Declaration
public bool IsContentPreserved { get; set; }
Property Value
System.Boolean

True if the first tab will preserve the content state; otherwise, false.

ItemContainerStyle

Gets or sets the ItemContainerStyle of the TabControl.

Declaration
public Style ItemContainerStyle { get; set; }
Property Value
System.Windows.Style

ItemContainerStyleSelector

Gets or sets the ItemContainerStyleSelector of the TabControl.

Declaration
public StyleSelector ItemContainerStyleSelector { get; set; }
Property Value
System.Windows.Controls.StyleSelector

ItemMinWidth

Gets or sets the minimum width of the tab items.

Declaration
public double ItemMinWidth { get; set; }
Property Value
System.Double

Items

Gets the Items of the inner RadTabControl. They can be populated either in XAML or in code.

Declaration
public IList Items { get; }
Property Value
System.Collections.IList

ItemsPanel

Gets or sets the ItemsPanel of the TabControl.

Declaration
public ItemsPanelTemplate ItemsPanel { get; set; }
Property Value
System.Windows.Controls.ItemsPanelTemplate

ItemsSource

Gets or sets the ItemsSource of the TabControl.

Declaration
public IEnumerable ItemsSource { get; set; }
Property Value
System.Collections.IEnumerable

ItemTemplate

Gets or sets the ItemTemplate of the TabControl.

Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
System.Windows.DataTemplate

ItemTemplateSelector

Gets or sets the ItemTemplateSelector of the TabControl.

Declaration
public DataTemplateSelector ItemTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

ItemWidth

Gets or sets the default width of the tab items.

Declaration
public double ItemWidth { get; set; }
Property Value
System.Double

PinnedItems

Gets the collection of currently pinned RadTabItems.

Declaration
public ReadOnlyObservableCollection<RadTabItem> PinnedItems { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyObservableCollection<RadTabItem>

ScrollMode

Gets or sets the type of scrolling that will occur when the user presses the scroll buttons.

Declaration
public TabControlScrollMode ScrollMode { get; set; }
Property Value
TabControlScrollMode

SelectedIndex

Gets or sets the selected index of the TabControl.

Declaration
public int SelectedIndex { get; set; }
Property Value
System.Int32

SelectedItem

Gets or sets the selected item of the TabControl.

Declaration
public object SelectedItem { get; set; }
Property Value
System.Object

SelectedItemRemoveBehaviour

Determines what item should be selected when SelectedItem is removed.

Declaration
public SelectedItemRemoveBehaviour SelectedItemRemoveBehaviour { get; set; }
Property Value
SelectedItemRemoveBehaviour

Methods

add_PreviewSelectionChanged(RadSelectionChangedEventHandler)

Declaration
public void add_PreviewSelectionChanged(RadSelectionChangedEventHandler value)
Parameters
RadSelectionChangedEventHandler value

add_SelectionChanged(RadSelectionChangedEventHandler)

Declaration
public void add_SelectionChanged(RadSelectionChangedEventHandler value)
Parameters
RadSelectionChangedEventHandler value

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.

Declaration
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

Overrides

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event and sets System.Windows.FrameworkElement.DefaultStyleKey from the active theme.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

OnRenderSizeChanged(SizeChangedInfo)

Occurs when the render sized is changed.

Declaration
protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)
Parameters
System.Windows.SizeChangedInfo sizeInfo

OnTabbedWindowCreating(TabbedWindowCreatingEventArgs)

Occurs when new RadTabbedWindow is created with drag drop operation.

Declaration
protected virtual bool OnTabbedWindowCreating(TabbedWindowCreatingEventArgs args)
Parameters
TabbedWindowCreatingEventArgs args

Returns
System.Boolean

Returns True if user has not canceled the creation.

OnWindowStateChanged(EventArgs)

Occurs when WindowState is changed.

Declaration
protected override void OnWindowStateChanged(EventArgs args)
Parameters
System.EventArgs args

Overrides

PrepareNewWindow()

Creates a new RadTabbedWindow host when a tab is dragged out of its parent window.

Declaration
protected virtual RadTabbedWindow PrepareNewWindow()
Returns
RadTabbedWindow

Returns a new instance of RadTabbedWindow that serves as a host of the dragged out RadTabItem

remove_PreviewSelectionChanged(RadSelectionChangedEventHandler)

Declaration
public void remove_PreviewSelectionChanged(RadSelectionChangedEventHandler value)
Parameters
RadSelectionChangedEventHandler value

remove_SelectionChanged(RadSelectionChangedEventHandler)

Declaration
public void remove_SelectionChanged(RadSelectionChangedEventHandler value)
Parameters
RadSelectionChangedEventHandler value

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

Events

AddingNewTab

Occurs when RadTabItem is being added via the 'Add' button in the UI.

Declaration
public event EventHandler<AddingNewTabEventArgs> AddingNewTab
Event Type
System.EventHandler<AddingNewTabEventArgs>

ItemsChanged

Occurs when Items collection of RadTabItems is changed.

Declaration
public event NotifyCollectionChangedEventHandler ItemsChanged
Event Type
System.Collections.Specialized.NotifyCollectionChangedEventHandler

PreviewSelectionChanged

The preview event for SelectionChanged event. Handling this event rollbacks the selection. This is a RoutedEvent.

Declaration
public event RadSelectionChangedEventHandler PreviewSelectionChanged
Event Type
RadSelectionChangedEventHandler

PreviewTabClosed

Occurs when a RadTabItem is about to be closed.

Declaration
public event EventHandler<PreviewTabChangedEventArgs> PreviewTabClosed
Event Type
System.EventHandler<PreviewTabChangedEventArgs>

PreviewTabPinned

Occurs when a RadTabItem is about to be pinned.

Declaration
public event EventHandler<PreviewTabChangedEventArgs> PreviewTabPinned
Event Type
System.EventHandler<PreviewTabChangedEventArgs>

PreviewTabUnpinned

Occurs when a RadTabItem is about to be unpinned.

Declaration
public event EventHandler<PreviewTabChangedEventArgs> PreviewTabUnpinned
Event Type
System.EventHandler<PreviewTabChangedEventArgs>

SelectionChanged

Occurs when a changed has been made to the selection. This is a RoutedEvent.

Declaration
public event RadSelectionChangedEventHandler SelectionChanged
Event Type
RadSelectionChangedEventHandler

TabbedWindowCreating

Occurs when a new RadTabbedWindow is created via drag drop and is about to be shown.

Declaration
public event EventHandler<TabbedWindowCreatingEventArgs> TabbedWindowCreating
Event Type
System.EventHandler<TabbedWindowCreatingEventArgs>

TabClosed

Occurs when a RadTabItem is closed.

Declaration
public event EventHandler<TabChangedEventArgs> TabClosed
Event Type
System.EventHandler<TabChangedEventArgs>

TabPinned

Occurs when a RadTabItem is pinned.

Declaration
public event EventHandler<TabChangedEventArgs> TabPinned
Event Type
System.EventHandler<TabChangedEventArgs>

TabUnpinned

Occurs when a RadTabItem is unpinned.

Declaration
public event EventHandler<TabChangedEventArgs> TabUnpinned
Event Type
System.EventHandler<TabChangedEventArgs>

Extension Methods