menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PivotCellDescriptor - API Reference

    Show / Hide Table of Contents

    Class PivotCellDescriptor

    Represents the descriptor for pivot cell.

    Inheritance
    System.Object
    PivotCellDescriptor
    Implements
    ICloneable<PivotCellDescriptor>
    Inherited Members
    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.Olap.Engine
    Assembly: Syncfusion.Olap.Base.dll
    Syntax
    public class PivotCellDescriptor : ICloneable<PivotCellDescriptor>

    Constructors

    PivotCellDescriptor()

    Declaration
    public PivotCellDescriptor()

    Properties

    Background

    Gets or sets the background color of the cell.

    Declaration
    public SolidColorBrush Background { get; set; }
    Property Value
    Type Description
    System.Windows.Media.SolidColorBrush

    CellCaption

    Gets or sets the caption of the cell descriptor.

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

    The caption of the cell descriptor.

    CellData

    Gets or sets the data associated with the cell descriptor.

    Declaration
    public PivotValueCellData CellData { get; }
    Property Value
    Type Description
    PivotValueCellData

    The data associated with the cell descriptor.

    CellExTypes

    Gets or sets the extended type of the cell descriptor.

    Declaration
    public List<string> CellExTypes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.String>
    Remarks

    Extended type of any cell can be changed without any consequences to grouping logic.

    CellIndex

    Gets or sets the index of the cell descriptor in a column.

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

    CellObject

    Gets or sets the cell object.

    Declaration
    public object CellObject { get; set; }
    Property Value
    Type Description
    System.Object

    The cell object.

    CellType

    Gets or sets the type of the cell descriptor.

    Declaration
    public PivotCellDescriptorType CellType { get; set; }
    Property Value
    Type Description
    PivotCellDescriptorType
    Remarks

    Types of row or column header cells should not be changed.

    CellValue

    Gets or sets the cell value.

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

    ClassName

    Gets or sets the class name of the cell descriptor.

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

    DoubleValue

    Gets the double value of the cell descriptor.

    Declaration
    public double DoubleValue { get; }
    Property Value
    Type Description
    System.Double

    The double value of the cell descriptor.

    Engine

    Gets or sets the Pivot Engine.

    Declaration
    public PivotEngine Engine { get; set; }
    Property Value
    Type Description
    PivotEngine

    The Engine.

    ExpandableState

    Gets or sets the value that specifies how the cell is expanded.

    Declaration
    public ExpandableState ExpandableState { get; set; }
    Property Value
    Type Description
    ExpandableState

    FontFlags

    Gets or sets the font effects.

    Declaration
    public int? FontFlags { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    FontName

    Gets or sets the font name of the cell.

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

    FontSize

    Gets or sets the font size of the cell.

    Declaration
    public int? FontSize { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    Foreground

    Gets or sets the cell foreground color.

    Declaration
    public SolidColorBrush Foreground { get; set; }
    Property Value
    Type Description
    System.Windows.Media.SolidColorBrush

    FormatString

    Gets or sets the format string of the cell descriptor.

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

    The format string of the cell descriptor.

    HasChildren

    Gets or sets a value indicating whether the pivot cell descriptor has children.

    Declaration
    public bool HasChildren { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsEmpty

    Gets or sets a value indicating whether the cell descriptor is empty.

    Declaration
    public bool IsEmpty { get; set; }
    Property Value
    Type Description
    System.Boolean

    Returns true if the cell descriptor is empty; otherwise, false.

    IsLastLevel

    Gets or sets a value indicating whether this instance is last level.

    Declaration
    public bool IsLastLevel { get; set; }
    Property Value
    Type Description
    System.Boolean

    KpiGraphicsStyle

    Gets or sets the KPI graphical rendering style (for status and trend cell types).

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

    KpiType

    Gets or sets the KPI type of the cell descriptor.

    Declaration
    public KpiTypeEnum KpiType { get; set; }
    Property Value
    Type Description
    KpiTypeEnum

    Level

    Gets or sets the level of the cell descriptor.

    Declaration
    public long Level { get; set; }
    Property Value
    Type Description
    System.Int64

    The level of the cell descriptor.

    PivotRowIndex

    Gets or sets the index of the pivot row.

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

    The index of the pivot row.

    Range

    Gets or sets the range occupied by this cell.

    Declaration
    public GridRangeInfo Range { get; set; }
    Property Value
    Type Description
    GridRangeInfo
    Remarks

    Location data is ignored and assumed to be this cell location.

    SpanCell

    Gets or sets the main cell in the span.

    Declaration
    public PivotCellDescriptor SpanCell { get; set; }
    Property Value
    Type Description
    PivotCellDescriptor

    Tag

    Gets or sets the tag.

    Declaration
    public object Tag { get; set; }
    Property Value
    Type Description
    System.Object

    The tag.

    UniqueName

    Gets or sets the unique name of the cell descriptor.

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

    The unique name of the cell descriptor.

    Value

    Gets or sets the unformatted value of the cell descriptor.

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

    Methods

    Clone()

    Clones this instance.

    Declaration
    public PivotCellDescriptor Clone()
    Returns
    Type Description
    PivotCellDescriptor

    A copy of this instance.

    ToString()

    Returns a System.String that represents this instance.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    A System.String that represents this instance.

    Overrides
    System.Object.ToString()

    Implements

    ICloneable<T>
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved