WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface ITabbedMDIChildForm

    Show / Hide Table of Contents

    Interface ITabbedMDIChildForm

    Defines an interface through which a child System.Windows.Forms.Form will get notifications from a TabbedMDIManager regarding certain events.

    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public interface ITabbedMDIChildForm
    Remarks

    You should implement this interface when you want to customize certain features in the TabbedMDIManager. You can customize the context menu that pops up when the user right clicks on the tab, for example.

    Properties

    AllowUserDrag

    Indicates whether the user can drag and drop the tab corresponding to this mdi child in the tabbed mdi.

    Declaration
    bool AllowUserDrag { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    GetCustomTabText(out Boolean)

    Returns the custom text for the tab.

    Declaration
    string GetCustomTabText(out bool validValueReturned)
    Parameters
    Type Name Description
    System.Boolean validValueReturned

    Set this "out" param to true if you intend to provide a custom tab text, or else set it to false.

    Returns
    Type Description
    System.String

    A string value that will be the corresponding tab's text, if you intend to return a valid value; else return value will be ignored.

    OnAttachTabbedMDI(TabbedMDIManager)

    Called when a TabbedMDIManager is attached to the main form.

    Declaration
    void OnAttachTabbedMDI(TabbedMDIManager manager)
    Parameters
    Type Name Description
    TabbedMDIManager manager

    The TabbedMDIManager.

    Remarks

    This will also get called when a new child form implementing this interface is being created and added to an mdi parent bound to a TabbedMDIManager.

    OnDetachTabbedMDI(TabbedMDIManager)

    Called to indicate that the TabbedMDIManager is being detached from the mdi parent.

    Declaration
    void OnDetachTabbedMDI(TabbedMDIManager manager)
    Parameters
    Type Name Description
    TabbedMDIManager manager

    The TabbedMDIManager.

    OnMdiChildAddedToTabHost(TabHost, Int32)

    Called when the mdi child has been added to a new TabHost.

    Declaration
    void OnMdiChildAddedToTabHost(TabHost tabHost, int tabIndex)
    Parameters
    Type Name Description
    TabHost tabHost

    The TabHost to which the mdi child form was added to.

    System.Int32 tabIndex

    The tab index representing the mdi child form in the tab control.

    Remarks

    Use the MDITabPanel property to get a reference to the tab control.

    OnTabContextMenuClosed(ParentBarItem)

    Called after the context menu is shown when the user right-clicks on a tab.

    Declaration
    void OnTabContextMenuClosed(ParentBarItem contextMenuParentItem)
    Parameters
    Type Name Description
    ParentBarItem contextMenuParentItem

    The ParentBarItem representing the context menu.

    OnTabContextMenuPopup(ParentBarItem)

    Called before the context menu is shown when the user right-clicks on a tab.

    Declaration
    void OnTabContextMenuPopup(ParentBarItem contextMenuParentItem)
    Parameters
    Type Name Description
    ParentBarItem contextMenuParentItem

    The ParentBarItem representing the context menu.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved