PivotCacheDefinition Class

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.

Inheritance Hierarchy

SystemObject
  DocumentFormat.OpenXmlOpenXmlElement
    DocumentFormat.OpenXmlOpenXmlCompositeElement
      DocumentFormat.OpenXmlOpenXmlPartRootElement
        TypedOpenXmlPartRootElement
          DocumentFormat.OpenXml.SpreadsheetPivotCacheDefinition

Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll) Version: 2.20.0+Branch.release-v2.20.0.Sha.a873d3fbff9bffe179fea62486da950adf5be65d.a873d3fbff9bffe179fea62486da950adf5be65d

Syntax

C++

Copy

public class PivotCacheDefinition : TypedOpenXmlPartRootElement

Public Class PivotCacheDefinition
	Inherits TypedOpenXmlPartRootElement

public ref class PivotCacheDefinition : public TypedOpenXmlPartRootElement

type PivotCacheDefinition = 
    class
        inherit TypedOpenXmlPartRootElement
    end

The PivotCacheDefinition type exposes the following members.

Constructors

	Name	Description
	PivotCacheDefinition	Initializes a new instance of the PivotCacheDefinition class.
	PivotCacheDefinition(IEnumerableOpenXmlElement)	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.

Top

Properties

	Name	Description
	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 indicating 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 node and all of its children. (Inherited from OpenXmlCompositeElement)
	InnerXml	Gets or sets the markup that represents only the child elements of the current element. (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)
	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)

Top

Methods

	Name	Description
	AddAnnotation	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
	AddChild	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	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
	Ancestors	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
	Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
	AnnotationT	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)
	AnnotationsT	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
	Append(IEnumerableOpenXmlElement)	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)
	AppendChildT	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	When overridden in a derived class, creates a duplicate of the node. (Overrides OpenXmlElementCloneNode(Boolean))
	DescendantsT	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
	ElementsT	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)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAttribute	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)
	GetFirstChildT	Finds the first child element in type T. (Inherited from OpenXmlElement)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InsertAfterT	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
	InsertAfterSelfT	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
	InsertAtT	Inserts the specified element at the specified index in the current element's list of child elements. (Inherited from OpenXmlCompositeElement)
	InsertBeforeT	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
	InsertBeforeSelfT	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
	IsAfter	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
	IsBefore	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
	Load	Loads the DOM from the PivotTableCacheDefinitionPart
	LookupNamespace	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
	LookupPrefix	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)
	PrependChildT	Inserts the specified element at the beginning of the current element's list of child elements. (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)
	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)
	RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
	RemoveAnnotationsT	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
	RemoveAttribute	Removes the attribute from the current element. (Inherited from OpenXmlElement)
	RemoveChildT	Removes the specified child element from the current element's list of child elements. (Inherited from OpenXmlCompositeElement)
	RemoveNamespaceDeclaration	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
	ReplaceChildT	Replaces a child element with another child element in the current element's list of child elements. (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	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	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)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WriteTo	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlPartRootElement)

Top

Reference

DocumentFormat.OpenXml.Spreadsheet Namespace