Namespace EasyXLS.PivotTables

Class ExcelField

System.Object
EasyXLS.PivotTables.ExcelField
Direct Known Subclasses:
ExcelCalculatedField
public class ExcelField extends System.Object
This class stores pivot table field information like name, area location, subtotals & filters options, layout & print options and sort order.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExcelField()
    Defines an instance of the pivot table field.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addSubtotal​(int subtotal)
    Adds a subtotal for the pivot table field.
    ExcelField
    Clone()
    Creates and returns a copy of this object.
    int
    getArea()
    Returns the area location of the pivot table field.
    System.String
    getBaseField()
    If the field is part of a group, returns the base field.
    System.String
    getCustomName()
    Returns the name of the pivot table field.
    System.String
    getGroupBy()
    If the field is part of a group, returns the group by option.
    System.String
    getGroupEndAt()
    If the field is part of a group, returns the end value for a group.
    double
    getGroupInterval()
    If the field is part of a group, returns the group interval.
    System.String
    getGroupStartAt()
    If the field is part of a group, returns the start value for a group.
    System.String
    getNumberFormat()
    Returns the field number format.
    System.String
    getOriginalName()
    Returns the original name of source range column.
    int
    getSortOrder()
    Returns the sort order of the field data.
    int
    getSubtotalAt​(int index)
    Returns the subtotal from the specified index.
    void
    groupBy​(bool autoStartAt, bool autoEndAt, System.String startAt, System.String endAt, System.String groupBy, System.String baseField, double groupInterval)
    Internal use only
    bool
    HasNewItemsInFilter()
    Returns true if any new items in the pivot table having a filter are included, false otherwise.
    bool
    IsGroupAutoEnd()
    Returns true if the group end value is automatic, false otherwise.
    bool
    IsGroupAutoStart()
    Returns true if the group start value is automatic, false otherwise.
    bool
    IsInsertBlankLine()
    Returns true if a blank line is inserted after each item label, false otherwise.
    bool
    IsInsertPageBreak()
    Returns true if a blank line is inserted after each item, false otherwise.
    void
    removeSubtotal​(int index)
    Removes the subtotal from the specified index.
    void
    setCustomName​(System.String customName)
    Sets the name of the pivot table field.
    void
    setInsertBlankLine​(bool insertBlankLine)
    Sets if a blank line is inserted after each item label.
    void
    setInsertPageBreak​(bool insertPageBreak)
    Sets if a blank line is inserted after each item.
    void
    setNewItemsInFilter​(bool include)
    Sets if any new items in the pivot table having a filter are included.
    void
    setNumberFormat​(System.String numberFormat)
    Sets the field number format.
    void
    setOriginalName​(System.String name)
    Sets the original name of the pivot table field.
    void
    setShowItemLabelsInOutlineForm​(bool show, bool compact, bool subtotalsOnTop)
    Sets if the field items are displayed in outline form.
    void
    setShowItemLabelsInTabularForm​(bool show)
    Sets if the field items are displayed in tabular form.
    void
    setShowItemsWithNoData​(bool show)
    Sets if the items with no data are displayed.
    void
    setSortOrder​(int sortOrder)
    Sets the sort order of the field data.
    bool
    ShowCompactForm()
    Returns true if the labels from the next field in the same column or compact form are displayed, false otherwise.
    bool
    ShowItemLabelsInOutlineForm()
    Returns true if the field items are displayed in outline form, false if the field items are displayed in tabular form.
    bool
    ShowItemLabelsInTabularForm()
    Returns true if the field items are displayed in tabular form, false if the field items are displayed in outline form.
    bool
    ShowItemsWithNoData()
    Returns true if the items with no data are displayed, false otherwise.
    bool
    ShowSubtotalsOnTop()
    Returns true if the subtotals at the top of each group are displayed, false otherwise.
    int
    SubtotalCount()
    Returns the number of subtotals for the pivot table field.

    Methods inherited from class System.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait