Class

RadTabbedFormControl

Initializes a new instance of the RadTabbedFormControl class with default settings for tabbed form functionality.

Declaration

public RadTabbedFormControl()

Gets a value indicating whether event raising is currently enabled for this control, taking into account the suspend events counter.

Declaration

protected override bool CanRaiseEvents { get; }

Property Value

Overrides Control.CanRaiseEvents

Gets or sets the height of the extended title bar area that contains the tabs and caption elements.

Declaration

public virtual int CaptionHeight { get; set; }

Property Value

Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.

Declaration

[Browsable(false)]
public bool CausesValidation { get; set; }

Property Value

Gets or sets a value indicating whether the tabbed form displays a close button in its caption area.

Declaration

public bool CloseButton { get; set; }

Property Value

Gets the default size of the tabbed form control when no explicit size is specified.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets the help button element from the form's caption area, providing access to context-sensitive help functionality.

Declaration

public override RadItem HelpButtonElement { get; }

Property Value

Overrides RadNCEnabledControl.HelpButtonElement

Gets the icon caption element that represents the form's icon in the title bar area of the tabbed form control.

Declaration

public override ImagePrimitive IconCaptionElement { get; }

Property Value

Overrides RadNCEnabledControl.IconCaptionElement

Gets or sets the drag mode for tabs, determining when and how tab drag operations are initiated by the user.

Declaration

public TabItemDragMode ItemDragMode { get; set; }

Property Value

Gets the collection of items displayed on the left side of the tabbed form control's caption area, providing quick access functionality.

Declaration

[Browsable(true)]
[RadEditItemsAction]
[RadNewItem("Type here", true, false)]
public virtual RadItemOwnerCollection LeftItems { get; }

Property Value

Gets the left items container element that hosts quick access items on the left side of the tabbed form control's caption area.

Declaration

[Browsable(true)]
public RadQuickAccessToolBar LeftItemsContainer { get; }

Property Value

Gets or sets a value indicating whether the tabbed form displays a maximize button in its caption area.

Declaration

public bool MaximizeButton { get; set; }

Property Value

Gets the maximize button element from the form's caption area, providing access to the system maximize/restore functionality.

Declaration

public override RadItem MaximizeButtonElement { get; }

Property Value

Overrides RadNCEnabledControl.MaximizeButtonElement

Gets or sets a value indicating whether the tabbed form displays a minimize button in its caption area.

Declaration

public bool MinimizeButton { get; set; }

Property Value

Gets the minimize button element from the form's caption area, providing access to the system minimize functionality.

Declaration

public override RadItem MinimizeButtonElement { get; }

Property Value

Overrides RadNCEnabledControl.MinimizeButtonElement

Gets or sets the minimum width that tabs can be resized to, ensuring tabs remain readable and functional.

Declaration

public virtual int MinimumTabWidth { get; set; }

Property Value

Gets or sets the position where pinned tabs will be displayed relative to regular tabs in the title bar area.

Declaration

public virtual PinnedItemsPosition PinnedItemsPosition { get; set; }

Property Value

Gets the collection of items displayed on the right side of the tabbed form control's caption area, providing additional quick access functionality.

Declaration

[Browsable(true)]
[RadEditItemsAction]
[RadNewItem("Type here", true, false)]
public virtual RadItemOwnerCollection RightItems { get; }

Property Value

Gets the right items container element that hosts quick access items on the right side of the tabbed form control's caption area.

Declaration

[Browsable(true)]
public RadQuickAccessToolBar RightItemsContainer { get; }

Property Value

Gets or sets the RadTabbedFormControlTab instance that is currently selected and active in the tabbed form control.

Declaration

[Browsable(false)]
public RadTabbedFormControlTab SelectedTab { get; set; }

Property Value

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

Declaration

public virtual bool ShowIcon { get; set; }

Property Value

Gets or sets a value indicating whether the new tab button is visible, allowing users to create new tabs through the UI.

Declaration

public virtual bool ShowNewTabButton { get; set; }

Property Value

Gets or sets a value indicating whether close buttons are displayed on individual tabs, allowing users to close tabs directly.

Declaration

public virtual bool ShowTabCloseButton { get; set; }

Property Value

Gets or sets a value indicating whether pin buttons are displayed on individual tabs, allowing users to pin tabs for persistent visibility.

Declaration

public virtual bool ShowTabPinButton { get; set; }

Property Value

Gets or sets a value indicating whether the element holding the form title text is visible in the caption area.

Declaration

public virtual bool ShowText { get; set; }

Property Value

Gets or sets the collection of small images used throughout the tabbed form control for icons and visual elements.

Declaration

[Browsable(true)]
public override ImageList SmallImageList { get; set; }

Property Value

Overrides RadControl.SmallImageList

Gets the system buttons element container from the form's caption area, which houses the minimize, maximize, and close buttons.

Declaration

public override RadItem SystemButtonsElement { get; }

Property Value

