Back to all docs
API Reference / Telerik.Windows.Controls / RadTabbedWindow

Class
RadTabbedWindow

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

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:
cs-api-definition
[TelerikToolboxCategory("Navigation")]
public class RadTabbedWindow : RadWindow, INotifyLayoutChange, IDragAware

Inheritance: objectWindowBaseRadWindowRadTabbedWindow

Implements: IDragAwareINotifyLayoutChange

Inherited Members RadWindow.ResponseButtonPropertyRadWindow.IconPropertyRadWindow.IconMarginPropertyRadWindow.IconTemplatePropertyRadWindow.WindowStartupLocationPropertyRadWindow.DialogResultPropertyRadWindow.PromptResultPropertyRadWindow.BorderBackgroundPropertyRadWindow.RestoreMinimizedLocationPropertyRadWindow.IsRestrictedPropertyRadWindow.RestrictedAreaMarginPropertyRadWindow.IsRestrictedWhenMaximizedPropertyRadWindow.ShouldUpdateActiveStatePropertyRadWindow.Alert(object)RadWindow.Alert(object, EventHandler<WindowClosedEventArgs>)RadWindow.Alert(DialogParameters)RadWindow.Prompt(object, EventHandler<WindowClosedEventArgs>)RadWindow.Prompt(object, EventHandler<WindowClosedEventArgs>, string)RadWindow.Prompt(DialogParameters)RadWindow.Confirm(DialogParameters)RadWindow.Confirm(object, EventHandler<WindowClosedEventArgs>)RadWindow.ConfigureModal(RadAlert, DialogParameters)RadWindow.GetParentRadWindow(DependencyObject)RadWindow.GetResponseButton(DependencyObject)RadWindow.SetResponseButton(DependencyObject, ResponseButton)RadWindow.Show()RadWindow.ShowDialog()RadWindow.ShouldFocusOnActivate()RadWindow.ChangeVisualState(bool)RadWindow.OnPreviewClosed(WindowPreviewClosedEventArgs)RadWindow.OnClosed(WindowClosedEventArgs)RadWindow.OnHostCreated(HostWindowCreatedEventArgs)RadWindow.OnGotFocus(RoutedEventArgs)RadWindow.OnLostFocus(RoutedEventArgs)RadWindow.OnKeyDown(KeyEventArgs)RadWindow.OnClosing()RadWindow.OnPreviewClosed()RadWindow.GetWindowOwner()RadWindow.GetWindowStartupLocation()RadWindow.OnClosed()RadWindow.DefaultSizeRatioRadWindow.BorderBackgroundRadWindow.IconTemplateRadWindow.IconRadWindow.IconMarginRadWindow.WindowStartupLocationRadWindow.DialogResultRadWindow.PromptResultRadWindow.RestoreMinimizedLocationRadWindow.IsRestrictedRadWindow.RestrictedAreaMarginRadWindow.IsRestrictedWhenMaximizedRadWindow.ShouldUpdateActiveStateRadWindow.ClosedRadWindow.PreviewClosedRadWindow.HostCreatedWindowBase.IsModalPropertyWindowBase.IsOpenPropertyWindowBase.IsResizingPropertyWindowBase.IsDraggingPropertyWindowBase.IsActiveWindowPropertyWindowBase.IsInActiveStatePropertyWindowBase.IsTopmostPropertyWindowBase.CaptionHeightPropertyWindowBase.ResizeBorderPropertyWindowBase.LeftPropertyWindowBase.TopPropertyWindowBase.WindowStatePropertyWindowBase.ResizeModePropertyWindowBase.CanClosePropertyWindowBase.CanMovePropertyWindowBase.SizeToContentPropertyWindowBase.HideMinimizeButtonPropertyWindowBase.HideMaximizeButtonPropertyWindowBase.CornerRadiusPropertyWindowBase.Close()WindowBase.GetZIndex()WindowBase.BringToFront()WindowBase.GetNormalSizeAndPosition()WindowBase.ShouldActivateOnShow()WindowBase.ShouldShowInTaskSwitcher()WindowBase.ShouldActivate()WindowBase.ChangeVisualState()WindowBase.ShowWindow(bool)WindowBase.CheckCanClose()WindowBase.OnLayoutChangeEnded(EventArgs)WindowBase.OnLocationChanged(EventArgs)WindowBase.OnLayoutChangeStarted(EventArgs)WindowBase.OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)WindowBase.GetApplicationSize()WindowBase.OnLayoutChangeEnded()WindowBase.OnLayoutChangeStarted()WindowBase.CloseWithoutEventsAndAnimations()WindowBase.OnCloseAnimationFinished()WindowBase.OnShowAnimationFinished()WindowBase.OnRightMouseButtonUp()WindowBase.OnRootVisualSizeChanged()WindowBase.OnDragStart(Point, bool)WindowBase.OnDragEnd(Point, bool, bool)WindowBase.OnDragDelta(Point, Rect, Rect, bool)WindowBase.GetWindowOwnerHandle()WindowBase.OnActivated(EventArgs)WindowBase.OnDeactivated(EventArgs)WindowBase.ShouldSystemMenuOnRightClick()WindowBase.IsModalWindowBase.IsOpenWindowBase.IsTopmostWindowBase.CaptionHeightWindowBase.ResizeBorderWindowBase.LeftWindowBase.TopWindowBase.IsResizingWindowBase.IsDraggingWindowBase.IsLayoutChangingWindowBase.WindowStateWindowBase.ResizeModeWindowBase.CanCloseWindowBase.CanMoveWindowBase.IsActiveWindowWindowBase.IsInActiveStateWindowBase.CornerRadiusWindowBase.SizeToContentWindowBase.HideMaximizeButtonWindowBase.HideMinimizeButtonWindowBase.OwnerWindowBase.ActivatedWindowBase.DeactivatedWindowBase.LayoutChangeEndedWindowBase.LayoutChangeStartedWindowBase.LocationChangedWindowBase.WindowStateChanged

