Class RadTabbedFormControlElement

Represents the main element of a tabbed form control that provides comprehensive tabbed interface functionality with integrated caption management, drag-and-drop support, and content area handling for creating modern tabbed applications.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadTabbedFormControlElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[ComVisible(false)]
public class RadTabbedFormControlElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadTabbedFormControlElement()

Declaration
public RadTabbedFormControlElement()

Fields

IsTabbedFormActiveProperty

Identifies the IsTabbedFormActive dependency property that indicates whether the tabbed form is currently active and focused.

Declaration
public static RadProperty IsTabbedFormActiveProperty
Field Value
RadProperty

ItemDragHintProperty

Identifies the ItemDragHint dependency property that defines the visual hint displayed during drag operations.

Declaration
public static RadProperty ItemDragHintProperty
Field Value
RadProperty

ItemDragModeProperty

Identifies the ItemDragMode dependency property that controls how tab items respond to drag operations.

Declaration
public static RadProperty ItemDragModeProperty
Field Value
RadProperty

TabbedFormWindowStateProperty

Identifies the TabbedFormWindowState dependency property that tracks the current window state of the tabbed form.

Declaration
public static RadProperty TabbedFormWindowStateProperty
Field Value
RadProperty

Properties

CaptionBorder

Gets the BorderPrimitive instance that represents the border of the tabbed control's caption.

Declaration
public BorderPrimitive CaptionBorder { get; }
Property Value
BorderPrimitive

CaptionFill

Gets the FillPrimitive instance that represents the fill of the tabbed control's caption.

Declaration
public FillPrimitive CaptionFill { get; }
Property Value
FillPrimitive

CaptionHeight

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

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

CaptionTextElement

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

Declaration
public TextPrimitive CaptionTextElement { get; }
Property Value
TextPrimitive

CloseButton

Gets or sets a value indicating whether the close button is visible in the caption area of the tabbed form control.

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

ContentArea

Gets the content area element that hosts and manages the display of tab content panels.

Declaration
public RadTabbedFormControlContentAreaElement ContentArea { get; }
Property Value
RadTabbedFormControlContentAreaElement

IconPrimitive

Gets the image primitive element that displays the form icon in the caption area of the tabbed form control.

Declaration
public ImagePrimitive IconPrimitive { get; }
Property Value
ImagePrimitive

ItemDragHint

Gets or sets the RadImageShape instance which describes the hint that indicates where an item will be dropped after a drag operation.

Declaration
[VsbBrowsable(true)]
public RadImageShape ItemDragHint { get; set; }
Property Value
RadImageShape

ItemDragMode

Gets or sets the drag mode for tab items, controlling when and how tab drag operations are initiated by user interaction.

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

ItemDragService

Gets or sets the RadTabbedFormDragDropService instance which handles item drag requests.

Declaration
public RadTabbedFormDragDropService ItemDragService { get; set; }
Property Value
RadTabbedFormDragDropService

Items

Gets all the items currently present within this element.

Declaration
public IReadOnlyCollection<RadTabbedFormControlItem> Items { get; }
Property Value
IReadOnlyCollection<RadTabbedFormControlItem>

LeftItems

Gets the collection of items hosted in the left quick access toolbar container.

Declaration
public RadItemOwnerCollection LeftItems { get; }
Property Value
RadItemOwnerCollection

LeftItemsContainer

Gets the quick access toolbar container that hosts items on the left side of the caption area.

Declaration
public RadQuickAccessToolBar LeftItemsContainer { get; }
Property Value
RadQuickAccessToolBar

MaximizeButton

Gets or sets a value indicating whether the maximize button is visible in the caption area of the tabbed form control.

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

MinimizeButton

Gets or sets a value indicating whether the minimize button is visible in the caption area of the tabbed form control.

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

MinimumTabWidth

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

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

NewItem

Gets the item which stands for adding new tabs on click.

Declaration
public LightVisualButtonElement NewItem { get; }
Property Value
LightVisualButtonElement

