WorkbookView Class

Workbook View.When the object is serialized out as xml, its qualified name is x:workbookView.

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

[ChildElementInfoAttribute(typeof(ExtensionList))]
public class WorkbookView : OpenXmlCompositeElement

The following table lists the possible child types:

  • ExtensionList <x:extLst>


[ISO/IEC 29500-1 1st Edition]

18.2.30 workbookView (Workbook View)

This element specifies a single Workbook view.

Units for window widths and other dimensions are expressed in twips. Twip measurements are portable between different display resolutions. The formula is (screen pixels) * (20 * 72) / (logical device dpi), where the logical device dpi can be different for x and y coordinates.

Parent Elements

bookViews (§18.2.1)

Child Elements

Subclause

extLst (Future Feature Data Storage Area)

§18.2.10

Attributes

Description

activeTab (Active Sheet Index)

Specifies an unsignedInt that contains the index to the active sheet in this book view.

The default value for this attribute is 0.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

autoFilterDateGrouping (AutoFilter Date Grouping)

Specifies a boolean value that indicates whether to group dates when presenting the user with filtering options in the user interface.

A value of 1 or true indicates that dates are grouped.

A value of 0 or false indicates that dates are not grouped.

The default value for this attribute is true.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

firstSheet (First Sheet)

Specifies the index to the first sheet in this book view.

The default value for this attribute is 0.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

minimized (Minimized)

Specifies a boolean value that indicates whether the workbook window is minimized.

A value of 1 or true indicates the workbook window is minimized.

A value of 0 or false indicates the workbook window is not minimized.

The default value for this attribute is false.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

showHorizontalScroll (Show Horizontal Scroll)

Specifies a boolean value that indicates whether to display the horizontal scroll bar in the user interface.

A value of 1 or true indicates that the horizontal scrollbar shall be shown.

A value of 0 or false indicates that the horizontal scrollbar shall not be shown.

The default value for this attribute is true.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

showSheetTabs (Show Sheet Tabs)

Specifies a boolean value that indicates whether to display the sheet tabs in the user interface.

A value of 1 or true indicates that sheet tabs shall be shown.

A value of 0 or false indicates that sheet tabs shall not be shown.

The default value for this attribute is true.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

showVerticalScroll (Show Vertical Scroll)

Specifies a boolean value that indicates whether to display the vertical scroll bar.

A value of 1 or true indicates the vertical scrollbar shall be shown.

A value of 0 or false indicates the vertical scrollbar shall not be shown.

The default value for this attribute is true.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

tabRatio (Sheet Tab Ratio)

Specifies ratio between the workbook tabs bar and the horizontal scroll bar.

The default value for this attribute is 600.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

visibility (Visibility)

Specifies visible state of the workbook window.

The default value for this attribute is "visible."

The possible values for this attribute are defined by the ST_Visibility simple type (§18.18.89).

windowHeight (Window Height)

Specifies the height of the workbook window. The unit of measurement for this value is twips.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

windowWidth (Window Width)

Specifies the width of the workbook window. The unit of measurement for this value is twips.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

xWindow (Upper Left Corner (X Coordinate))

Specifies the X coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.

The possible values for this attribute are defined by the W3C XML Schema int datatype.

yWindow (Upper Left Corner (Y Coordinate))

Specifies the Y coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.

The possible values for this attribute are defined by the W3C XML Schema int datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_BookView) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2015 Microsoft