Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

A Condition object represents a condition within a ConditionalFormat, a format that Excel will apply to a cell or group of cells if a specified condition is met.

Signature
C#C#
Wiki Markup
{description}
{excerpt}A [Condition|Condition] object represents a condition within a [ConditionalFormat], a format that Excel will apply to a cell or group of cells if a specified condition is met. {excerpt}
{signature:C#}
 public sealed class Condition
Signature
{signature}{signature:vb.net
vb.net
}
Public NotInheritable Class Condition
Remarks

A ConditionalFormat object contains up to three Condition objects and a Range object representing the set of cells on which the conditions will be tested.

To create a Condition object, call one of the ConditionalFormat object's CreateCondition methods.

{signature}
{remarks}A [ConditionalFormat|ConditionalFormat] object contains up to three {{Condition}} objects and a [Range] object representing the set of cells on which the conditions will be tested.

To create a {{Condition}} object, call one of the {{ConditionalFormat}} object's [CreateCondition|ConditionalFormat.CreateCondition] methods.
{remarks}
{example}
{code:csharp|title=C#}
ExcelApplication xla = new ExcelApplication();
Workbook wb = xla.Create();
Range rng = wb.Worksheets[0].CreateRange("$B$2:$F$10");
ConditionalFormat condFmt = wb.CreateConditionalFormat();
Condition cond =
     condFmt.CreateCondition(
     Condition.Comparison.CellValueGreaterThan, 
     "=100");
Font fnt = cond.Style.Font;
fnt.Bold = true;
fnt.Color = wb.Palette.GetClosestColor(100, 100, 255);
rng.SetConditionalFormat(condFmt);
{code}
{code:vb.net
|title=vb.net
}
Dim xla As New ExcelApplication()
Dim wb As Workbook = xla.Create()
Dim rng As Range = wb.Worksheets(0).CreateRange("$B$2:$F$10")
Dim condFmt As ConditionalFormat = wb.CreateConditionalFormat()
Dim cond As Condition = _
     condFmt.CreateCondition( _
     Condition.Comparison.CellValueGreaterThan, _
     "=100")
Dim fnt As Font = cond.Style.Font
fnt.Bold = true
fnt.Color = wb.Palette.GetClosestColor(100, 100, 255)
rng.SetConditionalFormat(condFmt)
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle
Properties

...

Name

...

Description

...

ComparisonType

...

{code}

{example}
{properties}
||Name||Description||
|[ComparisonType|Condition.ComparisonType]|{excerpt-include:Condition.ComparisonType

...

Formula1

|nopanel=true}|
|[Formula1|Condition.Formula1]|{excerpt-include

...

:Condition.Formula1

...

Formula2

|nopanel=true}|
|[Formula2|Condition.Formula2]|{excerpt-include

...

:Condition.Formula2

...

Style

|nopanel=true}|
|[Style|Condition.Style]|{excerpt-include

...

:Condition.Style

...

Methods

...

Name

...

Description

|nopanel=true}|
{methods}
||Name||Description||
|[ApplyStyle(Style)

...

|Condition.ApplyStyle(Style)

...

]|{excerpt-include:Condition.ApplyStyle(Style)

...

|nopanel

...

=true}|
|[ChangeCondition(Condition.Comparison, String)

...

|Condition.ChangeCondition(Condition.Comparison, String)

...

]|{excerpt-include:Condition.ChangeCondition(Condition.Comparison, String)

...

|nopanel

...

=true}|
|[ChangeCondition(Condition.Comparison, String, String)

...

|Condition.ChangeCondition(Condition.Comparison, String, String)

...

]|{excerpt-include:Condition.ChangeCondition(Condition.Comparison, String, String)

...

|nopanel

...

Classes

...

Name

...

Description

...

Comparison

...

=true}|
{classes}
||Name||Description||
|[Comparison|Condition.Comparison]|{excerpt-include:Condition.Comparison

...

|nopanel=true}|