SheetView Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Worksheet View.

This class is available in Office 2007 and above.

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

public class SheetView : DocumentFormat.OpenXml.OpenXmlCompositeElement

type SheetView = class
    inherit OpenXmlCompositeElement

Public Class SheetView
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

SheetView

Remarks

[ISO/IEC 29500-1 1st Edition]

sheetView (Worksheet View)

A single sheet view definition. When more than one sheet view is defined in the file, it means that when opening the workbook, each sheet view corresponds to a separate window within the spreadsheet application, where each window is showing the particular sheet containing the same workbookViewId value, the last sheetView definition is loaded, and the others are discarded. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding workbookView entries) are saved.

Parent Elements
sheetViews (§18.3.1.88)

Child Elements	Subclause
extLst (Future Feature Data Storage Area)	§18.2.10
pane (View Pane)	§18.3.1.66
pivotSelection (PivotTable Selection)	§18.3.1.69
selection (Selection)	§18.3.1.78

Attributes	Description
colorId (Color Id)	Index to the color value for row/column text headings and gridlines. This is an 'index color value' (ICV) rather than rgb value. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
defaultGridColor (Default Grid Color)	Flag indicating that the consuming application should use the default grid lines color (system dependent). Overrides any color specified in colorId. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
rightToLeft (Right To Left)	Flag indicating whether the sheet is in 'right to left' display mode. When in this mode, Column A is on the far right, Column B ;is one column left of Column A, and so on. Also, information in cells is displayed in the Right to Left format. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showFormulas (Show Formulas)	Flag indicating whether this sheet should display formulas. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showGridLines (Show Grid Lines)	Flag indicating whether this sheet should display gridlines. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showOutlineSymbols (Show Outline Symbols)	Flag indicating whether the sheet has outline symbols visible. This flag shall always override SheetPr element's outlinePr child element whose attribute is named showOutlineSymbols when there is a conflict. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showRowColHeaders (Show Headers)	Flag indicating whether the sheet should display row and column headings. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showRuler (Show Ruler)	Show the ruler in Page Layout View. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showWhiteSpace (Show White Space)	Flag indicating whether page layout view shall display margins. False means do not display left, right, top (header), and bottom (footer) margins (even when there is data in the header or footer). The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showZeros (Show Zero Values)	Flag indicating whether the window should show 0 (zero) in cells containing zero value. When false, cells with zero value appear blank instead of showing the number zero. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
tabSelected (Sheet Tab Selected)	Flag indicating whether this sheet is selected. When only 1 sheet is selected and active, this value should be in synch with the activeTab value. In case of a conflict, the Start Part setting wins and sets the active sheet tab. Multiple sheets can be selected, but only one sheet shall be active at one time. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
topLeftCell (Top Left Visible Cell)	Location of the top left visible cell Location of the top left visible cell in the bottom right pane (when in Left-to-Right mode). The possible values for this attribute are defined by the ST_CellRef simple type (§18.18.7).
view (View Type)	Indicates the view type. The possible values for this attribute are defined by the ST_SheetViewType simple type (§18.18.69).
windowProtection (Window Protection)	Flag indicating whether the panes in the window are locked due to workbook protection. This is an option when the workbook structure is protected. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
workbookViewId (Workbook View Index)	Zero-based index of this workbook view, pointing to a workbookView element in the bookViews collection. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
zoomScale (Zoom Scale)	Window zoom magnification for current view representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together. [Example: 10 - 10% 20 - 20% … 100 - 100% … 400 - 400% end example] Current view can be Normal, Page Layout, or Page Break Preview. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
zoomScaleNormal (Zoom Scale Normal View)	Zoom magnification to use when in normal view, representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together. [Example: 10 - 10% 20 - 20% … 100 - 100% … 400 - 400% end example] Applies for worksheets only; zero implies the automatic setting. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
zoomScalePageLayoutView (Zoom Scale Page Layout View)	Zoom magnification to use when in page layout view, representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together. [Example: 10 - 10% 20 - 20% … 100 - 100% … 400 - 400% end example] Applies for worksheets only; zero implies the automatic setting. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
zoomScaleSheetLayoutView (Zoom Scale Page Break Preview)	Zoom magnification to use when in page break preview, representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together. [Example: 10 - 10% 20 - 20% … 100 - 100% … 400 - 400% end example] Applies for worksheet only; zero implies the automatic setting. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ColorId	Color Id Represents the following attribute in the schema: colorId
DefaultGridColor	Default Grid Color Represents the following attribute in the schema: defaultGridColor
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
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)
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)
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)
Pane	View Pane. Represents the following element tag in the schema: x:pane.
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
RightToLeft	Right To Left Represents the following attribute in the schema: rightToLeft
ShowFormulas	Show Formulas Represents the following attribute in the schema: showFormulas
ShowGridLines	Show Grid Lines Represents the following attribute in the schema: showGridLines
ShowOutlineSymbols	Show Outline Symbols Represents the following attribute in the schema: showOutlineSymbols
ShowRowColHeaders	Show Headers Represents the following attribute in the schema: showRowColHeaders
ShowRuler	Show Ruler Represents the following attribute in the schema: showRuler
ShowWhiteSpace	Show White Space Represents the following attribute in the schema: showWhiteSpace
ShowZeros	Show Zero Values Represents the following attribute in the schema: showZeros
TabSelected	Sheet Tab Selected Represents the following attribute in the schema: tabSelected
TopLeftCell	Top Left Visible Cell Represents the following attribute in the schema: topLeftCell
View	View Type Represents the following attribute in the schema: view
WindowProtection	Window Protection Represents the following attribute in the schema: windowProtection
WorkbookViewId	Workbook View Index Represents the following attribute in the schema: workbookViewId
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
ZoomScale	Zoom Scale Represents the following attribute in the schema: zoomScale
ZoomScaleNormal	Zoom Scale Normal View Represents the following attribute in the schema: zoomScaleNormal
ZoomScalePageLayoutView	Zoom Scale Page Layout View Represents the following attribute in the schema: zoomScalePageLayoutView
ZoomScaleSheetLayoutView	Zoom Scale Page Break Preview Represents the following attribute in the schema: zoomScaleSheetLayoutView

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)