Slicer Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Excel

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the Slicer Class.

This class is available in Office 2010 and above.

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

public class Slicer : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Slicer = class
    inherit OpenXmlCompositeElement

Public Class Slicer
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Slicer

Remarks

2.6.68 CT_Slicer

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

Referenced by: CT_Slicers

A complex type that specifies a slicer view, as specified in section 2.3.2.2, in this worksheet.

Child Elements:

extLst: A CT_ExtensionList element, a specified in [ISO/IEC-29500-4] section A.2, that specifies future extensibility for this element.

Attributes:

name: An ST_Xstring attribute, as specified in [ISO/IEC-29500-1] section 22.9.2.19, that specifies the name of the slicer view. MUST be a unique case-insensitive name within the scope of this workbook. The length of this attribute MUST be greater than or equal to 1 character and MUST be less than or equal to 32767 characters.

cache: An ST_Xstring attribute that specifies the name of the slicer cache, as specified in section 2.3.2.1, that this slicer view is associated with. There MUST be a CT_SlicerCacheDefinition element, as specified in section 2.6.70, within this workbook with the name attribute equal to the value of this attribute.

caption: An ST_Xstring attribute that specifies the caption of the slicer view. If this string exists, the length MUST be greater than or equal to 1 character.

startItem: An unsignedInt attribute, as specified in [XMLSCHEMA2] section 3.3.22, that specifies the zero-based index of the first slicer item, as specified in section 2.3.2.1.6, displayed by the slicer view.

columnCount: An unsignedInt attribute that specifies the number of columns (2) in the slicer view. MUST be greater than or equal to 1 and MUST be less than or equal to 20000.

showCaption: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the caption is displayed.

level: An unsignedInt attribute that specifies the OLAP level of the OLAP hierarchy of the slicer source data used by this slicer view.

If the slicer source data is OLAP, the value MUST be greater than or equal to 0 and MUST be less than count of the CT_OlapSlicerCacheLevelsData element specified by the CT_SlicerCacheDefinition element specified by cache. If the OLAP hierarchy has an OLAP All level, the value MUST NOT be 0.

If the slicer source data is non-OLAP, this attribute MUST NOT exist.

style: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the slicer style of the slicer view. If this field (1) exists, this string MUST match the name attribute of a CT_SlicerStyle element within this workbook or MUST be equal to one of the built-in slicer style names:

Built-in slicer style names
SlicerStyleLight1
SlicerStyleLight2
SlicerStyleLight3
SlicerStyleLight4
SlicerStyleLight5
SlicerStyleLight6
SlicerStyleOther1
SlicerStyleOther2
SlicerStyleDark1
SlicerStyleDark2
SlicerStyleDark3
SlicerStyleDark4
SlicerStyleDark5
SlicerStyleDark6

lockedPosition: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the slicer view is locked.

rowHeight: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the row (2) height of the slicer view in English Metric Units (EMUs).

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_Slicer">

<xsd:sequence>

<xsd:element name="extLst" type="x:CT_ExtensionList" minOccurs="0" maxOccurs="1"/>

</xsd:sequence>

<xsd:attribute name="name" type="x:ST_Xstring" use="required"/>

<xsd:attribute name="cache" type="x:ST_Xstring" use="required"/>

<xsd:attribute name="caption" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="startItem" type="xsd:unsignedInt" use="optional" default="0"/>

<xsd:attribute name="columnCount" type="xsd:unsignedInt" use="optional" default="1"/>

<xsd:attribute name="showCaption" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="level" type="xsd:unsignedInt" use="optional" default="0"/>

<xsd:attribute name="style" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="lockedPosition" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="rowHeight" type="xsd:unsignedInt" use="required"/>

</xsd:complexType>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Constructors

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

Properties

Cache	cache, this property is only available in Office 2010 and later. Represents the following attribute in the schema: cache
Caption	caption, this property is only available in Office 2010 and later. Represents the following attribute in the schema: caption
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ColumnCount	columnCount, this property is only available in Office 2010 and later. Represents the following attribute in the schema: columnCount
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: x14: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)
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)
Level	level, this property is only available in Office 2010 and later. Represents the following attribute in the schema: level
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
LockedPosition	lockedPosition, this property is only available in Office 2010 and later. Represents the following attribute in the schema: lockedPosition
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
Name	name, this property is only available in Office 2010 and later. Represents the following attribute in the schema: name
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)
RowHeight	rowHeight, this property is only available in Office 2010 and later. Represents the following attribute in the schema: rowHeight
ShowCaption	showCaption, this property is only available in Office 2010 and later. Represents the following attribute in the schema: showCaption
StartItem	startItem, this property is only available in Office 2010 and later. Represents the following attribute in the schema: startItem
Style	style, this property is only available in Office 2010 and later. Represents the following attribute in the schema: style
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

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)