<customWorkbookView> (Custom Workbook View)

This element specifies a single custom workbook view. A custom workbook view consists of a set of display and print settings that you can name and apply to a workbook. You can create more than one view of the same workbook without saving separate copies of the workbook. Custom workbook views are created by the end-user via tools in the application user interface.

Parent Elements

<customWorkbookViews> (§3.2.4)

Child Elements

Subclause

<extLst> (Future Feature Data Storage Area)

§3.2.10

Attributes

Description

<activeSheetId> (Active Sheet in Book View)

Specifies the @sheetId of a sheet in the workbook that is the active sheet in this book view. Correpsonds to a @sheetId of a <sheet> in the <sheets> collection.

This attribute is required.

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

<autoUpdate> (Auto Update)

Specifies a boolean value that indicates that this application will automatically update changes at the interval specified by the mergeInterval attribute. This is only applicable for shared workbooks.

A value of on, 1, or true indicates the application will update changes at the interval specified in the mergeInterval attribute.

A value of off, 0, or false indicates the application will update changes whenever the workbook is saved by the user.

The default value for this attribute is false.

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

<changesSavedWin> (Changes Saved Win)

Specifies a boolean value that indicates that when conflicts are found, the changes being saved always take precedence. This is only applicable for shared workbooks in automatic refresh mode.

A value of on, 1, or true indicates that changes being saved take precedence when conflicts in data are found in a shared workbook.

A value of off, 0, or false indicates that changes being saved do not take precedence over other changes if conflicts are found in a shared workbook.

The default value for this attribute is false.

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

<guid> (Custom View GUID)

Specifies a globally unique identifier (GUID) for this custom view

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

<includeHiddenRowCol> (Include Hidden Rows & Columns)

Specifies a boolean value that indicates whether to include hidden rows, columns, and filter settings in this custom view.

A value of on, 1, or true indicates that hidden rows, columns, and filter settings are included in this custom view.

A value of off, 0, or false indicates that hidden rows, columns, and filter settings are not included.

The default value for this attribute is true.

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

<includePrintSettings> (Include Print Settings)

Specifies a boolean value that indicates whether to include print settings in this custom view.

A value of on, 1, or true indicates that print settings are included in this custom view.

A value of off, 0, or false indicates print settings are not included in this custom view.

The default value for this attribute is true.

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

<maximized> (Maximized)

Specifies a boolean value that indicates whether the book window is maximized.

A value of on, 1, or true indicates the workbook window is maximized.

A value of off, 0, or false indicates the workbook window is not maximized.

The default value for this attribute is false.

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

<mergeInterval> (Merge Interval)

Automatic update interval (in minutes). Only applicable for shared workbooks in automatic refresh mode.

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

<minimized> (Minimized)

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

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

A value of off, 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 XML Schema boolean datatype.

<name> (Custom View Name)

Specifies the name of the custom view.

This attribute is required.

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

<onlySync> (Only Synch)

Specifies a boolean value that indicates, during automatic refresh, the current user's changes will not be saved. The workbook will only be updated with other users' changes. Only applicable for shared workbooks in automatic refresh mode.

A value of on, 1, or true indicates the current user's changes will not be saved during automatic refresh.

A value of off, 0, or false indicates the current user's will be saved during automatic refresh.

The default value for this attribute is false.

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

<personalView> (Personal View)

Specifies a boolean value that indicates that this custom view is a personal view for a shared workbook user. Only applicable for shared workbooks. Personal views allow each user of a shared workbook to store their individual print and filter settings.

A value of on, 1, or true indicates this custom view is a personal view for a shared workbook user.

A value of off, 0, or false indicates this view is not a personal view.

The default value for this attribute is false.

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

<showComments> (Show Comments)

Specifies how comments are displayed in this custom view

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

<showFormulaBar> (Show Formula Bar)

Specifies a boolean value that indicates whether to display the formula bar in the application user interface.

A value of on, 1, or true indicates the formula bar is shown in the user interface.

A value of off, 0, or false indicates the formula bar is not shown in the user interface.

The default value for this attribute is true.

The possible values for this attribute are defined by the 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 on, 1, or true indicates that the horizontal scrollbar is shown.

A value of off, 0, or false indicates that the horizontal scrollbar is not shown.

The default value for this attribute is true.

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

<showObjects> (Show Objects)

Specifies how objects are displayed in this custom view.

The default value for this attribute is "all."

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

<showSheetTabs> (Show Sheet Tabs)

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

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

A value of off, 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 XML Schema boolean datatype.

<showStatusbar> (Show Status Bar)

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

A value of on, 1, or true indicates that the status bar is shown.

A value of off, 0, or false indicates the status bar is not shown.

The default value for this attribute is true.

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

<showVerticalScroll> (Show Vertical Scroll)

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

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

A value of off, 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 XML Schema boolean datatype.

<tabRatio> (Sheet Tab Ratio)

Specified the ratio between the workbook tabs bar and the horizontal scroll bar. tabRatio is assumed to be out of 1000 of the horizontal window width.

The default value for this attribute is 600.

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

<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 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 XML Schema unsignedInt datatype.

<xWindow> (Top Left Corner (X Coordinate))

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

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

<yWindow> (Top Left Corner (Y Coordinate))

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

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

The following XML Schema fragment defines the contents of this element:

<complexType name="CT_CustomWorkbookView">
	<sequence>
	<element name="extLst" minOccurs="0" type="CT_ExtensionList"/>
	</sequence>
	<attribute name="name" type="ST_Xstring" use="required"/>
	<attribute name="guid" type="ST_Guid" use="required"/>
	<attribute name="autoUpdate" type="xsd:boolean" use="optional" default="false"/>
	<attribute name="mergeInterval" type="xsd:unsignedInt" use="optional"/>
	<attribute name="changesSavedWin" type="xsd:boolean" use="optional" default="false"/>
	<attribute name="onlySync" type="xsd:boolean" use="optional" default="false"/>
	<attribute name="personalView" type="xsd:boolean" use="optional" default="false"/>
	<attribute name="includePrintSettings" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="includeHiddenRowCol" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="maximized" type="xsd:boolean" use="optional" default="false"/>
	<attribute name="minimized" type="xsd:boolean" use="optional" default="false"/>
	<attribute name="showHorizontalScroll" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="showVerticalScroll" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="showSheetTabs" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="xWindow" type="xsd:int" use="optional" default="0"/>
	<attribute name="yWindow" type="xsd:int" use="optional" default="0"/>
	<attribute name="windowWidth" type="xsd:unsignedInt" use="required"/>
	<attribute name="windowHeight" type="xsd:unsignedInt" use="required"/>
	<attribute name="tabRatio" type="xsd:unsignedInt" use="optional" default="600"/>
	<attribute name="activeSheetId" type="xsd:unsignedInt" use="required"/>
	<attribute name="showFormulaBar" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="showStatusbar" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="showComments" type="ST_Comments" use="optional" default="commIndicator"/>
	<attribute name="showObjects" type="ST_Objects" use="optional" default="all"/>
</complexType>