HtmlSiteBundle
OfficeIMO.Html
A bounded ZIP website snapshot with an inert HTML root and archive-owned resource bytes. Loading does not extract files, execute scripts or fetch resources from the host or network.
Inheritance
- object
- HtmlSiteBundle
Usage
Explore 2 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
- Method HtmlSiteBundle.Load
- Method HtmlSiteBundle.LoadAsync
Methods
public HtmlRenderRequest CreateRenderRequest(HtmlRenderRequest request) #Snapshots a display-list, SVG or raster request with archive-first resources. Any explicitly supplied resolver remains the fallback, subject to the renderer's URL and byte limits. PDF callers use the owning PDF adapter so its embedded-package policy also applies.
Parameters
- request OfficeIMO.Html.HtmlRenderRequest
Returns
HtmlRenderRequestpublic HtmlRenderResourceResolver CreateResourceResolver() #Creates a resolver serving only archive snapshots. It never reads local or remote files.
Returns
HtmlRenderResourceResolverpublic static HtmlSiteBundle Load(string path, HtmlSiteBundleOptions? options = null, HtmlConversionDocumentOptions? htmlOptions = null, CancellationToken cancellationToken = default) #Loads a ZIP site bundle from a file, without extracting it.
Parameters
- path string
- options OfficeIMO.Html.HtmlSiteBundleOptions? = null
- htmlOptions OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
HtmlSiteBundlepublic static HtmlSiteBundle Load(Stream stream, HtmlSiteBundleOptions? options = null, HtmlConversionDocumentOptions? htmlOptions = null, CancellationToken cancellationToken = default) #Loads a ZIP site bundle from a caller-owned stream. Seekable input is read from the beginning and its original position is restored; nonseekable input is read forward.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlSiteBundleOptions? = null
- htmlOptions OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
HtmlSiteBundlepublic static async Task<HtmlSiteBundle> LoadAsync(string path, HtmlSiteBundleOptions? options = null, HtmlConversionDocumentOptions? htmlOptions = null, CancellationToken cancellationToken = default) #Asynchronously loads a ZIP site bundle from a file, without extracting it.
Parameters
- path string
- options OfficeIMO.Html.HtmlSiteBundleOptions? = null
- htmlOptions OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<HtmlSiteBundle>public static async Task<HtmlSiteBundle> LoadAsync(Stream stream, HtmlSiteBundleOptions? options = null, HtmlConversionDocumentOptions? htmlOptions = null, CancellationToken cancellationToken = default) #Asynchronously loads a ZIP site bundle while leaving the caller's stream open and restoring its original position when seekable.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlSiteBundleOptions? = null
- htmlOptions OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<HtmlSiteBundle>Inherited Methods
Properties
public HtmlConversionDocument HtmlDocument { get; } #Parsed HTML entry document.
public string EntryPath { get; } #Selected normalized, case-sensitive HTML entry path.
public Uri ArchiveBaseUri { get; } #Virtual directory URI that maps archive paths.
public IReadOnlyList<string> EntryNames { get; } #Regular-file entry names in ordinal order.
public long DecodedBytes { get; } #Combined decoded size of all regular-file entries.