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, WordTextMatchType matchType, String matchFillColorHex = null, String matchFontColorHex = null, String noMatchFillColorHex = null, String noMatchFontColorHex = null, Boolean ignoreCase = true, IEnumerable<String> highlightColumns = null, Action<WordParagraph> matchTextFormat = null, Action<WordParagraph> noMatchTextFormat = null) #
OfficeIMO.Word/WordTable.ConditionalFormatting.cs:310
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.WordTextMatchType requiredposition: 2
matchFillColorHex System.String = null optionalposition: 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
public WordTableConditionalFormattingBuilder AddRule(String columnName, String matchText, WordTextMatchType 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 using OfficeColor parameters.

Parameters

arg1 System.String requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.Word.WordTextMatchType requiredposition: 2
arg4 OfficeIMO.Drawing.OfficeColor requiredposition: 3
arg5 System.Nullable{OfficeIMO.Drawing.OfficeColor} = null optionalposition: 4
arg6 System.Nullable{OfficeIMO.Drawing.OfficeColor} = null optionalposition: 5
arg7 System.Nullable{OfficeIMO.Drawing.OfficeColor} = null optionalposition: 6
arg8 System.Boolean = true optionalposition: 7
arg9 System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 8
arg10 System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 9
arg11 System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 10
public WordTableConditionalFormattingBuilder AddRule(IEnumerable<ValueTuple<String, String, WordTextMatchType>> conditions, Boolean matchAll, String matchFillColorHex = null, String matchFontColorHex = null, String noMatchFillColorHex = null, String noMatchFontColorHex = null, Boolean ignoreCase = true, IEnumerable<String> highlightColumns = null, Action<WordParagraph> matchTextFormat = null, Action<WordParagraph> noMatchTextFormat = null) #
OfficeIMO.Word/WordTable.ConditionalFormatting.cs:341
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.WordTextMatchType}} requiredposition: 0
matchAll System.Boolean requiredposition: 1
matchFillColorHex System.String = null optionalposition: 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
public WordTableConditionalFormattingBuilder AddRule(IEnumerable<ValueTuple<String, String, WordTextMatchType>> 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 using OfficeColor parameters.

Parameters

arg1 System.Collections.Generic.IEnumerable{System.ValueTuple{System.String,System.String,OfficeIMO.Word.WordTextMatchType}} requiredposition: 0
arg2 System.Boolean requiredposition: 1
arg3 OfficeIMO.Drawing.OfficeColor requiredposition: 2
arg4 System.Nullable{OfficeIMO.Drawing.OfficeColor} = null optionalposition: 3
arg5 System.Nullable{OfficeIMO.Drawing.OfficeColor} = null optionalposition: 4
arg6 System.Nullable{OfficeIMO.Drawing.OfficeColor} = null optionalposition: 5
arg7 System.Boolean = true optionalposition: 6
arg8 System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 7
arg9 System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 8
arg10 System.Action{OfficeIMO.Word.WordParagraph} = null optionalposition: 9
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.