API Reference
EmailTableCondition
Represents a conditional formatting rule for table cells.
Inheritance
- Object
- EmailTableCondition
Constructors
public EmailTableCondition() #Methods
Evaluate(System.Object cellValue) #Evaluates the condition against a value.
Parameters
- cellValue System.Object
- The cell value to test.
Returns
True if condition is met, false otherwise.
public EmailTableCondition WhenContains(String value) #EmailTableConditionSets the comparison operator to contains (for strings).
Parameters
- value System.String
- The value to search for.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenEndsWith(String value) #EmailTableConditionSets the comparison operator to ends with (for strings).
Parameters
- value System.String
- The value to search for.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenEquals(Object value) #EmailTableConditionSets the comparison operator to equals.
Parameters
- value System.Object
- The value to compare against.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenGreaterThan(Object value) #EmailTableConditionSets the comparison operator to greater than.
Parameters
- value System.Object
- The value to compare against.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenGreaterThanOrEqual(Object value) #EmailTableConditionSets the comparison operator to greater than or equal.
Parameters
- value System.Object
- The value to compare against.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenLessThan(Object value) #EmailTableConditionSets the comparison operator to less than.
Parameters
- value System.Object
- The value to compare against.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenLessThanOrEqual(Object value) #EmailTableConditionSets the comparison operator to less than or equal.
Parameters
- value System.Object
- The value to compare against.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenLike(String pattern) #EmailTableConditionSets the comparison operator to pattern match (like).
Parameters
- pattern System.String
- The pattern to match (supports * wildcard).
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenNotEquals(Object value) #EmailTableConditionSets the comparison operator to not equals.
Parameters
- value System.Object
- The value to compare against.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WhenStartsWith(String value) #EmailTableConditionSets the comparison operator to starts with (for strings).
Parameters
- value System.String
- The value to search for.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithAlignment(Alignment alignment) #EmailTableConditionSets the alignment to apply when condition is met.
Parameters
- alignment HtmlForgeX.Email.Alignment
- The alignment value.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithBackgroundColor(String color) #EmailTableConditionSets the background color to apply when condition is met.
Parameters
- color System.String
- The background color value.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithColor(String color) #EmailTableConditionSets the text color to apply when condition is met.
Parameters
- color System.String
- The color value.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithFailBackgroundColor(String color) #EmailTableConditionSets the fail background color (applied when condition is NOT met).
Parameters
- color System.String
- The background color value.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithFailColor(String color) #EmailTableConditionSets the fail text color (applied when condition is NOT met).
Parameters
- color System.String
- The text color value.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithFontSize(String size) #EmailTableConditionSets the font size to apply when condition is met.
Parameters
- size System.String
- The font size value.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithFontStyle(FontStyle style) #EmailTableConditionSets the font style to apply when condition is met.
Parameters
- style HtmlForgeX.Email.FontStyle
- The font style.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithFontWeight(FontWeight weight) #EmailTableConditionSets the font weight to apply when condition is met.
Parameters
- weight HtmlForgeX.Email.FontWeight
- The font weight.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithHighlightHeaders(params String[] headers) #EmailTableConditionSets headers to highlight when condition is met.
Parameters
- headers System.String[]
- The headers to highlight.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithRowHighlight(Boolean highlight = true) #EmailTableConditionSets whether to highlight the entire row when condition is met.
Parameters
- highlight System.Boolean = true
- Whether to highlight the row.
Returns
The EmailTableCondition object, allowing for method chaining.
public EmailTableCondition WithTextDecoration(TextDecoration decoration) #EmailTableConditionSets the text decoration to apply when condition is met.
Parameters
- decoration HtmlForgeX.Email.TextDecoration
- The text decoration.
Returns
The EmailTableCondition object, allowing for method chaining.
Inherited Methods
Properties
public String ColumnName { get; set; } #Column name to apply the condition to.
public ComparisonOperator Operator { get; set; } #Comparison operator.
public Object Value { get; set; } #Value to compare against.
public Nullable<FontWeight> FontWeight { get; set; } #Font weight to apply when condition is met.
public Nullable<TextDecoration> TextDecoration { get; set; } #Text decoration to apply when condition is met.
public String TextColor { get; set; } #Text color to apply when condition is met.
public String BackgroundColor { get; set; } #Background color to apply when condition is met.
public String FontSize { get; set; } #Font size to apply when condition is met.
public Nullable<FontStyle> FontStyle { get; set; } #Font style to apply when condition is met.
public Nullable<Alignment> Alignment { get; set; } #Alignment to apply when condition is met.
public String FailBackgroundColor { get; set; } #Background color to apply when condition is NOT met (fail color).
public String FailTextColor { get; set; } #Text color to apply when condition is NOT met (fail color).
public Boolean HighlightRow { get; set; } #Whether to highlight the entire row when condition is met.
public List<String> HighlightHeaders { get; set; } #Headers to highlight when condition is met.