Constructors

RadTabbedWindow()

Initializes a new instance of the RadTabbedWindow class.

Declaration

cs-api-definition
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

cs-api-definition
public static readonly DependencyProperty AddButtonStyleProperty

Field Value

DependencyProperty

AddButtonVisibilityProperty

Identifies the AddButtonVisibility dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AddButtonVisibilityProperty

Field Value

DependencyProperty

DisplayMemberPathProperty

Registers the DisplayMemberPath property.

Declaration

cs-api-definition
public static readonly DependencyProperty DisplayMemberPathProperty

Field Value

DependencyProperty

DragDropModeProperty

Registers the DragDropMode property.

Declaration

cs-api-definition
public static readonly DependencyProperty DragDropModeProperty

Field Value

DependencyProperty

IsContentPreservedProperty

Identifies the IsContentPreserved property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsContentPreservedProperty

Field Value

DependencyProperty

ItemContainerStyleProperty

Identifies the ItemContainerStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemContainerStyleProperty

Field Value

DependencyProperty

ItemContainerStyleSelectorProperty

Identifies the ItemContainerStyleSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemContainerStyleSelectorProperty

Field Value

DependencyProperty

ItemMinWidthProperty

Registers the ItemMinWidth property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemMinWidthProperty

Field Value

DependencyProperty

ItemTemplateProperty

Identifies the ItemTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemTemplateProperty

Field Value

DependencyProperty

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemTemplateSelectorProperty

Field Value

DependencyProperty

ItemWidthProperty

Registers the ItemWidth property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemWidthProperty

Field Value

DependencyProperty

ItemsPanelProperty

Identifies the ItemsPanel dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemsPanelProperty

Field Value

DependencyProperty

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemsSourceProperty

Field Value

DependencyProperty

ScrollModeProperty

Identifies the ScrollModeProperty property.

Declaration

cs-api-definition
public static readonly DependencyProperty ScrollModeProperty

Field Value

DependencyProperty

SelectedIndexProperty

Identifies the SelectedIndex dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedIndexProperty

Field Value

DependencyProperty

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedItemProperty

Field Value

DependencyProperty

SelectedItemRemoveBehaviourProperty

Identifies the SelectedItemRemoveBehaviour property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedItemRemoveBehaviourProperty

Field Value

DependencyProperty

TabbedWindowCreatingEvent

Registers the TabbedWindowCreating routed event.

Declaration

cs-api-definition
public static readonly RoutedEvent TabbedWindowCreatingEvent

Field Value

RoutedEvent

Properties

AddButtonStyle

Gets or sets the style of the add tabs button.

Declaration

cs-api-definition
public Style AddButtonStyle { get; set; }

Property Value

Style

AddButtonVisibility