Overrides RadNCEnabledControl.SystemButtonsElement

Gets or sets the default height for all tabs in the tabbed form control, affecting the overall appearance of the tab strip.

Declaration

public virtual int TabHeight { get; set; }

Property Value

Gets or sets the spacing between individual tabs in the tab strip, controlling the visual separation between tabs.

Declaration

public virtual int TabSpacing { get; set; }

Property Value

Gets or sets the default width for all tabs in the tabbed form control, determining the initial size of new tabs.

Declaration

public virtual int TabWidth { get; set; }

Property Value

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 the RadTabbedFormControl.

Declaration

[Browsable(false)]
public RadTabbedFormControlElement TabbedFormControlElement { get; }

Property Value

Gets the RadTabbedFormControlTabsElement element that manages the display and layout of tabs within the tabbed form control.

Declaration

[Browsable(true)]
public RadTabbedFormControlTabsElement TabbedFormControlTabsElement { get; }

Property Value

Gets the collection of tabs managed by this tabbed form control, providing access to add, remove, and manipulate individual tabs.

Declaration

public RadTabbedFormControlTabCollection Tabs { get; }

Property Value

Gets or sets the text displayed in the caption area of the tabbed form control, typically representing the form title.

Declaration

public override string Text { get; set; }

Property Value

Overrides RadControl.Text

Gets the text caption element that displays the form's title text in the caption area of the tabbed form control.

Declaration

public override RadElement TextCaptionElement { get; }

Property Value

Overrides RadNCEnabledControl.TextCaptionElement

Gets the theme class name for the control, which is used by the theming system to apply appropriate visual styles.

Declaration

public override string ThemeClassName { get; }

Property Value

Overrides RadControl.ThemeClassName

Constructs the control by initializing its default settings and creating the tabs collection that will hold all tabbed form control tabs.

Declaration

protected override void Construct()

Overrides RadControl.Construct()

Creates a new accessibility object for the control to support screen readers and automation tools.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates the child elements of the control, including the main tabbed form control element that provides the core tabbed interface functionality.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates a new instance of the control collection specifically designed for this tabbed form control.

Declaration

protected override Control.ControlCollection CreateControlsInstance()

Returns

Overrides Control.CreateControlsInstance()

Creates the main tabbed form control element that provides the core functionality for tab management, caption handling, and user interaction.

Declaration

protected virtual RadTabbedFormControlElement CreateTabbedFormControlElement()

Returns

Creates a new instance of the tabs collection that will manage all tabs within this tabbed form control.

Declaration

protected virtual RadTabbedFormControlTabCollection CreateTabsInstance()

Returns

Releases the unmanaged resources used by the RadTabbedFormControl and optionally releases the managed resources, including cleanup of parent form event handlers.

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

Initializes the root element of the control and performs any additional setup required for the tabbed form control element hierarchy.

Declaration

protected override void InitializeRootElement(RootRadElement rootElement)

Parameters

Overrides RadControl.InitializeRootElement(RootRadElement)

Raises the KeyDown event and processes keyboard shortcuts and navigation for the tabbed form control.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Raises the NewTabRequested event when the user requests a new tab through the user interface.

Declaration

protected virtual void OnNewTabRequested(RadTabbedFormControlNewTabRequestedEventArgs e)

Parameters

Raises the ParentChanged event and handles parent form text synchronization setup.

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Overrides RadControl.OnParentChanged(EventArgs)

Raises the RightToLeftChanged event and updates the layout to reflect right-to-left reading order changes.

Declaration

protected override void OnRightToLeftChanged(EventArgs e)

Parameters

Overrides RadControl.OnRightToLeftChanged(EventArgs)

Raises the SelectedTabChanged event and performs analytics tracking for the tab selection change.

Declaration

protected virtual void OnSelectedTabChanged(EventArgs e)

Parameters

Raises the SelectedTabChanging event, allowing subscribers to validate or cancel the tab selection change.

Declaration

protected virtual void OnSelectedTabChanging(RadTabbedFormControlCancelEventArgs e)

Parameters

Raises the TabAdded event after a tab has been successfully added to the control.

Declaration

protected virtual void OnTabAdded(RadTabbedFormControlEventArgs e)

Parameters

Raises the TabAdding event before a tab is added to the control, allowing validation and cancellation.

Declaration

protected virtual void OnTabAdding(RadTabbedFormControlCancelEventArgs e)

Parameters

Raises the TabItemIndexChanged event after a tab's index position has been successfully changed.

Declaration

protected virtual void OnTabIndexChanged(RadTabbedFormControlIndexChangedEventArgs e)

Parameters

Raises the TabItemIndexChanging event before a tab's index position changes, allowing validation and cancellation.

Declaration

protected virtual void OnTabIndexChanging(RadTabbedFormControlIndexChangingEventArgs e)

Parameters

Raises the TabRemoved event after a tab has been successfully removed from the control, and handles automatic form closure when no tabs remain.

