API Reference
TablerMultiPageBuilder
Builder for creating multi-page applications with shared navigation.
Inheritance
- Object
- TablerMultiPageBuilder
Constructors
public TablerMultiPageBuilder() #Initializes a new instance of the TablerMultiPageBuilder class.
Methods
public TablerMultiPageBuilder AddPage(String id, String title, String fileName, Action<TablerPageBuilder> config) #TablerMultiPageBuilderAdds a page to the multi-page application.
Parameters
- id System.String
- title System.String
- fileName System.String
- config System.Action{HtmlForgeX.TablerPageBuilder}
public TablerMultiPageBuilder ConfigureDocument(Action<Document> configure) #TablerMultiPageBuilderApplies additional configuration to each generated Document. Use this to set global lazy-init defaults, custom head content, or other document-level behavior without duplicating the same setup for multi-page and single-file outputs.
Parameters
- configure System.Action{HtmlForgeX.Document}
public TablerMultiPageBuilder EnableCanonicalUrls(Boolean enable = true) #TablerMultiPageBuilderEnables emitting a canonical link tag for each generated page (requires String)).
Parameters
- enable System.Boolean = true
public TablerMultiPageBuilder EnableParallelGeneration(Boolean parallel = true) #TablerMultiPageBuilderEnables parallel page generation for better performance.
Parameters
- parallel System.Boolean = true
public TablerMultiPageBuilder EnableRobotsTxt(String fileName = "robots.txt") #TablerMultiPageBuilderEnables generating a robots.txt file in the output root. When sitemap generation is enabled and a base URL is set, a Sitemap: line is included.
Parameters
- fileName System.String = "robots.txt"
public TablerMultiPageBuilder EnableSitemap(String fileName = "sitemap.xml", Boolean includeLastModified = false) #TablerMultiPageBuilderEnables generating a sitemap.xml file in the output root (requires String)).
Parameters
- fileName System.String = "sitemap.xml"
- includeLastModified System.Boolean = false
public List<String> Generate(String outputDirectory, Boolean openInBrowser = false) #List<String>Generates all pages synchronously.
Parameters
- outputDirectory System.String
- openInBrowser System.Boolean = false
public async Task<List<String>> GenerateAsync(String outputDirectory, Boolean openInBrowser = false) #Task<List<String>>Generates all pages.
Parameters
- outputDirectory System.String
- openInBrowser System.Boolean = false
public String GenerateSingleFile(String outputFile, Boolean openInBrowser = false) #StringGenerates a single HTML document synchronously.
Parameters
- outputFile System.String
- openInBrowser System.Boolean = false
public async Task<String> GenerateSingleFileAsync(String outputFile, Boolean openInBrowser = false) #Task<String>Generates a single HTML document that keeps the shared navigation shell but swaps between registered pages inside the same file.
Parameters
- outputFile System.String
- openInBrowser System.Boolean = false
public TablerMultiPageBuilder WithBackgroundColor(String color) #TablerMultiPageBuilderSets the background color for all pages.
Parameters
- color System.String
public TablerMultiPageBuilder WithBackgroundGradient(String gradient) #TablerMultiPageBuilderSets the background gradient for all pages.
Parameters
- gradient System.String
public TablerMultiPageBuilder WithBackgroundPattern(String pattern) #TablerMultiPageBuilderSets the background pattern for all pages.
Parameters
- pattern System.String
public TablerMultiPageBuilder WithBaseUrl(String baseUrl) #TablerMultiPageBuilderSets the base URL used for absolute URL generation (canonical links, sitemap, robots sitemap pointer). Example: https://example.com/ or https://example.com/app/.
Parameters
- baseUrl System.String
public TablerMultiPageBuilder WithBrand(String brandText, String brandSubtitle = null) #TablerMultiPageBuilderSets the brand text for the navigation.
Parameters
- brandText System.String
- brandSubtitle System.String = null
public TablerMultiPageBuilder WithHomePageId(String pageId) #TablerMultiPageBuilderSets which page should be treated as the "home" page (brand link target). If not set, the builder will prefer a page with file name index.html, otherwise the first page added.
Parameters
- pageId System.String
public TablerMultiPageBuilder WithLayout(TablerLayout layout) #TablerMultiPageBuilderSets the layout type for all pages.
Parameters
- layout HtmlForgeX.TablerLayout
public TablerMultiPageBuilder WithLibraryMode(LibraryMode mode) #TablerMultiPageBuilderSets the library mode for all pages.
Parameters
- mode HtmlForgeX.LibraryMode
public TablerMultiPageBuilder WithLogo(String logoPath, TablerLogoSize size = Default) #TablerMultiPageBuilderConfigures the logo for the navigation.
Parameters
- logoPath System.String
- size HtmlForgeX.TablerLogoSize = Default
public TablerMultiPageBuilder WithOfflineAssetPaths(String scriptPath, String stylePath) #TablerMultiPageBuilderSets where embedded JS/CSS files are written when using OfflineWithFiles. Paths are relative to the output root directory (e.g. assets/js, assets/css).
Parameters
- scriptPath System.String
- stylePath System.String
public TablerMultiPageBuilder WithOfflineAssetPaths(String scriptPath, String stylePath, String imagePath) #TablerMultiPageBuilderSets where embedded JS/CSS/image files are written when using OfflineWithFiles. Paths are relative to the output root directory (e.g. assets/js, assets/css, assets/img).
Parameters
- scriptPath System.String
- stylePath System.String
- imagePath System.String
public TablerMultiPageBuilder WithThemeAccessibility(HfxThemeAccessibility accessibility) #TablerMultiPageBuilderEnables accessibility overrides for contrast/palette adjustments.
Parameters
- accessibility HtmlForgeX.HfxThemeAccessibility
public TablerMultiPageBuilder WithThemeMode(ThemeMode mode) #TablerMultiPageBuilderSets the theme mode for all pages.
Parameters
- mode HtmlForgeX.ThemeMode
public TablerMultiPageBuilder WithThemeVariants(HfxThemeVariant light = Default, HfxThemeVariant dark = Default) #TablerMultiPageBuilderSets the default theme variants used by documents when the resolved mode is light/dark. For example, you can enable a deeper dark mode via DarkBlack or DarkCarbon.
Parameters
- light HtmlForgeX.HfxThemeVariant = Default
- dark HtmlForgeX.HfxThemeVariant = Default