WorkbookView Class

Provides a fully functional spreadsheet control which supports rich functionality including familiar keyboard and mouse selections, in-cell editing, a FormulaBar control, goto, cut, copy, paste, clear, undo, redo, printing, interruptible background calculation, real time workbook updates, multiple workbooks, DisplayReference, WorkbookDesigner, WorkbookExplorer, RangeExplorer, ChartExplorer, ShapeExplorer and more.

Object Model

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
<System.ComponentModel.DefaultEventAttribute("RangeSelectionChanged")>
<System.Windows.TemplatePartAttribute(Name="SheetPresenter", Type=SpreadsheetGear.Windows.Controls.SheetPresenter)>
<System.Windows.TemplatePartAttribute(Name="HorizontalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.HorizontalScrollbarsPresenter)>
<System.Windows.TemplatePartAttribute(Name="VerticalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.VerticalScrollbarsPresenter)>
<System.Windows.TemplateVisualStateAttribute(Name="Disabled", GroupName="CommonStates")>
<System.Windows.TemplateVisualStateAttribute(Name="Normal", GroupName="CommonStates")>
<System.Windows.StyleTypedPropertyAttribute(Property="ColumnHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.ColumnHeader)>
<System.Windows.StyleTypedPropertyAttribute(Property="RowHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.RowHeader)>
<System.Windows.StyleTypedPropertyAttribute(Property="SheetTabStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTab)>
<System.Windows.StyleTypedPropertyAttribute(Property="SheetTabScrollButtonStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTabScrollButton)>
Public Class WorkbookView 
   Inherits System.Windows.Controls.Control

'Usage
 
Dim instance As WorkbookView

[System.ComponentModel.DefaultEvent("RangeSelectionChanged")]
[System.Windows.TemplatePart(Name="SheetPresenter", Type=SpreadsheetGear.Windows.Controls.SheetPresenter)]
[System.Windows.TemplatePart(Name="HorizontalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.HorizontalScrollbarsPresenter)]
[System.Windows.TemplatePart(Name="VerticalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.VerticalScrollbarsPresenter)]
[System.Windows.TemplateVisualState(Name="Disabled", GroupName="CommonStates")]
[System.Windows.TemplateVisualState(Name="Normal", GroupName="CommonStates")]
[System.Windows.StyleTypedProperty(Property="ColumnHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.ColumnHeader)]
[System.Windows.StyleTypedProperty(Property="RowHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.RowHeader)]
[System.Windows.StyleTypedProperty(Property="SheetTabStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTab)]
[System.Windows.StyleTypedProperty(Property="SheetTabScrollButtonStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTabScrollButton)]
public class WorkbookView : System.Windows.Controls.Control

public class WorkbookView = class(System.Windows.Controls.Control)

System.ComponentModel.DefaultEventAttribute("RangeSelectionChanged")
System.Windows.TemplatePartAttribute(Name="SheetPresenter", Type=SpreadsheetGear.Windows.Controls.SheetPresenter)
System.Windows.TemplatePartAttribute(Name="HorizontalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.HorizontalScrollbarsPresenter)
System.Windows.TemplatePartAttribute(Name="VerticalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.VerticalScrollbarsPresenter)
System.Windows.TemplateVisualStateAttribute(Name="Disabled", GroupName="CommonStates")
System.Windows.TemplateVisualStateAttribute(Name="Normal", GroupName="CommonStates")
System.Windows.StyleTypedPropertyAttribute(Property="ColumnHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.ColumnHeader)
System.Windows.StyleTypedPropertyAttribute(Property="RowHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.RowHeader)
System.Windows.StyleTypedPropertyAttribute(Property="SheetTabStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTab)
System.Windows.StyleTypedPropertyAttribute(Property="SheetTabScrollButtonStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTabScrollButton)
public class WorkbookView extends System.Windows.Controls.Control

[System.ComponentModel.DefaultEvent("RangeSelectionChanged")]
[System.Windows.TemplatePart(Name="SheetPresenter", Type=SpreadsheetGear.Windows.Controls.SheetPresenter)]
[System.Windows.TemplatePart(Name="HorizontalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.HorizontalScrollbarsPresenter)]
[System.Windows.TemplatePart(Name="VerticalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.VerticalScrollbarsPresenter)]
[System.Windows.TemplateVisualState(Name="Disabled", GroupName="CommonStates")]
[System.Windows.TemplateVisualState(Name="Normal", GroupName="CommonStates")]
[System.Windows.StyleTypedProperty(Property="ColumnHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.ColumnHeader)]
[System.Windows.StyleTypedProperty(Property="RowHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.RowHeader)]
[System.Windows.StyleTypedProperty(Property="SheetTabStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTab)]
[System.Windows.StyleTypedProperty(Property="SheetTabScrollButtonStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTabScrollButton)]
public __gc class WorkbookView : public System.Windows.Controls.Control

[System.ComponentModel.DefaultEvent("RangeSelectionChanged")]
[System.Windows.TemplatePart(Name="SheetPresenter", Type=SpreadsheetGear.Windows.Controls.SheetPresenter)]
[System.Windows.TemplatePart(Name="HorizontalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.HorizontalScrollbarsPresenter)]
[System.Windows.TemplatePart(Name="VerticalScrollbarsPresenter", Type=SpreadsheetGear.Windows.Controls.VerticalScrollbarsPresenter)]
[System.Windows.TemplateVisualState(Name="Disabled", GroupName="CommonStates")]
[System.Windows.TemplateVisualState(Name="Normal", GroupName="CommonStates")]
[System.Windows.StyleTypedProperty(Property="ColumnHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.ColumnHeader)]
[System.Windows.StyleTypedProperty(Property="RowHeaderStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.RowHeader)]
[System.Windows.StyleTypedProperty(Property="SheetTabStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTab)]
[System.Windows.StyleTypedProperty(Property="SheetTabScrollButtonStyle", StyleTargetType=SpreadsheetGear.Windows.Controls.SheetTabScrollButton)]
public ref class WorkbookView : public System.Windows.Controls.Control

Remarks

The WorkbookView control adheres to the standard WPF threading model. Accessing any members of a WorkbookView must be done from the thread which created the WorkbookView.

For important information about the threading model of SpreadsheetGear see GetLock and ReleaseLock.

To modify the workbook(s) associated with a WorkbookView at design time, right click on the WorkbookView and select Workbook Designer. From the Workbook Designer, you can open, edit, format, save and close workbooks. The workbooks which are left open in the Workbook Designer when the designer is closed will be saved with the form containing the WorkbookView, and will be loaded into the workbook set associated with the WorkbookView when the form is created at run time.

The RangeSelection, ActiveCell, ActiveWorksheet, ActiveWorkbook and ActiveWorkbookSet properties are the most commonly used workbook view properties.

Use the DisplayReference and DisplayReferenceName properties to control which workbook or which worksheet ranges are displayed in the workbook view. The DisplayReference property provides the ability to display multiple workbooks in a single workbook view control, as well as the ability to limit what the user of the workbook view control is able to see.

The RangeChanged, RangeSelectionChanged and Calculate events are the most commonly used workbook view events.

Inheritance Hierarchy

System.Object
   System.Windows.Threading.DispatcherObject
      System.Windows.DependencyObject
         System.Windows.Media.Visual
            System.Windows.UIElement
               System.Windows.FrameworkElement
                  System.Windows.Controls.Control
                     SpreadsheetGear.Windows.Controls.WorkbookView

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

WorkbookView Members
SpreadsheetGear.Windows.Controls Namespace
FormulaBar Property
DisplayReference Property
WorkbookDesigner
WorkbookExplorer
RangeExplorer
ChartExplorer
ShapeExplorer