Declaration

protected virtual void OnTabRemoved(RadTabbedFormControlEventArgs e)

Parameters

Raises the TabRemoving event before a tab is removed from the control, allowing validation and cancellation.

Declaration

protected virtual void OnTabRemoving(RadTabbedFormControlCancelEventArgs e)

Parameters

Raises the TabsCleared event after all tabs have been successfully removed from the control.

Declaration

protected virtual void OnTabsCleared(EventArgs e)

Parameters

Raises the TabsClearing event before all tabs are removed from the control, allowing validation and cancellation.

Declaration

protected virtual void OnTabsClearing(CancelEventArgs e)

Parameters

Processes CodedUI messages for automation and testing purposes, handling tab selection, property retrieval, and other automation commands.

Declaration

protected override void ProcessCodedUIMessage(ref IPCMessage request)

Parameters

Overrides RadControl.ProcessCodedUIMessage(ref IPCMessage)

Processes parent notification messages for the control, forwarding them to the window procedure for handling.

Declaration

protected virtual void ProcessParentNotifyMessage(ref Message m)

Parameters

Resumes event raising for tab-related events, previously suspended by a SuspendEvents() call. Events will be raised normally after this call.

Declaration

public void ResumeEvents()

Sets the selected tab and performs the necessary layout operations to reflect the change in the user interface.

Declaration

protected virtual void SetSelectedTab(RadTabbedFormControlEventArgs e)

Parameters

Temporarily suspends event raising for all tab-related events to improve performance during bulk operations.

Declaration

public void SuspendEvents()

Processes Windows messages for hit testing in the non-client area, handling special cases for tabbed form behavior and composition.

Declaration

protected override bool WmNCHitTest(ref Message msg)

Parameters

Returns

Overrides RadNCEnabledControl.WmNCHitTest(ref Message)

Occurs when the context menu is about to be opened for a tab item, providing an opportunity to customize the context menu contents or cancel the operation.

Declaration

public event EventHandler<RadTabbedFormControlItemConextMenuOpeningEventArgs> ContextMenuOpening

Event Value

Occurs when a new tab item is about to be created, allowing customization of the tab creation process and initial properties.

Declaration

public event EventHandler<RadTabbedFormControlItemCreatingEventArgs> ItemCreating

Event Value

Occurs when a tab item has been successfully dropped over another item, completing the drag and drop operation. This event provides notification of the completed drop action.

Declaration

public event EventHandler<RadTabbedFormControlItemDroppedEventArgs> ItemDropped

Event Value

Occurs when a tab item is about to be dropped over another item during a drag and drop operation. This event allows customization of the drop behavior.

Declaration

public event EventHandler<RadTabbedFormControlItemDroppingEventArgs> ItemDropping

Event Value

Occurs when a new tab is requested by the user, typically through clicking a new tab button or similar UI element.

Declaration

public event EventHandler<RadTabbedFormControlNewTabRequestedEventArgs> NewTabRequested

Event Value

Occurs when the currently selected tab has changed, providing notification that a new tab is now active and selected.

Declaration

public event EventHandler SelectedTabChanged

Event Value

Occurs when the currently selected tab is about to change. This event is cancelable and allows validation or cleanup before the selection changes.

Declaration

public event EventHandler<RadTabbedFormControlCancelEventArgs> SelectedTabChanging

Event Value

Occurs when a new tab has been successfully added to the control, providing notification that the addition operation completed successfully.

Declaration

public event EventHandler<RadTabbedFormControlEventArgs> TabAdded

Event Value

Occurs when a new tab is about to be added to the control. This event is cancelable and allows validation or modification before the tab is added.

Declaration

public event EventHandler<RadTabbedFormControlCancelEventArgs> TabAdding

Event Value

Occurs when a tab's index position has been successfully changed within the tab collection, providing notification of the completed index change operation.

Declaration

public event EventHandler<RadTabbedFormControlIndexChangedEventArgs> TabItemIndexChanged

Event Value

Occurs when a tab is about to change its index position within the tab collection. This event is cancelable and allows validation of the index change.

Declaration

public event EventHandler<RadTabbedFormControlIndexChangingEventArgs> TabItemIndexChanging

Event Value

Occurs when a tab has been successfully removed from the control, providing notification that the removal operation completed successfully.

Declaration

public event EventHandler<RadTabbedFormControlEventArgs> TabRemoved

Event Value

Occurs when a tab is about to be removed from the control. This event is cancelable and allows validation or cleanup operations before removal.

Declaration

public event EventHandler<RadTabbedFormControlCancelEventArgs> TabRemoving

Event Value

Occurs when all tabs have been successfully removed from the control, providing notification that the clear operation completed successfully.

Declaration

public event EventHandler TabsCleared

Event Value

Occurs when all tabs are about to be removed from the control. This event is cancelable and allows validation or bulk cleanup operations before clearing.

Declaration

public event CancelEventHandler TabsClearing

Event Value