API Reference
Class
DocumentConfiguration
Configuration class for email documents.
Inheritance
- Object
- DocumentConfiguration
Constructors
public DocumentConfiguration() #Methods
public Void AddDiagnostic(EmailDiagnostic diagnostic) #Returns:
VoidAdds a diagnostic entry to the configuration.
Parameters
- diagnostic HtmlForgeX.Email.EmailDiagnostic
- The diagnostic to add.
public Int32 GetDiagnosticCount(Nullable<EmailDiagnosticSeverity> severity = null, Nullable<EmailDiagnosticCategory> category = null) #Returns:
Int32Gets the number of diagnostics optionally filtered by severity and category.
Parameters
- severity System.Nullable{HtmlForgeX.Email.EmailDiagnosticSeverity} = null
- category System.Nullable{HtmlForgeX.Email.EmailDiagnosticCategory} = null
public IReadOnlyList<EmailDiagnostic> GetDiagnostics(Nullable<EmailDiagnosticSeverity> severity = null, Nullable<EmailDiagnosticCategory> category = null) #Returns:
IReadOnlyList<EmailDiagnostic>Returns diagnostics optionally filtered by severity and category.
Parameters
- severity System.Nullable{HtmlForgeX.Email.EmailDiagnosticSeverity} = null
- category System.Nullable{HtmlForgeX.Email.EmailDiagnosticCategory} = null
public IReadOnlyList<EmailDiagnostic> GetDiagnosticsSnapshot() #Returns:
IReadOnlyList<EmailDiagnostic>Returns a point-in-time snapshot of diagnostics.
Inherited Methods
Properties
public Boolean DarkModeSupport { get; set; } #Gets or sets whether dark mode support is enabled.
public IReadOnlyCollection<EmailDiagnostic> Diagnostics { get; } #Collection of diagnostics that occurred during document generation.
public EmailConfiguration Email { get; } #Email-specific configuration.
public Int32 MaxWidth { get; set; } #Gets or sets the maximum width for the email content (in pixels). Convenience wrapper around MaxWidth.
public ImageConfiguration Images { get; } #Image-specific configuration.
public LayoutConfiguration Layout { get; } #Layout-specific configuration.