API Reference
ExcelPivotFieldInfo
Describes a source field in an existing pivot table.
Inheritance
- Object
- ExcelPivotFieldInfo
Usage
Explore 2 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Property ExcelPivotTableInfo.Fields
Accepted by parameters 1
- Constructor ExcelPivotTableInfo.ExcelPivotTableInfo
Constructors
public ExcelPivotFieldInfo(String fieldName, ExcelPivotTableAxis? axis = null, ExcelPivotFieldSort? sortType = null, UInt32? numberFormatId = null, Boolean? showAll = null, Boolean? defaultSubtotal = null, Boolean? subtotalTop = null, Boolean? insertBlankRow = null, Boolean? insertPageBreak = null, Boolean? compact = null, Boolean? outline = null, Boolean? showDropDowns = null, Boolean? multipleItemSelectionAllowed = null, 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 OfficeIMO.Excel.ExcelPivotTableAxis? = null
- sortType OfficeIMO.Excel.ExcelPivotFieldSort? = null
- numberFormatId System.UInt32? = null
- showAll System.Boolean? = null
- defaultSubtotal System.Boolean? = null
- subtotalTop System.Boolean? = null
- insertBlankRow System.Boolean? = null
- insertPageBreak System.Boolean? = null
- compact System.Boolean? = null
- outline System.Boolean? = null
- showDropDowns System.Boolean? = null
- multipleItemSelectionAllowed System.Boolean? = null
- includeNewItemsInFilter 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 virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public ExcelPivotTableAxis? Axis { get; } #Gets the pivot axis this field is assigned to, if any.
public String? NumberFormatCode { get; } #Gets the custom number format code for the field, when it can be resolved from workbook styles.
public Boolean? DefaultSubtotal { get; } #Gets whether the default subtotal is used.
public Boolean? SubtotalTop { get; } #Gets whether subtotals are shown at the top.
public Boolean? InsertBlankRow { get; } #Gets whether a blank row is inserted after each item.
public Boolean? InsertPageBreak { get; } #Gets whether a page break is inserted after each item.
public Boolean? Compact { get; } #Gets whether compact field layout is enabled.
public Boolean? Outline { get; } #Gets whether outline field layout is enabled.
public Boolean? ShowDropDowns { get; } #Gets whether filter drop-downs are shown for the field.
public Boolean? MultipleItemSelectionAllowed { get; } #Gets whether multiple item selection is allowed.
public 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.