Get Started

API Reference

Class

WordTableConditionalFormattingBuilder

Edit on GitHub
Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Source OfficeIMO.Word/WordTable.ConditionalFormatting.cs:310

Provides a fluent API for defining and applying multiple conditional formatting rules.

Inheritance

  • Object
  • WordTableConditionalFormattingBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

AddRule 5 overloads
public WordTableConditionalFormattingBuilder AddRule(String columnName, String matchText, TextMatchType matchType, OfficeColor matchFillColor, Nullable<OfficeColor> matchFontColor = null, Nullable<OfficeColor> noMatchFillColor = null, Nullable<OfficeColor> noMatchFontColor = null, Boolean ignoreCase = true, IEnumerable<String> highlightColumns = null, Action<WordParagraph> matchTextFormat = null, Action<WordParagraph> noMatchTextFormat = null) #
OfficeIMO.Word/WordTable.ConditionalFormatting.cs:325
Returns: WordTableConditionalFormattingBuilder

Adds a conditional formatting rule based on a column value.

Parameters

columnName System.String requiredposition: 0
matchText System.String requiredposition: 1
matchType OfficeIMO.Word.TextMatchType requiredposition: 2
matchFillColorHex System.String = null requiredposition: 3
matchFontColorHex System.String = null optionalposition: 4
noMatchFillColorHex System.String = null optionalposition: 5
noMatchFontColorHex System.String = null optionalposition: 6
ignoreCase System.Boolean = true optionalposition: 7
highlightColumns System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 8
matchTextFormat System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 9
noMatchTextFormat System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 10
AddRule(System.String columnName, System.String matchText, OfficeIMO.Word.TextMatchType matchType, OfficeIMO.Drawing.OfficeColor matchFillColor, System.Nullable{OfficeIMO.Drawing.OfficeColor} matchFontColor, System.Nullable{OfficeIMO.Drawing.OfficeColor} noMatchFillColor, System.Nullable{OfficeIMO.Drawing.OfficeColor} noMatchFontColor, System.Boolean ignoreCase, System.Collections.Generic.IEnumerable{System.String} highlightColumns, System.Action{OfficeIMO.Word.WordParagraph} matchTextFormat, System.Action{OfficeIMO.Word.WordParagraph} noMatchTextFormat) #

Adds a conditional formatting rule using OfficeColor parameters.

Parameters

columnName System.String required
matchText System.String required
matchType OfficeIMO.Word.TextMatchType required
matchFillColor OfficeIMO.Drawing.OfficeColor required
matchFontColor System.Nullable{OfficeIMO.Drawing.OfficeColor} required
noMatchFillColor System.Nullable{OfficeIMO.Drawing.OfficeColor} required
noMatchFontColor System.Nullable{OfficeIMO.Drawing.OfficeColor} required
ignoreCase System.Boolean required
highlightColumns System.Collections.Generic.IEnumerable{System.String} required
matchTextFormat System.Action{OfficeIMO.Word.WordParagraph} required
noMatchTextFormat System.Action{OfficeIMO.Word.WordParagraph} required
public WordTableConditionalFormattingBuilder AddRule(IEnumerable<ValueTuple<String, String, TextMatchType>> conditions, Boolean matchAll, OfficeColor matchFillColor, Nullable<OfficeColor> matchFontColor = null, Nullable<OfficeColor> noMatchFillColor = null, Nullable<OfficeColor> noMatchFontColor = null, Boolean ignoreCase = true, IEnumerable<String> highlightColumns = null, Action<WordParagraph> matchTextFormat = null, Action<WordParagraph> noMatchTextFormat = null) #
OfficeIMO.Word/WordTable.ConditionalFormatting.cs:357
Returns: WordTableConditionalFormattingBuilder

Adds a conditional formatting rule based on multiple column values.

Parameters

conditions System.Collections.Generic.IEnumerable{System.ValueTuple{System.String,System.String,OfficeIMO.Word.TextMatchType}} requiredposition: 0
matchAll System.Boolean requiredposition: 1
matchFillColorHex System.String = null requiredposition: 2
matchFontColorHex System.String = null optionalposition: 3
noMatchFillColorHex System.String = null optionalposition: 4
noMatchFontColorHex System.String = null optionalposition: 5
ignoreCase System.Boolean = true optionalposition: 6
highlightColumns System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 7
matchTextFormat System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 8
noMatchTextFormat System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 9
AddRule(System.Collections.Generic.IEnumerable{System.ValueTuple{System.String,System.String,OfficeIMO.Word.TextMatchType}} conditions, System.Boolean matchAll, OfficeIMO.Drawing.OfficeColor matchFillColor, System.Nullable{OfficeIMO.Drawing.OfficeColor} matchFontColor, System.Nullable{OfficeIMO.Drawing.OfficeColor} noMatchFillColor, System.Nullable{OfficeIMO.Drawing.OfficeColor} noMatchFontColor, System.Boolean ignoreCase, System.Collections.Generic.IEnumerable{System.String} highlightColumns, System.Action{OfficeIMO.Word.WordParagraph} matchTextFormat, System.Action{OfficeIMO.Word.WordParagraph} noMatchTextFormat) #

Adds a conditional formatting rule based on multiple column values using OfficeColor parameters.

Parameters

conditions System.Collections.Generic.IEnumerable{System.ValueTuple{System.String,System.String,OfficeIMO.Word.TextMatchType}} required
matchAll System.Boolean required
matchFillColor OfficeIMO.Drawing.OfficeColor required
matchFontColor System.Nullable{OfficeIMO.Drawing.OfficeColor} required
noMatchFillColor System.Nullable{OfficeIMO.Drawing.OfficeColor} required
noMatchFontColor System.Nullable{OfficeIMO.Drawing.OfficeColor} required
ignoreCase System.Boolean required
highlightColumns System.Collections.Generic.IEnumerable{System.String} required
matchTextFormat System.Action{OfficeIMO.Word.WordParagraph} required
noMatchTextFormat System.Action{OfficeIMO.Word.WordParagraph} required
public WordTableConditionalFormattingBuilder AddRule(Func<WordTableRow, Boolean> predicate, Action<WordTableRow> matchAction, Action<WordTableRow> noMatchAction = null) #
OfficeIMO.Word/WordTable.ConditionalFormatting.cs:368
Returns: WordTableConditionalFormattingBuilder

Adds a conditional formatting rule using a predicate.

Parameters

predicate System.Func{OfficeIMO.Word.WordTableRow,System.Boolean} requiredposition: 0
matchAction System.Action{OfficeIMO.Word.WordTableRow} requiredposition: 1
noMatchAction System.Action{OfficeIMO.Word.WordTableRow} = null optionalposition: 2
public Void Apply() #
OfficeIMO.Word/WordTable.ConditionalFormatting.cs:376
Returns: Void

Applies all configured rules to the table.