WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PivotGridColorScaleConditionalFormat - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PivotGridColorScaleConditionalFormat

    Class that defines the conditional formatting settings to format PivotGrid cells based on gradient color scale values.

    Inheritance
    System.Object
    PivotGridColorScaleConditionalFormat
    Namespace: Syncfusion.Windows.Controls.PivotGrid
    Assembly: Syncfusion.PivotAnalysis.Wpf.dll
    Syntax
    public class PivotGridColorScaleConditionalFormat : Freezable

    Constructors

    PivotGridColorScaleConditionalFormat()

    Declaration
    public PivotGridColorScaleConditionalFormat()

    Fields

    ApplyToAllLevelsProperty

    Specifies whether to apply conditional formatting to all the data cells for corresponding measure.

    Declaration
    public static readonly DependencyProperty ApplyToAllLevelsProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ApplyToSpecificLevelProperty

    Specifies whether to apply conditional formatting to data cells placed at the intersection of specified column and row fields.

    Declaration
    public static readonly DependencyProperty ApplyToSpecificLevelProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    CalculationNameProperty

    Gets or sets a data field name for whose values conditional formatting is applied.

    Declaration
    public static readonly DependencyProperty CalculationNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ColorScaleNameProperty

    Gets or sets the name of the predefined format to be applied to the cells.

    Declaration
    public static readonly DependencyProperty ColorScaleNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ColumnNameProperty

    Gets or sets a name of the column field to which, on intersection with a row field, a format is applied.

    Declaration
    public static readonly DependencyProperty ColumnNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    EndColorProperty

    Specifies the color that corresponds to the minimum value.

    Declaration
    public static readonly DependencyProperty EndColorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MiddleColorProperty

    Specifies the color that corresponds to the middle value.

    Declaration
    public static readonly DependencyProperty MiddleColorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    NameProperty

    The Name for each conditional format can be specified using PivotGridColorScaleConditionalFormat.Name property, which should be of type string.

    Declaration
    public static readonly DependencyProperty NameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    RowNameProperty

    Gets or sets a name of the row field, to which intersection with column field a format is applied.

    Declaration
    public static readonly DependencyProperty RowNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    StartColorProperty

    Specifies the color that corresponds to the maximum value.

    Declaration
    public static readonly DependencyProperty StartColorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    ApplyToAllLevels

    Specifies whether to apply conditional formatting to all the data cells for corresponding measure.

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

    ApplyToSpecificLevel

    Specifies whether to apply conditional formatting to data cells placed at the intersection of specified column and row fields.

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

    CalculationName

    Gets or sets a data field name for whose values conditional formatting is applied.

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

    ColorScaleName

    Gets or sets the name of the predefined format to be applied to the cells. The default value is GreenYellowRed. i.e., gradient colors of green, yellow and red.

    Declaration
    public ColorScale ColorScaleName { get; set; }
    Property Value
    Type Description
    ColorScale

    ColumnName

    Gets or sets a name of the column field to which, on intersection with a row field, a format is applied.

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

    EndColor

    Specifies the color that corresponds to the minimum value.

    Declaration
    public Color EndColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    MaxValue

    Specifies the maximum data field value to accept for conditional formatting.

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

    MiddleColor

    Specifies the color that corresponds to the middle value.

    Declaration
    public Color MiddleColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    MinValue

    Specifies the minimum data field value to accept for conditional formatting.

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

    Name

    The Name for each conditional format can be specified using PivotGridColorScaleConditionalFormat.Name property, which should be of type string.

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

    RowName

    Gets or sets a name of the row field, to which intersection with column field a format is applied.

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

    StartColor

    Specifies the color that corresponds to the maximum value.

    Declaration
    public Color StartColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    Methods

    CreateInstanceCore()

    Override method to create instance of freezable collection.

    Declaration
    protected override Freezable CreateInstanceCore()
    Returns
    Type Description
    System.Windows.Freezable

    Returns null.

    OnApplyToAllLevelsChanged(DependencyObject, DependencyPropertyChangedEventArgs)

    Calls when the value of "ApplyToAllLevels" is changed.

    Declaration
    public static void OnApplyToAllLevelsChanged(DependencyObject dependencyObj, DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dependencyObj

    The pivot grid color scale conditional format instance.

    System.Windows.DependencyPropertyChangedEventArgs args

    The property event changed arguement.

    OnApplyToSpecificLevelChanged(DependencyObject, DependencyPropertyChangedEventArgs)

    Calls when the value of "ApplyToAllLevels" is changed.

    Declaration
    public static void OnApplyToSpecificLevelChanged(DependencyObject dependencyObj, DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dependencyObj

    The pivot grid color scale conditional format instance.

    System.Windows.DependencyPropertyChangedEventArgs args

    The property event changed arguement.

    OnEndColorChanged(DependencyObject, DependencyPropertyChangedEventArgs)

    Calls when the value of end color is changed.

    Declaration
    public static void OnEndColorChanged(DependencyObject dependencyObj, DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dependencyObj

    The pivot grid color scale conditional format instance.

    System.Windows.DependencyPropertyChangedEventArgs args

    The property event changed arguement.

    OnMiddleColorChanged(DependencyObject, DependencyPropertyChangedEventArgs)

    Calls when the value of middle color is changed.

    Declaration
    public static void OnMiddleColorChanged(DependencyObject dependencyObj, DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dependencyObj

    The pivot grid color scale conditional format instance.

    System.Windows.DependencyPropertyChangedEventArgs args

    The property event changed arguement.

    OnStartColorChanged(DependencyObject, DependencyPropertyChangedEventArgs)

    Calls when the value of start color is changed.

    Declaration
    public static void OnStartColorChanged(DependencyObject dependencyObj, DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dependencyObj

    The pivot grid color scale conditional format instance.

    System.Windows.DependencyPropertyChangedEventArgs args

    The property event changed arguement.

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