Class RadTabbedFormControl

Represents a control that has a collection of tabs painted in the non-client area and associated containers hosting other controls.

Inheritance
System.Object
RadControl
RadNonClientUIControl
RadNCEnabledControl
RadTabbedFormControl
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadTabbedFormControl : RadNCEnabledControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadTabbedFormControl()

Declaration
public RadTabbedFormControl()

Properties

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

BackColor

RadTabbedFormControl consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

CanRaiseEvents

Determines whether event raising is currently enabled.

Declaration
protected override bool CanRaiseEvents { get; }
Property Value
System.Boolean

CaptionHeight

Gets or sets the height of the extended title bar.

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

CausesValidation

Gets or sets a flag indicating whether the control causes validation

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

CloseButton

Gets or sets if the tabbed form has close button in its caption

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

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Dock

Declaration
public override DockStyle Dock { get; set; }
Property Value
System.Windows.Forms.DockStyle

ForeColor

RadTabbedFormControl consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

HelpButtonElement

Declaration
public override RadItem HelpButtonElement { get; }
Property Value
RadItem

Overrides

IconCaptionElement

Declaration
public override ImagePrimitive IconCaptionElement { get; }
Property Value
ImagePrimitive

Overrides

ItemDragMode

Gets or sets the drag mode of the tabs.

Declaration
public TabItemDragMode ItemDragMode { get; set; }
Property Value
TabItemDragMode

LeftItems

Declaration
[RadEditItemsAction]
[RadDescription("QuickAccessMenuItems", typeof(RadTabbedFormControlElement))]
[RadNewItem("Type here", true, false)]
public virtual RadItemOwnerCollection LeftItems { get; }
Property Value
RadItemOwnerCollection

LeftItemsContainer

Gets the left LeftItemsContainer element

Declaration
public RadQuickAccessToolBar LeftItemsContainer { get; }
Property Value
RadQuickAccessToolBar

MaximizeButton

Gets or sets if the tabbed form has maximize button in its caption

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

MaximizeButtonElement

Declaration
public override RadItem MaximizeButtonElement { get; }
Property Value
RadItem

Overrides

MinimizeButton

Gets or sets if the tabbed form has minimize button in its caption

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

MinimizeButtonElement

Declaration
public override RadItem MinimizeButtonElement { get; }
Property Value
RadItem

Overrides

MinimumTabWidth

Gets or sets the minimum width of the tab.

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

PinnedItemsPosition

Gets or sets whether the pinned items will be displayed at the front or at the back of the title bar.

Declaration
public virtual PinnedItemsPosition PinnedItemsPosition { get; set; }
Property Value
PinnedItemsPosition

RightItems

Declaration
[RadEditItemsAction]
[RadDescription("QuickAccessMenuItems", typeof(RadTabbedFormControlElement))]
[RadNewItem("Type here", true, false)]
public virtual RadItemOwnerCollection RightItems { get; }
Property Value
RadItemOwnerCollection

RightItemsContainer

Gets the right RightItemsContainer element

Declaration
public RadQuickAccessToolBar RightItemsContainer { get; }
Property Value
RadQuickAccessToolBar

SelectedTab

Gets or sets the RadTabbedFormControlTab instance that is currently selected.

Declaration
public RadTabbedFormControlTab SelectedTab { get; set; }
Property Value
RadTabbedFormControlTab

ShowIcon

Gets or sets a value indicating whether an icon is displayed in the caption bar of the form.

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

ShowNewTabButton

Gets or sets whether the new tab button will be visible.

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

ShowTabCloseButton

Gets or sets whether close button will be displayed in the tab.

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

ShowTabPinButton

Gets or sets whether pin button will be displayed in the tab.

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

ShowText

Gets or sets whether the element holding the text is visible.

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

SmallImageList

Gets or sets the small image list

Declaration
public override ImageList SmallImageList { get; set; }
Property Value
System.Windows.Forms.ImageList

Overrides

SystemButtonsElement

Declaration
public override RadItem SystemButtonsElement { get; }
Property Value
RadItem

Overrides

TabbedFormControlElement

Gets the instance of RadTabbedFormControlElement wrapped by this control. The RadTabbedFormControlElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadTabbedFormControl.

Declaration
public RadTabbedFormControlElement TabbedFormControlElement { get; }
Property Value
RadTabbedFormControlElement