Owner

Gets or sets the owner RadTabbedFormControl instance.

Declaration
public RadTabbedFormControl Owner { get; }
Property Value
RadTabbedFormControl

PinnedItems

Gets all the pinned items in the tab collection.

Declaration
public ObservableCollection<RadTabbedFormControlItem> PinnedItems { get; }
Property Value
ObservableCollection<RadTabbedFormControlItem>

PinnedItemsPosition

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

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

RightItems

Gets the collection of items hosted in the right quick access toolbar container.

Declaration
public RadItemOwnerCollection RightItems { get; }
Property Value
RadItemOwnerCollection

RightItemsContainer

Gets the quick access toolbar container that hosts items on the right side of the caption area.

Declaration
public RadQuickAccessToolBar RightItemsContainer { get; }
Property Value
RadQuickAccessToolBar

SelectedItem

Gets or sets the currently selected item in the view.

Declaration
public RadTabbedFormControlItem SelectedItem { get; set; }
Property Value
RadTabbedFormControlItem

ShowIcon

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
System.Boolean

ShowNewTabButton

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

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

ShowTabCloseButton

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
System.Boolean

ShowTabPinButton

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

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

ShowText

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

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

TabbedFormCaption

Gets or sets the caption element that manages the display of tabs, system buttons, and title text in the tabbed form control.

Declaration
public RadTabbedFormControlCaption TabbedFormCaption { get; set; }
Property Value
RadTabbedFormControlCaption

TabHeight

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

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

TabSpacing

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
System.Int32

TabWidth

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

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

Methods

AddItemCore(RadTabbedFormControlItem)

Adds an item to the internal collection and configures it as part of the tabbed form control.

