[]
        
(Showing Draft Content)

FarPoint.Web.Spread.ConditionalFormatting

ConditionalFormatting Class

Represents a conditional format.

Inheritance
ConditionalFormatting
Namespace: FarPoint.Web.Spread
Assembly: FarPoint.Web.Spread.dll
Syntax
public sealed class ConditionalFormatting : ICollection<IConditionalFormattingRule>, IEnumerable<IConditionalFormattingRule>, IEnumerable, IDeserializationCallback, ISerializeSupport, ICloneable, ISerializable, INotifyItemChanged<IConditionalFormattingRule>
Public NotInheritable Class ConditionalFormatting
    Implements ICollection(Of IConditionalFormattingRule), IEnumerable(Of IConditionalFormattingRule), IEnumerable, IDeserializationCallback, ISerializeSupport, ICloneable, ISerializable, INotifyItemChanged(Of IConditionalFormattingRule)

Constructors

Name Description
ConditionalFormatting(CellRange)

Initializes a new instance of the ConditionalFormatting class.

ConditionalFormatting(CellRange, params IConditionalFormattingRule[])

Initializes a new instance of the ConditionalFormatting class.

ConditionalFormatting(IEnumerable<CellRange>)

Initializes a new instance of the ConditionalFormatting class.

ConditionalFormatting(IEnumerable<CellRange>, params IConditionalFormattingRule[])

Initializes a new instance of the ConditionalFormatting class.

Properties

Name Description
AverageValue

Gets the average value.

ContainsCalcError

Gets a value that indicates whether the conditional formatting range(s) contains a CalcError value.

Count

Gets the number of elements contained in the ICollection<T>.

DoubleValues

Gets all values.

IsReadOnly

Gets a value that indicates whether the ICollection<T> is read-only.

Ranges

Gets the ranges that the conditional formatting applied.

Rules

Gets the rules.

StandardDeviation

Gets the standard deviation.

ValuesCount

Gets the ranges value count.

Methods

Name Description
Add(IConditionalFormattingRule)

Adds an item to the ICollection<T>.

AddRange(IEnumerable<IConditionalFormattingRule>)

Adds the elements of the specified IConditionalFormattingRule collection to the ConditionalFormatting object.

Clear()

Removes all items from the ICollection<T>.

Contains(IConditionalFormattingRule)

Determines whether the ICollection<T> contains a specific value.

CopyTo(IConditionalFormattingRule[], int)

Copies the items to a compatible one-dimensional array, starting at the specified index of the target array.

Evaluate(int, int, Expression)

Evaluates the specified expression.

Evaluate(int, int, string)

Evaluates the specified formula.

GetComparedValue(ConditionalFormattingValueType, object)

Gets the compare value.

GetEnumerator()

Returns an enumerator that iterates through the collection.

GetValue(int)

Gets the value.

IndexOf(IConditionalFormattingRule)

The index of the item.

NotifyFormulaChanged(object, FormulaChangedType)

Notifies the ConditionalFormatting object that the formula in the conditional formatting rule has changed.

NotifyRequiresChanged()

Notifies when the requirements have changed.

Remove(IConditionalFormattingRule)

Removes the first occurrence of a specific object from the ICollection<T>.

Events

Name Description
Changed

Occurs after a conditional formatting rule has been changed.

ConditionalFormattingSplit

Occurs when the conditional formatting needs to be split due to an internal change.