Gets or sets the AddButtonVisibility.

Declaration

cs-api-definition
public Visibility AddButtonVisibility { get; set; }

Property Value

Visibility

DisplayMemberPath

Gets or sets the DisplayMemberPath of the TabControl.

Declaration

cs-api-definition
public string DisplayMemberPath { get; set; }

Property Value

string

DragDropMode

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

Declaration

cs-api-definition
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

cs-api-definition
public bool IsContentPreserved { get; set; }

Property Value

bool

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

ItemContainerStyle

Gets or sets the ItemContainerStyle of the TabControl.

Declaration

cs-api-definition
public Style ItemContainerStyle { get; set; }

Property Value

Style

ItemContainerStyleSelector

Gets or sets the ItemContainerStyleSelector of the TabControl.

Declaration

cs-api-definition
public StyleSelector ItemContainerStyleSelector { get; set; }

Property Value

StyleSelector

ItemMinWidth

Gets or sets the minimum width of the tab items.

Declaration

cs-api-definition
public double ItemMinWidth { get; set; }

Property Value

double

ItemTemplate

Gets or sets the ItemTemplate of the TabControl.

Declaration

cs-api-definition
public DataTemplate ItemTemplate { get; set; }

Property Value

DataTemplate

ItemTemplateSelector

Gets or sets the ItemTemplateSelector of the TabControl.

Declaration

cs-api-definition
public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector

ItemWidth

Gets or sets the default width of the tab items.

Declaration

cs-api-definition
public double ItemWidth { get; set; }

Property Value

double

Items

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

Declaration

cs-api-definition
public IList Items { get; }

Property Value

IList

ItemsPanel

Gets or sets the ItemsPanel of the TabControl.

Declaration

cs-api-definition
public ItemsPanelTemplate ItemsPanel { get; set; }

Property Value

ItemsPanelTemplate

ItemsSource

Gets or sets the ItemsSource of the TabControl.

Declaration

cs-api-definition
public IEnumerable ItemsSource { get; set; }

Property Value

IEnumerable

PinnedItems

Gets the collection of currently pinned RadTabItems.

Declaration

cs-api-definition
public ReadOnlyObservableCollection<RadTabItem> PinnedItems { get; }

Property Value

ReadOnlyObservableCollection<RadTabItem>

ScrollMode

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

Declaration

cs-api-definition
public TabControlScrollMode ScrollMode { get; set; }

Property Value

TabControlScrollMode

SelectedIndex

Gets or sets the selected index of the TabControl.

Declaration

cs-api-definition
public int SelectedIndex { get; set; }

Property Value

int

SelectedItem

Gets or sets the selected item of the TabControl.

Declaration

cs-api-definition
public object SelectedItem { get; set; }

Property Value

object

SelectedItemRemoveBehaviour

Determines what item should be selected when SelectedItem is removed.

Declaration

cs-api-definition
public SelectedItemRemoveBehaviour SelectedItemRemoveBehaviour { get; set; }

Property Value

SelectedItemRemoveBehaviour

Methods

OnApplyTemplate()

Invoked whenever application-specific logic is needed to apply the template for the current instance of the RadTabbedWindow.

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides RadWindow.OnApplyTemplate()

Remarks

This method is called when the element is being templated and is used to apply visual tree changes and binding logic associated with the control's template.

OnCreateAutomationPeer()

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

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

Overrides RadWindow.OnCreateAutomationPeer()

OnInitialized(EventArgs)

Raises the event and sets from the active theme.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

Overrides RadWindow.OnInitialized(EventArgs)

OnRenderSizeChanged(SizeChangedInfo)

Occurs when the render sized is changed.

Declaration

cs-api-definition
protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)

Parameters

sizeInfo

SizeChangedInfo

OnTabbedWindowCreating(TabbedWindowCreatingEventArgs)

Occurs when new RadTabbedWindow is created with drag drop operation.

Declaration

cs-api-definition
protected virtual bool OnTabbedWindowCreating(TabbedWindowCreatingEventArgs args)

Parameters

args

TabbedWindowCreatingEventArgs

Returns

bool

Returns True if user has not canceled the creation.

OnWindowStateChanged(EventArgs)

Occurs when WindowState is changed.

Declaration

cs-api-definition
protected override void OnWindowStateChanged(EventArgs args)

Parameters

args

EventArgs

