PageField Class
Page Field.When the object is serialized out as xml, its qualified name is x:pageField.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Spreadsheet.PageField
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(ExtensionList))> _
Public Class PageField _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As PageField
[ChildElementInfoAttribute(typeof(ExtensionList))]
public class PageField : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
- ExtensionList <x:extLst>
[ISO/IEC 29500-1 1st Edition]
18.10.1.62 pageField (Page Field)
Represents a field on the page or report filter of the PivotTable.
.gif "DocumentFormat.OpenXml.Spreadsheet.PageField-image")
In the image above, the blue field is a page or report filter field. Page/filter fields allow you to filter the entire PivotTable to display data for a single item or all the items.
[Example:
<sh:pageField fld="43" hier="103"
name="[Product].[Product Categories].[All Products]" cap="All Products"/>
end example]
Parent Elements |
|---|
pageFields (§18.10.1.63) |
Child Elements |
Subclause |
|---|---|
extLst (Future Feature Data Storage Area) |
§18.2.10 |
Attributes |
Description |
|---|---|
cap (Hierarchy Display Name) |
Specifies the display name of the hierarchy. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
fld (Field) |
Specifies the index of the field that appears on the page or filter report area of the PivotTable. The possible values for this attribute are defined by the W3C XML Schema int datatype. |
hier (OLAP Hierarchy Index) |
Specifies the index of the OLAP hierarchy to which this item belongs. The possible values for this attribute are defined by the W3C XML Schema int datatype. |
item (Item Index) |
Specifies the index of the item in the PivotCache. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
name (Hierarchy Unique Name) |
Specifies the unique name of the hierarchy. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
[Note: The W3C XML Schema definition of this element’s content model (CT_PageField) is located in §A.2. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.