GrapeCity.Documents.Excel.IDataBar

Interface IDataBar

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents a data bar conditional formating rule. Applying a data bar to a range helps you see the value of a cell relative to other cells.

public interface IDataBar

Properties

AppliesTo

Returns a Range object that specifies the cell range to which the formatting rule is applied.

IRange AppliesTo { get; set; }

Property Value

IRange

AxisColor

Gets the color of the axis for cells with conditional formatting as data bars.

IFormatColor AxisColor { get; }

Property Value

IFormatColor

AxisPosition

Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.

DataBarAxisPosition AxisPosition { get; set; }

Property Value

DataBarAxisPosition

BarBorder

Gets an object that specifies the border of a data bar.

IDataBarBorder BarBorder { get; }

Property Value

IDataBarBorder

BarColor

Returns a FormatColor object that you can use to modify the color of the bars in a data bar conditional format.

IFormatColor BarColor { get; }

Property Value

IFormatColor

BarFillType

Gets or sets how a data bar is filled with color.

DataBarFillType BarFillType { get; set; }

Property Value

DataBarFillType

Direction

Gets or sets the direction the data bar is displayed.

DataBarDirection Direction { get; set; }

Property Value

DataBarDirection

MaxPoint

Returns a IConditionValue object that specifies how the longest bar is evaluated for a data bar conditional format.

IConditionValue MaxPoint { get; }

Property Value

IConditionValue

MinPoint

Returns a ConditionValue object that specifies how the shortest bar is evaluated for a data bar conditional format.

IConditionValue MinPoint { get; }

Property Value

IConditionValue

NegativeBarFormat

Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.

INegativeBarFormat NegativeBarFormat { get; }

Property Value

INegativeBarFormat

PercentMax

Returns or sets an Integer value that specifies the length of the longest data bar as a percentage of cell width.

int PercentMax { get; set; }

Property Value

int

PercentMin

Returns or sets an Integer value that specifies the length of the shortest data bar as a percentage of cell width.

int PercentMin { get; set; }

Property Value

int

Priority

Returns or sets the priority value of the conditional formatting rule. The priority determines the order of evaluation when multiple conditional formatting rules exist in a worksheet.

int Priority { get; set; }

Property Value

int

Remarks

When setting the priority, the value must be a positive integer between 1 and the total number of conditional formatting rules on the worksheet. The priority must be a unique value for all rules on the worksheet, so changing the priority for the specified conditional formatting rule may cause the priority value of the other rules on the worksheet to be shifted.

ShowValue

Returns or sets a Boolean value that specifies if the value in the cell is displayed if the data bar conditional format is applied to the range.

bool ShowValue { get; set; }

Property Value

bool

StopIfTrue

Returns or sets a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.

bool StopIfTrue { get; }

Property Value

bool

Type

Returns the type of this conditional format.

FormatConditionType Type { get; }

Property Value

FormatConditionType

Methods

Delete()

Deletes this conditional format.

void Delete()

FromJson(string)

Generates the conditional format from the json string.

void FromJson(string json)

Parameters

json string

The json string.

SetFirstPriority()

Sets the priority value for this conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.

void SetFirstPriority()

SetLastPriority()

Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.

void SetLastPriority()

ToJson()

Generates a json string from the conditional format.

string ToJson()

Returns

string

The json string.