API Reference

Class

ExcelConditionalFormattingInfo

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Format-neutral conditional-formatting rule model. Instances returned by a worksheet are editable snapshots and can be applied through ExcelConditionalFormattingInfo).

Inheritance

  • Object
  • ExcelConditionalFormattingInfo

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

public ExcelConditionalFormattingInfo() #

Properties

public ExcelConditionalFormattingSource Source { get; set; } #

Gets the SpreadsheetML surface that owns the rule.

public String ExtensionId { get; set; } #

Gets the persistent extension rule identifier when the imported rule provides one.

public Boolean HasPreservedUnknownMarkup { get; set; } #

Gets whether markup not projected by this model is attached to the rule or its container and will be preserved by lifecycle edits.

public String Range { get; set; } #

Gets or sets the A1 range covered by the rule.

public String Type { get; set; } #

Gets or sets the OpenXML conditional formatting type.

public String Operator { get; set; } #

Gets or sets the OpenXML conditional formatting operator.

public String Text { get; set; } #

Gets or sets the text payload attached to a text conditional-formatting rule.

public String TimePeriod { get; set; } #

Gets or sets the relative time period attached to a time-period conditional-formatting rule.

public Int32 Priority { get; set; } #

Gets or sets the rule priority.

public Boolean StopIfTrue { get; set; } #

Gets or sets whether evaluation stops when the rule is true.

public Nullable<UInt32> DifferentialFormatId { get; set; } #

Gets or sets the differential format id attached to the rule, when present.

public String DifferentialFillColorArgb { get; set; } #

Gets or sets the resolved ARGB fill color from the rule's differential format, when present.

public String DifferentialFontColorArgb { get; set; } #

Gets or sets the resolved ARGB font color from the rule's differential format, when present.

public Nullable<Boolean> DifferentialFontBold { get; set; } #

Gets or sets whether the rule's differential format requests bold text, when present.

public Nullable<Boolean> DifferentialFontItalic { get; set; } #

Gets or sets whether the rule's differential format requests italic text, when present.

public Nullable<Boolean> DifferentialFontUnderline { get; set; } #

Gets or sets whether the rule's differential format requests underlined text, when present.

public String DifferentialFontName { get; set; } #

Gets or sets the rule's differential format font family, when present.

public Nullable<Double> DifferentialFontSize { get; set; } #

Gets or sets the rule's differential format font size in points, when present.

public ExcelCellBorderSnapshot DifferentialBorder { get; set; } #

Gets or sets the rule's differential format border, when present.

public IReadOnlyList<String> Formulas { get; set; } #

Gets or sets formulas attached to the rule.

public IReadOnlyList<String> ColorScaleColors { get; set; } #

Gets or sets ARGB colors attached to a color-scale rule, in rule order. An empty entry in an imported rule represents a theme, indexed, or automatic color that remains preserved unless replaced.

public IReadOnlyList<ExcelConditionalFormatThreshold> ColorScaleThresholds { get; set; } #

Gets or sets color-scale thresholds in rule order.

public String DataBarColor { get; set; } #

Gets or sets the ARGB color attached to a data-bar rule.

public IReadOnlyList<ExcelConditionalFormatThreshold> DataBarThresholds { get; set; } #

Gets or sets data-bar thresholds in rule order.

public Boolean DataBarShowValue { get; set; } #

Gets or sets whether the data-bar rule displays the underlying cell value.

public Nullable<UInt32> DataBarMinimumLength { get; set; } #

Gets or sets the minimum data-bar length percentage for Office extension rules.

public Nullable<UInt32> DataBarMaximumLength { get; set; } #

Gets or sets the maximum data-bar length percentage for Office extension rules.

public Nullable<Boolean> DataBarBorder { get; set; } #

Gets or sets whether an Office extension data bar has a border.

public Nullable<Boolean> DataBarGradient { get; set; } #

Gets or sets whether an Office extension data bar uses a gradient fill.

public String DataBarDirection { get; set; } #

Gets or sets the Office extension data-bar direction.

public String DataBarAxisPosition { get; set; } #

Gets or sets the Office extension data-bar axis position.

public Nullable<Boolean> DataBarNegativeColorSameAsPositive { get; set; } #

Gets or sets whether negative bars reuse the positive fill color.

public Nullable<Boolean> DataBarNegativeBorderColorSameAsPositive { get; set; } #

Gets or sets whether negative bar borders reuse the positive border color.

public String DataBarBorderColor { get; set; } #

Gets or sets the ARGB data-bar border color.

public String DataBarNegativeColor { get; set; } #

Gets or sets the ARGB negative data-bar fill color.

public String DataBarNegativeBorderColor { get; set; } #

Gets or sets the ARGB negative data-bar border color.

public String DataBarAxisColor { get; set; } #

Gets or sets the ARGB data-bar axis color.

public String IconSet { get; set; } #

Gets or sets the icon-set name attached to an icon-set rule.

public Boolean IconSetShowValue { get; set; } #

Gets or sets whether the icon-set rule displays the underlying cell value.

public Boolean IconSetReverse { get; set; } #

Gets or sets whether the icon-set rule reverses icon order.

public Nullable<Boolean> IconSetPercent { get; set; } #

Gets or sets whether an Office extension icon set interprets thresholds as percentages.

public Nullable<Boolean> IconSetCustom { get; set; } #

Gets or sets whether an Office extension icon set uses explicit custom icons.

public IReadOnlyList<ExcelConditionalIconSetThreshold> IconSetThresholds { get; set; } #

Gets or sets icon-set thresholds in rule order.

public IReadOnlyList<ExcelConditionalFormatIcon> CustomIcons { get; set; } #

Gets or sets custom icon references in rule order.

public Nullable<UInt32> TopBottomRank { get; set; } #

Gets or sets the top/bottom rule rank, when present.

public Boolean TopBottomBottom { get; set; } #

Gets or sets whether the top/bottom rule selects bottom values.

public Boolean TopBottomPercent { get; set; } #

Gets or sets whether the top/bottom rule rank is a percentage.

public Boolean AboveAverageAbove { get; set; } #

Gets or sets whether the above-average rule selects values above the average.

public Boolean AboveAverageEqual { get; set; } #

Gets or sets whether the above-average rule includes values equal to the average.

public Nullable<Int32> AboveAverageStdDev { get; set; } #

Gets or sets the standard-deviation threshold for above-average rules, when present.