API Reference
EmailButton
Represents an email-compatible button component using table-based layout. Applies HeadingMargin between successive buttons and ParagraphMargin when adjacent to other components.
Inheritance
- Element
- EmailButton
Constructors
public EmailButton() #Initializes a new instance of the EmailButton class.
public EmailButton(String text, String href, EmailButtonStyle style = Primary) #Initializes a new instance of the EmailButton class with text and URL.
Parameters
- text System.String
- The button text.
- href System.String
- The button link URL.
- style HtmlForgeX.Email.EmailButtonStyle = Primary
- The button style.
Methods
public EmailButton AsFullWidth(Boolean fullWidth = true) #EmailButtonMakes the button full width.
Parameters
- fullWidth System.Boolean = true
- Whether the button should be full width.
Returns
This instance for method chaining.
public override Void EvaluateLayout(LayoutContext context) #VoidApplies default border radius for the button based on configuration.
Parameters
- context HtmlForgeX.Email.LayoutContext
- Layout evaluation context.
public override String ToString() #StringConverts the EmailButton to its HTML representation.
Returns
HTML string representing the email button.
public virtual EmailButton WithAlignment(Alignment alignment) #EmailButtonSets the text alignment inside the button.
Parameters
- alignment HtmlForgeX.Email.Alignment
- The alignment to apply.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithBackground(RGBColor color) #EmailButtonSets the background color of the button.
Parameters
- color System.String
- The background color value.
Returns
The current EmailButton for chaining.
WithBackground(HtmlForgeX.Email.RGBColor color) #Sets the background color using an RGBColor instance.
Parameters
- color HtmlForgeX.Email.RGBColor
- The RGBColor to apply.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithBorder(BorderWidth width, String customValue = null) #EmailButtonSets the border width using a predefined BorderWidth value.
Parameters
- width HtmlForgeX.Email.BorderWidth
- The predefined border width.
- customValue System.String = null
- Optional custom CSS value.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithBorder(Boolean enabled) #EmailButtonEnables or disables the button border.
Parameters
- enabled System.Boolean
Returns
The current EmailButton for chaining.
public virtual EmailButton WithBorderColor(RGBColor color) #EmailButtonSets the border color of the button.
Parameters
- color System.String
- The border color value.
Returns
The current EmailButton for chaining.
WithBorderColor(HtmlForgeX.Email.RGBColor color) #Sets the border color using an RGBColor instance.
Parameters
- color HtmlForgeX.Email.RGBColor
- The RGBColor to apply.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithBorderRadius(String radius) #EmailButtonSets the border radius of the button.
Parameters
- radius System.String
- The CSS radius value.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithColor(RGBColor color) #EmailButtonSets the button text color.
Parameters
- color System.String
- The text color value.
Returns
The current EmailButton for chaining.
WithColor(HtmlForgeX.Email.RGBColor color) #Sets the button text color using an RGBColor instance.
Parameters
- color HtmlForgeX.Email.RGBColor
- The RGBColor to apply.
Returns
The current EmailButton for chaining.
public EmailButton WithColors(RGBColor backgroundColor, RGBColor textColor, RGBColor borderColor = null) #EmailButtonSets custom colors for the button.
Parameters
- backgroundColor System.String
- The background color.
- textColor System.String
- The text color.
- borderColor System.String = null
- The border color (optional).
Returns
The EmailButton object, allowing for method chaining.
WithColors(HtmlForgeX.Email.RGBColor backgroundColor, HtmlForgeX.Email.RGBColor textColor, HtmlForgeX.Email.RGBColor borderColor) #Sets custom colors for the button.
Parameters
- backgroundColor HtmlForgeX.Email.RGBColor
- The background color.
- textColor HtmlForgeX.Email.RGBColor
- The text color.
- borderColor HtmlForgeX.Email.RGBColor
- The border color (optional).
Returns
The EmailButton object, allowing for method chaining.
public virtual EmailButton WithFontFamily(String fontFamily) #EmailButtonSets the font family of the button text.
Parameters
- fontFamily System.String
- The font family name.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithFontSize(EmailFontSize fontSize) #EmailButtonSets the font size of the button text.
Parameters
- fontSize System.String
- The font size value.
Returns
The current EmailButton for chaining.
WithFontSize(HtmlForgeX.Email.EmailFontSize fontSize) #Sets the font size using a predefined EmailFontSize value.
Parameters
- fontSize HtmlForgeX.Email.EmailFontSize
- The predefined font size.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithFontWeight(FontWeight fontWeight) #EmailButtonSets the font weight of the button text.
Parameters
- fontWeight System.String
- The font weight value.
Returns
The current EmailButton for chaining.
WithFontWeight(HtmlForgeX.Email.FontWeight fontWeight) #Sets the font weight using a predefined value.
Parameters
- fontWeight HtmlForgeX.Email.FontWeight
- The predefined font weight.
Returns
The current EmailButton for chaining.
public EmailButton WithFullWidth() #EmailButtonMakes the button full width.
Returns
The EmailButton object, allowing for method chaining.
public EmailButton WithHref(String href) #EmailButtonSets the button URL.
Parameters
- href System.String
- The button link URL.
Returns
The EmailButton object, allowing for method chaining.
public virtual EmailButton WithLineHeight(String lineHeight) #EmailButtonSets the line height of the button text.
Parameters
- lineHeight System.String
- The line height value.
Returns
The current EmailButton for chaining.
public EmailButton WithLink(String href) #EmailButtonSets the button link URL.
Parameters
- href System.String
- The URL to link to.
Returns
This instance for method chaining.
public virtual EmailButton WithRounded(Radius radius = Medium, String customValue = null) #EmailButtonSets the border radius using a predefined size.
Parameters
- radius HtmlForgeX.Email.Radius = Medium
- The border radius size.
- customValue System.String = null
- Custom value when using Custom.
Returns
This instance for method chaining.
public virtual EmailButton WithRounded() #EmailButtonApplies a medium border radius to the button.
Returns
The current EmailButton for chaining.
public virtual EmailButton WithRoundingMode(RoundingMode mode) #EmailButtonSets the rounding mode for this button.
Parameters
- mode HtmlForgeX.Email.RoundingMode
- Rounding mode.
Returns
The current instance.
public EmailButton WithSize(EmailButtonSize size) #EmailButtonSets the button size.
Parameters
- size HtmlForgeX.Email.EmailButtonSize
- The button size.
Returns
The EmailButton object, allowing for method chaining.
public EmailButton WithStyle(EmailButtonStyle style) #EmailButtonSets the button style.
Parameters
- style HtmlForgeX.Email.EmailButtonStyle
- The button style.
Returns
The EmailButton object, allowing for method chaining.
public EmailButton WithText(String text) #EmailButtonSets the button text.
Parameters
- text System.String
- The button text.
Returns
The EmailButton object, allowing for method chaining.
public virtual EmailButton WithTextDecoration(TextDecoration decoration) #EmailButtonSets the text decoration style.
Parameters
- textDecoration System.String
- The decoration string.
Returns
The current EmailButton for chaining.
WithTextDecoration(HtmlForgeX.Email.TextDecoration decoration) #Sets the text decoration using a predefined value.
Parameters
- decoration HtmlForgeX.Email.TextDecoration
- The decoration to apply.
Returns
The current EmailButton for chaining.
public EmailButton WithVerticalSpacing(EmailSpacing spacing) #EmailButtonSets the vertical spacing around the button using semantic spacing.
Parameters
- spacing HtmlForgeX.Email.EmailSpacing
- The vertical spacing to apply.
Returns
The EmailButton object, allowing for method chaining.
public EmailButton WithVerticalSpacing(EmailSpacing above, EmailSpacing below) #EmailButtonSets different spacing above and below the button.
Parameters
- above HtmlForgeX.Email.EmailSpacing
- The spacing above the button.
- below HtmlForgeX.Email.EmailSpacing
- The spacing below the button.
Returns
The EmailButton object, allowing for method chaining.
Inherited Methods
public override Element Add(Element element) #ElementParameters
- element Element
public override Element AddCssClass(String cssClass) #ElementParameters
- cssClass String
public EmailActivityList EmailActivityList() #EmailActivityListParameters
- config Action<EmailActivityList>
public EmailAddressBlock EmailAddressBlock() #EmailAddressBlockParameters
- config Action<EmailAddressBlock>
public EmailAddressCard EmailAddressCard() #EmailAddressCardParameters
- config Action<EmailAddressCard>
public EmailAlert EmailAlert(EmailAlertType type, String title, String message = "") #EmailAlertParameters
- config Action<EmailAlert>
public EmailArticleCard EmailArticleCard() #EmailArticleCardParameters
- config Action<EmailArticleCard>
public EmailArticleList EmailArticleList() #EmailArticleListParameters
- config Action<EmailArticleList>
public EmailAttachmentList EmailAttachmentList() #EmailAttachmentListParameters
- config Action<EmailAttachmentList>
public EmailAvatar EmailAvatar(String initials, String size = "40px") #EmailAvatarParameters
- config Action<EmailAvatar>
public EmailAvatarStack EmailAvatarStack() #EmailAvatarStackParameters
- config Action<EmailAvatarStack>
public EmailBackgroundImageBox EmailBackgroundImageBox() #EmailBackgroundImageBoxParameters
- config Action<EmailBackgroundImageBox>
public EmailBadge EmailBadge(String text, String backgroundColor = "#64748B", String color = "#FFFFFF") #EmailBadgeParameters
- config Action<EmailBadge>
public EmailBadgeList EmailBadgeList() #EmailBadgeListParameters
- config Action<EmailBadgeList>
public EmailBarChart EmailBarChart() #EmailBarChartParameters
- config Action<EmailBarChart>
public EmailBarcode EmailBarcode(String value) #EmailBarcodeParameters
- config Action<EmailBarcode>
public Element EmailBlockquote(Action<EmailBlockquote> config) #ElementParameters
- content String = ""
public Element EmailBox(Action<EmailBox> config) #ElementParameters
- config Action<EmailBox>
public Element EmailBoxWithBuilder(Action<EmailBoxBuilder> config) #ElementParameters
- config Action<EmailBoxBuilder>
public EmailBrandStrip EmailBrandStrip() #EmailBrandStripParameters
- config Action<EmailBrandStrip>
public Element EmailButton(Action<EmailButton> config) #ElementParameters
- config Action<EmailButton>
public EmailButtonGroup EmailButtonGroup() #EmailButtonGroupParameters
- config Action<EmailButtonGroup>
public EmailCalendar EmailCalendar() #EmailCalendarParameters
- config Action<EmailCalendar>
public EmailCalloutCard EmailCalloutCard() #EmailCalloutCardParameters
- config Action<EmailCalloutCard>
public EmailChangelog EmailChangelog() #EmailChangelogParameters
- config Action<EmailChangelog>
public Element EmailColumn(Action<EmailColumn> config) #ElementParameters
- config Action<EmailColumn>
public EmailCommentList EmailCommentList() #EmailCommentListParameters
- config Action<EmailCommentList>
public EmailComparisonTable EmailComparisonTable() #EmailComparisonTableParameters
- config Action<EmailComparisonTable>
public Element EmailContent(Action<EmailContent> config) #ElementParameters
- config Action<EmailContent>
public EmailCredentialCard EmailCredentialCard() #EmailCredentialCardParameters
- config Action<EmailCredentialCard>
public EmailDateStrip EmailDateStrip() #EmailDateStripParameters
- config Action<EmailDateStrip>
public Element EmailDivider(Action<EmailDivider> config) #ElementParameters
- config Action<EmailDivider>
public EmailDnsRecordsTable EmailDnsRecordsTable() #EmailDnsRecordsTableParameters
- config Action<EmailDnsRecordsTable>
public EmailDonutChart EmailDonutChart() #EmailDonutChartParameters
- config Action<EmailDonutChart>
public EmailDownloadCard EmailDownloadCard() #EmailDownloadCardParameters
- config Action<EmailDownloadCard>
public EmailEmojiRating EmailEmojiRating() #EmailEmojiRatingParameters
- config Action<EmailEmojiRating>
public EmailEmptyStateCard EmailEmptyStateCard() #EmailEmptyStateCardParameters
- config Action<EmailEmptyStateCard>
public EmailEventCard EmailEventCard() #EmailEventCardParameters
- config Action<EmailEventCard>
public EmailFaqList EmailFaqList() #EmailFaqListParameters
- config Action<EmailFaqList>
public EmailFeatureList EmailFeatureList() #EmailFeatureListParameters
- config Action<EmailFeatureList>
public Element EmailHeading(Action<EmailHeading> config) #ElementParameters
- content String = ""
- level Int32 = 2
public EmailHeatmap EmailHeatmap() #EmailHeatmapParameters
- config Action<EmailHeatmap>
public EmailHero EmailHero() #EmailHeroParameters
- config Action<EmailHero>
public EmailIconCircle EmailIconCircle() #EmailIconCircleParameters
- config Action<EmailIconCircle>
public EmailImage EmailImage(String source, String width) #EmailImageParameters
- config Action<EmailImage>
public EmailIncidentSummaryCard EmailIncidentSummaryCard() #EmailIncidentSummaryCardParameters
- config Action<EmailIncidentSummaryCard>
public EmailInlineStack EmailInlineStack() #EmailInlineStackParameters
- config Action<EmailInlineStack>
public EmailInvoiceLineItemsTable EmailInvoiceLineItemsTable() #EmailInvoiceLineItemsTableParameters
- config Action<EmailInvoiceLineItemsTable>
public EmailInvoiceTotals EmailInvoiceTotals() #EmailInvoiceTotalsParameters
- config Action<EmailInvoiceTotals>
public EmailKeyValueTable EmailKeyValueTable() #EmailKeyValueTableParameters
- config Action<EmailKeyValueTable>
public EmailKpiDelta EmailKpiDelta() #EmailKpiDeltaParameters
- config Action<EmailKpiDelta>
public EmailLineBreak EmailLineBreak(String height) #EmailLineBreakParameters
- height String
public EmailLineItemsTable EmailLineItemsTable() #EmailLineItemsTableParameters
- config Action<EmailLineItemsTable>
public Element EmailLink(Action<EmailLink> config) #ElementParameters
- content String
- href String
public Element EmailList(Action<EmailList> config) #ElementParameters
- config Action<EmailList>
public EmailMapCard EmailMapCard() #EmailMapCardParameters
- config Action<EmailMapCard>
public EmailMediaObject EmailMediaObject() #EmailMediaObjectParameters
- config Action<EmailMediaObject>
public EmailMessageThread EmailMessageThread() #EmailMessageThreadParameters
- config Action<EmailMessageThread>
public EmailMetricTile EmailMetricTile(String value, String label, String icon = "") #EmailMetricTileParameters
- config Action<EmailMetricTile>
public EmailNpsRating EmailNpsRating() #EmailNpsRatingParameters
- config Action<EmailNpsRating>
public EmailOfferCard EmailOfferCard() #EmailOfferCardParameters
- config Action<EmailOfferCard>
public EmailOtpCode EmailOtpCode(String code) #EmailOtpCodeParameters
- config Action<EmailOtpCode>
public EmailPhotoCard EmailPhotoCard() #EmailPhotoCardParameters
- config Action<EmailPhotoCard>
public EmailPhotoGrid EmailPhotoGrid() #EmailPhotoGridParameters
- config Action<EmailPhotoGrid>
public EmailPricingTable EmailPricingTable() #EmailPricingTableParameters
- config Action<EmailPricingTable>
public EmailProductCard EmailProductCard() #EmailProductCardParameters
- config Action<EmailProductCard>
public EmailProductGrid EmailProductGrid() #EmailProductGridParameters
- config Action<EmailProductGrid>
public EmailProfileCard EmailProfileCard() #EmailProfileCardParameters
- config Action<EmailProfileCard>
public EmailProgressBar EmailProgressBar(Int32 value) #EmailProgressBarParameters
- config Action<EmailProgressBar>
public EmailProjectList EmailProjectList() #EmailProjectListParameters
- config Action<EmailProjectList>
public EmailPromoCodeCard EmailPromoCodeCard() #EmailPromoCodeCardParameters
- config Action<EmailPromoCodeCard>
public EmailQrCode EmailQrCode(String value) #EmailQrCodeParameters
- config Action<EmailQrCode>
public EmailReceiptCard EmailReceiptCard() #EmailReceiptCardParameters
- config Action<EmailReceiptCard>
public EmailRepoStatsCard EmailRepoStatsCard() #EmailRepoStatsCardParameters
- config Action<EmailRepoStatsCard>
public EmailReviewStars EmailReviewStars() #EmailReviewStarsParameters
- config Action<EmailReviewStars>
public EmailReviewSummary EmailReviewSummary() #EmailReviewSummaryParameters
- config Action<EmailReviewSummary>
public Element EmailRow(Action<EmailRow> config) #ElementParameters
- config Action<EmailRow>
public EmailScheduleCard EmailScheduleCard() #EmailScheduleCardParameters
- config Action<EmailScheduleCard>
public EmailScheduleList EmailScheduleList() #EmailScheduleListParameters
- config Action<EmailScheduleList>
public EmailShippingProgress EmailShippingProgress() #EmailShippingProgressParameters
- config Action<EmailShippingProgress>
public EmailSocialLinks EmailSocialLinks() #EmailSocialLinksParameters
- config Action<EmailSocialLinks>
public Element EmailSpacer(Action<EmailSpacer> config) #ElementParameters
- height String
public EmailSparklineBars EmailSparklineBars(params Int32[] values) #EmailSparklineBarsParameters
- config Action<EmailSparklineBars>
public EmailStatCard EmailStatCard(String title, String value, String subtitle = "", String delta = "", EmailTrendDirection trend = Neutral) #EmailStatCardParameters
- config Action<EmailStatCard>
public EmailStatusTimeline EmailStatusTimeline() #EmailStatusTimelineParameters
- config Action<EmailStatusTimeline>
public EmailStepsIndicator EmailStepsIndicator() #EmailStepsIndicatorParameters
- config Action<EmailStepsIndicator>
public EmailStoreBadges EmailStoreBadges() #EmailStoreBadgesParameters
- config Action<EmailStoreBadges>
public EmailSubscriptionSummaryCard EmailSubscriptionSummaryCard() #EmailSubscriptionSummaryCardParameters
- config Action<EmailSubscriptionSummaryCard>
public EmailSurveyOptions EmailSurveyOptions() #EmailSurveyOptionsParameters
- config Action<EmailSurveyOptions>
public Element EmailTable<T>(IEnumerable<T> data, Action<EmailDynamicTable<T>> config) #ElementType Parameters
- T
Parameters
- config Action<EmailTable>
public Element EmailText(Action<EmailText> config) #ElementParameters
- content String = ""
public EmailTextBlock EmailTextBlock() #EmailTextBlockParameters
- config Action<EmailTextBlock>
public EmailTodoList EmailTodoList() #EmailTodoListParameters
- config Action<EmailTodoList>
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
public override Element WithCssClass(String cssClass) #ElementParameters
- cssClass String
public override Element WithMargin(String margin) #ElementSets the vertical margin around the button.
Parameters
- margin System.String
- The margin value (e.g., "16px 0" for vertical spacing).
Returns
The EmailButton object, allowing for method chaining.
Properties
public String Text { get; set; } #Gets or sets the button text.
public String Href { get; set; } #Gets or sets the button link URL.
public EmailButtonStyle Style { get; set; } #Gets or sets the button style type.
public EmailButtonSize Size { get; set; } #Gets or sets the button size.
public virtual String BackgroundColor { get; set; } #Gets or sets the background color for custom styling.
public String TextColor { get; set; } #Gets or sets the text color for custom styling.
public virtual String BorderColor { get; set; } #Gets or sets the border color for custom styling.
public virtual String FontFamily { get; set; } #Gets or sets the font family for the button text.
public virtual String FontSize { get; set; } #Gets or sets the font size. This is overridden by the Size property when set.
public virtual String Color { get; set; } #Gets or sets the text color.
public virtual String LineHeight { get; set; } #Gets or sets the line height of the button text.
public virtual String TextAlign { get; set; } #Gets or sets the text alignment inside the button.
public virtual String FontWeight { get; set; } #Gets or sets the font weight of the button text.
public virtual String TextDecoration { get; set; } #Gets or sets the text decoration style (e.g., underline).
public virtual String BorderWidth { get; set; } #Gets or sets the width of the button border.
public virtual String BorderRadius { get; set; } #Gets or sets the border radius.
public virtual RoundingMode RoundingMode { get; set; } #Determines how border radius should be applied.
public Boolean FullWidth { get; set; } #Gets or sets whether the button should be full width.
public Boolean EnableOutlookVmlFallback { get; set; } #When enabled, renders an Outlook (MSO) VML v:roundrect fallback for rounded corners. This improves visual fidelity in classic Outlook for Windows (Word rendering engine).