Class

RadTabControl

Initializes a new instance of the RadTabControl class.

Declaration

public RadTabControl()

Remarks

<pre><code class="lang-csharp"><telerik:RadTabControl>
    <telerik:RadTabItem Header="Tab 1"/>
</telerik:RadTabControl></code></pre>

<pre><code class="lang-csharp">RadTabControl tabControl = new RadTabControl();
tabControl.Items.Add(new RadTabItem(){Header="Tab 1", Content="Tab Content"});</code></pre>

Identifies the AdditionalContent property.

Declaration

public static readonly DependencyProperty AdditionalContentProperty

Field Value

Identifies the Align property.

Declaration

public static readonly DependencyProperty AlignProperty

Field Value

Identifies the AllTabsEqualHeight property.

Declaration

public static readonly DependencyProperty AllTabsEqualHeightProperty

Field Value

Identifies the AllowDragOverTab property.

Declaration

public static readonly DependencyProperty AllowDragOverTabProperty

Field Value

Identifies the AllowDragReorder property.

Declaration

public static readonly DependencyProperty AllowDragReorderProperty

Field Value

Identifies the BottomTemplate property.

Declaration

public static readonly DependencyProperty BottomTemplateProperty

Field Value

Identifies the CloseTabsOnMouseMiddleButtonDown property.

Declaration

public static readonly DependencyProperty CloseTabsOnMouseMiddleButtonDownProperty

Field Value

Identifies the DropDownButtonStyle property.

Declaration

public static readonly DependencyProperty DropDownButtonStyleProperty

Field Value

Identifies the DropDownDisplayMemberPath property.

Declaration

public static readonly DependencyProperty DropDownDisplayMemberPathProperty

Field Value

Identifies the DropDownDisplayMode property.

Declaration

public static readonly DependencyProperty DropDownDisplayModeProperty

Field Value

Identifies the DropDownStyle property.

Declaration

public static readonly DependencyProperty DropDownStyleProperty

Field Value

Identifies the InvertMouseWheelScrollDirection property.

Declaration

public static readonly DependencyProperty InvertMouseWheelScrollDirectionProperty

Field Value

Identifies the IsDropDownOpen property.

Declaration

public static readonly DependencyProperty IsDropDownOpenProperty

Field Value

Identifies the ItemDropDownContentTemplate property.

Declaration

public static readonly DependencyProperty ItemDropDownContentTemplateProperty

Field Value

Identifies the ItemDropDownContentTemplateSelector property.

Declaration

public static readonly DependencyProperty ItemDropDownContentTemplateSelectorProperty

Field Value

Identifies the ItemReordered routed event.

Declaration

public static readonly RoutedEvent ItemReorderedEvent

Field Value

Identifies the LeftTemplate property.

Declaration

public static readonly DependencyProperty LeftTemplateProperty

Field Value

Identifies the OverflowModeProperty property.

Declaration

public static readonly DependencyProperty OverflowModeProperty

Field Value

Registers the PreviewTabClosed routed event.

Declaration

public static readonly RoutedEvent PreviewTabClosedEvent

Field Value

Registers the PreviewTabPinned routed event.

Declaration

public static readonly RoutedEvent PreviewTabPinnedEvent

Field Value

Registers the PreviewTabUnpinned routed event.

Declaration

public static readonly RoutedEvent PreviewTabUnpinnedEvent

Field Value

Identifies the RightTemplate property.

Declaration

public static readonly DependencyProperty RightTemplateProperty

Field Value

Identifies the ScrollModeProperty property.

Declaration

public static readonly DependencyProperty ScrollModeProperty

Field Value

Registers the TabClosed routed event.

Declaration

public static readonly RoutedEvent TabClosedEvent

Field Value

Identifies the TabOrientation property.

Declaration

public static readonly DependencyProperty TabOrientationProperty

Field Value

Registers the TabPinned routed event.

Declaration

public static readonly RoutedEvent TabPinnedEvent

Field Value

Identifies the TabStripPlacement property.

Declaration

public static readonly DependencyProperty TabStripPlacementProperty

Field Value

Registers the TabUnpinned routed event.

Declaration

public static readonly RoutedEvent TabUnpinnedEvent

Field Value

Identifies the TopTemplate property.

Declaration

public static readonly DependencyProperty TopTemplateProperty

Field Value

Identifies the AdditionalContent property.

Declaration

public object AdditionalContent { get; set; }

Property Value

Gets or sets the alignment of the tab items in the row - Left, Right, Center, Justify. This is a dependency property.

Declaration

[SRDescription("TabControlAlignDescription")]
[SRCategory("AppearanceCategory")]
public TabStripAlign Align { get; set; }

Property Value

Remarks

Gets or sets whether all displayed tabs have equal height. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
[SRDescription("TabControlAllTabsEqualHeightDescription")]
public bool AllTabsEqualHeight { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether dragging objects over a tab item will select this TabItem. This is a dependency property.

Declaration

[SRCategory("Behavior")]
public bool AllowDragOverTab { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether the user will be able to rearrange the tabs with dragging. This is a dependency property.

Declaration

[SRCategory("Behavior")]
public bool AllowDragReorder { get; set; }

Property Value

Remarks

Gets or sets the template of the tab control when the TabStripPlacement is set to Bottom. This is a dependency property.

Declaration

[SRCategory("Appearance")]
[SRDescription("TabControlBottomTemplateDescription")]
public ControlTemplate BottomTemplate { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether user can close tabs by clicking the mouse middle button over a particular RadTabItem.

Declaration

public bool CloseTabsOnMouseMiddleButtonDown { get; set; }

Property Value

Gets or sets the style for the toggle button in the ControlTemplate of the tab control. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
public Style DropDownButtonStyle { get; set; }

Property Value

Gets or sets the name of property that will be used to display tab items in the . This is a dependency property.

Declaration

public string DropDownDisplayMemberPath { get; set; }

Property Value

Gets or sets when the button should be displayed: always, never, when needed. This is a dependency property.

Declaration

public TabControlDropDownDisplayMode DropDownDisplayMode { get; set; }

Property Value

Gets or sets the style for the of the tab control. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
public Style DropDownStyle { get; set; }

Property Value

Inverts the scrolling direction when using the mouse wheel over the tab strip panel.

Declaration

public bool InvertMouseWheelScrollDirection { get; set; }

Property Value

Gets or sets a value indicating whether the of the tab control is open. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
public bool IsDropDownOpen { get; set; }

Property Value

Gets or sets the DataTemplate that will be used to display the items in the drop down menu if they do not have a ItemDropDownContentTemplateSelector. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
public DataTemplate ItemDropDownContentTemplate { get; set; }

Property Value

Gets or sets the DataTemplateSelector that will be used to display the items in the drop down menu if they do not have a ItemDropDownContentTemplate. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
public DataTemplateSelector ItemDropDownContentTemplateSelector { get; set; }

Property Value

Gets or sets the template of the tab control when the TabStripPlacement is set to Left. This is a dependency property.

Declaration

[SRCategory("Appearance")]
[SRDescription("TabControlLeftTemplateDescription")]
public ControlTemplate LeftTemplate { get; set; }

Property Value

Remarks

Gets or sets what happens when the width of the tab items exceeds the available width. They will either scroll or wrap.

Declaration

public TabOverflowMode OverflowMode { get; set; }

Property Value

Gets the collection of currently pinned RadTabItems.

Declaration

public ReadOnlyObservableCollection<RadTabItem> PinnedItems { get; }

Property Value

Gets or sets the template of the tab control when the TabStripPlacement is set to Right. This is a dependency property.

Declaration

[SRCategory("Appearance")]
[SRDescription("TabControlRightTemplateDescription")]
public ControlTemplate RightTemplate { get; set; }

Property Value

Remarks

Gets or sets the type of scrolling that will occur when the user presses the scroll buttons. This is a dependency property.

Declaration

public TabControlScrollMode ScrollMode { get; set; }

Property Value

Gets or sets the orientation of the TabItems in the TabControl. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
[SRDescription("TabControlTabOrientationDescription")]
public Orientation TabOrientation { get; set; }

Property Value

Remarks

Gets or sets the position of the tab strip with regard to the content. This is a dependency property.

Declaration

[SRCategory("AppearanceCategory")]
[SRDescription("TabControlTabStripPlacementDescription")]
public Dock TabStripPlacement { get; set; }

Property Value

Remarks

Gets or sets the template of the tab control when the TabStripPlacement is set to Top. This is a dependency property.

Declaration

[SRCategory("Appearance")]
[SRDescription("TabControlTopTemplateDescription")]
public ControlTemplate TopTemplate { get; set; }

Property Value

Remarks

Updates the visual states of the control.

Declaration

protected override void ChangeVisualState(bool useTransitions)

Parameters

Overrides RadTabControlBase.ChangeVisualState(bool)

When overridden in a derived class, undoes the effects of the method.

Declaration

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

Returns a template for the given position of the tab strip.

Declaration

protected virtual ControlTemplate FindTemplateFromPosition(Dock position)

Parameters

Returns

Returns a new instance of the control that implements the IRadTabItem interface.

Declaration

protected override IRadTabItem GetContainer()

Returns

Overrides RadTabControlBase.GetContainer()

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

Declaration

public override void OnApplyTemplate()

Creates a peer associated with this object.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Called when a menu item has been clicked.

Declaration

[SuppressMessage("Microsoft.Security", "CA2109:ReviewVisibleEventHandlers", Justification = "There is no need to make the method private.")]
protected virtual void OnDropDownMenuItemClick(object sender, RoutedEventArgs e)

Parameters

Raises the event. This method is invoked whenever is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Called when the IsDropDownOpen property changes.

Declaration

protected virtual void OnIsDropDownOpenChanged(bool oldValue, bool newValue)

Parameters

Invoked when the property changes.

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

Invoked when the property changes.

Declaration

protected override void OnItemsPanelChanged(ItemsPanelTemplate oldItemsPanel, ItemsPanelTemplate newItemsPanel)

Parameters

Invoked when the left scroll button has been clicked.

Declaration

protected virtual void OnLeftScrollButtonClick(object sender, RoutedEventArgs e)

Parameters

Raises the event.

Declaration

protected virtual bool OnPreviewTabClosed(PreviewTabChangedEventArgs args)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewTabPinned(PreviewTabChangedEventArgs args)

Parameters

Returns

Raises the event.

Declaration

protected virtual bool OnPreviewTabUnpinned(PreviewTabChangedEventArgs args)

Parameters

Returns

Invoked when the right scroll button has been clicked.

Declaration

protected virtual void OnRightScrollButtonClick(object sender, RoutedEventArgs e)

Parameters

Invoked when scroll buttons visibility changes.

Declaration

protected virtual void OnScrollButtonsVisibilityChanged()

Raises the SelectionChanged routed event and selection automation events.

Declaration

protected override void OnSelectionChanged(RadSelectionChangedEventArgs e)

Parameters

Overrides RadTabControlBase.OnSelectionChanged(RadSelectionChangedEventArgs)

Raises the event.

Declaration

protected virtual void OnTabClosed(TabChangedEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnTabPinned(TabChangedEventArgs args)

Parameters

Raises the event.

Declaration

protected virtual void OnTabUnpinned(TabChangedEventArgs args)

Parameters

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

Scrolls the container of given item into view.

Declaration

public void ScrollIntoView(object item)

Parameters

Updates the selected content properties SelectedContent, SelectedContentTemplate and SelectedContentTemplateSelector. Selected content properties are used when representing the content of selected tab item.

Declaration

protected override void UpdateSelectedContentProperties()

Overrides RadTabControlBase.UpdateSelectedContentProperties()

Updates the tab strip.

Declaration

protected void UpdateTabStrip()

Occurs when a item is reordered while dragging. This is a RoutedEvent.

Declaration

public virtual event ItemReorderedEventHandler ItemReordered

Event Value

Occurs when a RadTabItem is about to be closed.

Declaration

public event EventHandler<PreviewTabChangedEventArgs> PreviewTabClosed

Event Value

Occurs when a RadTabItem is about to be pinned.

Declaration

public event EventHandler<PreviewTabChangedEventArgs> PreviewTabPinned

Event Value

Occurs when a RadTabItem is about to be unpinned.

Declaration

public event EventHandler<PreviewTabChangedEventArgs> PreviewTabUnpinned

Event Value

Occurs when a RadTabItem is closed.

Declaration

public event EventHandler<TabChangedEventArgs> TabClosed

Event Value

Occurs when a RadTabItem is pinned.

Declaration

public event EventHandler<TabChangedEventArgs> TabPinned

Event Value

Occurs when a RadTabItem is unpinned.

Declaration

public event EventHandler<TabChangedEventArgs> TabUnpinned

Event Value