OptionalauthorWho authored this change. Recorded on the commit (ICommit.getAuthor).
OptionalautoIf true or set then this will select the affect item after the transaction is complete.
OptionalconditionThe predicate. Set for every rule that is a per-cell test.
Mutually exclusive with IConditionalFormat.Properties.scale.
OptionaldescriptionA human description.
OptionalexpectedOptimistic concurrency guard. If set, the operation only begins if the store's current commit id matches; otherwise a TransactionConflictError is thrown.
OptionalindexPosition in the collection. 0 is first — for a conditional format, the highest priority.
OptionalreadDeclares the operation read-only: any state update within it throws.
Writes are tracked automatically — a batch that performs no updates never creates a commit (no new commit id, no events, no undo entry) whether or not this is set. The flag is purely an assertion for callers that want the guarantee enforced. Nested transactions inherit it; they cannot opt back out.
OptionalreplaceRedefine the item already at index instead of inserting, when it is anchored to exactly
the same ranges (discontiguous ranges compare area by area, in authored order).
Only the item at index is considered, as in Excel. What counts as the same item is per
collection: a data validation or protected range matches on ranges alone; a conditional
format only redefines a scale rule (data bar, color scale, icon set) of the same kind —
a style rule always inserts, since several may apply to one cell, whereas a second scale
of one kind on the same ranges could never render.
OptionalscaleThe value→visual mapping, for the three rules that are not predicates.
Mutually exclusive with IConditionalFormat.Properties.condition.
OptionalstopStop evaluating later rules for a cell this one matched.
OptionalstyleThe differential style applied where the condition holds.
Options for adding a IConditionalFormat.
Remarks
replaceExistingredefines the rule atindexonly when it is a scale rule of the same kind on exactly the same ranges — see IAnchored.AddOptions.replaceExisting.