TabbedFormControlTabsElement

Gets the TabbedFormControlTabsElement element

Declaration
public RadTabbedFormControlTabsElement TabbedFormControlTabsElement { get; }
Property Value
RadTabbedFormControlTabsElement

TabHeight

Gets or sets the default height of the tab.

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

Tabs

Gets the collection of tabs for this view.

Declaration
public RadTabbedFormControlTabCollection Tabs { get; }
Property Value
RadTabbedFormControlTabCollection

TabSpacing

Gets or sets the spacing between the tabs.

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

TabWidth

Gets or sets the default width of the tab.

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

Text

Gets or sets the text of the control

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

Overrides

TextCaptionElement

Declaration
public override RadElement TextCaptionElement { get; }
Property Value
RadElement

Overrides

ThemeClassName

Declaration
public override string ThemeClassName { get; }
Property Value
System.String

Overrides

Methods

Construct()

Declaration
protected override void Construct()
Overrides

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateControlsInstance()

Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
System.Windows.Forms.Control.ControlCollection

CreateTabbedFormControlElement()

Declaration
protected virtual RadTabbedFormControlElement CreateTabbedFormControlElement()
Returns
RadTabbedFormControlElement

CreateTabsInstance()

Declaration
protected virtual RadTabbedFormControlTabCollection CreateTabsInstance()
Returns
RadTabbedFormControlTabCollection

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

InitializeRootElement(RootRadElement)

Declaration
protected override void InitializeRootElement(RootRadElement rootElement)
Parameters
RootRadElement rootElement

Overrides

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnNewTabRequested(RadTabbedFormControlNewTabRequestedEventArgs)

Declaration
protected virtual void OnNewTabRequested(RadTabbedFormControlNewTabRequestedEventArgs e)
Parameters
RadTabbedFormControlNewTabRequestedEventArgs e

OnParentChanged(EventArgs)

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

Overrides

OnRightToLeftChanged(EventArgs)

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

Overrides

OnSelectedTabChanged(EventArgs)

Declaration
protected virtual void OnSelectedTabChanged(EventArgs e)
Parameters
System.EventArgs e

OnSelectedTabChanging(RadTabbedFormControlCancelEventArgs)

Declaration
protected virtual void OnSelectedTabChanging(RadTabbedFormControlCancelEventArgs e)
Parameters
RadTabbedFormControlCancelEventArgs e

OnTabAdded(RadTabbedFormControlEventArgs)

Declaration
protected virtual void OnTabAdded(RadTabbedFormControlEventArgs e)
Parameters
RadTabbedFormControlEventArgs e

OnTabAdding(RadTabbedFormControlCancelEventArgs)

Declaration
protected virtual void OnTabAdding(RadTabbedFormControlCancelEventArgs e)
Parameters
RadTabbedFormControlCancelEventArgs e

OnTabIndexChanged(RadTabbedFormControlIndexChangedEventArgs)

Declaration
protected virtual void OnTabIndexChanged(RadTabbedFormControlIndexChangedEventArgs e)
Parameters
RadTabbedFormControlIndexChangedEventArgs e

OnTabIndexChanging(RadTabbedFormControlIndexChangingEventArgs)

Declaration
protected virtual void OnTabIndexChanging(RadTabbedFormControlIndexChangingEventArgs e)
Parameters
RadTabbedFormControlIndexChangingEventArgs e

OnTabRemoved(RadTabbedFormControlEventArgs)

Declaration
protected virtual void OnTabRemoved(RadTabbedFormControlEventArgs e)
Parameters
RadTabbedFormControlEventArgs e

OnTabRemoving(RadTabbedFormControlCancelEventArgs)

Declaration
protected virtual void OnTabRemoving(RadTabbedFormControlCancelEventArgs e)
Parameters
RadTabbedFormControlCancelEventArgs e

OnTabsCleared(EventArgs)

Declaration
protected virtual void OnTabsCleared(EventArgs e)
Parameters
System.EventArgs e

OnTabsClearing(CancelEventArgs)

