Class DataBarRule

Renders horizontal data bars within cells based on their numeric values relative to the range minimum and maximum, with customizable colors, gradients, and axis positioning.

Inheritance
System.Object
ConditionalFormattingRule
DataBarRule
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: Telerik.Windows.Documents.Spreadsheet.Model.ConditionalFormattings
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class DataBarRule : ConditionalFormattingRule, IRenderCellValue

Constructors

DataBarRule(DataBarValueContext)

Initializes a new DataBarRule with the specified data bar value context defining the range bounds.

Declaration
public DataBarRule(DataBarValueContext values)
Parameters
DataBarValueContext values

Properties

AxisColor

Gets or sets the color of the vertical axis line that separates positive and negative data bars, defaulting to black.

Declaration
public ThemableColor AxisColor { get; set; }
Property Value
ThemableColor

AxisPosition

Gets or sets the axis position for the data bar, controlling whether bars grow from the cell edge, midpoint, or auto-calculated position.

Declaration
public DataBarAxisPosition AxisPosition { get; set; }
Property Value
DataBarAxisPosition

BorderColor

Gets or sets the border color for positive-value data bars when borders are enabled.

Declaration
public ThemableColor BorderColor { get; set; }
Property Value
ThemableColor

Direction

Gets or sets the direction in which data bars grow within the cell, such as left-to-right or right-to-left.

Declaration
public DataBarDirection Direction { get; set; }
Property Value
DataBarDirection

FillColor

Gets or sets the fill color for positive-value data bars, supporting theme-based or explicit colors.

Declaration
public ThemableColor FillColor { get; set; }
Property Value
ThemableColor

MaxLength

Gets or sets the maximum length of the data bar as a percentage of the cell width, capping the bar for the largest values.

Declaration
public double MaxLength { get; set; }
Property Value
System.Double

The maximum length represented as a percentage of the cell length.

MinLength

Gets or sets the minimum length of the data bar as a percentage of the cell width, ensuring bars remain visible even for the smallest values.

Declaration
public double MinLength { get; set; }
Property Value
System.Double

The minimum length represented as a percentage of the cell length.

NegativeBorderColor

Gets or sets the border color for negative-value data bars when borders are enabled.

Declaration
public ThemableColor NegativeBorderColor { get; set; }
Property Value
ThemableColor

NegativeFillColor

Gets or sets the fill color for negative-value data bars, allowing distinct styling for values below zero.

Declaration
public ThemableColor NegativeFillColor { get; set; }
Property Value
ThemableColor

ShowBarsOnly

Gets or sets whether only the data bars are visible, hiding the underlying numeric cell values.

Declaration
public bool ShowBarsOnly { get; set; }
Property Value
System.Boolean

ShowBorder

Gets or sets whether data bars display a border, using the configured border colors.

Declaration
public bool ShowBorder { get; set; }
Property Value
System.Boolean

UseGradientFill

Gets or sets whether data bars use gradient fill from the fill color to white, creating a shaded appearance.

Declaration
public bool UseGradientFill { get; set; }
Property Value
System.Boolean

ValueContext

Gets the data bar value context that defines the minimum and maximum values for calculating bar lengths.

Declaration
public DataBarValueContext ValueContext { get; }
Property Value
DataBarValueContext