Class

RadTabbedFormControlElement

Declaration

public RadTabbedFormControlElement()

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

Declaration

public static RadProperty IsTabbedFormActiveProperty

Field Value

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

Declaration

public static RadProperty ItemDragHintProperty

Field Value

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

Declaration

public static RadProperty ItemDragModeProperty

Field Value

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

Declaration

public static RadProperty TabbedFormWindowStateProperty

Field Value

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

Declaration

[Browsable(false)]
public BorderPrimitive CaptionBorder { get; }

Property Value

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

Declaration

[Browsable(false)]
public FillPrimitive CaptionFill { get; }

Property Value

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

Declaration

[Browsable(true)]
public int CaptionHeight { get; set; }

Property Value

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

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

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

Declaration

[Browsable(false)]
public RadTabbedFormControlContentAreaElement ContentArea { get; }

Property Value

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

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

Declaration

[Browsable(false)]
[VsbBrowsable(true)]
public RadImageShape ItemDragHint { get; set; }

Property Value

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

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

Declaration

[Browsable(false)]
public RadTabbedFormDragDropService ItemDragService { get; set; }

Property Value

Gets all the items currently present within this element.

Declaration

[Browsable(false)]
public IReadOnlyCollection<RadTabbedFormControlItem> Items { get; }

Property Value

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

Declaration

[Browsable(false)]
public RadItemOwnerCollection LeftItems { get; }

Property Value

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

Declaration

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

Property Value

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

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

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

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

Declaration

[Browsable(false)]
public LightVisualButtonElement NewItem { get; }

Property Value

Gets or sets the owner RadTabbedFormControl instance.

Declaration

public RadTabbedFormControl Owner { get; }

Property Value

Gets all the pinned items in the tab collection.

Declaration

[Browsable(false)]
public ObservableCollection<RadTabbedFormControlItem> PinnedItems { get; }

Property Value

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

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

Declaration

[Browsable(false)]
public RadItemOwnerCollection RightItems { get; }

Property Value

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

Declaration

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

Property Value

Gets or sets the currently selected item in the view.

Declaration

[Browsable(false)]
public RadTabbedFormControlItem SelectedItem { 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, providing users with the ability 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 bool ShowTabPinButton { get; set; }

Property Value

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

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

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 tabs in the tabbed form control, determining the initial size of new tabs.

Declaration

public virtual int TabWidth { get; set; }

Property Value

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

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

Arranges the content and child elements within the final allocated space, positioning text, images, and child elements.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

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

Declaration

protected virtual void BringFormToFront()

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

Declaration

protected virtual void BringIntoView(RadTabbedFormControlItem item)

Parameters

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

Declaration

protected virtual bool CanDropInTitleBarArea(Point client, RadTabbedFormControlElement dropTarget)

Parameters

Returns

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

Returns

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

Declaration

protected virtual bool CanPerformImmediateDrag(Point mousePosition)

Parameters

Returns

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

Returns

Declaration

protected virtual bool CanSelectItem(RadTabbedFormControlItem item)

Parameters

Returns

Closes the parent tabbed form.

Declaration

protected virtual void CloseForm()

Declaration

protected virtual void CloseItem(RadTabbedFormControlItem item)

Parameters

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

Declaration

protected void Control_VisibleChanged(object sender, EventArgs e)

Parameters

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

Declaration

protected virtual BorderPrimitive CreateBorderElement()

Returns

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

Declaration

protected virtual RadQuickAccessToolBar CreateButtonGroup()

Returns

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

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

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

Declaration

protected virtual RadTabbedFormControlContentAreaElement CreateContentAreaElement()

Returns

Declaration

protected virtual RadDropDownMenu CreateDefaultContextMenu()

Returns

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

Declaration

protected virtual FillPrimitive CreateFillElement()

Returns

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

Declaration

protected virtual ImagePrimitive CreateIconElement()

Returns

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

Declaration

protected virtual RadTabbedFormControlItem CreateItem()

Returns

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

Declaration

protected virtual RadTabbedFormControlCaption CreateTabbedFormCaption()

Returns

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

Declaration

protected virtual TextPrimitive CreateTextElement()

Returns

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

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Called when the DPI scale factor changes. Updates the scale factor and notifies child elements.

Declaration

public override void DpiScaleChanged(SizeF scaleFactor)

Parameters

Overrides RadElement.DpiScaleChanged(SizeF)

Ends the drag operation for the specified tab item.

Declaration

protected virtual void EndItemDrag(RadTabbedFormControlItem item)

Parameters

Declaration

public virtual Rectangle GetClientRectangleFromContentElement(RadTabbedFormControlContentAreaElement contentArea)

Parameters

Returns

Declaration

public virtual Rectangle GetContentAreaRectangle()

Returns

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

Declaration

protected virtual RadTabbedFormControlTab GetEmptyTab()

Returns

Gets the item at the specified index in the collection.

Declaration

public RadTabbedFormControlItem GetItemAt(int index)

Parameters

Returns

Declaration

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

Parameters

Returns

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

Declaration

protected virtual void HandleNewTabRequested()

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 LightVisualElement.InitializeFields()

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

Declaration

protected virtual RadTabbedForm InitializeNewForm()

Returns

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

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

Declaration

public RadTabbedFormControlItem ItemFromPoint(Point client)

Parameters

Returns

Measures the desired size of the element by calculating the space needed for content, padding, and borders.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Declaration

protected virtual Rectangle OffsetTabContent(Rectangle contentRect)

Parameters

Returns

Declaration

protected virtual void OnCloseMenuItemClick(object sender, EventArgs e)

Parameters

Declaration

protected virtual void OnContentBoundsChanged()

Declaration

protected virtual void OnContextMenuOpening(RadTabbedFormControlItemConextMenuOpeningEventArgs args)

Parameters

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

Declaration

protected virtual void OnControlAdded(object sender, ControlEventArgs e)

Parameters

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

Declaration

protected override void OnDoubleClick(EventArgs e)

Parameters

Overrides RadElement.OnDoubleClick(EventArgs)

Declaration

protected virtual void OnItemClick(RadTabbedFormControlItem sender, EventArgs e)

Parameters

Declaration

protected virtual RadTabbedFormControlItem OnItemCreating(RadTabbedFormControlItemCreatingEventArgs args)

Parameters

Returns

Declaration

protected virtual void OnItemDrag(RadTabbedFormControlItem sender, MouseEventArgs e)

Parameters

Declaration

protected virtual void OnItemDropped(object sender, RadTabbedFormControlItemDroppedEventArgs args)

Parameters

Declaration

protected virtual void OnItemDropping(object sender, RadTabbedFormControlItemDroppingEventArgs args)

Parameters

Declaration

protected virtual void OnItemMouseDown(RadTabbedFormControlItem sender, MouseEventArgs e)

Parameters

Declaration

protected virtual void OnItemMouseUp(RadTabbedFormControlItem sender, MouseEventArgs e)

Parameters

Declaration

public virtual void OnItemSelected(object sender, RadTabbedFormControlItemSelectedEventArgs args)

Parameters

Declaration

public virtual void OnItemSelecting(object sender, RadTabbedFormControlItemSelectingEventArgs args)

Parameters

Declaration

protected virtual void OnItemsChanged(object sender, RadTabbedFormControlItemsChangedEventArgs args)

Parameters

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 LightVisualElement.OnLoaded()

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

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

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

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides LightVisualElement.OnMouseMove(MouseEventArgs)

Declaration

protected virtual void OnNewMenuItemClick(object sender, EventArgs e)

Parameters

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

Declaration

protected virtual void OnNewTabItemClicked(object sender, EventArgs e)

Parameters

Declaration

protected virtual void OnOtherMenuItemClick(object sender, EventArgs e)

Parameters

Declaration