SharedItems Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the SharedItems Class.

This class is available in Office 2007 and above.

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

public class SharedItems : DocumentFormat.OpenXml.OpenXmlCompositeElement

type SharedItems = class
    inherit OpenXmlCompositeElement

Public Class SharedItems
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

SharedItems

Remarks

[ISO/IEC 29500-1 1st Edition]

sharedItems (Shared Items)

Represents the collection of unique items for a field in the PivotCacheDefinition. The sharedItems complex type stores data type and formatting information about the data in a field. Items in the PivotCacheDefinition can be shared in order to reduce the redundancy of those values that are referenced in multiple places across all the PivotTable parts. [Example: A value might be part of a filter, it might appear on a row or column axis, and will appear in the pivotCacheRecords definition as well. However, because of the performance cost of creating the optimized shared items, items are only shared if they are actually in use in the PivotTable. Therefore, depending on user actions on the PivotTable layout, the pivotCacheDefinition and underlying PivotCacheRecords part can be updated. end example]

If there are no shared items, then field values are stored directly in the pivotCacheRecords part.

[Example:

<sharedItems count="1">  
  <s v="[Customer].[Customer Geography].[Country].&[United States]"     c="United States"/>  
</sharedItems>  

end example]

The following attributes are not required or used if there are no items in sharedItems.

• containsBlank

• containsSemiMixedTypes

• containsMixedTypes

• longText

The following attributes are not used unless there is more than one item in sharedItems or the one and only item is not a blank item. If the first item is a blank item the data type the field cannot be verified.

• containsNumber

• containsDates

• containsString

• containsInteger

The following attributes can be omitted without loss of functionality.

• containsNonDate

• count

The following attributes are not required and can be omitted. However, refreshing the PivotTable could produce different groupings than before.

• maxDate

• minDate

• maxValue

• minValue

Applications should ensure that “date” attributes are not mixed with “value” attributes.

Parent Elements
cacheField (§18.10.1.3)

Child Elements	Subclause
b (Boolean)	§18.10.1.2
d (Date Time)	§18.10.1.21
e (Error Value)	§18.10.1.27
m (No Value)	§18.10.1.50
n (Numeric)	§18.10.1.60
s (Character Value)	§18.10.1.85

Attributes	Description
containsBlank (Contains Blank)	Specifies a boolean value that indicates whether this field contains a blank value. A value of 1 or true indicates this field contains one or more blank values. A value of 0 or false indicates this field does not contain blank values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
containsDate (Contains Date)	Specifies a boolean value that indicates that the field contains at least one date. A value of 1 or true indicates the field contains at least one date value. A value of 0 or false indicates the field does not contain any date values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
containsInteger (Contains Integer)	Specifies a boolean value that indicates whether this field contains integer values. A value of 1 or true indicates this field contains integer values. A value of 0 or false indicates non-integer or mixed values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
containsMixedTypes (Contains Mixed Data Types)	Specifies a boolean value that indicates whether this field contains more than one data type. A value of 1 or true indicates this field contains more than one data type. A value of 0 or false indicates contains only one data type. The field can still contain blank values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
containsNonDate (Contains Non Date)	Specifies a boolean value that indicates that the field contains at least one value that is not a date. A value of 1 or true indicates the field contains at least one non-date values. A value of 0 or false indicates this field contains no date fields. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
containsNumber (Contains Numbers)	Specifies a boolean value that indicates whether this field contains numeric values. A value of 1 or true indicates this field contains at least one numeric value. A value of 0 or false indicates this field contains no numeric values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
containsSemiMixedTypes (Contains Semi Mixed Data Types)	Specifies a boolean value that indicates that this field contains text values. The field can also contain a mix of other data type and blank values. A value of 1 or true indicates at least one text value, and can also contain a mix of other data types and blank values. A value of 0 or false indicates the field does not have a mix of text and other values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
containsString (Contains String)	Specifies a boolean value that indicates whether this field contains a text value. A value of 1 or true indicates this field contains at least one text value. A value of 0 or false indicates this field does not contain any text values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
count (Shared Items Count)	Specifies the number of shared items to load for this field. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
longText (Long Text)	Specifies a boolean value that indicates whether this field contains a long text value. A string is considered long if it is over 255 characters. A value of 1 or true indicates the value contains more than 255 characters of text. A value of 0 or false indicates the value contains less than 255 characters. [Note: This is used as many legacy spreadsheet application support a limit of 255 characters for text values. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
maxDate (Maximum Date Time Value)	Specifies the maximum date/time value found in a date field. The possible values for this attribute are defined by the W3C XML Schema dateTime datatype.
maxValue (Maximum Numeric Value)	Specifies the maximum numeric value found in a numeric field. The possible values for this attribute are defined by the W3C XML Schema double datatype.
minDate (Minimum Date Time)	Specifies the minimum date/time value found in a date field. The possible values for this attribute are defined by the W3C XML Schema dateTime datatype.
minValue (Minimum Numeric Value)	Specifies the minimum numeric value found in a numeric field. The possible values for this attribute are defined by the W3C XML Schema double datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ContainsBlank	Contains Blank Represents the following attribute in the schema: containsBlank
ContainsDate	Contains Date Represents the following attribute in the schema: containsDate
ContainsInteger	Contains Integer Represents the following attribute in the schema: containsInteger
ContainsMixedTypes	Contains Mixed Data Types Represents the following attribute in the schema: containsMixedTypes
ContainsNonDate	Contains Non Date Represents the following attribute in the schema: containsNonDate
ContainsNumber	Contains Numbers Represents the following attribute in the schema: containsNumber
ContainsSemiMixedTypes	Contains Semi Mixed Data Types Represents the following attribute in the schema: containsSemiMixedTypes
ContainsString	Contains String Represents the following attribute in the schema: containsString
Count	Shared Items Count Represents the following attribute in the schema: count
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)
LongText	Long Text Represents the following attribute in the schema: longText
MaxDate	Maximum Date Time Value Represents the following attribute in the schema: maxDate
MaxValue	Maximum Numeric Value Represents the following attribute in the schema: maxValue
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MinDate	Minimum Date Time Represents the following attribute in the schema: minDate
MinValue	Minimum Numeric Value Represents the following attribute in the schema: minValue
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)
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)