HtmlForgeX

API Reference

Class

MultiPageDocument

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Core/MultiPageDocument.cs:18
Implements
IDisposable
Attributes
EditorBrowsable(2) Obsolete("Legacy multi-page API. Prefer TablerMultiPageBuilder (HtmlForgeX.Containers.Tabler.Navigation).", false)

Represents a collection of related HTML documents that can be generated as a multi-page site.

Inheritance

  • Object
  • MultiPageDocument

Constructors

public MultiPageDocument(LibraryMode libraryMode = Online, ThemeMode themeMode = Light) #
Core/MultiPageDocument.cs:18

Initializes a new instance of the MultiPageDocument class.

Parameters

libraryMode HtmlForgeX.LibraryMode = Online optionalposition: 0
themeMode HtmlForgeX.ThemeMode = Light optionalposition: 1

Methods

public MultiPageDocument AddPage(String pageId, String fileName, String title, Action<Document> config) #
Core/MultiPageDocument.cs:72
Returns: MultiPageDocument

Adds a page to the multi-page document.

Parameters

pageId System.String requiredposition: 0
fileName System.String requiredposition: 1
title System.String requiredposition: 2
config System.Action{HtmlForgeX.Document} requiredposition: 3
public MultiPageDocument AddPageWithLayout(String pageId, String fileName, String title, Action<TablerLayoutPage> config) #
Core/MultiPageDocument.cs:118
Returns: MultiPageDocument

Adds a page with direct layout configuration.

Parameters

pageId System.String requiredposition: 0
fileName System.String requiredposition: 1
title System.String requiredposition: 2
config System.Action{HtmlForgeX.TablerLayoutPage} requiredposition: 3
public virtual Void Dispose() #
Core/MultiPageDocument.cs:251
Returns: Void

Disposes of all documents.

public Void SaveAll(String outputDirectory, Boolean openInBrowser = false) #
Core/MultiPageDocument.cs:183
Returns: Void

Saves all documents to the specified directory.

Parameters

outputDirectory System.String requiredposition: 0
openInBrowser System.Boolean = false optionalposition: 1
public async Task SaveAllAsync(String outputDirectory, Boolean openInBrowser = false) #
Returns: Task

Saves all documents asynchronously to the specified directory.

Parameters

outputDirectory System.String requiredposition: 0
openInBrowser System.Boolean = false optionalposition: 1
public MultiPageDocument WithLayout(TablerLayout layoutType) #
Core/MultiPageDocument.cs:56
Returns: MultiPageDocument

Sets the layout type for all pages.

Parameters

layoutType HtmlForgeX.TablerLayout requiredposition: 0
public MultiPageDocument WithSharedFooter(String footer) #
Core/MultiPageDocument.cs:48
Returns: MultiPageDocument

Sets the shared footer for all pages.

Parameters

footer System.String requiredposition: 0
public MultiPageDocument WithSharedNavigation(Action<TablerNavbar> config) #
Core/MultiPageDocument.cs:39
Returns: MultiPageDocument

Sets the shared navigation for all pages.

Parameters

config System.Action{HtmlForgeX.TablerNavbar} requiredposition: 0
public MultiPageDocument WithThemeAccessibility(HfxThemeAccessibility accessibility) #
Core/MultiPageDocument.cs:64
Returns: MultiPageDocument

Enables accessibility overrides for contrast/palette adjustments.

Parameters

accessibility HtmlForgeX.HfxThemeAccessibility requiredposition: 0