OfficeIMO

API Reference

Class

WordTableConditionalFormattingBuilder

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word

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

Inheritance

  • Object
  • WordTableConditionalFormattingBuilder

Methods

AddRule 5 overloads
public WordTableConditionalFormattingBuilder AddRule(String columnName, String matchText, TextMatchType matchType, Color matchFillColor, Nullable<Color> matchFontColor = null, Nullable<Color> noMatchFillColor = null, Nullable<Color> noMatchFontColor = null, Boolean ignoreCase = true, IEnumerable<String> highlightColumns = null, Action<WordParagraph> matchTextFormat = null, Action<WordParagraph> noMatchTextFormat = null) #
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, SixLabors.ImageSharp.Color matchFillColor, System.Nullable{SixLabors.ImageSharp.Color} matchFontColor, System.Nullable{SixLabors.ImageSharp.Color} noMatchFillColor, System.Nullable{SixLabors.ImageSharp.Color} 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 Color parameters.

Parameters

columnName System.String required
matchText System.String required
matchType OfficeIMO.Word.TextMatchType required
matchFillColor SixLabors.ImageSharp.Color required
matchFontColor System.Nullable{SixLabors.ImageSharp.Color} required
noMatchFillColor System.Nullable{SixLabors.ImageSharp.Color} required
noMatchFontColor System.Nullable{SixLabors.ImageSharp.Color} 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, Color matchFillColor, Nullable<Color> matchFontColor = null, Nullable<Color> noMatchFillColor = null, Nullable<Color> noMatchFontColor = null, Boolean ignoreCase = true, IEnumerable<String> highlightColumns = null, Action<WordParagraph> matchTextFormat = null, Action<WordParagraph> noMatchTextFormat = null) #
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, SixLabors.ImageSharp.Color matchFillColor, System.Nullable{SixLabors.ImageSharp.Color} matchFontColor, System.Nullable{SixLabors.ImageSharp.Color} noMatchFillColor, System.Nullable{SixLabors.ImageSharp.Color} 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 Color parameters.

Parameters

conditions System.Collections.Generic.IEnumerable{System.ValueTuple{System.String,System.String,OfficeIMO.Word.TextMatchType}} required
matchAll System.Boolean required
matchFillColor SixLabors.ImageSharp.Color required
matchFontColor System.Nullable{SixLabors.ImageSharp.Color} required
noMatchFillColor System.Nullable{SixLabors.ImageSharp.Color} required
noMatchFontColor System.Nullable{SixLabors.ImageSharp.Color} 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) #
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() #
Returns: Void

Applies all configured rules to the table.