API Reference
LegacyXlsPivotTableRecord
Describes a preserve-only PivotTable BIFF record and any shallow fields decoded from it.
Inheritance
- Object
- LegacyXlsPivotTableRecord
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property LegacyXlsWorkbook.PivotTableRecords
Constructors
public LegacyXlsPivotTableRecord(LegacyXlsPivotTableRecordKind kind, String recordName, String sheetName, Int32 recordOffset, UInt16 recordType, Int32 payloadLength) #Creates PivotTable BIFF record metadata.
Parameters
- kind OfficeIMO.Excel.LegacyXls.Model.LegacyXlsPivotTableRecordKind
- recordName System.String
- sheetName System.String
- recordOffset System.Int32
- recordType System.UInt16
- payloadLength System.Int32
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public LegacyXlsPivotTableRecordKind Kind { get; } #Gets the decoded PivotTable metadata kind.
public String RecordName { get; } #Gets the BIFF record name.
public String SheetName { get; } #Gets the worksheet or sheet entry name associated with the record, when known.
public Int32 RecordOffset { get; } #Gets the byte offset of the BIFF record.
public UInt16 RecordType { get; } #Gets the BIFF record type identifier.
public Int32 PayloadLength { get; } #Gets the BIFF record payload length in bytes.
public Nullable<Int16> DataItemFieldIndex { get; set; } #Gets the pivot field index for an SXDI data item, when decoded.
public Nullable<Int16> AggregationFunction { get; set; } #Gets the aggregation function identifier for an SXDI data item, when decoded.
public Nullable<LegacyXlsPivotAggregationFunction> AggregationFunctionKind { get; set; } #Gets the decoded aggregation function for an SXDI data item, when the identifier is known.
public String AggregationFunctionName { get; set; } #Gets the aggregation function name for an SXDI data item, or a stable raw identifier for unknown values.
public Nullable<Int16> DisplayCalculation { get; set; } #Gets the display calculation identifier for an SXDI data item, when decoded.
public Nullable<LegacyXlsPivotDisplayCalculation> DisplayCalculationKind { get; set; } #Gets the decoded display calculation for an SXDI data item, when the identifier is known.
public String DisplayCalculationName { get; set; } #Gets the display calculation name for an SXDI data item, or a stable raw identifier for unknown values.
public Nullable<Int16> DisplayCalculationFieldIndex { get; set; } #Gets the pivot field index used by an SXDI display calculation, when decoded.
public String DisplayCalculationFieldReferenceName { get; set; } #Gets a stable field-reference name for an SXDI display calculation.
public Nullable<Int16> DisplayCalculationItemIndex { get; set; } #Gets the pivot item index used by an SXDI display calculation, when decoded.
public String DisplayCalculationItemReferenceName { get; set; } #Gets a stable item-reference name for an SXDI display calculation.
public Nullable<UInt16> NumberFormatId { get; set; } #Gets the number format identifier stored in an SXDI data item, when decoded.
public String Name { get; set; } #Gets the optional custom SXDI data item name, when decoded.
public String ViewRange { get; set; } #Gets the A1 range covered by an SxView PivotTable view, when decoded.
public Nullable<UInt16> ViewFirstRow { get; set; } #Gets the zero-based first row covered by an SxView PivotTable view, when decoded.
public Nullable<UInt16> ViewLastRow { get; set; } #Gets the zero-based last row covered by an SxView PivotTable view, when decoded.
public Nullable<UInt16> ViewFirstColumn { get; set; } #Gets the zero-based first column covered by an SxView PivotTable view, when decoded.
public Nullable<UInt16> ViewLastColumn { get; set; } #Gets the zero-based last column covered by an SxView PivotTable view, when decoded.
public Nullable<UInt16> ViewFirstHeaderRow { get; set; } #Gets the first row of the row area from an SxView PivotTable view, when decoded.
public Nullable<UInt16> ViewFirstDataRow { get; set; } #Gets the first data row from an SxView PivotTable view, when decoded.
public Nullable<UInt16> ViewFirstDataColumn { get; set; } #Gets the first data column from an SxView PivotTable view, when decoded.
public Nullable<Int16> ViewCacheIndex { get; set; } #Gets the PivotCache index referenced by an SxView PivotTable view, when decoded.
public String ViewDataAxisName { get; set; } #Gets the default data-axis name decoded from sxaxis4Data in an SxView record.
public Nullable<Int16> ViewDataPosition { get; set; } #Gets the data field position from an SxView PivotTable view, when decoded.
public Nullable<Int16> ViewFieldCount { get; set; } #Gets the declared pivot field count from an SxView record.
public Nullable<UInt16> ViewRowFieldCount { get; set; } #Gets the row-axis field count from an SxView record.
public Nullable<UInt16> ViewColumnFieldCount { get; set; } #Gets the column-axis field count from an SxView record.
public Nullable<UInt16> ViewPageFieldCount { get; set; } #Gets the page-axis field count from an SxView record.
public Nullable<Int16> ViewDataFieldCount { get; set; } #Gets the data field count from an SxView record.
public Nullable<UInt16> ViewRowLineCount { get; set; } #Gets the row-area pivot line count from an SxView record.
public Nullable<UInt16> ViewColumnLineCount { get; set; } #Gets the column-area pivot line count from an SxView record.
public Nullable<Boolean> ViewRowGrandTotals { get; set; } #Gets whether an SxView record declares row grand totals.
public Nullable<Boolean> ViewColumnGrandTotals { get; set; } #Gets whether an SxView record declares column grand totals.
public Nullable<Boolean> ViewAutoFormat { get; set; } #Gets whether an SxView record declares AutoFormat is applied.
public Nullable<UInt16> ViewAutoFormatId { get; set; } #Gets the AutoFormat identifier from an SxView record.
public String ViewTableName { get; set; } #Gets the PivotTable name carried by an SxView record.
public String ViewDataName { get; set; } #Gets the data field caption carried by an SxView record.
public String FieldAxisName { get; set; } #Gets the decoded pivot field axis for an Sxvd record.
public Nullable<UInt16> FieldSubtotalCount { get; set; } #Gets the declared subtotal count for an Sxvd record.
public Nullable<UInt16> FieldSubtotalFlags { get; set; } #Gets the raw subtotal-function flags for an Sxvd record.
public IReadOnlyList<String> FieldSubtotalFunctionNames { get; set; } #Gets decoded subtotal-function names for an Sxvd record.
public Nullable<Int16> FieldItemCount { get; set; } #Gets the declared pivot item count for an Sxvd record.
public String FieldName { get; set; } #Gets the optional pivot field caption carried by an Sxvd record.
public IReadOnlyList<Int16> FieldIndexReferences { get; set; } #Gets the pivot field indexes referenced by an SxIvd row or column field-index list.
public IReadOnlyList<LegacyXlsPivotLineItem> LineItems { get; set; } #Gets the row or column line items decoded from an SXLI record.
public IReadOnlyList<LegacyXlsPivotPageItem> PageItems { get; set; } #Gets the page-axis pivot item selectors decoded from an SXPI record.
public Nullable<Int16> ItemType { get; set; } #Gets the raw item type stored in an SXVI PivotTable item record.
public Nullable<LegacyXlsPivotItemType> ItemTypeKind { get; set; } #Gets the decoded item type stored in an SXVI PivotTable item record, when known.
public String ItemTypeName { get; set; } #Gets the item type name for an SXVI PivotTable item record, or a stable raw identifier for unknown values.
public Nullable<Boolean> ItemHideDetail { get; set; } #Gets whether an SXVI PivotTable item hides detail.
public Nullable<Boolean> ItemFormula { get; set; } #Gets whether an SXVI PivotTable item represents a calculated item formula.
public Nullable<Boolean> ItemMissing { get; set; } #Gets whether an SXVI PivotTable item is missing from the cache.
public Nullable<Int16> ItemCacheIndex { get; set; } #Gets the PivotCache item index referenced by an SXVI PivotTable item.
public String ItemCacheIndexName { get; set; } #Gets a stable cache-index name for an SXVI PivotTable item.
public String ItemName { get; set; } #Gets the optional caption carried by an SXVI PivotTable item.
public Nullable<UInt16> CacheStreamId { get; set; } #Gets the PivotCache stream identifier, when decoded from SXStreamID or SXDB.
public String CacheStreamName { get; set; } #Gets the four-character PivotCache stream name implied by the stream identifier.
public Nullable<Int32> CacheRecordCount { get; set; } #Gets the number of cache records declared by SXDB, when decoded.
public Nullable<Boolean> CacheHasRecords { get; set; } #Gets whether SXDB declares cached records exist for this PivotCache.
public Nullable<Boolean> CacheInvalid { get; set; } #Gets whether SXDB marks the PivotCache records as invalid.
public Nullable<Boolean> CacheRefreshOnLoad { get; set; } #Gets whether SXDB requests refresh when the workbook is loaded.
public Nullable<Boolean> CacheOptimizeMemory { get; set; } #Gets whether SXDB requests optimized cache storage.
public Nullable<Boolean> CacheBackgroundQuery { get; set; } #Gets whether SXDB declares background refresh for external cache data.
public Nullable<Boolean> CacheEnableRefresh { get; set; } #Gets whether SXDB declares that cache refresh is enabled.
public Nullable<Int16> CacheSourceFieldCount { get; set; } #Gets the source-data field count declared by SXDB, when decoded.
public Nullable<Int16> CacheTotalFieldCount { get; set; } #Gets the total PivotCache field count declared by SXDB, when decoded.
public Nullable<UInt16> CacheUsedRecordCount { get; set; } #Gets the cache record count used to calculate the PivotTable report, when decoded.
public Nullable<UInt16> CacheSourceType { get; set; } #Gets the raw PivotCache source-data type declared by SXDB or SXVS.
public Nullable<LegacyXlsPivotCacheSourceType> CacheSourceTypeKind { get; set; } #Gets the decoded PivotCache source-data type, when known.
public String CacheSourceTypeName { get; set; } #Gets the source-data type name, or a stable raw identifier for unknown values.
public String CacheRefreshedBy { get; set; } #Gets the optional user name stored in SXDB for the last cache refresh.
public Nullable<Boolean> AutoStart { get; set; } #Gets whether an SXRng record recalculates its starting value from source data.
public Nullable<Boolean> AutoEnd { get; set; } #Gets whether an SXRng record recalculates its ending value from source data.
public Nullable<LegacyXlsPivotGroupingKind> GroupingKind { get; set; } #Gets the grouping criteria stored in an SXRng record, when decoded.
public Nullable<Double> GroupingNumericStart { get; set; } #Gets the numeric grouping start value attached to an SXRng record, when decoded from the following SXNum records.
public Nullable<Double> GroupingNumericEnd { get; set; } #Gets the numeric grouping end value attached to an SXRng record, when decoded from the following SXNum records.
public Nullable<Double> GroupingNumericInterval { get; set; } #Gets the numeric grouping interval attached to an SXRng record, when decoded from the following SXNum records.
public LegacyXlsPivotDateTimeValue GroupingDateStart { get; set; } #Gets the date grouping start value attached to an SXRng record, when decoded from the following SXDtr records.
public LegacyXlsPivotDateTimeValue GroupingDateEnd { get; set; } #Gets the date grouping end value attached to an SXRng record, when decoded from the following SXDtr records.
public Nullable<Int16> GroupingDateInterval { get; set; } #Gets the date grouping interval attached to an SXRng record, when decoded from the following SXInt record.
public Nullable<UInt16> CalculatedItemFormulaReserved { get; set; } #Gets the reserved SXFormula field, when decoded for a calculated-item formula scope.
public Nullable<Int16> CalculatedItemFormulaCacheFieldIndex { get; set; } #Gets the cache field index targeted by an SXFormula calculated-item formula scope.
public Boolean HasCalculatedItemFormulaScope { get; } #Gets whether SXFormula calculated-item formula scope metadata was decoded.
public Boolean CalculatedItemFormulaAppliesToAllCacheFields { get; } #Gets whether SXFormula applies the calculated-item formula to all cache fields.
public String CalculatedItemFormulaScopeName { get; set; } #Gets a stable calculated-item formula scope name derived from SXFormula.
public Nullable<Boolean> ShowAllItems { get; set; } #Gets whether an SXVDEx record requests showing all items.
public Nullable<Boolean> CanDragToRow { get; set; } #Gets whether an SXVDEx record allows dragging the field to rows.
public Nullable<Boolean> CanDragToColumn { get; set; } #Gets whether an SXVDEx record allows dragging the field to columns.
public Nullable<Boolean> CanDragToPage { get; set; } #Gets whether an SXVDEx record allows dragging the field to pages.
public Nullable<Boolean> CanDragToHide { get; set; } #Gets whether an SXVDEx record allows hiding the field from the view.
public Nullable<Boolean> PreventDragToData { get; set; } #Gets whether an SXVDEx record prevents dragging the field to data values.
public Nullable<Boolean> ServerBased { get; set; } #Gets whether an SXVDEx record marks the pivot field as server-based.
public Nullable<UInt16> AdditionalFutureRecordType { get; set; } #Gets the future-record type stored in an SXAddl header, when decoded.
public Nullable<UInt16> AdditionalFutureFlags { get; set; } #Gets the future-record flags stored in an SXAddl header, when decoded.
public Nullable<Byte> AdditionalClass { get; set; } #Gets the SXAddl class byte, when decoded.
public String AdditionalClassName { get; set; } #Gets the decoded SXAddl class name, or a stable raw identifier for unknown values.
public Nullable<Byte> AdditionalType { get; set; } #Gets the SXAddl detail type byte, when decoded.
public String AdditionalTypeName { get; set; } #Gets the decoded SXAddl detail type name, or a stable raw identifier for unknown values.
public Nullable<UInt32> AdditionalCacheId { get; set; } #Gets the PivotCache identifier carried by an SXAddl SxcCache/SXDId record, when decoded.
public Nullable<Int32> AdditionalSequenceIndex { get; set; } #Gets the one-based SXAddl sequence index within the scanned PivotTable scope.
public Nullable<Int32> AdditionalClassDepthBefore { get; set; } #Gets the SXAddl class nesting depth before this record is applied.
public Nullable<Int32> AdditionalClassDepthAfter { get; set; } #Gets the SXAddl class nesting depth after this record is applied.
public String AdditionalClassTransition { get; set; } #Gets the shallow SXAddl class-stack transition represented by this record.
public Nullable<LegacyXlsPivotCacheItemKind> CacheItemKind { get; set; } #Gets the value kind for a PivotCache cache item record, when decoded.
public String CacheItemKindName { get; set; } #Gets the value kind name for a PivotCache cache item record, when decoded.
public Nullable<Double> CacheItemNumericValue { get; set; } #Gets the numeric value for an SXNum PivotCache item, when decoded.
public Nullable<Int16> CacheItemIntegerValue { get; set; } #Gets the signed integer value for an SXInt PivotCache item, when decoded.
public Nullable<Boolean> CacheItemBooleanValue { get; set; } #Gets the Boolean value for an SxBool PivotCache item, when decoded.
public Nullable<UInt16> CacheItemErrorCode { get; set; } #Gets the error code for an SxErr PivotCache item, when decoded.
public String CacheItemErrorText { get; set; } #Gets the error text for an SxErr PivotCache item, when decoded.
public String CacheItemStringValue { get; set; } #Gets the string value for an SXString PivotCache item, when decoded.
public LegacyXlsPivotDateTimeValue CacheItemDateTimeValue { get; set; } #Gets the date/time value for an SXDtr PivotCache item, when decoded.
public Boolean IsEmptyCacheItem { get; } #Gets whether this record is an empty SxNil PivotCache item.
public Nullable<UInt16> QueryTableTagFutureRecordType { get; set; } #Gets the future-record type stored in a QsiSXTag header, when decoded.
public Nullable<UInt16> QueryTableTagFutureFlags { get; set; } #Gets the future-record flags stored in a QsiSXTag header, when decoded.
public Nullable<Boolean> QueryTableTagRelatesToPivotTable { get; set; } #Gets whether a QsiSXTag record relates to a PivotTable view instead of a query table.
public String QueryTableTagTargetName { get; set; } #Gets a stable target name for the QsiSXTag record.
public Nullable<Boolean> QueryTableTagRefreshEnabled { get; set; } #Gets whether refresh is enabled according to QsiSXTag, when decoded.
public Nullable<Boolean> QueryTableTagCacheInvalid { get; set; } #Gets whether QsiSXTag marks the associated PivotCache records invalid.
public Nullable<Boolean> QueryTableTagTensorEx { get; set; } #Gets whether QsiSXTag marks the PivotTable view as OLAP.
public Nullable<UInt32> QueryTableTagFutureOptions { get; set; } #Gets the raw QsiSXTag future option flags.
public Nullable<Byte> QueryTableTagLastUpdatedVersion { get; set; } #Gets the data functionality level that last refreshed the QsiSXTag target.
public Nullable<Byte> QueryTableTagUpdatableMinimumVersion { get; set; } #Gets the minimum data functionality level required to refresh the QsiSXTag target.
public Nullable<Byte> QueryTableTagNameOffsetMarker { get; set; } #Gets the QsiSXTag name offset marker byte.
public String QueryTableTagName { get; set; } #Gets the query table or PivotTable view name carried by QsiSXTag.
public Nullable<UInt16> QueryTableTagUnused { get; set; } #Gets the trailing unused QsiSXTag field value.