Search Results for

    Show / Hide Table of Contents

    Interface ISheetConditionalFormatting

    The Conditional Formatting facet of WorkSheet

    Namespace: IronXL.Formatting
    Assembly: IronXL.dll
    Syntax
    public interface ISheetConditionalFormatting

    Properties

    ConditionalFormattingsCount

    Get the number of conditional formats in this sheet

    Declaration
    int ConditionalFormattingsCount { get; }
    Property Value
    Type Description
    System.Int32

    The conditional formattings count.

    Methods

    AddConditionalFormatting(ConditionalFormatting)

    Adds a copy of a ConditionalFormatting object to the sheet

    Declaration
    ConditionalFormatting AddConditionalFormatting(ConditionalFormatting cf)
    Parameters
    Type Name Description
    ConditionalFormatting cf

    The Conditional Formatting to clone.

    Returns
    Type Description
    ConditionalFormatting

    The new Conditional Formatting object.

    Remarks

    This method could be used to copy ConditionalFormatting object from one sheet to another. For example: ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index); newSheet.AddConditionalFormatting(cf);

    AddConditionalFormatting(IEnumerable<String>, ConditionalFormattingRule)

    Add a new Conditional Formatting to the sheet.

    Declaration
    ConditionalFormatting AddConditionalFormatting(IEnumerable<string> regions, ConditionalFormattingRule rule)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.String> regions

    List of rectangular ranges of cells (e.g. "A1:C10") to apply conditional formatting rules

    ConditionalFormattingRule rule

    The rule to apply

    Returns
    Type Description
    ConditionalFormatting

    The newly created Conditional Formatting object

    AddConditionalFormatting(IEnumerable<String>, ConditionalFormattingRule, ConditionalFormattingRule)

    Add a new Conditional Formatting consisting of two rules.

    Declaration
    ConditionalFormatting AddConditionalFormatting(IEnumerable<string> regions, ConditionalFormattingRule rule1, ConditionalFormattingRule rule2)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.String> regions

    List of rectangular ranges of cells (e.g. "A1:C10") to apply conditional formatting rules

    ConditionalFormattingRule rule1

    The first rule

    ConditionalFormattingRule rule2

    The second rule

    Returns
    Type Description
    ConditionalFormatting

    The newly created Conditional Formatting object

    AddConditionalFormatting(IEnumerable<String>, List<ConditionalFormattingRule>)

    Add a new Conditional Formatting Set to the sheet.

    Declaration
    ConditionalFormatting AddConditionalFormatting(IEnumerable<string> regions, List<ConditionalFormattingRule> cfRules)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.String> regions

    List of rectangular ranges of cells (e.g. "A1:C10") to apply conditional formatting rules

    System.Collections.Generic.List<ConditionalFormattingRule> cfRules

    Set of up to three conditional formatting rules

    Returns
    Type Description
    ConditionalFormatting

    The newly created Conditional Formatting object

    AddConditionalFormatting(String, ConditionalFormattingRule)

    Add a new Conditional Formatting to the sheet.

    Declaration
    ConditionalFormatting AddConditionalFormatting(string region, ConditionalFormattingRule rule)
    Parameters
    Type Name Description
    System.String region

    Range of cells (e.g. "A1:C10") to apply conditional formatting rules

    ConditionalFormattingRule rule

    The rule to apply

    Returns
    Type Description
    ConditionalFormatting

    The newly created Conditional Formatting object

    AddConditionalFormatting(String, ConditionalFormattingRule, ConditionalFormattingRule)

    Add a new Conditional Formatting consisting of two rules.

    Declaration
    ConditionalFormatting AddConditionalFormatting(string region, ConditionalFormattingRule rule1, ConditionalFormattingRule rule2)
    Parameters
    Type Name Description
    System.String region

    Range of cells (e.g. "A1:C10") to apply conditional formatting rules

    ConditionalFormattingRule rule1

    The first rule

    ConditionalFormattingRule rule2

    The second rule

    Returns
    Type Description
    ConditionalFormatting

    The newly created Conditional Formatting object

    AddConditionalFormatting(String, List<ConditionalFormattingRule>)

    Add a new Conditional Formatting Set to the sheet.

    Declaration
    ConditionalFormatting AddConditionalFormatting(string region, List<ConditionalFormattingRule> cfRules)
    Parameters
    Type Name Description
    System.String region

    Range of cells (e.g. "A1:C10") to apply conditional formatting rules

    System.Collections.Generic.List<ConditionalFormattingRule> cfRules

    Set of up to three conditional formatting rules

    Returns
    Type Description
    ConditionalFormatting

    The newly created Conditional Formatting object

    CreateConditionalFormattingRule(ComparisonOperator, String)

    Create a conditional formatting rule that Compares a cell value to a formula calculated result, using an operator

    Declaration
    ConditionalFormattingRule CreateConditionalFormattingRule(ComparisonOperator comparisonOperation, string formula)
    Parameters
    Type Name Description
    ComparisonOperator comparisonOperation

    MUST be a constant value from ComparisonOperator except Between and NotBetween

    System.String formula

    The formula to determine if the conditional formatting is applied

    Returns
    Type Description
    ConditionalFormattingRule

    A conditional formatting rule

    CreateConditionalFormattingRule(ComparisonOperator, String, String)

    A factory method allowing to create a conditional formatting rule with a cell comparison operator.

    The Created conditional formatting rule compares a cell value to a formula calculated result, using the specified operator. The type of the Created condition is CellValueIs

    Declaration
    ConditionalFormattingRule CreateConditionalFormattingRule(ComparisonOperator comparisonOperation, string formula1, string formula2)
    Parameters
    Type Name Description
    ComparisonOperator comparisonOperation

    Value from ComparisonOperator enum.

    System.String formula1

    Formula for the valued, Compared with the cell

    System.String formula2

    The second formula (only used with Between and NotBetween operations.

    Returns
    Type Description
    ConditionalFormattingRule

    New conditional formatting rule.

    CreateConditionalFormattingRule(String)

    Create a conditional formatting rule based on a Boolean formula. When the formula result is true, the cell is highlighted.

    Declaration
    ConditionalFormattingRule CreateConditionalFormattingRule(string formula)
    Parameters
    Type Name Description
    System.String formula

    The formula to Evaluate. MUST be a Boolean function.

    Returns
    Type Description
    ConditionalFormattingRule

    Conditional formatting rule

    GetConditionalFormattingAt(Int32)

    Gets Conditional Formatting object at a particular index

    Declaration
    ConditionalFormatting GetConditionalFormattingAt(int index)
    Parameters
    Type Name Description
    System.Int32 index

    0-based index of the Conditional Formatting object to fetch

    Returns
    Type Description
    ConditionalFormatting

    Conditional Formatting object or null if not found

    Exceptions
    Type Condition
    System.ArgumentException

    throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)

    RemoveConditionalFormatting(Int32)

    Removes a Conditional Formatting object by index

    Declaration
    void RemoveConditionalFormatting(int index)
    Parameters
    Type Name Description
    System.Int32 index

    0-based index of the Conditional Formatting object to remove

    Exceptions
    Type Condition
    System.ArgumentException

    throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)

    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget
    Want to deploy IronXL to a live project for FREE?
    What’s included?
    30 days of fully-functional product
    Test and share in a live environment
    No watermarks in production
    Get your free 30-day Trial Key instantly.
    No credit card or account creation required
    Your Trial License Key has been emailed to you.
    Download IronXL free to apply
    your Trial Licenses Key
    Install with NuGet View Licenses
    Licenses from $499. Have a question? Get in touch.