DataBarCondition Class

Namespace:
GemBox.Spreadsheet.ConditionalFormatting
Assembly:
GemBox.Spreadsheet.dll

Represents a condition that formats all cells based on their values by displaying a data bar whose length is proportional to cell's value.

public sealed class DataBarCondition : FormatCondition
Public NotInheritable Class DataBarCondition
    Inherits FormatCondition
Inheritance:
System.Object
DataBarCondition
Remarks

DataBarCondition is not supported when writing to XLS file format.

Properties

BarStyle

Gets the bar appearance settings.

public DataBarStyle BarStyle { get; }
Public ReadOnly Property BarStyle As DataBarStyle
Property Value
DataBarStyle

The bar appearance settings.

ConditionType

Gets the DataBar value.

public override FormatConditionType ConditionType { get; }
Public Overrides ReadOnly Property ConditionType As FormatConditionType
Property Value
FormatConditionType

The DataBar value.

Overrides

Maximum

Gets the data bar maximum.

public ConditionalLength Maximum { get; }
Public ReadOnly Property Maximum As ConditionalLength
Property Value
ConditionalLength

The data bar maximum.

Minimum

Gets the data bar minimum.

public ConditionalLength Minimum { get; }
Public ReadOnly Property Minimum As ConditionalLength
Property Value
ConditionalLength

The data bar minimum.

ShowBarOnly

Gets or sets a value indicating whether to show bar only.

Default value is false (cell value is shown together with bar).

public bool ShowBarOnly { get; set; }
Public Property ShowBarOnly As Boolean
Property Value
System.Boolean

true to show bar only; otherwise, false.

Methods

ToString()

Returns a System.String that represents this DataBarCondition instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this DataBarCondition instance.

Overrides
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Inherited Properties

Rule

Gets the conditional formatting rule associated with this condition.

(Inherited from FormatCondition)

Examples