API Reference
Class
EmailLink
Represents a link element for email layouts with email-safe styling and attributes. Provides clickable text links with customizable fonts, colors, and text formatting.
Inheritance
- Element
- EmailLink
Constructors
EmailLink 3 overloads
public EmailLink(String content, String href) #Initializes a new instance of the EmailLink class with content and URL.
Parameters
- content System.String
- The link text content.
- href System.String
- The link URL.
public EmailLink(String content, String href, Boolean openInNewWindow) #Initializes a new instance of the EmailLink class with content, URL, and new window setting.
Parameters
- content System.String
- The link text content.
- href System.String
- The link URL.
- openInNewWindow System.Boolean
- Whether to open in a new window.
Methods
public String GetThemeHoverColor() #Returns:
StringGets the appropriate hover color based on theme mode.
IsInEmailColumn() #Checks if this EmailLink is being rendered inside an EmailColumn.
Returns
True if inside an EmailColumn, false otherwise.
public override String ToString() #Returns:
StringConverts the EmailLink to its HTML representation.
Returns
HTML string representing the email link.
public virtual EmailLink WithAlignment(Alignment alignment) #Returns:
EmailLinkSets the text alignment.
Parameters
- alignment HtmlForgeX.Email.Alignment
- The alignment option.
Returns
The EmailLink instance.
WithColor 2 overloads
public virtual EmailLink WithColor(RGBColor color) #Returns:
EmailLinkSets the link color.
Parameters
- color System.String
- The link color.
Returns
The EmailLink object, allowing for method chaining.
WithColor(HtmlForgeX.Email.RGBColor color) #Sets the link color using RGBColor.
Parameters
- color HtmlForgeX.Email.RGBColor
- The link color.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithContent(String content) #Returns:
EmailLinkSets the link text content.
Parameters
- content System.String
- The link text content.
Returns
The EmailLink object, allowing for method chaining.
public virtual EmailLink WithFontFamily(String fontFamily) #Returns:
EmailLinkSets the font family.
Parameters
- fontFamily System.String
- The font family.
Returns
The EmailLink object, allowing for method chaining.
WithFontSize 2 overloads
public virtual EmailLink WithFontSize(EmailFontSize fontSize) #Returns:
EmailLinkSets the font size.
Parameters
- fontSize System.String
- The font size.
Returns
The EmailLink object, allowing for method chaining.
WithFontSize(HtmlForgeX.Email.EmailFontSize fontSize) #Sets the font size using predefined values.
Parameters
- fontSize HtmlForgeX.Email.EmailFontSize
- The predefined font size.
Returns
The EmailLink object, allowing for method chaining.
WithFontWeight 2 overloads
public virtual EmailLink WithFontWeight(FontWeight fontWeight) #Returns:
EmailLinkSets the font weight.
Parameters
- fontWeight System.String
- The font weight.
Returns
The EmailLink object, allowing for method chaining.
WithFontWeight(HtmlForgeX.Email.FontWeight fontWeight) #Sets the font weight using predefined values.
Parameters
- fontWeight HtmlForgeX.Email.FontWeight
- The predefined font weight.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithHoverColor(String hoverColor) #Returns:
EmailLinkSets the hover color for the link.
Parameters
- hoverColor System.String
- The hover color.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithHref(String href) #Returns:
EmailLinkSets the link URL.
Parameters
- href System.String
- The link URL.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithInlineStyle(String style) #Returns:
EmailLinkAdds custom inline styles.
Parameters
- style System.String
- The inline style to add.
Returns
The EmailLink object, allowing for method chaining.
public virtual EmailLink WithLineHeight(String lineHeight) #Returns:
EmailLinkSets the line height.
Parameters
- lineHeight System.String
- The line height.
Returns
The EmailLink object, allowing for method chaining.
WithMargin 3 overloads
WithMargin(HtmlForgeX.Email.EmailSpacing spacing) #Sets the margin using predefined spacing values.
Parameters
- spacing HtmlForgeX.Email.EmailSpacing
- The predefined spacing value for all sides.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithMargin(EmailSpacing vertical, EmailSpacing horizontal) #Returns:
EmailLinkSets the margin using predefined spacing values for vertical and horizontal.
Parameters
- vertical HtmlForgeX.Email.EmailSpacing
- The predefined vertical spacing (top and bottom).
- horizontal HtmlForgeX.Email.EmailSpacing
- The predefined horizontal spacing (left and right).
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithMargin(EmailSpacing top, EmailSpacing right, EmailSpacing bottom, EmailSpacing left) #Returns:
EmailLinkSets the margin using predefined spacing values for all sides.
Parameters
- top HtmlForgeX.Email.EmailSpacing
- The predefined top spacing.
- right HtmlForgeX.Email.EmailSpacing
- The predefined right spacing.
- bottom HtmlForgeX.Email.EmailSpacing
- The predefined bottom spacing.
- left HtmlForgeX.Email.EmailSpacing
- The predefined left spacing.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithNewWindow(Boolean openInNewWindow = true) #Returns:
EmailLinkSets whether the link should open in a new window.
Parameters
- openInNewWindow System.Boolean = true
- Whether to open in a new window.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithoutUnderlineOnHover() #Returns:
EmailLinkDisables underline on hover.
Returns
The EmailLink object, allowing for method chaining.
WithTextDecoration 2 overloads
public virtual EmailLink WithTextDecoration(TextDecoration decoration) #Returns:
EmailLinkSets the text decoration.
Parameters
- textDecoration System.String
- The text decoration.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithTitle(String title) #Returns:
EmailLinkSets the link title (tooltip text).
Parameters
- title System.String
- The title text.
Returns
The EmailLink object, allowing for method chaining.
public EmailLink WithUnderlineOnHover() #Returns:
EmailLinkEnables underline on hover.
Returns
The EmailLink object, allowing for method chaining.
Inherited Methods
public override Element Add(Element element) #Returns:
ElementInherited from Element
Parameters
- element Element
public override Element AddCssClass(String cssClass) #Returns:
ElementInherited from Element
Parameters
- cssClass String
public EmailActivityList EmailActivityList() #Returns:
EmailActivityListInherited from Element
Parameters
- config Action<EmailActivityList>
public EmailAddressBlock EmailAddressBlock() #Returns:
EmailAddressBlockInherited from Element
Parameters
- config Action<EmailAddressBlock>
public EmailAddressCard EmailAddressCard() #Returns:
EmailAddressCardInherited from Element
Parameters
- config Action<EmailAddressCard>
public EmailAlert EmailAlert(EmailAlertType type, String title, String message = "") #Returns:
EmailAlertInherited from Element
Parameters
- config Action<EmailAlert>
public EmailArticleCard EmailArticleCard() #Returns:
EmailArticleCardInherited from Element
Parameters
- config Action<EmailArticleCard>
public EmailArticleList EmailArticleList() #Returns:
EmailArticleListInherited from Element
Parameters
- config Action<EmailArticleList>
public EmailAttachmentList EmailAttachmentList() #Returns:
EmailAttachmentListInherited from Element
Parameters
- config Action<EmailAttachmentList>
public EmailAvatar EmailAvatar(String initials, String size = "40px") #Returns:
EmailAvatarInherited from Element
Parameters
- config Action<EmailAvatar>
public EmailAvatarStack EmailAvatarStack() #Returns:
EmailAvatarStackInherited from Element
Parameters
- config Action<EmailAvatarStack>
public EmailBackgroundImageBox EmailBackgroundImageBox() #Returns:
EmailBackgroundImageBoxInherited from Element
Parameters
- config Action<EmailBackgroundImageBox>
public EmailBadge EmailBadge(String text, String backgroundColor = "#64748B", String color = "#FFFFFF") #Returns:
EmailBadgeInherited from Element
Parameters
- config Action<EmailBadge>
public EmailBadgeList EmailBadgeList() #Returns:
EmailBadgeListInherited from Element
Parameters
- config Action<EmailBadgeList>
public EmailBarChart EmailBarChart() #Returns:
EmailBarChartInherited from Element
Parameters
- config Action<EmailBarChart>
public EmailBarcode EmailBarcode(String value) #Returns:
EmailBarcodeInherited from Element
Parameters
- config Action<EmailBarcode>
public Element EmailBlockquote(Action<EmailBlockquote> config) #Returns:
ElementInherited from Element
Parameters
- content String = ""
public Element EmailBox(Action<EmailBox> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailBox>
public Element EmailBoxWithBuilder(Action<EmailBoxBuilder> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailBoxBuilder>
public EmailBrandStrip EmailBrandStrip() #Returns:
EmailBrandStripInherited from Element
Parameters
- config Action<EmailBrandStrip>
public Element EmailButton(Action<EmailButton> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailButton>
public EmailButtonGroup EmailButtonGroup() #Returns:
EmailButtonGroupInherited from Element
Parameters
- config Action<EmailButtonGroup>
public EmailCalendar EmailCalendar() #Returns:
EmailCalendarInherited from Element
Parameters
- config Action<EmailCalendar>
public EmailCalloutCard EmailCalloutCard() #Returns:
EmailCalloutCardInherited from Element
Parameters
- config Action<EmailCalloutCard>
public EmailChangelog EmailChangelog() #Returns:
EmailChangelogInherited from Element
Parameters
- config Action<EmailChangelog>
public Element EmailColumn(Action<EmailColumn> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailColumn>
public EmailCommentList EmailCommentList() #Returns:
EmailCommentListInherited from Element
Parameters
- config Action<EmailCommentList>
public EmailComparisonTable EmailComparisonTable() #Returns:
EmailComparisonTableInherited from Element
Parameters
- config Action<EmailComparisonTable>
public Element EmailContent(Action<EmailContent> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailContent>
public EmailCredentialCard EmailCredentialCard() #Returns:
EmailCredentialCardInherited from Element
Parameters
- config Action<EmailCredentialCard>
public EmailDateStrip EmailDateStrip() #Returns:
EmailDateStripInherited from Element
Parameters
- config Action<EmailDateStrip>
public Element EmailDivider(Action<EmailDivider> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailDivider>
public EmailDnsRecordsTable EmailDnsRecordsTable() #Returns:
EmailDnsRecordsTableInherited from Element
Parameters
- config Action<EmailDnsRecordsTable>
public EmailDonutChart EmailDonutChart() #Returns:
EmailDonutChartInherited from Element
Parameters
- config Action<EmailDonutChart>
public EmailDownloadCard EmailDownloadCard() #Returns:
EmailDownloadCardInherited from Element
Parameters
- config Action<EmailDownloadCard>
public EmailEmojiRating EmailEmojiRating() #Returns:
EmailEmojiRatingInherited from Element
Parameters
- config Action<EmailEmojiRating>
public EmailEmptyStateCard EmailEmptyStateCard() #Returns:
EmailEmptyStateCardInherited from Element
Parameters
- config Action<EmailEmptyStateCard>
public EmailEventCard EmailEventCard() #Returns:
EmailEventCardInherited from Element
Parameters
- config Action<EmailEventCard>
public EmailFaqList EmailFaqList() #Returns:
EmailFaqListInherited from Element
Parameters
- config Action<EmailFaqList>
public EmailFeatureList EmailFeatureList() #Returns:
EmailFeatureListInherited from Element
Parameters
- config Action<EmailFeatureList>
public Element EmailHeading(Action<EmailHeading> config) #Returns:
ElementInherited from Element
Parameters
- content String = ""
- level Int32 = 2
public EmailHeatmap EmailHeatmap() #Returns:
EmailHeatmapInherited from Element
Parameters
- config Action<EmailHeatmap>
public EmailHero EmailHero() #Returns:
EmailHeroInherited from Element
Parameters
- config Action<EmailHero>
public EmailIconCircle EmailIconCircle() #Returns:
EmailIconCircleInherited from Element
Parameters
- config Action<EmailIconCircle>
public EmailImage EmailImage(String source, String width) #Returns:
EmailImageInherited from Element
Parameters
- config Action<EmailImage>
public EmailIncidentSummaryCard EmailIncidentSummaryCard() #Returns:
EmailIncidentSummaryCardInherited from Element
Parameters
- config Action<EmailIncidentSummaryCard>
public EmailInlineStack EmailInlineStack() #Returns:
EmailInlineStackInherited from Element
Parameters
- config Action<EmailInlineStack>
public EmailInvoiceLineItemsTable EmailInvoiceLineItemsTable() #Returns:
EmailInvoiceLineItemsTableInherited from Element
Parameters
- config Action<EmailInvoiceLineItemsTable>
public EmailInvoiceTotals EmailInvoiceTotals() #Returns:
EmailInvoiceTotalsInherited from Element
Parameters
- config Action<EmailInvoiceTotals>
public EmailKeyValueTable EmailKeyValueTable() #Returns:
EmailKeyValueTableInherited from Element
Parameters
- config Action<EmailKeyValueTable>
public EmailKpiDelta EmailKpiDelta() #Returns:
EmailKpiDeltaInherited from Element
Parameters
- config Action<EmailKpiDelta>
public EmailLineBreak EmailLineBreak(String height) #Returns:
EmailLineBreakInherited from Element
Parameters
- height String
public EmailLineItemsTable EmailLineItemsTable() #Returns:
EmailLineItemsTableInherited from Element
Parameters
- config Action<EmailLineItemsTable>
public Element EmailLink(Action<EmailLink> config) #Returns:
ElementInherited from Element
Parameters
- content String
- href String
public Element EmailList(Action<EmailList> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailList>
public EmailMapCard EmailMapCard() #Returns:
EmailMapCardInherited from Element
Parameters
- config Action<EmailMapCard>
public EmailMediaObject EmailMediaObject() #Returns:
EmailMediaObjectInherited from Element
Parameters
- config Action<EmailMediaObject>
public EmailMessageThread EmailMessageThread() #Returns:
EmailMessageThreadInherited from Element
Parameters
- config Action<EmailMessageThread>
public EmailMetricTile EmailMetricTile(String value, String label, String icon = "") #Returns:
EmailMetricTileInherited from Element
Parameters
- config Action<EmailMetricTile>
public EmailNpsRating EmailNpsRating() #Returns:
EmailNpsRatingInherited from Element
Parameters
- config Action<EmailNpsRating>
public EmailOfferCard EmailOfferCard() #Returns:
EmailOfferCardInherited from Element
Parameters
- config Action<EmailOfferCard>
public EmailOtpCode EmailOtpCode(String code) #Returns:
EmailOtpCodeInherited from Element
Parameters
- config Action<EmailOtpCode>
public EmailPhotoCard EmailPhotoCard() #Returns:
EmailPhotoCardInherited from Element
Parameters
- config Action<EmailPhotoCard>
public EmailPhotoGrid EmailPhotoGrid() #Returns:
EmailPhotoGridInherited from Element
Parameters
- config Action<EmailPhotoGrid>
public EmailPricingTable EmailPricingTable() #Returns:
EmailPricingTableInherited from Element
Parameters
- config Action<EmailPricingTable>
public EmailProductCard EmailProductCard() #Returns:
EmailProductCardInherited from Element
Parameters
- config Action<EmailProductCard>
public EmailProductGrid EmailProductGrid() #Returns:
EmailProductGridInherited from Element
Parameters
- config Action<EmailProductGrid>
public EmailProfileCard EmailProfileCard() #Returns:
EmailProfileCardInherited from Element
Parameters
- config Action<EmailProfileCard>
public EmailProgressBar EmailProgressBar(Int32 value) #Returns:
EmailProgressBarInherited from Element
Parameters
- config Action<EmailProgressBar>
public EmailProjectList EmailProjectList() #Returns:
EmailProjectListInherited from Element
Parameters
- config Action<EmailProjectList>
public EmailPromoCodeCard EmailPromoCodeCard() #Returns:
EmailPromoCodeCardInherited from Element
Parameters
- config Action<EmailPromoCodeCard>
public EmailQrCode EmailQrCode(String value) #Returns:
EmailQrCodeInherited from Element
Parameters
- config Action<EmailQrCode>
public EmailReceiptCard EmailReceiptCard() #Returns:
EmailReceiptCardInherited from Element
Parameters
- config Action<EmailReceiptCard>
public EmailRepoStatsCard EmailRepoStatsCard() #Returns:
EmailRepoStatsCardInherited from Element
Parameters
- config Action<EmailRepoStatsCard>
public EmailReviewStars EmailReviewStars() #Returns:
EmailReviewStarsInherited from Element
Parameters
- config Action<EmailReviewStars>
public EmailReviewSummary EmailReviewSummary() #Returns:
EmailReviewSummaryInherited from Element
Parameters
- config Action<EmailReviewSummary>
public Element EmailRow(Action<EmailRow> config) #Returns:
ElementInherited from Element
Parameters
- config Action<EmailRow>
public EmailScheduleCard EmailScheduleCard() #Returns:
EmailScheduleCardInherited from Element
Parameters
- config Action<EmailScheduleCard>
public EmailScheduleList EmailScheduleList() #Returns:
EmailScheduleListInherited from Element
Parameters
- config Action<EmailScheduleList>
public EmailShippingProgress EmailShippingProgress() #Returns:
EmailShippingProgressInherited from Element
Parameters
- config Action<EmailShippingProgress>
public EmailSocialLinks EmailSocialLinks() #Returns:
EmailSocialLinksInherited from Element
Parameters
- config Action<EmailSocialLinks>
public Element EmailSpacer(Action<EmailSpacer> config) #Returns:
ElementInherited from Element
Parameters
- height String
public EmailSparklineBars EmailSparklineBars(params Int32[] values) #Returns:
EmailSparklineBarsInherited from Element
Parameters
- config Action<EmailSparklineBars>
public EmailStatCard EmailStatCard(String title, String value, String subtitle = "", String delta = "", EmailTrendDirection trend = Neutral) #Returns:
EmailStatCardInherited from Element
Parameters
- config Action<EmailStatCard>
public EmailStatusTimeline EmailStatusTimeline() #Returns:
EmailStatusTimelineInherited from Element
Parameters
- config Action<EmailStatusTimeline>
public EmailStepsIndicator EmailStepsIndicator() #Returns:
EmailStepsIndicatorInherited from Element
Parameters
- config Action<EmailStepsIndicator>
public EmailStoreBadges EmailStoreBadges() #Returns:
EmailStoreBadgesInherited from Element
Parameters
- config Action<EmailStoreBadges>
public EmailSubscriptionSummaryCard EmailSubscriptionSummaryCard() #Returns:
EmailSubscriptionSummaryCardInherited from Element
Parameters
- config Action<EmailSubscriptionSummaryCard>
public EmailSurveyOptions EmailSurveyOptions() #Returns:
EmailSurveyOptionsInherited from Element
Parameters
- config Action<EmailSurveyOptions>
public Element EmailTable<T>(IEnumerable<T> data, Action<EmailDynamicTable<T>> config) #Returns:
ElementInherited from Element
Type Parameters
- T
Parameters
- config Action<EmailTable>
public Element EmailText(Action<EmailText> config) #Returns:
ElementInherited from Element
Parameters
- content String = ""
public EmailTextBlock EmailTextBlock() #Returns:
EmailTextBlockInherited from Element
Parameters
- config Action<EmailTextBlock>
public EmailTodoList EmailTodoList() #Returns:
EmailTodoListInherited from Element
Parameters
- config Action<EmailTodoList>
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public override Void EvaluateLayout(LayoutContext context) #Returns:
VoidInherited from Element
Parameters
- context LayoutContext
public override Element WithCssClass(String cssClass) #Returns:
ElementInherited from Element
Sets the CSS class for the link.
Parameters
- cssClass System.String
- The CSS class.
Returns
The EmailLink object, allowing for method chaining.
public override Element WithMargin(String margin) #Returns:
ElementInherited from Element
Sets the margin.
Parameters
- margin System.String
- The margin value.
Returns
The EmailLink object, allowing for method chaining.
Properties
public String Content { get; set; } #Gets or sets the link text content.
public virtual String FontFamily { get; set; } #Gets or sets the font family.
public virtual String FontSize { get; set; } #Gets or sets the font size.
public virtual String LineHeight { get; set; } #Gets or sets the line height.
public virtual String Color { get; set; } #Gets or sets the link color.
public virtual String TextAlign { get; set; } #Gets or sets the text alignment.
public virtual String FontWeight { get; set; } #Gets or sets the font weight.
public virtual String TextDecoration { get; set; } #Gets or sets the text decoration.
public Boolean OpenInNewWindow { get; set; } #Gets or sets whether the link should open in a new window.
public String Title { get; set; } #Gets or sets the link title (tooltip text).
public String InlineStyle { get; set; } #Gets or sets additional inline styles.
public String HoverColor { get; set; } #Gets or sets the hover color for the link.
public Boolean UnderlineOnHover { get; set; } #Gets or sets whether to underline the link on hover.