Declaration
protected virtual void OnTabsClearing(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

ProcessCodedUIMessage(ref IPCMessage)

Declaration
protected override void ProcessCodedUIMessage(ref IPCMessage request)
Parameters
IPCMessage request

Overrides

ProcessParentNotifyMessage(ref Message)

Declaration
protected virtual void ProcessParentNotifyMessage(ref Message m)
Parameters
System.Windows.Forms.Message m

ResumeEvents()

Resumes event raising, previously suspended by a SuspendEvents call.

Declaration
public void ResumeEvents()

SetSelectedTab(RadTabbedFormControlEventArgs)

Declaration
protected virtual void SetSelectedTab(RadTabbedFormControlEventArgs e)
Parameters
RadTabbedFormControlEventArgs e

SuspendEvents()

Temporary suspends event raising.

Declaration
public void SuspendEvents()

WmNCHitTest(ref Message)

Declaration
protected override bool WmNCHitTest(ref Message msg)
Parameters
System.Windows.Forms.Message msg

Returns
System.Boolean

Overrides

Events

ContextMenuOpening

Raised when tab item is about to be created.

Declaration
public event EventHandler<RadTabbedFormControlItemConextMenuOpeningEventArgs> ContextMenuOpening
Event Type
System.EventHandler<RadTabbedFormControlItemConextMenuOpeningEventArgs>

ItemCreating

Raised when tab item is about to be created.

Declaration
public event EventHandler<RadTabbedFormControlItemCreatingEventArgs> ItemCreating
Event Type
System.EventHandler<RadTabbedFormControlItemCreatingEventArgs>

ItemDropped

Occurs when an item was dropped over another item.

Declaration
public event EventHandler<RadTabbedFormControlItemDroppedEventArgs> ItemDropped
Event Type
System.EventHandler<RadTabbedFormControlItemDroppedEventArgs>

ItemDropping

Occurs when an item is about to be dropped over another item.

Declaration
public event EventHandler<RadTabbedFormControlItemDroppingEventArgs> ItemDropping
Event Type
System.EventHandler<RadTabbedFormControlItemDroppingEventArgs>

NewTabRequested

Raised when a new tab is requested.

Declaration
public event EventHandler<RadTabbedFormControlNewTabRequestedEventArgs> NewTabRequested
Event Type
System.EventHandler<RadTabbedFormControlNewTabRequestedEventArgs>

SelectedTabChanged

Raised when currently selected tab has changed.

Declaration
public event EventHandler SelectedTabChanged
Event Type
System.EventHandler

SelectedTabChanging

Raised when currently selected tab has changed.

Declaration
public event EventHandler<RadTabbedFormControlCancelEventArgs> SelectedTabChanging
Event Type
System.EventHandler<RadTabbedFormControlCancelEventArgs>

TabAdded

Raised when a new tab has been successfully added to the control.

Declaration
public event EventHandler<RadTabbedFormControlEventArgs> TabAdded
Event Type
System.EventHandler<RadTabbedFormControlEventArgs>

TabAdding

Raised when a new tab is about to be added to the control. Cancelable.

Declaration
public event EventHandler<RadTabbedFormControlCancelEventArgs> TabAdding
Event Type
System.EventHandler<RadTabbedFormControlCancelEventArgs>

TabItemIndexChanged

Raised when a tab's index has been successfully changed.

Declaration
public event EventHandler<RadTabbedFormControlIndexChangedEventArgs> TabItemIndexChanged
Event Type
System.EventHandler<RadTabbedFormControlIndexChangedEventArgs>

TabItemIndexChanging

Raised when a tab is about to change its index. Cancelable.

Declaration
public event EventHandler<RadTabbedFormControlIndexChangingEventArgs> TabItemIndexChanging
Event Type
System.EventHandler<RadTabbedFormControlIndexChangingEventArgs>

TabRemoved

Raised when a tab has been successfully removed from the control.

Declaration
public event EventHandler<RadTabbedFormControlEventArgs> TabRemoved
Event Type
System.EventHandler<RadTabbedFormControlEventArgs>

TabRemoving

Raised when a tab is about to be removed from the control. Cancelable.

Declaration
public event EventHandler<RadTabbedFormControlCancelEventArgs> TabRemoving
Event Type
System.EventHandler<RadTabbedFormControlCancelEventArgs>

TabsCleared

Raised when all tabs have been successfully removed from the control.

Declaration
public event EventHandler TabsCleared
Event Type
System.EventHandler

TabsClearing

Raised when all tabs are about to be removed from the control. Cancelable.

Declaration
public event CancelEventHandler TabsClearing
Event Type
System.ComponentModel.CancelEventHandler

Extension Methods