HtmlForgeX

API Reference

Class

EmailStoreBadges

Namespace HtmlForgeX.Email
Assembly HtmlForgeX.Email
Base Element
Implements
Modifiers sealed

Email-safe "store badges" row (App Store / Google Play / other) rendered using tables. Does not include any third-party assets; callers provide badge images (URL/path/cid/base64).

Inheritance

Constructors

Methods

AddBadge 2 overloads
public EmailStoreBadges AddBadge(String href, String imageSource, String altText = "", Int32 widthPx = 0, Int32 heightPx = 0, String darkModeImageSource = "") #
Returns: EmailStoreBadges

Adds a generic badge.

Parameters

href System.String requiredposition: 0
imageSource System.String requiredposition: 1
altText System.String = "" optionalposition: 2
widthPx System.Int32 = 0 optionalposition: 3
heightPx System.Int32 = 0 optionalposition: 4
darkModeImageSource System.String = "" optionalposition: 5
public EmailStoreBadges AddBadge(Action<EmailStoreBadge> configure) #
Returns: EmailStoreBadges

Adds a badge configured via callback.

Parameters

configure System.Action{HtmlForgeX.Email.EmailStoreBadge} requiredposition: 0
public override String ToString() #
Returns: String
public EmailStoreBadges WithAppleBadge(String href, String imageSource, String darkModeImageSource = null, Int32 widthPx = 0, Int32 heightPx = 0, String altText = "Download on the App Store") #
Returns: EmailStoreBadges

Convenience method for adding an Apple App Store badge.

Parameters

href System.String requiredposition: 0
imageSource System.String requiredposition: 1
darkModeImageSource System.String = null optionalposition: 2
widthPx System.Int32 = 0 optionalposition: 3
heightPx System.Int32 = 0 optionalposition: 4
altText System.String = "Download on the App Store" optionalposition: 5
public EmailStoreBadges WithGoogleBadge(String href, String imageSource, String darkModeImageSource = null, Int32 widthPx = 0, Int32 heightPx = 0, String altText = "Get it on Google Play") #
Returns: EmailStoreBadges

Convenience method for adding a Google Play badge.

Parameters

href System.String requiredposition: 0
imageSource System.String requiredposition: 1
darkModeImageSource System.String = null optionalposition: 2
widthPx System.Int32 = 0 optionalposition: 3
heightPx System.Int32 = 0 optionalposition: 4
altText System.String = "Get it on Google Play" optionalposition: 5

Properties

public List<EmailStoreBadge> Badges { get; } #

Badges rendered in the row.

public Alignment Alignment { get; set; } #

Alignment of the badges row.

public Int32 GapPx { get; set; } #

Gap between badges (px).

public Int32 BadgeHeightPx { get; set; } #

Default badge height (px) when not set per badge.

public Boolean OpenInNewWindow { get; set; } #

When true, badge links open in a new window/tab where supported.