API Reference
Class
EmailHeader
Represents a flexible email header section that works like Body. Users can directly call email.Header.EmailRow(), email.Header.EmailContent(), etc.
Inheritance
- EmailContainer
- EmailHeader
Constructors
public EmailHeader() #Initializes a new instance of the EmailHeader class.
Methods
PropagateEmailReference(HtmlForgeX.Email.Element element, HtmlForgeX.Email.Email email) #Recursively propagates the Email reference to an element and all its children.
Parameters
- element HtmlForgeX.Email.Element
- The element to propagate to.
- email HtmlForgeX.Email.Email
- The Email instance to propagate.
public override String ToString() #Returns:
StringConverts the EmailHeader to its HTML representation.
Returns
HTML string representing the email header.
WithBackground 2 overloads
public EmailHeader WithBackground(RGBColor color) #Returns:
EmailHeaderSets the header background color.
Parameters
- color System.String
- The background color.
Returns
The EmailHeader object, allowing for method chaining.
WithBackground(HtmlForgeX.Email.RGBColor color) #Sets the header background color.
Parameters
- color HtmlForgeX.Email.RGBColor
- The background color.
Returns
The EmailHeader object, allowing for method chaining.
Inherited Methods
public override Element Add(Element element) #Returns:
ElementInherited from Element
Adds an element to the header.
Parameters
- element HtmlForgeX.Email.Element
- The element to add.
Returns
The EmailHeader object, allowing for method chaining.
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
Adds an EmailContent section to the header.
Parameters
- configure System.Action{HtmlForgeX.Email.EmailContent}
- Action to configure the content.
Returns
The EmailHeader object, allowing for method chaining.
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>
EmailImage 2 overloads
public EmailImage EmailImage(String source, String width) #Returns:
EmailImageInherited from Element
Adds an EmailImage to the header.
Parameters
- source String
- width String
Returns
The EmailImage object, allowing for method chaining.
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
Adds an EmailLink to the header.
Parameters
- text System.String
- The link text.
- url System.String
- The link URL.
Returns
The EmailLink object, allowing for method chaining.
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
Adds an EmailRow to the header.
Parameters
- configure System.Action{HtmlForgeX.Email.EmailRow}
- Action to configure the row.
Returns
The EmailHeader object, allowing for method chaining.
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
Adds an EmailText to the header.
Parameters
- text System.String = ""
- The text content.
Returns
The EmailText object, allowing for method chaining.
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
Parameters
- cssClass String
public override Element WithMargin(String margin) #Returns:
ElementInherited from Element
Parameters
- margin String
public override Element WithPadding(String padding) #Returns:
ElementInherited from Element
Sets the header padding.
Parameters
- padding System.String
- The padding value.
Returns
The EmailHeader object, allowing for method chaining.
public EmailContainer WithSpacingMode(SpacingMode mode) #Returns:
EmailContainerInherited from EmailContainer
Sets the spacing mode for header elements.
Parameters
- mode HtmlForgeX.Email.SpacingMode
- Spacing mode.
Returns
The EmailHeader object.
Properties
public String BackgroundColor { get; set; } #Gets or sets the background color for the header section.
Inherited Properties
public override sealed SpacingMode SpacingMode { get; set; } #Inherited from EmailContainer