API Reference
DocumentConfiguration
Configuration class for Document instances. It keeps track of library references, theme selection and output paths used when generating HTML documents.
Inheritance
- Object
- DocumentConfiguration
Constructors
public DocumentConfiguration() #Methods
public String GenerateRandomId(String preText, Int32 length = 8) #StringGenerates a random ID with the specified prefix.
Parameters
- preText System.String
- The prefix for the ID.
- length System.Int32 = 8
- Length of the random part (default: 8).
Returns
Generated identifier.
Inherited Methods
Properties
public LibraryMode LibraryMode { get; set; } #Gets or sets the library mode for this document.
public String HtmlLanguage { get; set; } #Gets or sets the default language for the root <html> element. Set to null/empty to omit the attribute.
public ThemeMode ThemeMode { get; set; } #Gets or sets the theme mode for this document.
public HfxThemeVariant LightThemeVariant { get; set; } #Default variant used when the effective theme is light.
public HfxThemeVariant DarkThemeVariant { get; set; } #Default variant used when the effective theme is dark.
public HfxThemeAccessibility ThemeAccessibility { get; set; } #Accessibility overrides for contrast/palette adjustments.
public String Path { get; set; } #Gets or sets the file path for this document.
public String StylePath { get; set; } #Gets or sets the style path for this document.
public String ScriptPath { get; set; } #Gets or sets the script path for this document.
public Boolean EnableDeferredScripts { get; set; } #Gets or sets whether deferred scripts are enabled.
public Boolean DarkModeSupport { get; set; } #Gets or sets whether dark mode support is enabled.
public String DarkModeStorageKey { get; set; } #Gets or sets the localStorage key used to persist the user's theme preference.
public String ThemeAccessibilityStorageKey { get; set; } #Gets or sets the localStorage key used to persist accessibility overrides.
public ConcurrentDictionary<Libraries, Byte> Libraries { get; } #Collection of libraries registered for this document. Acts as a thread-safe set to avoid duplicate registrations.
public ConcurrentDictionary<String, Library> CustomLibraries { get; } #Custom libraries registered for this document (non-enum libraries). Used for libraries that must contribute to Body/Footer sections as well (e.g., helper initializers).
public ConcurrentBag<String> Errors { get; } #Collection of errors that occurred during document generation.
public CdnConfiguration Cdn { get; } #CDN configuration used when LibraryMode is Online.
public ImageConfiguration Images { get; } #Image-specific configuration.
public LayoutConfiguration Layout { get; } #Layout-specific configuration.
public DataTablesGlobalConfig DataTables { get; } #DataTables-specific global configuration.
public ApexChartsGlobalConfig ApexCharts { get; } #ApexCharts-specific global configuration.
public ChartJsGlobalConfig ChartJs { get; } #Chart.js-specific global configuration.
public VisNetworkGlobalConfig VisNetwork { get; } #VisNetwork-specific global configuration.
public MapboxGlobalConfig Mapbox { get; } #Mapbox-specific global configuration.
public LeafletGlobalConfig Leaflet { get; } #Leaflet-specific global configuration.
public GlobeGlGlobalConfig Globe { get; } #Globe-specific global configuration.
public JsVectorMapGlobalConfig JsVectorMap { get; } #jsVectorMap-specific global configuration.
public DeepLinksGlobalConfig DeepLinks { get; } #Deep-linking global configuration (tabs activation + optional DataTables search from URL).
public VisibilityGlobalConfig Visibility { get; } #Visibility / deferred-initialization configuration used by HtmlForgeX helper scripts.
public TablerThemeGlobalConfig TablerTheme { get; } #Global Tabler theme configuration applied via data-bs-theme-* attributes.
public TabsGlobalConfig Tabs { get; } #Global configuration for Bootstrap/Tabler tabs.
public SmartWizardGlobalConfig SmartWizard { get; } #Global configuration for SmartWizard.
public IMarkdownProvider MarkdownProvider { get; set; } #Optional Markdown provider used by MarkdownOptions). When null, the built-in Markdown renderer is used.
public Dictionary<String, String> SmartTabCssVars { get; } #Document-wide default CSS variables for SmartTab themes. Keys should be valid CSS custom properties (e.g., "--st-anchor-active-primary-color").
public List<String> JsVectorMarkerDefaultPalette { get; } #Default palette used by jsVectorMap for implicit marker category series created via AddMarker(lat,lng,name, categoryKey). Entries should be hex colors.