Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordTableConditionalFormattingBuilder

OfficeIMO.Word

Namespace
OfficeIMO.Word
Assembly
OfficeIMO.Word
Source revision
0eef6a5756b9 with working tree changes

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

Inheritance

  • object
  • WordTableConditionalFormattingBuilder

Usage

Explore 2 API references to this type

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

Methods

AddRule 3 overloads
public WordTableConditionalFormattingBuilder AddRule(string columnName, string? matchText, WordTextMatchType matchType, OfficeColor? matchFillColor = null, OfficeColor? matchFontColor = null, OfficeColor? noMatchFillColor = null, OfficeColor? noMatchFontColor = null, bool ignoreCase = true, IEnumerable<string>? highlightColumns = null, Action<WordParagraph>? matchTextFormat = null, Action<WordParagraph>? noMatchTextFormat = null) #

Adds a conditional formatting rule based on a column value.

Parameters

columnName string required
matchText string? required
matchType OfficeIMO.Word.WordTextMatchType required
matchFillColor OfficeIMO.OfficeColor? = null optional
matchFontColor OfficeIMO.OfficeColor? = null optional
noMatchFillColor OfficeIMO.OfficeColor? = null optional
noMatchFontColor OfficeIMO.OfficeColor? = null optional
ignoreCase bool = true optional
highlightColumns System.Collections.Generic.IEnumerable<string>? = null optional
matchTextFormat System.Action<OfficeIMO.Word.WordParagraph>? = null optional
noMatchTextFormat System.Action<OfficeIMO.Word.WordParagraph>? = null optional
public WordTableConditionalFormattingBuilder AddRule(IEnumerable<ValueTuple<string, string, WordTextMatchType>> conditions, bool matchAll, OfficeColor? matchFillColor = null, OfficeColor? matchFontColor = null, OfficeColor? noMatchFillColor = null, OfficeColor? noMatchFontColor = null, bool ignoreCase = true, IEnumerable<string>? highlightColumns = null, Action<WordParagraph>? matchTextFormat = null, Action<WordParagraph>? noMatchTextFormat = null) #

Adds a conditional formatting rule based on multiple column values.

Parameters

conditions System.Collections.Generic.IEnumerable<System.ValueTuple<string, string, OfficeIMO.Word.WordTextMatchType>> required
matchAll bool required
matchFillColor OfficeIMO.OfficeColor? = null optional
matchFontColor OfficeIMO.OfficeColor? = null optional
noMatchFillColor OfficeIMO.OfficeColor? = null optional
noMatchFontColor OfficeIMO.OfficeColor? = null optional
ignoreCase bool = true optional
highlightColumns System.Collections.Generic.IEnumerable<string>? = null optional
matchTextFormat System.Action<OfficeIMO.Word.WordParagraph>? = null optional
noMatchTextFormat System.Action<OfficeIMO.Word.WordParagraph>? = null optional
public WordTableConditionalFormattingBuilder AddRule(Func<WordTableRow, bool> predicate, Action<WordTableRow> matchAction, Action<WordTableRow>? noMatchAction = null) #

Adds a conditional formatting rule using a predicate.

Parameters

predicate System.Func<OfficeIMO.Word.WordTableRow, bool> required
matchAction System.Action<OfficeIMO.Word.WordTableRow> required
noMatchAction System.Action<OfficeIMO.Word.WordTableRow>? = null optional
public void Apply() #

Applies all configured rules to the table.