Overrides RadWindow.OnWindowStateChanged(EventArgs)

PrepareNewWindow()

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

Declaration

cs-api-definition
protected virtual RadTabbedWindow PrepareNewWindow()

Returns

RadTabbedWindow

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

ResetTheme()

Resets the theme.

Declaration

cs-api-definition
public void ResetTheme()

Events

AddingNewTab

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

Declaration

cs-api-definition
public event EventHandler<AddingNewTabEventArgs> AddingNewTab

Event Value

EventHandler<AddingNewTabEventArgs>

ItemsChanged

Occurs when Items collection of RadTabItems is changed.

Declaration

cs-api-definition
public event NotifyCollectionChangedEventHandler ItemsChanged

Event Value

NotifyCollectionChangedEventHandler

PreviewSelectionChanged

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

Declaration

cs-api-definition
public event RadSelectionChangedEventHandler PreviewSelectionChanged

Event Value

RadSelectionChangedEventHandler

PreviewTabClosed

Occurs when a RadTabItem is about to be closed.

Declaration

cs-api-definition
public event EventHandler<PreviewTabChangedEventArgs> PreviewTabClosed

Event Value

EventHandler<PreviewTabChangedEventArgs>

PreviewTabPinned

Occurs when a RadTabItem is about to be pinned.

Declaration

cs-api-definition
public event EventHandler<PreviewTabChangedEventArgs> PreviewTabPinned

Event Value

EventHandler<PreviewTabChangedEventArgs>

PreviewTabUnpinned

Occurs when a RadTabItem is about to be unpinned.

Declaration

cs-api-definition
public event EventHandler<PreviewTabChangedEventArgs> PreviewTabUnpinned

Event Value

EventHandler<PreviewTabChangedEventArgs>

SelectionChanged

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

Declaration

cs-api-definition
public event RadSelectionChangedEventHandler SelectionChanged

Event Value

RadSelectionChangedEventHandler

TabClosed

Occurs when a RadTabItem is closed.

Declaration

cs-api-definition
public event EventHandler<TabChangedEventArgs> TabClosed

Event Value

EventHandler<TabChangedEventArgs>

TabPinned

Occurs when a RadTabItem is pinned.

Declaration

cs-api-definition
public event EventHandler<TabChangedEventArgs> TabPinned

Event Value

EventHandler<TabChangedEventArgs>

TabUnpinned

Occurs when a RadTabItem is unpinned.

Declaration

cs-api-definition
public event EventHandler<TabChangedEventArgs> TabUnpinned

Event Value

EventHandler<TabChangedEventArgs>

TabbedWindowCreating

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

Declaration

cs-api-definition
public event EventHandler<TabbedWindowCreatingEventArgs> TabbedWindowCreating

Event Value

EventHandler<TabbedWindowCreatingEventArgs>

In this article
DefinitionConstructorsRadTabbedWindow()FieldsAddButtonStylePropertyAddButtonVisibilityPropertyDisplayMemberPathPropertyDragDropModePropertyIsContentPreservedPropertyItemContainerStylePropertyItemContainerStyleSelectorPropertyItemMinWidthPropertyItemTemplatePropertyItemTemplateSelectorPropertyItemWidthPropertyItemsPanelPropertyItemsSourcePropertyScrollModePropertySelectedIndexPropertySelectedItemPropertySelectedItemRemoveBehaviourPropertyTabbedWindowCreatingEventPropertiesAddButtonStyleAddButtonVisibilityDisplayMemberPathDragDropModeIsContentPreservedItemContainerStyleItemContainerStyleSelectorItemMinWidthItemTemplateItemTemplateSelectorItemWidthItemsItemsPanelItemsSourcePinnedItemsScrollModeSelectedIndexSelectedItemSelectedItemRemoveBehaviourMethodsOnApplyTemplate()OnCreateAutomationPeer()OnInitialized(EventArgs)OnRenderSizeChanged(SizeChangedInfo)OnTabbedWindowCreating(TabbedWindowCreatingEventArgs)OnWindowStateChanged(EventArgs)PrepareNewWindow()ResetTheme()EventsAddingNewTabItemsChangedPreviewSelectionChangedPreviewTabClosedPreviewTabPinnedPreviewTabUnpinnedSelectionChangedTabClosedTabPinnedTabUnpinnedTabbedWindowCreating
Not finding the help you need?
Contact Support