Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

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#
 public sealed class Condition
{signature}{signature:
}
Signature
vb.net
vb.net
Public NotInheritable Class Condition
{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#}
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.

Example
Code Block
csharp
csharp
titleC#

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:
Code Block
vb.net
|title=
vb.net
titlevb.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)
{code} {example} {properties} ||Name||Description|| |[ComparisonType|Condition.ComparisonType]|{excerpt-include:Condition.ComparisonType|nopanel=true}| |[Formula1|Condition.Formula1]|{excerpt-include:Condition.Formula1|nopanel=true}| |[Formula2|Condition.Formula2]|{excerpt-include:Condition.Formula2|nopanel=true}| |[Style|Condition.Style]|{excerpt-include:Condition.Style|nopanel=true}| {methods} ||Name||Description|| |[ApplyStyle(Style)|Condition.ApplyStyle(Style)]|{excerpt-include:
Properties

Name

Description

ComparisonType

Excerpt Include
Condition.ComparisonType
Condition.ComparisonType
nopaneltrue

Formula1

Excerpt Include
Condition.Formula1
Condition.Formula1
nopaneltrue

Formula2

Excerpt Include
Condition.Formula2
Condition.Formula2
nopaneltrue

Style

Excerpt Include
Condition.Style
Condition.Style
nopaneltrue
Methods

Name

Description

ApplyStyle(Style)

Excerpt Include
Condition.ApplyStyle(Style)
Condition.ApplyStyle(Style)

...

nopanel

...

...

...

Excerpt Include
Condition.ChangeCondition(Condition.Comparison,

...

String)

...

Condition.ChangeCondition(Condition.Comparison,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
Condition.ChangeCondition(Condition.Comparison,

...

String,

...

String)

...

Condition.ChangeCondition(Condition.Comparison,

...

String,

...

String)

...

nopanel

...

true
Classes

Name

Description

Comparison

Excerpt Include
Condition.Comparison
Condition.Comparison
nopaneltrue