CustomSheetView Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Custom Sheet View.

This class is available in Office 2007 and above.

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

public class CustomSheetView : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CustomSheetView = class
    inherit OpenXmlCompositeElement

Public Class CustomSheetView
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

CustomSheetView

Remarks

[ISO/IEC 29500-1 1st Edition]

customSheetView (Custom Sheet View)

This collection stores information pertaining to one custom sheet view definition. A custom view is a collection of settings defining a particular view of the sheet. These views can be selected by the user for quick access to predefined views of the sheet.

[Example:This example indicates that there is both a horizontal and vertical split in the sheet view, and that the top left cell of the bottom right pane is F7. Page margin, print options, page setup, and header / footer information is also stored with this view.

<customSheetView guid="{F3A061A9-D5FD-4F9C-A7CD-483AD476BA25}"  sizeWithWindow="0">  
  <pane xSplit="5" ySplit="6" topLeftCell="F7"/>  
  <selection/>  
  <pageMargins left="0.7" right="0.7" top="0.75" bottom="0.75" header="0.3"    footer="0.3"/>  
  <printOptions gridLinesSet="0"/>  
  <pageSetup paperSize="0" scale="0" orientation="portrait" printDriver="0"    horizontalDpi="0" verticalDpi="0" copies="0"/>  
  <headerFooter/>  
</customSheetView>  

end example]

Parent Elements
customSheetViews (§18.3.1.27)

Child Elements	Subclause
autoFilter (AutoFilter Settings)	§18.3.1.2
colBreaks (Vertical Page Breaks)	§18.3.1.14
extLst (Future Feature Data Storage Area)	§18.2.10
headerFooter (Header Footer Settings)	§18.3.1.46
pageMargins (Page Margins)	§18.3.1.62
pageSetup (Page Setup Settings)	§18.3.1.63
pane (View Pane)	§18.3.1.66
printOptions (Print Options)	§18.3.1.70
rowBreaks (Horizontal Page Breaks (Row))	§18.3.1.74
selection (Selection)	§18.3.1.78

Attributes	Description
colorId (Color Id)	Index to the color value for the text in row/column headings and gridlines for this custom view. 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.
filter (Filtered List)	Flag indicating whether the view contains a filtered range. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
filterUnique (Filter)	Indicates whether an advanced filter has been applied, and the option to filter out duplicate records from the data list has been selected, in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
fitToPage (Fit To Page)	Flag indicating whether this view should be fit to page when printing this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
guid (GUID)	Unique identifier of this custom view. This is used to ensure uniqueness. It is generated when the view is created. Shall correspond to a customWorkbookView guid value in the workbook Start Part. The possible values for this attribute are defined by the ST_Guid simple type (§22.9.2.4).
hiddenColumns (Hidden Columns)	Flag indicating that there is one or more hidden column(s) in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
hiddenRows (Hidden Rows)	Flag indicating that there is one or more hidden row(s) in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
outlineSymbols (Show Outline Symbols)	Flag indicating whether outline symbols are displayed in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
printArea (Print Area Defined)	Flag indicating whether a print area is defined as part of this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
scale (Print Scale)	Print scaling for this custom view. The values of this attribute shall be restricted to the range from 10 to 400. [Example: 10 - 10% 20 - 20% … 100 - 100% … 400 - 400% end example] The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
showAutoFilter (Show AutoFitler Drop Down Controls)	Flag indicating whether the autofilter dropdown buttons are visible in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showFormulas (Show Formulas)	Flag indicating whether formulas are shown in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showGridLines (Show Grid Lines)	Flag indicating whether gridlines are shown in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showPageBreaks (Show Page Breaks)	Flag indicating whether page breaks are shown in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showRowCol (Show Headers)	Flag indicating whether row and column headers are shown in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showRuler (Show Ruler)	Flag indicating whether to show the ruler in this custom view. Only applicable if this Custom View is in Page Layout View. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
state (Visible State)	Visibility state for this custom view. The possible values for this attribute are defined by the ST_SheetState simple type (§18.18.68).
topLeftCell (Top Left Visible Cell)	Location of the top left visible cell in the bottom right pane in this custom view (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 for this Custom View The possible values for this attribute are defined by the ST_SheetViewType simple type (§18.18.69).
zeroValues (Show Zero Values)	Flag indicating whether the window should display 0 (zero) values in this custom view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

AutoFilter	AutoFilter Settings. Represents the following element tag in the schema: x:autoFilter.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ColorId	Color Id Represents the following attribute in the schema: colorId
ColumnBreaks	Vertical Page Breaks. Represents the following element tag in the schema: x:colBreaks.
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)
Filter	Filtered List Represents the following attribute in the schema: filter
FilterUnique	Filter Represents the following attribute in the schema: filterUnique
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FitToPage	Fit To Page Represents the following attribute in the schema: fitToPage
Guid	GUID Represents the following attribute in the schema: guid
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)
HeaderFooter	Header Footer Settings. Represents the following element tag in the schema: x:headerFooter.
HiddenColumns	Hidden Columns Represents the following attribute in the schema: hiddenColumns
HiddenRows	Hidden Rows Represents the following attribute in the schema: hiddenRows
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)
OutlineSymbols	Show Outline Symbols Represents the following attribute in the schema: outlineSymbols
PageMargins	Page Margins. Represents the following element tag in the schema: x:pageMargins.
PageSetup	Page Setup Settings. Represents the following element tag in the schema: x:pageSetup.
Pane	Pane Split Information. 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)
PrintArea	Print Area Defined Represents the following attribute in the schema: printArea
PrintOptions	Print Options. Represents the following element tag in the schema: x:printOptions.
RowBreaks	Horizontal Page Breaks. Represents the following element tag in the schema: x:rowBreaks.
Scale	Print Scale Represents the following attribute in the schema: scale
Selection	Selection. Represents the following element tag in the schema: x:selection.
ShowAutoFilter	Show AutoFitler Drop Down Controls Represents the following attribute in the schema: showAutoFilter
ShowFormulas	Show Formulas Represents the following attribute in the schema: showFormulas
ShowGridLines	Show Grid Lines Represents the following attribute in the schema: showGridLines
ShowPageBreaks	Show Page Breaks Represents the following attribute in the schema: showPageBreaks
ShowRowColumn	Show Headers Represents the following attribute in the schema: showRowCol
ShowRuler	Show Ruler Represents the following attribute in the schema: showRuler
State	Visible State Represents the following attribute in the schema: state
TopLeftCell	Top Left Visible Cell Represents the following attribute in the schema: topLeftCell
View	View Type Represents the following attribute in the schema: view
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
ZeroValues	Show Zero Values Represents the following attribute in the schema: zeroValues

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)