API Reference
HtmlResourceSession
Operation-scoped owner for HTML resource policy, resolution, MIME validation, deduplication, caching, budgets, timeouts, cancellation evidence, canonical identities, and content digests.
Inheritance
- Object
- HtmlResourceSession
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
Constructors
public HtmlResourceSession(HtmlUrlPolicy? resourcePolicy = null, HtmlRenderResourceResolver? resolver = null, TimeSpan? resourceTimeout = null, Int32 maxConcurrentLoads = 8, Int64 maxResourceBytes = 10485760, Int64 maxTotalResourceBytes = 52428800, Int32 maxResourceCount = 256, Int32 maxResourceRequests = 512, Int32 maxStylesheetImportDepth = 16) #Creates an independent resource session.
Parameters
- resourcePolicy OfficeIMO.Html.HtmlUrlPolicy? = null
- resolver OfficeIMO.Html.HtmlRenderResourceResolver? = null
- resourceTimeout System.TimeSpan? = null
- maxConcurrentLoads System.Int32 = 8
- maxResourceBytes System.Int64 = 10485760
- maxTotalResourceBytes System.Int64 = 52428800
- maxResourceCount System.Int32 = 256
- maxResourceRequests System.Int32 = 512
- maxStylesheetImportDepth System.Int32 = 16
Methods
public static HtmlResourceSession Resolve(HtmlResourceManifest manifest, HtmlRenderOptions options, HtmlDiagnosticReport? diagnostics = null, CancellationToken cancellationToken = default) #HtmlResourceSessionResolves a manifest synchronously using the configured synchronous package resolver, when present.
Parameters
- manifest OfficeIMO.Html.HtmlResourceManifest
- options OfficeIMO.Html.HtmlRenderOptions
- diagnostics OfficeIMO.Html.HtmlDiagnosticReport? = null
- cancellationToken System.Threading.CancellationToken = default
public static Task<HtmlResourceSession> ResolveAsync(HtmlResourceManifest manifest, HtmlRenderOptions options, HtmlDiagnosticReport? diagnostics = null, CancellationToken cancellationToken = default) #Task<HtmlResourceSession>Resolves a manifest asynchronously using one operation-scoped session.
Parameters
- manifest OfficeIMO.Html.HtmlResourceManifest
- options OfficeIMO.Html.HtmlRenderOptions
- diagnostics OfficeIMO.Html.HtmlDiagnosticReport? = null
- cancellationToken System.Threading.CancellationToken = default
public Boolean TryGet(String? source, String? resolvedSource, out HtmlResolvedResource resource) #BooleanGets a cached resource by original or canonical source.
Parameters
- source System.String?
- resolvedSource System.String?
- resource OfficeIMO.Html.HtmlResolvedResource
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public HtmlUrlPolicy ResourcePolicy { get; } #Resource URL policy snapshot owned by this operation.
public HtmlRenderResourceResolver? Resolver { get; } #Asynchronous application resolver snapshot owned by this operation.
public TimeSpan ResourceTimeout { get; } #Deadline after which one resolver invocation's cancellation token is cancelled.
public Int32 MaxConcurrentLoads { get; } #Maximum concurrent asynchronous resolver invocations.
public Int64 MaxResourceBytes { get; } #Maximum accepted bytes for one resource.
public Int64 MaxTotalResourceBytes { get; } #Maximum accepted bytes for the operation.
public Int32 MaxResourceCount { get; } #Maximum accepted resource count.
public Int32 MaxResourceRequests { get; } #Maximum attempted resolver requests.
public Int32 MaxStylesheetImportDepth { get; } #Maximum external stylesheet import depth.
public HtmlDiagnosticReport Diagnostics { get; } #Diagnostics emitted by this session.
public IReadOnlyList<HtmlResourceSessionEntry> Resources { get; } #Accepted canonical resources in acceptance order.
public Int64 AcceptedResourceBytes { get; private set; } #Total accepted encoded bytes.
public Int32 AcceptedResourceCount { get; private set; } #Number of accepted deduplicated resources.
public Int32 ResolverRequestCount { get; } #Number of resolver requests reserved by the session.
public Int64 DecodedFontBytes { get; private set; } #Accepted decoded font bytes retained by the operation, including nested documents and installed fallback faces. Encoded resource bytes remain separate.