API Reference
ExcelPivotFieldInfo
Describes a source field in an existing pivot table.
Inheritance
- Object
- ExcelPivotFieldInfo
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 ExcelPivotTableInfo.Fields
Accepted by parameters
- Constructor ExcelPivotTableInfo.ExcelPivotTableInfo
- Constructor ExcelPivotTableInfo.ExcelPivotTableInfo
Constructors
public ExcelPivotFieldInfo(String fieldName, Nullable<PivotTableAxisValues> axis = null, Nullable<FieldSortValues> sortType = null, Nullable<UInt32> numberFormatId = null, Nullable<Boolean> showAll = null, Nullable<Boolean> defaultSubtotal = null, Nullable<Boolean> subtotalTop = null, Nullable<Boolean> insertBlankRow = null, Nullable<Boolean> insertPageBreak = null, Nullable<Boolean> compact = null, Nullable<Boolean> outline = null, Nullable<Boolean> showDropDowns = null, Nullable<Boolean> multipleItemSelectionAllowed = null, Nullable<Boolean> includeNewItemsInFilter = null, String subtotalCaption = null, IReadOnlyList<String> hiddenItems = null, String selectedItem = null, IReadOnlyList<String> visibleItems = null, String numberFormatCode = null) #Creates pivot field readback information.
Parameters
- fieldName System.String
- axis System.Nullable{DocumentFormat.OpenXml.Spreadsheet.PivotTableAxisValues} = null
- sortType System.Nullable{DocumentFormat.OpenXml.Spreadsheet.FieldSortValues} = null
- numberFormatId System.Nullable{System.UInt32} = null
- showAll System.Nullable{System.Boolean} = null
- defaultSubtotal System.Nullable{System.Boolean} = null
- subtotalTop System.Nullable{System.Boolean} = null
- insertBlankRow System.Nullable{System.Boolean} = null
- insertPageBreak System.Nullable{System.Boolean} = null
- compact System.Nullable{System.Boolean} = null
- outline System.Nullable{System.Boolean} = null
- showDropDowns System.Nullable{System.Boolean} = null
- multipleItemSelectionAllowed System.Nullable{System.Boolean} = null
- includeNewItemsInFilter System.Nullable{System.Boolean} = null
- subtotalCaption System.String = null
- hiddenItems System.Collections.Generic.IReadOnlyList{System.String} = null
- selectedItem System.String = null
- visibleItems System.Collections.Generic.IReadOnlyList{System.String} = null
- numberFormatCode System.String = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String FieldName { get; } #Gets the source field name.
public Nullable<PivotTableAxisValues> Axis { get; } #Gets the pivot axis this field is assigned to, if any.
public Nullable<FieldSortValues> SortType { get; } #Gets the sort mode.
public Nullable<UInt32> NumberFormatId { get; } #Gets the field number format id.
public String NumberFormatCode { get; } #Gets the custom number format code for the field, when it can be resolved from workbook styles.
public Nullable<Boolean> ShowAll { get; } #Gets whether all items should be shown.
public Nullable<Boolean> DefaultSubtotal { get; } #Gets whether the default subtotal is used.
public Nullable<Boolean> SubtotalTop { get; } #Gets whether subtotals are shown at the top.
public Nullable<Boolean> InsertBlankRow { get; } #Gets whether a blank row is inserted after each item.
public Nullable<Boolean> InsertPageBreak { get; } #Gets whether a page break is inserted after each item.
public Nullable<Boolean> Compact { get; } #Gets whether compact field layout is enabled.
public Nullable<Boolean> Outline { get; } #Gets whether outline field layout is enabled.
public Nullable<Boolean> ShowDropDowns { get; } #Gets whether filter drop-downs are shown for the field.
public Nullable<Boolean> MultipleItemSelectionAllowed { get; } #Gets whether multiple item selection is allowed.
public Nullable<Boolean> IncludeNewItemsInFilter { get; } #Gets whether new items are included in the filter by default.
public String SubtotalCaption { get; } #Gets the custom subtotal caption.
public String SelectedItem { get; } #Gets the selected item caption when this field is used as a page/filter field.
public IReadOnlyList<String> VisibleItems { get; } #Gets visible item captions captured from the field item list.