menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WorkbookView - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class WorkbookView

    Provides functionality for displaying several WorksheetView controls in an Excel-like workbook.

    Inheritance
    System.Object
    SplitterControl
    TabBarSplitterControl
    WorkbookView
    Implements
    IControlToolTipProvider
    IScrollBarFrame
    IDynamicSplitterFrame
    IThemedControl
    System.Windows.Forms.IContainerControl
    INonClientPaintingSupport
    IThemeProvider
    IVisualStyle
    Inherited Members
    SplitterControl.ActivateControl(Control)
    SplitterControl.ActivateNext(Boolean)
    SplitterControl.ActiveControl
    SplitterControl.ActivePane
    SplitterControl.BeforeTouchSize
    SplitterControl.BorderStyle
    SplitterControl.ButtonLook
    SplitterControl.ButtonLookChanged
    SplitterControl.CanActivateNext(Boolean)
    SplitterControl.CanApplyTheme
    SplitterControl.CancelMode
    SplitterControl.CancelUpdate()
    SplitterControl.CanOverrideStyle
    SplitterControl.ColumnCount
    SplitterControl.CreateScrollBar(ScrollBars, Int32)
    SplitterControl.CurrentLayout
    SplitterControl.Deactivated
    SplitterControl.DefaultSize
    SplitterControl.DeleteColumn(Int32)
    SplitterControl.DeleteRow(Int32)
    SplitterControl.DisposePane(Int32, Int32)
    SplitterControl.FindPane(Control, Int32, Int32)
    SplitterControl.GetActiveThemeName()
    SplitterControl.GetHScrollBar(Control)
    SplitterControl.GetPane(Int32, Int32)
    SplitterControl.GetVScrollBar(Control)
    SplitterControl.GridOfficeScrollBars
    SplitterControl.HasControlFocus
    SplitterControl.HSplitPos
    SplitterControl.HSplitPosChanged
    SplitterControl.IControlToolTipProvider.GetControlToolTip()
    SplitterControl.IDynamicSplitterFrame.ActivePane
    SplitterControl.IDynamicSplitterFrame.ColumnCount
    SplitterControl.IDynamicSplitterFrame.RowCount
    SplitterControl.IDynamicSplitterFrame.SplitBars
    SplitterControl.IsActive(Control, ScrollBars)
    SplitterControl.IsActiveControl
    SplitterControl.IsDeactivated
    SplitterControl.IsValidated
    SplitterControl.IsValidating
    SplitterControl.IThemeProvider.BaseThemeName
    SplitterControl.IThemeProvider.ControlName
    SplitterControl.Office2007ScrollBarsChanged
    SplitterControl.Office2007ScrollBarsColorSchemeChanged
    SplitterControl.Office2010ScrollBarsColorScheme
    SplitterControl.Office2010ScrollBarsColorSchemeChanged
    SplitterControl.Office2016ScrollBarsColorScheme
    SplitterControl.Office2016ScrollBarsColorSchemeChanged
    SplitterControl.OfficeScrollBarsChanged
    SplitterControl.OnControlAdded(ControlEventArgs)
    SplitterControl.OnControlGotFocus()
    SplitterControl.OnControlLostFocus()
    SplitterControl.OnCreateNewControl(Int32, Int32, Control)
    SplitterControl.OnDeactivated(EventArgs)
    SplitterControl.OnEnter(EventArgs)
    SplitterControl.OnGotFocus(EventArgs)
    SplitterControl.OnHandleDestroyed(EventArgs)
    SplitterControl.OnHSplitPosChanged(EventArgs)
    SplitterControl.OnLeave(EventArgs)
    SplitterControl.OnLostFocus(EventArgs)
    SplitterControl.OnMouseDown(MouseEventArgs)
    SplitterControl.OnMouseUp(MouseEventArgs)
    SplitterControl.OnMovedSplitter(Object)
    SplitterControl.OnMoveSplitter(Object, Int32, Int32)
    SplitterControl.OnOffice2007ScrollBarsChanged(EventArgs)
    SplitterControl.OnOffice2007ScrollBarsColorSchemeChanged(EventArgs)
    SplitterControl.OnOffice2010ScrollBarsColorSchemeChanged(EventArgs)
    SplitterControl.OnOffice2016ScrollBarsColorSchemeChanged(EventArgs)
    SplitterControl.OnOfficeScrollBarsChanged(SplitterControl.OfficeScrollBarsEventArgs)
    SplitterControl.OnPaneClosing(SplitterPaneEventArgs)
    SplitterControl.OnPaneCreated(SplitterPaneEventArgs)
    SplitterControl.OnParentChanged(EventArgs)
    SplitterControl.OnScrollBarAppearanceChanged(EventArgs)
    SplitterControl.OnScrollBarColorChanged(EventArgs)
    SplitterControl.OnSetCursor(Message)
    SplitterControl.OnShowHorizontalScrollBarChanged(EventArgs)
    SplitterControl.OnShowSizeGripChanged(EventArgs)
    SplitterControl.OnShowVerticalScrollBarChanged(EventArgs)
    SplitterControl.OnSplitBarsChanged(EventArgs)
    SplitterControl.OnSplitterLayoutChanged(EventArgs)
    SplitterControl.OnSupportsFlatScrollBarsChanged(EventArgs)
    SplitterControl.OnThemeChanged(EventArgs)
    SplitterControl.OnValidated(EventArgs)
    SplitterControl.OnValidating(CancelEventArgs)
    SplitterControl.OnVSplitPosChanged(EventArgs)
    SplitterControl.PaneClosing
    SplitterControl.PaneCreated
    SplitterControl.QueryFocusInside()
    SplitterControl.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    SplitterControl.ResetScrollBarColor()
    SplitterControl.ResetToolTips()
    SplitterControl.RowCount
    SplitterControl.ScrollBarAppearance
    SplitterControl.ScrollBarAppearanceChanged
    SplitterControl.ScrollBarColor
    SplitterControl.ScrollBarColorChanged
    SplitterControl.SetActivePane(Int32, Int32)
    SplitterControl.ShowHorizontalScrollBar
    SplitterControl.ShowHorizontalScrollBarChanged
    SplitterControl.ShowSizeGrip
    SplitterControl.ShowSizeGripChanged
    SplitterControl.ShowToolTips
    SplitterControl.ShowToolTipsChanged
    SplitterControl.ShowVerticalScrollBar
    SplitterControl.ShowVerticalScrollBarChanged
    SplitterControl.SplitBars
    SplitterControl.SplitBarsChanged
    SplitterControl.SplitColumn(Int32)
    SplitterControl.SplitRow(Int32)
    SplitterControl.SplitterLayout
    SplitterControl.SplitterLayoutChanged
    SplitterControl.SplitterPaneFactory
    SplitterControl.SupportsFlatScrollBars
    SplitterControl.SupportsFlatScrollBarsChanged
    SplitterControl.ThemeChanged
    SplitterControl.ThemeNameChanged
    SplitterControl.ThemesEnabled
    SplitterControl.VSplitPos
    SplitterControl.VSplitPosChanged
    TabBarSplitterControl.AccessibilityEnabled
    TabBarSplitterControl.ActivateNextPage(Boolean)
    TabBarSplitterControl.ActivePage
    TabBarSplitterControl.ActivePageBorderColor
    TabBarSplitterControl.ActivePageChanged
    TabBarSplitterControl.ActivePageChanging
    TabBarSplitterControl.ActivePageIndex
    TabBarSplitterControl.AddButtonHoverColor
    TabBarSplitterControl.AddNewButtonImage
    TabBarSplitterControl.ApplyScaleToControl(Single)
    TabBarSplitterControl.Bar
    TabBarSplitterControl.CreateAccessibilityInstance()
    TabBarSplitterControl.CreateParams
    TabBarSplitterControl.CreateScrollBarContainer(ScrollBars, Int32)
    TabBarSplitterControl.DisabledColor
    TabBarSplitterControl.Dispose(Boolean)
    TabBarSplitterControl.EditOnTab
    TabBarSplitterControl.EnabledColor
    TabBarSplitterControl.EnableOffice2013Style
    TabBarSplitterControl.EnableTouchMode
    TabBarSplitterControl.HidePage(TabBarPage)
    TabBarSplitterControl.InitLayout()
    TabBarSplitterControl.INonClientPaintingSupport.NonClientPaint(PaintEventArgs, Rectangle, Rectangle)
    TabBarSplitterControl.IsVisualStyleEnabled
    TabBarSplitterControl.IVisualStyle.VisualTheme
    TabBarSplitterControl.LabelEdit
    TabBarSplitterControl.LabelEditBegin
    TabBarSplitterControl.LabelEditEnd
    TabBarSplitterControl.MoveTabBarPage(Int32, Int32)
    TabBarSplitterControl.MoveTabBarPage(TabBarPage, TabBarPage)
    TabBarSplitterControl.Office2007ColorScheme
    TabBarSplitterControl.Office2007ScrollBars
    TabBarSplitterControl.Office2007ScrollBarsColorScheme
    TabBarSplitterControl.OnActivePageChanged(ControlEventArgs)
    TabBarSplitterControl.OnActivePageChanging(ControlEventArgs)
    TabBarSplitterControl.OnButtonLookChanged(EventArgs)
    TabBarSplitterControl.OnCancelMode(EventArgs)
    TabBarSplitterControl.OnControlRemoved(ControlEventArgs)
    TabBarSplitterControl.OnFontChanged(EventArgs)
    TabBarSplitterControl.OnKeyDown(KeyEventArgs)
    TabBarSplitterControl.OnLayout(LayoutEventArgs)
    TabBarSplitterControl.OnPaint(PaintEventArgs)
    TabBarSplitterControl.OnShowToolTipsChanged(EventArgs)
    TabBarSplitterControl.OnSizeChanged(EventArgs)
    TabBarSplitterControl.OnStyleChanged()
    TabBarSplitterControl.OnTabBarVisibleChanged(TabBarVisibleChangedEventArgs)
    TabBarSplitterControl.OnValidatingLostFocus()
    TabBarSplitterControl.OnVisibleChanged(EventArgs)
    TabBarSplitterControl.ProcessDialogKey(Keys)
    TabBarSplitterControl.ProcessKeyEventArgs(Message)
    TabBarSplitterControl.ProcessKeyMessage(Message)
    TabBarSplitterControl.ProcessKeyPreview(Message)
    TabBarSplitterControl.Refresh()
    TabBarSplitterControl.RelativeWidth
    TabBarSplitterControl.RepeatClickDelay
    TabBarSplitterControl.ResetAddButtonHoverColor()
    TabBarSplitterControl.ResetAddNewButtonImage()
    TabBarSplitterControl.ResetDisabledColor()
    TabBarSplitterControl.ResetEditOnTab()
    TabBarSplitterControl.ResetEnabledColor()
    TabBarSplitterControl.ResetLabelEdit()
    TabBarSplitterControl.ResetShowAddNewTabBarPageOption()
    TabBarSplitterControl.ResetSizeFactor()
    TabBarSplitterControl.Resizable
    TabBarSplitterControl.ScrollBehavior
    TabBarSplitterControl.ScrollButtons
    TabBarSplitterControl.ShouldSerializeEditOnTab()
    TabBarSplitterControl.ShouldSerializeLabelEdit()
    TabBarSplitterControl.ShowAddNewTabBarPageOption
    TabBarSplitterControl.ShowIcons
    TabBarSplitterControl.ShowMetroSeperator
    TabBarSplitterControl.ShowPage(TabBarPage)
    TabBarSplitterControl.SizeFactor
    TabBarSplitterControl.Style
    TabBarSplitterControl.TabBarMouseDown
    TabBarSplitterControl.TabBarPageAdding
    TabBarSplitterControl.TabBarPageMouseEnter
    TabBarSplitterControl.TabBarPageMouseLeave
    TabBarSplitterControl.TabBarPages
    TabBarSplitterControl.TabBarVisibleChanged
    TabBarSplitterControl.TabFolderDelta
    TabBarSplitterControl.TabsMoved(Object, TabMovedEventArgs)
    TabBarSplitterControl.ThemeName
    TabBarSplitterControl.ThemeStyle
    TabBarSplitterControl.ToString()
    TabBarSplitterControl.WndProc(Message)
    Namespace: Syncfusion.Windows.Forms
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class WorkbookView : TabBarSplitterControl, IControlToolTipProvider, IInternalSplitterParent, IScrollBarFrame, IDynamicSplitterFrame, IThemedControl, IContainerControl, INonClientPaintingSupport, IThemeProvider, IVisualStyle
    Remarks

    A WorkbookView is associated with a WorkbookModel. The WorkbookModel has a Worksheets collection. For each of the WorksheetModel objects in the Worksheets collection of the WorkbookModel, a WorksheetView is created and displayed in this WorkbookView.

    Examples
    public class NewWorkbookFile : BasicAction
    {
    	int windowCount = 0;
    	WorkbookModel workbook;
    	public override void InvokeAction(object sender, EventArgs e)
    	{
    		windowCount++;
    		workbook = new WorkbookModel("Workbook");
    		GridModel sheet1 = new GridModel();
    		SampleGrid.SetupGridModel(sheet1);
    		GridModel sheet2 = new GridModel();
    		SampleGrid.SetupGridModel(sheet2);
    
    		workbook.Worksheets.Add(new WorksheetModel(workbook, "Sheet 1", sheet1));
    		workbook.Worksheets.Add(new WorksheetModel(workbook, "Sheet 2", sheet2));
    
    		WorkbookForm doc = new WorkbookForm(workbook);
    		doc.Text = workbook.Name + windowCount;
    		doc.MdiParent = MainWindow;
    		doc.Show();
    	}
    }

    Constructors

    WorkbookView(WorkbookModel)

    Initializes a new WorkbookView for the specified WorkbookModel.

    Declaration
    public WorkbookView(WorkbookModel workbook)
    Parameters
    Type Name Description
    WorkbookModel workbook

    The WorkbookModel which holds data to be displayed in this view.

    Properties

    Workbook

    Returns the WorkbookModel which holds data to be displayed in this view.

    Declaration
    public WorkbookModel Workbook { get; }
    Property Value
    Type
    WorkbookModel

    Methods

    CreateControlsInstance()

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

    OnCreateTabBarPageCollection()

    Creates the WorksheetViewCollection.

    Declaration
    public override TabBarPageCollection OnCreateTabBarPageCollection()
    Returns
    Type Description
    TabBarPageCollection

    The new WorksheetViewCollection.

    Overrides
    TabBarSplitterControl.OnCreateTabBarPageCollection()

    OnHandleCreated(EventArgs)

    Declaration
    protected override void OnHandleCreated(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e
    Overrides
    SplitterControl.OnHandleCreated(EventArgs)

    TabsMoving(Object, TabMovedEventArgs)

    Declaration
    protected override void TabsMoving(object sender, TabMovedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    TabMovedEventArgs e
    Overrides
    TabBarSplitterControl.TabsMoving(Object, TabMovedEventArgs)

    Events

    Activated

    Occurs when the view is activated.

    Declaration
    public event EventHandler Activated
    Event Type
    Type
    System.EventHandler

    Implements

    IControlToolTipProvider
    IScrollBarFrame
    IDynamicSplitterFrame
    IThemedControl
    System.Windows.Forms.IContainerControl
    INonClientPaintingSupport
    IThemeProvider
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved