PivotCacheDefinition Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

PivotCache Definition.

This class is available in Office 2007 and above.

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

public class PivotCacheDefinition : DocumentFormat.OpenXml.OpenXmlPartRootElement

type PivotCacheDefinition = class
    inherit OpenXmlPartRootElement

Public Class PivotCacheDefinition
Inherits OpenXmlPartRootElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

PivotCacheDefinition

Remarks

[ISO/IEC 29500-1 1st Edition]

pivotCacheDefinition (PivotCache Definition)

Represents the pivotCacheDefinition part. This part defines each field in the source data, including the name, the string resources of the instance data (for shared items), and information about the type of data that appears in the field.

[Example:

<pivotCacheDefinition xmlns="…" xmlns:r="…" r:id="rId1" refreshedBy="AnonUser"  refreshedDate="2006-05-22T10:07:16Z" createdVersion="3" refreshedVersion="3"   minRefreshableVersion="3" recordCount="182">  
  <cacheSource type="worksheet">  
    <worksheetSource name="Table1"/>  
  </cacheSource>  
  <cacheFields count="28">  
    <cacheField name="Customer Name" numFmtId="0">  
    <cacheField name="Postal Code" numFmtId="0">  
      <sharedItems/>  
    </cacheField>  
    <cacheField name="Product Category" numFmtId="0">  
      <sharedItems count="1">  
        <s v="Bikes"/>  
      </sharedItems>  
    </cacheField>  
    <cacheField name="Year" numFmtId="0">  
      <sharedItems count="1">  
        <s v="2001"/>  
      </sharedItems>  
    </cacheField>  
    <cacheField name="Quarter" numFmtId="0">  
      <sharedItems containsSemiMixedTypes="0" containsString="0"         containsNumber="1" containsInteger="1" minValue="3" maxValue="3"         count="1">  
        <n v="3"/>  
      </sharedItems>  
    </cacheField>  
  </cacheField  
s>  
</pivotCacheDefinition>  

end example]

Parent Elements
Root element of SpreadsheetML Pivot Table Cache Definition part

Child Elements	Subclause
cacheFields (PivotCache Fields)	§18.10.1.4
cacheHierarchies (PivotCache Hierarchies)	§18.10.1.5
cacheSource (PivotCache Source Description)	§18.10.1.7
calculatedItems (Calculated Items)	§18.10.1.9
calculatedMembers (Calculated Members)	§18.10.1.11
dimensions (OLAP Dimensions)	§18.10.1.25
extLst (Future Feature Data Storage Area)	§18.2.10
kpis (OLAP KPIs)	§18.10.1.48
maps (OLAP Measure Group)	§18.10.1.52
measureGroups (OLAP Measure Groups)	§18.10.1.54
tupleCache (Tuple Cache)	§18.10.1.94

Attributes	Description
backgroundQuery (Background Query)	Specifies a boolean value that indicates whether the application should query and retrieve records asynchronously from the cache. A value of 1 or true indicates the application will retrieve records asynchronously from the cache. A value of 0 or false indicates the application will retrieve records synchronously. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
createdVersion (PivotCache Created Version)	Specifies the version of the application that created the cache. This attribute is application-dependent. The possible values for this attribute are defined by the W3C XML Schema unsignedByte datatype.
enableRefresh (Enable PivotCache Refresh)	Specifies a boolean value that indicates whether the end-user can refresh the cache. This attribute depends on whether the application exposes a method for allowing end-users control over refreshing the cache via the user interface. A value of 1 or true indicates the end-user can refresh the cache. A value of 0 or false indicates the end-user cannot refresh the cache. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
id (Relationship Identifier) Namespace: .../officeDocument/2006/relationships	Specifies the unique identifier that corresponds to the related pivotCacheRecords part. See (§18.10.1.68) for more information. The possible values for this attribute are defined by the ST_RelationshipId simple type (§22.8.2.1).
invalid (Invalid Cache)	Specifies a boolean value that indicates whether the cache needs to be refreshed. A value of 1 or true indicates the cache needs to be refreshed. A value of 0 or false indicates the cache does not need to be refreshed. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
minRefreshableVersion (Minimum Version Required for Refresh)	Specifies the earliest version of the application that is required to refresh the cache. This attribute is application-dependent. The possible values for this attribute are defined by the W3C XML Schema unsignedByte datatype.
missingItemsLimit (Missing Items Limit)	Specifies the number of unused items to allow before discarding unused items. This attribute is application-dependent. The application shall specify a threshold for unused items. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
optimizeMemory (Optimize Cache for Memory)	Specifies a boolean value that indicates whether the application will apply optimizations to the cache to reduce memory usage. This attribute is application-dependent. This application shall define its own cache optimization methods. The application shall also decide whether to expose cache optimization status via the user interface or an object model. A value of 1 or true indicates the application will apply optimizations to the cache. A value of 0 or false indicates the application will not apply optimizations to the cache. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
recordCount (PivotCache Record Count)	Specifies the number of records in the cache. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
refreshedBy (Last Refreshed By)	Specifies the name of the end-user who last refreshed the cache. This attribute is application-dependent and is specified by applications that track and store the identity of the current user. This attribute also depends on whether the application exposes mechanisms via the user interface whereby the end-user can refresh the cache. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
refreshedDateIso (PivotCache Last Refreshed Date ISO)	Specifies the date when the cache was last refreshed. This attribute depends on whether the application exposes mechanisms via the user interface whereby the end-user can refresh the cache. If refreshedDateIso and refreshedDate are both present, refreshedDateIso shall take precedence. The possible values for this attribute are defined by the W3C XML Schema dateTime datatype.
refreshedVersion (PivotCache Last Refreshed Version)	Specifies the version of the application that last refreshed the cache. This attribute depends on whether the application exposes mechanisms via the user interface whereby the end-user can refresh the cache. The possible values for this attribute are defined by the W3C XML Schema unsignedByte datatype.
refreshOnLoad (Refresh On Load)	Specifies a boolean value that indicates whether the application will refresh the cache when the workbook has been opened. A value of 1 or true indicates that application will refresh the cache when the workbook is loaded. A value of 0 or false indicates the application will not automatically refresh cached data. The end user shall trigger refresh of the cache manually via the application user interface. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
saveData (Save Pivot Records)	Specifies a boolean value that indicates whether the pivot records are saved with the cache. A value of 1 or true indicates pivot records are saved in the cache. A value of 0 or false indicates are not saved in the cache. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
supportAdvancedDrill (Supports Attribute Drilldown)	Specifies whether the cache's data source supports attribute drilldown. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
supportSubquery (Supports Subqueries)	Specifies whether the cache's data source supports subqueries. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
tupleCache (Stores Cache for OLAP Functions)	Specifies a boolean value that indicates whether the PivotCache is used store information for OLAP sheet data functions. A value of 1 or true indicates information about OLAP sheet data functions are stored in the cache. A value of 0 or false indicates the PivotCache does not contain information about OLAP sheet data functions. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
upgradeOnRefresh (Upgrade PivotCache on Refresh)	Specifies a boolean value that indicates whether the cache is scheduled for version upgrade. This attribute depends on whether the application exposes mechanisms via the user interface whereby the cache might be upgraded. A value of 1 or true indicates the cache is scheduled for upgrade. A value of 0 or false indicates the cache is not scheduled for upgrade. 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_PivotCacheDefinition) is located in §A.2. end note]

� ISO/IEC29500: 2008.

Constructors

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

Properties

BackgroundQuery	backgroundQuery Represents the following attribute in the schema: backgroundQuery
CacheFields	CacheFields. Represents the following element tag in the schema: x:cacheFields.
CacheHierarchies	CacheHierarchies. Represents the following element tag in the schema: x:cacheHierarchies.
CacheSource	CacheSource. Represents the following element tag in the schema: x:cacheSource.
CalculatedItems	CalculatedItems. Represents the following element tag in the schema: x:calculatedItems.
CalculatedMembers	CalculatedMembers. Represents the following element tag in the schema: x:calculatedMembers.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
CreatedVersion	createdVersion Represents the following attribute in the schema: createdVersion
Dimensions	Dimensions. Represents the following element tag in the schema: x:dimensions.
EnableRefresh	enableRefresh Represents the following attribute in the schema: enableRefresh
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)
Id	id Represents the following attribute in the schema: r:id
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)
Invalid	invalid Represents the following attribute in the schema: invalid
IsTupleCache	tupleCache Represents the following attribute in the schema: tupleCache
Kpis	Kpis. Represents the following element tag in the schema: x:kpis.
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)
LastRefreshedDateIso	refreshedDateIso Represents the following attribute in the schema: refreshedDateIso
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
Maps	Maps. Represents the following element tag in the schema: x:maps.
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MeasureGroups	MeasureGroups. Represents the following element tag in the schema: x:measureGroups.
MinRefreshableVersion	minRefreshableVersion Represents the following attribute in the schema: minRefreshableVersion
MissingItemsLimit	missingItemsLimit Represents the following attribute in the schema: missingItemsLimit
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)
OpenXmlPart	Gets the part that is associated with the DOM tree. It returns null when the DOM tree is not associated with a part. (Inherited from OpenXmlPartRootElement)
OptimizeMemory	optimizeMemory Represents the following attribute in the schema: optimizeMemory
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)
PivotCacheDefinitionExtensionList	PivotCacheDefinitionExtensionList. Represents the following element tag in the schema: x:extLst.
PivotTableCacheDefinitionPart	Gets the PivotTableCacheDefinitionPart associated with this element.
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
RecordCount	recordCount Represents the following attribute in the schema: recordCount
RefreshedBy	refreshedBy Represents the following attribute in the schema: refreshedBy
RefreshedDate	refreshedDate Represents the following attribute in the schema: refreshedDate
RefreshedVersion	refreshedVersion Represents the following attribute in the schema: refreshedVersion
RefreshOnLoad	refreshOnLoad Represents the following attribute in the schema: refreshOnLoad
SaveData	saveData Represents the following attribute in the schema: saveData
SupportAdvancedDrill	supportAdvancedDrill Represents the following attribute in the schema: supportAdvancedDrill
SupportSubquery	supportSubquery Represents the following attribute in the schema: supportSubquery
TupleCache	TupleCache. Represents the following element tag in the schema: x:tupleCache.
UpgradeOnRefresh	upgradeOnRefresh Represents the following attribute in the schema: upgradeOnRefresh
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)
Load(PivotTableCacheDefinitionPart)	Loads the DOM from the PivotTableCacheDefinitionPart
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)
Reload()	Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement)
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)
Save()	Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement)
Save(PivotTableCacheDefinitionPart)	Saves the DOM into the PivotTableCacheDefinitionPart.
Save(Stream)	Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement)
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 OpenXmlPartRootElement)

Explicit Interface Implementations

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