File Formats

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PivotDataField

    Show / Hide Table of Contents

    Class PivotDataField

    Represents pivot table data field.

    Inheritance
    System.Object
    PivotDataField
    Implements
    IPivotDataField
    ICloneParent
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.XlsIO.Implementation.PivotTables
    Assembly: Syncfusion.XlsIO.Base.dll
    Syntax
    public class PivotDataField : IPivotDataField, ICloneParent

    Constructors

    PivotDataField(String, PivotSubtotalTypes, PivotFieldImpl)

    Initializes a new instance of the data field.

    Declaration
    public PivotDataField(string name, PivotSubtotalTypes subtotal, PivotFieldImpl parentField)
    Parameters
    Type Name Description
    System.String name

    Name of the data field.

    PivotSubtotalTypes subtotal

    Subtotal function.

    PivotFieldImpl parentField

    Parent field.

    Properties

    BaseField

    Gets or sets the base field for a custom calculation.

    Declaration
    public int BaseField { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    Valid only for data fields.

    BaseItem

    Gets or sets the base item for a custom calculation.

    Declaration
    public int BaseItem { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    Valid only for data fields.

    Field

    Gets the parent field. Read-only.

    Declaration
    public PivotFieldImpl Field { get; }
    Property Value
    Type Description
    PivotFieldImpl

    Name

    Gets or sets name of the data field.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    System.String

    NumberFormat

    Gets or sets the number format for the pivot data field.

    Declaration
    public string NumberFormat { get; set; }
    Property Value
    Type Description
    System.String

    ShowDataAs

    Gets or sets the pivot table format indicating how the pivot data is shown.

    Declaration
    public PivotFieldDataFormat ShowDataAs { get; set; }
    Property Value
    Type Description
    PivotFieldDataFormat

    Subtotal

    Gets or sets the subtotal function used for data field.

    Declaration
    public PivotSubtotalTypes Subtotal { get; set; }
    Property Value
    Type Description
    PivotSubtotalTypes

    Methods

    Clone(Object)

    Creates a new object that is a copy of the current instance.

    Declaration
    public object Clone(object parent)
    Parameters
    Type Name Description
    System.Object parent

    Represents parent object.

    Returns
    Type Description
    System.Object

    A new object that is a copy of this instance.

    SetNextBaseItem()

    Set the next value to BaseItem.

    Declaration
    public void SetNextBaseItem()

    SetPreviousBaseItem()

    Set the previous value to BaseItem.

    Declaration
    public void SetPreviousBaseItem()

    Implements

    IPivotDataField
    ICloneParent
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved