ConditionalFormatStore Class
Store for conditional formatting rules per ranges.
Inheritance
Object
Documents.Spreadsheet.ConditionalFormatStore
Namespace: Radzen.Documents.Spreadsheet
Assembly: Radzen.Blazor.dll
Syntax
public class ConditionalFormatStoreConstructors
ConditionalFormatStorelink
Store for conditional formatting rules per ranges.
Declaration
public ConditionalFormatStore()Properties
Rangeslink
Gets all ranges that have conditional formatting rules.
Declaration
public IEnumerable<Documents.Spreadsheet.RangeRef> Ranges { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<Documents.Spreadsheet.RangeRef> | Gets all ranges that have conditional formatting rules. |
Methods
Addlink
Adds conditional formatting rules for a specific range.
Declaration
public void Add(Documents.Spreadsheet.RangeRef range, Documents.Spreadsheet.ConditionalFormatBase[] rules)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.RangeRef | range | |
| Documents.Spreadsheet.ConditionalFormatBase[] | rules |
Addlink
Adds conditional formatting rules for a specific range.
Declaration
public void Add(Documents.Spreadsheet.RangeRef range, Documents.Spreadsheet.ConditionalFormatBase rule)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.RangeRef | range | |
| Documents.Spreadsheet.ConditionalFormatBase | rule |
Calculatelink
Calculates the merged conditional overlay format for a cell from all matching rules.
Declaration
public Documents.Spreadsheet.Format Calculate(Documents.Spreadsheet.Cell cell)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.Cell | cell |
Returns
| Type | Description |
|---|---|
| Documents.Spreadsheet.Format |
GetRuleslink
Gets all rules for a specific range.
Declaration
public IReadOnlyList<Documents.Spreadsheet.ConditionalFormatBase> GetRules(Documents.Spreadsheet.RangeRef range)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.RangeRef | range |
Returns
| Type | Description |
|---|---|
| IReadOnlyList<Documents.Spreadsheet.ConditionalFormatBase> |
Removelink
Removes a conditional formatting rule from a specific range.
Declaration
public bool Remove(Documents.Spreadsheet.RangeRef range, Documents.Spreadsheet.ConditionalFormatBase rule)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.RangeRef | range | |
| Documents.Spreadsheet.ConditionalFormatBase | rule |
Returns
| Type | Description |
|---|---|
| bool |