HtmlForgeX

API Reference

Class

EmailStatCard

Namespace HtmlForgeX.Email
Assembly HtmlForgeX.Email
Base Element
Implements
ILayoutAware IVisualElement<EmailStatCard> IRoundable<EmailStatCard> IRoundable

A compact "metric card" component for email (title + value + optional delta). Rendered using table markup and inline styles for broad client compatibility.

Inheritance

Constructors

public EmailStatCard() #

Creates a new stat card with reasonable defaults.

Methods

public override Void EvaluateLayout(LayoutContext context) #
Returns: Void

Parameters

context HtmlForgeX.Email.LayoutContext requiredposition: 0
public override String ToString() #
Returns: String
WithBackground 2 overloads
public virtual EmailStatCard WithBackground(RGBColor color) #
Returns: EmailStatCard

Parameters

color System.String requiredposition: 0
WithBackground(HtmlForgeX.Email.RGBColor color) #

Parameters

color HtmlForgeX.Email.RGBColor required
WithBorder 2 overloads
public virtual EmailStatCard WithBorder(BorderWidth width, String customValue = null) #
Returns: EmailStatCard

Parameters

width HtmlForgeX.Email.BorderWidth requiredposition: 0
customValue System.String = null optionalposition: 1
public virtual EmailStatCard WithBorder(Boolean enabled) #
Returns: EmailStatCard

Parameters

enabled System.Boolean requiredposition: 0
WithBorderColor 2 overloads
public virtual EmailStatCard WithBorderColor(RGBColor color) #
Returns: EmailStatCard

Parameters

color System.String requiredposition: 0
WithBorderColor(HtmlForgeX.Email.RGBColor color) #

Parameters

color HtmlForgeX.Email.RGBColor required
public virtual EmailStatCard WithBorderRadius(String radius) #
Returns: EmailStatCard

Parameters

radius System.String requiredposition: 0
public EmailStatCard WithDelta(String delta, EmailTrendDirection trend = Neutral) #
Returns: EmailStatCard

Sets the delta text and trend direction.

Parameters

delta System.String requiredposition: 0
trend HtmlForgeX.Email.EmailTrendDirection = Neutral optionalposition: 1
public EmailStatCard WithDeltaColor(String color) #
Returns: EmailStatCard

Sets a delta color override.

Parameters

color System.String requiredposition: 0
public EmailStatCard WithIcon(String icon, Boolean show = true) #
Returns: EmailStatCard

Sets a top-right icon.

Parameters

icon System.String requiredposition: 0
show System.Boolean = true optionalposition: 1
WithRounded 2 overloads
public virtual EmailStatCard WithRounded(Radius radius, String customValue = null) #
Returns: EmailStatCard

Parameters

radius HtmlForgeX.Email.Radius requiredposition: 0
customValue System.String = null optionalposition: 1
public virtual EmailStatCard WithRounded() #
Returns: EmailStatCard
public virtual EmailStatCard WithRoundingMode(RoundingMode mode) #
Returns: EmailStatCard

Parameters

mode HtmlForgeX.Email.RoundingMode requiredposition: 0
public EmailStatCard WithSubtitle(String subtitle) #
Returns: EmailStatCard

Sets the subtitle.

Parameters

subtitle System.String requiredposition: 0
public EmailStatCard WithSubtitleColor(String color) #
Returns: EmailStatCard

Sets the subtitle color.

Parameters

color System.String requiredposition: 0
public EmailStatCard WithTitle(String title) #
Returns: EmailStatCard

Sets the title.

Parameters

title System.String requiredposition: 0
public EmailStatCard WithTitleColor(String color) #
Returns: EmailStatCard

Sets the title color.

Parameters

color System.String requiredposition: 0
public EmailStatCard WithValue(String value) #
Returns: EmailStatCard

Sets the value.

Parameters

value System.String requiredposition: 0
public EmailStatCard WithValueColor(String color) #
Returns: EmailStatCard

Sets the value color.

Parameters

color System.String requiredposition: 0
public EmailStatCard WithValueStyle(EmailStatValueStyle style) #
Returns: EmailStatCard

Sets the value typography style.

Parameters

style HtmlForgeX.Email.EmailStatValueStyle requiredposition: 0
public EmailStatCard WithValueWrapMode(EmailTextWrapMode wrapMode) #
Returns: EmailStatCard

Sets the wrapping mode for the value text.

Parameters

wrapMode HtmlForgeX.Email.EmailTextWrapMode requiredposition: 0

Properties

public String Title { get; set; } #

Metric label shown above the value.

public String Value { get; set; } #

Main metric value.

public EmailStatValueStyle ValueStyle { get; set; } #

Controls value typography density. Use Compact for long values (emails, hostnames, lists).

public EmailTextWrapMode ValueWrapMode { get; set; } #

Controls wrapping behavior for the value text.

public String Subtitle { get; set; } #

Optional secondary text shown under the value.

public String Delta { get; set; } #

Optional delta text (e.g. "+8% vs last week").

public EmailTrendDirection Trend { get; set; } #

Delta direction used to pick arrow and default color.

public String Icon { get; set; } #

Optional icon (emoji or short text) shown in the top-right corner.

public Boolean ShowIcon { get; set; } #

Whether to show the icon column.

public virtual String BackgroundColor { get; set; } #
public virtual String BorderRadius { get; set; } #
public virtual String BorderColor { get; set; } #
public virtual String BorderWidth { get; set; } #
public String TitleColor { get; set; } #

Title text color (theme-aware by default).

public String ValueColor { get; set; } #

Value text color (theme-aware by default).

public String SubtitleColor { get; set; } #

Subtitle text color (theme-aware by default).

public String DeltaColor { get; set; } #

Delta color override (when set).

public virtual RoundingMode RoundingMode { get; set; } #