API Reference
HtmlReportConfig
Options to include or exclude sections/tabs from the HTML report.
Inheritance
- Object
- HtmlReportConfig
Constructors
public HtmlReportConfig() #Inherited Methods
Properties
public String FilePath { get; set; } #Optional output path for the HTML report; overrides default when set.
public Nullable<Boolean> IncludeAboutTab { get; set; } #Include the About tab. Default: true.
public Nullable<Boolean> IncludeDiagnosticsTab { get; set; } #Include the Diagnostics tab. Default: true.
public Nullable<Boolean> IncludeForestTab { get; set; } #Include the Forest tab when there are forest-scope rules. Default: true.
public Nullable<Boolean> IncludeRuleDetails { get; set; } #Include per‑rule Details content (results, assertions, errors). Default: true.
public Nullable<Boolean> IncludeRuleGuidance { get; set; } #Include rule Guidance (Summary/Why/How/References and vendor mapping). Default: true.
public Nullable<Boolean> IncludeMatchDetails { get; set; } #Include vendor mapping rows and per‑vendor counts. Default: true.
public Nullable<Boolean> IncludeDocs { get; set; } #Include vendor documentation links (Reference column, vendor docs counts). Default: true.
public Nullable<Boolean> IncludeCharts { get; set; } #Render charts in Summary/Overview/Domain/DC/Diagnostics. Default: true.
public Nullable<HtmlReportTheme> Theme { get; set; } #Theme selection for HTML report.
public Nullable<Boolean> Trace { get; set; } #Enable verbose HTML render tracing to the run log. Default: false.
public Nullable<HtmlCatalogSource> CatalogSource { get; set; } #Source for the catalog rows shown in About tab.
public Nullable<Boolean> UsePrecomputedCrosswalkOnly { get; set; } #When true (default), HTML renderer uses only the precomputed Crosswalk snapshot.
public Nullable<Boolean> NoHashTabs { get; set; } #When true, all HtmlForgeX TablerTabs instances in the report render their tab triggers as buttons instead of anchor links to avoid URL hash changes and scroll jumps when switching tabs. This can improve responsiveness for very large offline reports with many nested tabs. Default: false (opt-in).
public Nullable<Boolean> ViewportLazyInit { get; set; } #When true, HtmlForgeX deferred initialization waits until elements enter the viewport (IntersectionObserver), not just until they are displayed (e.g., after expanding an accordion or switching a tab). This can reduce initial load time and memory usage for large reports by deferring tables/charts below the fold. Default: false (opt-in).
public String ViewportLazyInitRootMargin { get; set; } #Optional IntersectionObserver root margin used when ViewportLazyInit is enabled. Example values: "200px" or "200px 0px". When null, HtmlForgeX uses its default.
public Nullable<Double> ViewportLazyInitThreshold { get; set; } #Optional IntersectionObserver threshold used when ViewportLazyInit is enabled. Valid range: 0..1. When null, HtmlForgeX uses its default.
public Nullable<Int32> DataTablesSearchDelayMs { get; set; } #Optional DataTables searchDelay (milliseconds) applied globally in the report. This can significantly reduce UI jank when typing into DataTables search boxes on pages with many tables. When null, HtmlForgeX uses its default behavior.
public Nullable<Boolean> SmartTabReportMode { get; set; } #When true, HtmlForgeX applies "report-safe" defaults to SmartTab instances that haven't explicitly configured URL hash/back-button/keyboard/auto-height behaviors. This is recommended for large reports that render many SmartTabs to avoid excessive history updates and handlers. Default: false (opt-in).
public Nullable<Boolean> SmartWizardReportMode { get; set; } #When true, HtmlForgeX applies "report-safe" defaults to SmartWizard instances that haven't explicitly configured URL hash/back-button/keyboard/auto-height behaviors. This is recommended for large reports that render many wizards to avoid excessive history updates and handlers. Default: false (opt-in).