Declaration
protected virtual void AddItemCore(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

The item to add to the collection.

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BringFormToFront()

Brings the parent tabbed form to the front if it is not currently active.

Declaration
protected virtual void BringFormToFront()

BringIntoView(RadTabbedFormControlItem)

Scrolls the RadTabbedFormControlTabsElement so that the passed item is visible and centered.

Declaration
protected virtual void BringIntoView(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

The item to bring into view.

CanDropInTitleBarArea(Point, RadTabbedFormControlElement)

Determines whether a drop operation can occur in the title bar area.

Declaration
protected virtual bool CanDropInTitleBarArea(Point client, RadTabbedFormControlElement dropTarget)
Parameters
System.Drawing.Point client

The client coordinates of the drop position.
RadTabbedFormControlElement dropTarget

The element that would receive the drop.
Returns
System.Boolean

True if drop is allowed in the title bar area; otherwise, false.

CanDropOverItem(RadTabbedFormControlItem, RadTabbedFormControlItem, Point)

Determines whether a drag item can be dropped over the specified hit item at the given position.

Declaration
protected virtual bool CanDropOverItem(RadTabbedFormControlItem dragItem, RadTabbedFormControlItem hitItem, Point mousePosition)
Parameters
RadTabbedFormControlItem dragItem

The item being dragged.
RadTabbedFormControlItem hitItem

The item that would receive the drop.
System.Drawing.Point mousePosition

The current mouse position.
Returns
System.Boolean

True if the drop operation is allowed; otherwise, false.

CanPerformImmediateDrag(Point)

Determines whether an immediate drag operation can be performed at the specified mouse position.

Declaration
protected virtual bool CanPerformImmediateDrag(Point mousePosition)
Parameters
System.Drawing.Point mousePosition

The mouse position to check.
Returns
System.Boolean

True if immediate drag can be performed; otherwise, false.

CanPerformImmediateDrop(DragDirection, Int32, RadTabbedFormControlItem, RadTabbedFormControlItem)

Determines whether an immediate drop operation can be performed based on drag direction and position.

Declaration
protected virtual bool CanPerformImmediateDrop(DragDirection direction, int x, RadTabbedFormControlItem dragItem, RadTabbedFormControlItem hitItem)
Parameters
DragDirection direction

The direction of the drag operation.
System.Int32 x

The x-coordinate of the drop position.
RadTabbedFormControlItem dragItem

The item being dragged.
RadTabbedFormControlItem hitItem

The item that would receive the drop.
Returns
System.Boolean

True if immediate drop can be performed; otherwise, false.

CanSelectItem(RadTabbedFormControlItem)

Declaration
protected virtual bool CanSelectItem(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

Returns
System.Boolean

CloseForm()

Closes the parent tabbed form.

Declaration
protected virtual void CloseForm()

CloseItem(RadTabbedFormControlItem)

Declaration
protected virtual void CloseItem(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

Control_VisibleChanged(Object, EventArgs)

Handles the VisibleChanged event for the container control and triggers layout updates.

Declaration
protected void Control_VisibleChanged(object sender, EventArgs e)
Parameters
System.Object sender

The control that changed visibility.
System.EventArgs e

The event arguments.

CreateBorderElement()

Creates and configures the border primitive element that provides the border visualization for the caption area.

Declaration
protected virtual BorderPrimitive CreateBorderElement()
Returns
BorderPrimitive

A configured BorderPrimitive for the caption border.

CreateButtonGroup()

Creates and configures a button group element for hosting quick access toolbar items in the caption area.

Declaration
protected virtual RadQuickAccessToolBar CreateButtonGroup()
Returns
RadQuickAccessToolBar

A configured RadQuickAccessToolBar for hosting toolbar items.

CreateChildElements()

Creates and configures all child elements of the tabbed form control including icon, caption, toolbars, and content area.

Declaration
protected override void CreateChildElements()
Overrides

CreateContentAreaElement()

Creates and configures the content area element that hosts the tab content panels.

Declaration
protected virtual RadTabbedFormControlContentAreaElement CreateContentAreaElement()
Returns
RadTabbedFormControlContentAreaElement

A new instance of RadTabbedFormControlContentAreaElement for hosting tab contents.

CreateDefaultContextMenu()

Declaration
protected virtual RadDropDownMenu CreateDefaultContextMenu()
Returns
RadDropDownMenu

CreateFillElement()

Creates and configures the fill primitive element that provides the background fill for the caption area.

Declaration
protected virtual FillPrimitive CreateFillElement()
Returns
FillPrimitive

A configured FillPrimitive for the caption background.

CreateIconElement()

Creates and configures the icon primitive element for displaying the form icon in the caption area.

Declaration
protected virtual ImagePrimitive CreateIconElement()
Returns
ImagePrimitive

A configured ImagePrimitive for the form icon.

CreateItem()

Creates a new tab item element that represents an individual tab in the tabbed form control.

Declaration
protected virtual RadTabbedFormControlItem CreateItem()
Returns
RadTabbedFormControlItem

A new instance of RadTabbedFormControlItem representing a tab.

CreateTabbedFormCaption()

Creates and configures the main caption element that manages tabs, system buttons, and title text display.

Declaration
protected virtual RadTabbedFormControlCaption CreateTabbedFormCaption()
Returns
RadTabbedFormControlCaption

A configured RadTabbedFormControlCaption for the main caption area.

CreateTextElement()

Creates and configures the text primitive element for displaying the caption text in the tabbed form control.

Declaration
protected virtual TextPrimitive CreateTextElement()
Returns
TextPrimitive

A configured TextPrimitive for the caption text.

DisposeManagedResources()

Releases managed resources used by the tabbed form control element including drag service, event handlers, and child controls.

Declaration
protected override void DisposeManagedResources()
Overrides

DpiScaleChanged(SizeF)

Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF scaleFactor

Overrides

EndItemDrag(RadTabbedFormControlItem)

Ends the drag operation for the specified tab item.

Declaration
protected virtual void EndItemDrag(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

The item that finished dragging.

GetClientRectangleFromContentElement(RadTabbedFormControlContentAreaElement)

Declaration
public virtual Rectangle GetClientRectangleFromContentElement(RadTabbedFormControlContentAreaElement contentArea)
Parameters
RadTabbedFormControlContentAreaElement contentArea

Returns
System.Drawing.Rectangle

GetContentAreaRectangle()

Declaration
public virtual Rectangle GetContentAreaRectangle()
Returns
System.Drawing.Rectangle

GetEmptyTab()

Creates and returns a new empty tab instance for new tab requests.

Declaration
protected virtual RadTabbedFormControlTab GetEmptyTab()
Returns
RadTabbedFormControlTab

A new instance of RadTabbedFormControlTab.

GetItemAt(Int32)

Gets the item at the specified index in the collection.

Declaration
public RadTabbedFormControlItem GetItemAt(int index)
Parameters
System.Int32 index

The zero-based index of the item to retrieve.
Returns
RadTabbedFormControlItem

The RadTabbedFormControlItem at the specified index.

GetNextItemIndex(RadTabbedFormControlItem, Boolean, Boolean)

Declaration
protected virtual int GetNextItemIndex(RadTabbedFormControlItem current, bool forward, bool wrap)
Parameters
RadTabbedFormControlItem current

System.Boolean forward

System.Boolean wrap

Returns
System.Int32

HandleNewTabRequested()

Handles the request for creating a new tab and raises the appropriate events.

Declaration
protected virtual void HandleNewTabRequested()

InitializeFields()

Initializes the fields and sets up default configurations for the tabbed form control element including drag-drop service and collections.

Declaration
protected override void InitializeFields()
Overrides

InitializeNewForm()

Initializes and returns a new RadTabbedForm instance for drag-drop operations.

Declaration
protected virtual RadTabbedForm InitializeNewForm()
Returns
RadTabbedForm

A new instance of RadTabbedForm.

InsertItemCore(Int32, RadTabbedFormControlItem)

Inserts an item at the specified index in the internal collection and configures it as part of the tabbed form control.

Declaration
protected virtual void InsertItemCore(int index, RadTabbedFormControlItem item)
Parameters
System.Int32 index

The zero-based index at which to insert the item.
RadTabbedFormControlItem item

The item to insert into the collection.

ItemFromPoint(Point)

Gets the item that contains the provided point in control's client coordinates.

Declaration
public RadTabbedFormControlItem ItemFromPoint(Point client)
Parameters
System.Drawing.Point client

The point in client coordinates to check for item containment.
Returns
RadTabbedFormControlItem

The RadTabbedFormControlItem at the specified point, or null if no item is found.

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

OffsetTabContent(Rectangle)

Declaration
protected virtual Rectangle OffsetTabContent(Rectangle contentRect)
Parameters
System.Drawing.Rectangle contentRect

Returns
System.Drawing.Rectangle

OnCloseMenuItemClick(Object, EventArgs)

Declaration
protected virtual void OnCloseMenuItemClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnContentBoundsChanged()

Declaration
protected virtual void OnContentBoundsChanged()

OnContextMenuOpening(RadTabbedFormControlItemConextMenuOpeningEventArgs)

Declaration
protected virtual void OnContextMenuOpening(RadTabbedFormControlItemConextMenuOpeningEventArgs args)
Parameters
RadTabbedFormControlItemConextMenuOpeningEventArgs args

OnControlAdded(Object, ControlEventArgs)

Handles the addition of a new control during drag-drop operations.

Declaration
protected virtual void OnControlAdded(object sender, ControlEventArgs e)
Parameters
System.Object sender

The object that raised the event.
System.Windows.Forms.ControlEventArgs e

The event arguments containing the added control information.

OnDoubleClick(EventArgs)

Handles the double click event and delegates to the caption element for maximize/restore functionality.

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

The event arguments.
Overrides

OnItemClick(RadTabbedFormControlItem, EventArgs)

Declaration
protected virtual void OnItemClick(RadTabbedFormControlItem sender, EventArgs e)
Parameters
RadTabbedFormControlItem sender

System.EventArgs e

OnItemCreating(RadTabbedFormControlItemCreatingEventArgs)

Declaration
protected virtual RadTabbedFormControlItem OnItemCreating(RadTabbedFormControlItemCreatingEventArgs args)
Parameters
RadTabbedFormControlItemCreatingEventArgs args

Returns
RadTabbedFormControlItem

OnItemDrag(RadTabbedFormControlItem, MouseEventArgs)

Declaration
protected virtual void OnItemDrag(RadTabbedFormControlItem sender, MouseEventArgs e)
Parameters
RadTabbedFormControlItem sender

System.Windows.Forms.MouseEventArgs e

OnItemDropped(Object, RadTabbedFormControlItemDroppedEventArgs)

Declaration
protected virtual void OnItemDropped(object sender, RadTabbedFormControlItemDroppedEventArgs args)
Parameters
System.Object sender

RadTabbedFormControlItemDroppedEventArgs args

OnItemDropping(Object, RadTabbedFormControlItemDroppingEventArgs)

Declaration
protected virtual void OnItemDropping(object sender, RadTabbedFormControlItemDroppingEventArgs args)
Parameters
System.Object sender

RadTabbedFormControlItemDroppingEventArgs args

OnItemMouseDown(RadTabbedFormControlItem, MouseEventArgs)

Declaration
protected virtual void OnItemMouseDown(RadTabbedFormControlItem sender, MouseEventArgs e)
Parameters
RadTabbedFormControlItem sender

System.Windows.Forms.MouseEventArgs e

OnItemMouseUp(RadTabbedFormControlItem, MouseEventArgs)

Declaration
protected virtual void OnItemMouseUp(RadTabbedFormControlItem sender, MouseEventArgs e)
Parameters
RadTabbedFormControlItem sender

System.Windows.Forms.MouseEventArgs e

OnItemsChanged(Object, RadTabbedFormControlItemsChangedEventArgs)

Declaration
protected virtual void OnItemsChanged(object sender, RadTabbedFormControlItemsChangedEventArgs args)
Parameters
System.Object sender

RadTabbedFormControlItemsChangedEventArgs args

OnItemSelected(Object, RadTabbedFormControlItemSelectedEventArgs)

Declaration
public virtual void OnItemSelected(object sender, RadTabbedFormControlItemSelectedEventArgs args)
Parameters
System.Object sender

RadTabbedFormControlItemSelectedEventArgs args

OnItemSelecting(Object, RadTabbedFormControlItemSelectingEventArgs)

Declaration
public virtual void OnItemSelecting(object sender, RadTabbedFormControlItemSelectingEventArgs args)
Parameters
System.Object sender

RadTabbedFormControlItemSelectingEventArgs args

OnLoaded()

Called when the element is loaded and handles initialization of tab visibility and event registration for tab management functionality.

Declaration
protected override void OnLoaded()
Overrides

OnMouseDown(MouseEventArgs)

Handles the mouse down event and delegates to the caption element for form dragging functionality.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.
Overrides

OnMouseMove(MouseEventArgs)

Handles the mouse move event and delegates to the caption element for form dragging functionality.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.
Overrides

OnNewMenuItemClick(Object, EventArgs)

Declaration
protected virtual void OnNewMenuItemClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnNewTabItemClicked(Object, EventArgs)

Handles the new tab item clicked event and initiates the new tab creation process.

Declaration
protected virtual void OnNewTabItemClicked(object sender, EventArgs e)
Parameters
System.Object sender

The object that raised the event.
System.EventArgs e

The event arguments.

OnOtherMenuItemClick(Object, EventArgs)

Declaration
protected virtual void OnOtherMenuItemClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnPinMenuItemClick(Object, EventArgs)

Declaration
protected virtual void OnPinMenuItemClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property changes and performs necessary updates for specific properties.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The property change event arguments.
Overrides

OnRightTabsMenuItemClick(Object, EventArgs)

Declaration
protected virtual void OnRightTabsMenuItemClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnSelectedTabChanged(RadTabbedFormControlEventArgs)

Handles changes to the selected tab in the owner control.

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

The event arguments containing the selected tab information.

OnTabbedFormControlCreating(Object, TabbedFormControlCreatingEventArgs)

Handles the creation of a new tabbed form control during drag operations.

Declaration
protected virtual void OnTabbedFormControlCreating(object sender, TabbedFormControlCreatingEventArgs e)
Parameters
System.Object sender

The object that raised the event.
TabbedFormControlCreatingEventArgs e

The event arguments containing the new form control information.

OnTabIndexChanged(RadTabbedFormControlIndexChangedEventArgs)

Handles changes to tab index positions within the collection.

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

The event arguments containing the old and new index information.

PaintOverride(IGraphics, Rectangle, Single, SizeF, Boolean)

Performs custom painting of the element including special handling for composition-enabled forms.

Declaration
protected override void PaintOverride(IGraphics screenRadGraphics, Rectangle clipRectangle, float angle, SizeF scale, bool useRelativeTransformation)
Parameters
IGraphics screenRadGraphics

The graphics object used for painting.
System.Drawing.Rectangle clipRectangle

The clipping rectangle for the paint operation.
System.Single angle

The rotation angle for the paint operation.
System.Drawing.SizeF scale

The scale factor for the paint operation.
System.Boolean useRelativeTransformation

Whether to use relative transformation.
Overrides

PerformItemDrop(RadTabbedFormControlItem, RadTabbedFormControlItem)

Performs the actual drop operation for moving or detaching tab items.

Declaration
protected virtual void PerformItemDrop(RadTabbedFormControlItem dragItem, RadTabbedFormControlItem hitItem)
Parameters
RadTabbedFormControlItem dragItem

The item being dropped.
RadTabbedFormControlItem hitItem

The item that received the drop.

ProcessDragDrop(Point, ISupportDrag)

Processes the final drop operation when a drag object is dropped.

Declaration
protected override void ProcessDragDrop(Point dropLocation, ISupportDrag dragObject)
Parameters
System.Drawing.Point dropLocation

The location where the drop occurred.
ISupportDrag dragObject

The object that was dropped.
Overrides

ProcessDragOver(Point, ISupportDrag)

Processes drag over events and determines whether the drag operation can proceed.

Declaration
protected override bool ProcessDragOver(Point mousePosition, ISupportDrag dragObject)
Parameters
System.Drawing.Point mousePosition

The current mouse position.
ISupportDrag dragObject

The object being dragged.
Returns
System.Boolean

True if the drag can proceed; otherwise, false.
Overrides

RemoveItemCore(RadTabbedFormControlItem)

Removes an item from the internal collection and handles selection updates.

Declaration
protected virtual void RemoveItemCore(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

The item to remove from the collection.

SelectNextItem()

Selects the next available item.

Declaration
public bool SelectNextItem()
Returns
System.Boolean

SelectNextItemCore(RadTabbedFormControlItem, Boolean, Boolean)

Declaration
protected virtual bool SelectNextItemCore(RadTabbedFormControlItem current, bool forward, bool wrap)
Parameters
RadTabbedFormControlItem current

System.Boolean forward

System.Boolean wrap

Returns
System.Boolean

SelectPreviousItem()

Selects the previous available item.

Declaration
public bool SelectPreviousItem()
Returns
System.Boolean

SetItemIndex(Int32, Int32)

Changes the position of an item within the collection by moving it from one index to another.

Declaration
protected virtual void SetItemIndex(int currentIndex, int newIndex)
Parameters
System.Int32 currentIndex

The current zero-based index of the item.
System.Int32 newIndex

The new zero-based index where the item should be moved.

SetSelectedContent(RadTabbedFormControlItem)

Declaration
protected virtual void SetSelectedContent(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

SetSelectedItem(RadTabbedFormControlItem)

Sets the specified item as the selected item in the tabbed form control.

Declaration
protected virtual void SetSelectedItem(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

The item to select.

ShouldArrangeChild(RadElement)

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ShouldFitTitleBarOnTwoRows()

Declaration
protected virtual bool ShouldFitTitleBarOnTwoRows()
Returns
System.Boolean

ShouldLayoutChild(RadElement)

Declaration
protected virtual bool ShouldLayoutChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

ShouldMeasureChild(RadElement)

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ShowContextMenu(RadTabbedFormControlItem)

Declaration
protected virtual void ShowContextMenu(RadTabbedFormControlItem tabItem)
Parameters
RadTabbedFormControlItem tabItem

StartItemDrag(RadTabbedFormControlItem)

Starts the drag operation for the specified tab item.

Declaration
protected virtual void StartItemDrag(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

The item to start dragging.

SyncronizeItem(RadTabbedFormControlItem)

Declaration
protected virtual void SyncronizeItem(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

UpdateButtonGroupsOnItemsChanged(RadItemCollection, RadItem, ItemsChangeOperation)

Updates button group configurations when items are added or removed from the toolbar collections.

Declaration
protected virtual void UpdateButtonGroupsOnItemsChanged(RadItemCollection changed, RadItem target, ItemsChangeOperation operation)
Parameters
RadItemCollection changed

The collection that changed.
RadItem target

The item that was affected.
ItemsChangeOperation operation

The type of change operation.

UpdateLayoutWhileImmediateDrag(RadTabbedFormControlItem, DragDirection, Int32)

Updates the layout during an immediate drag operation to provide visual feedback.

Declaration
protected virtual void UpdateLayoutWhileImmediateDrag(RadTabbedFormControlItem dragItem, DragDirection direction, int deltaX)
Parameters
RadTabbedFormControlItem dragItem

The item being dragged.
DragDirection direction

The direction of the drag operation.
System.Int32 deltaX

The horizontal displacement of the drag operation.

UpdatePinnedItems(RadTabbedFormControlItem)

Declaration
protected virtual void UpdatePinnedItems(RadTabbedFormControlItem item)
Parameters
RadTabbedFormControlItem item

UpdateReferences(ComponentThemableElementTree, Boolean, Boolean)

Updates element tree references and establishes event handlers for size and visibility changes.

Declaration
protected override void UpdateReferences(ComponentThemableElementTree tree, bool updateInheritance, bool recursive)
Parameters
ComponentThemableElementTree tree

The element tree to update references for.
System.Boolean updateInheritance

Whether to update property inheritance.
System.Boolean recursive

Whether to update references recursively.
Overrides

UpdateTabBounds(RadTabbedFormControlTab)

Declaration
protected virtual void UpdateTabBounds(RadTabbedFormControlTab tab)
Parameters
RadTabbedFormControlTab tab

VisibleChangedCore()

Core method for handling visibility and size changes that updates the layout when necessary.

Declaration
protected virtual void VisibleChangedCore()

Events

ContextMenuOpening

Occurs before the default context menu is opened.

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

ItemClicked

Occurs when a tab is clicked.

Declaration
public event EventHandler ItemClicked
Event Type
System.EventHandler

ItemCreating

Occurs before the tab items is attached to its owner element.

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

ItemDropped

Occurs after a tab is dropped.

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

ItemDropping

Occurs before a tab is dropped.

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

ItemsChanged

Occurs when a tab is added or removed.

Declaration
public event EventHandler<RadTabbedFormControlItemsChangedEventArgs> ItemsChanged
Event Type
System.EventHandler<RadTabbedFormControlItemsChangedEventArgs>

ItemSelected

Occurs after a tab is selected.

Declaration
public event EventHandler<RadTabbedFormControlItemSelectedEventArgs> ItemSelected
Event Type
System.EventHandler<RadTabbedFormControlItemSelectedEventArgs>

ItemSelecting

Occurs before the tab is selected.

Declaration
public event EventHandler<RadTabbedFormControlItemSelectingEventArgs> ItemSelecting
Event Type
System.EventHandler<RadTabbedFormControlItemSelectingEventArgs>

Extension Methods