WorkbookView Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Workbook View.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is x:workbookView.

public class WorkbookView : DocumentFormat.OpenXml.OpenXmlCompositeElement

type WorkbookView = class
    inherit OpenXmlCompositeElement

Public Class WorkbookView
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

WorkbookView

Remarks

[ISO/IEC 29500-1 1st Edition]

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.

Constructors

WorkbookView()	Initializes a new instance of the WorkbookView class.
WorkbookView(IEnumerable<OpenXmlElement>)	Initializes a new instance of the WorkbookView class with the specified child elements.
WorkbookView(OpenXmlElement[])	Initializes a new instance of the WorkbookView class with the specified child elements.
WorkbookView(String)	Initializes a new instance of the WorkbookView class from outer XML.

Properties

ActiveTab	Active Sheet Index Represents the following attribute in the schema: activeTab
AutoFilterDateGrouping	AutoFilter Date Grouping Represents the following attribute in the schema: autoFilterDateGrouping
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
ExtensionList	ExtensionList. Represents the following element tag in the schema: x:extLst.
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FirstSheet	First Sheet Represents the following attribute in the schema: firstSheet
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
Minimized	Minimized Represents the following attribute in the schema: minimized
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
ShowHorizontalScroll	Show Horizontal Scroll Represents the following attribute in the schema: showHorizontalScroll
ShowSheetTabs	Show Sheet Tabs Represents the following attribute in the schema: showSheetTabs
ShowVerticalScroll	Show Vertical Scroll Represents the following attribute in the schema: showVerticalScroll
TabRatio	Sheet Tab Ratio Represents the following attribute in the schema: tabRatio
Visibility	Visibility Represents the following attribute in the schema: visibility
WindowHeight	Window Height Represents the following attribute in the schema: windowHeight
WindowWidth	Window Width Represents the following attribute in the schema: windowWidth
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XWindow	Upper Left Corner (X Coordinate) Represents the following attribute in the schema: xWindow
YWindow	Upper Left Corner (Y Coordinate) Represents the following attribute in the schema: yWindow

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)