API Reference
Class
HtmlConversionDocument
Canonical OfficeIMO HTML conversion document shared by target adapters.
Inheritance
- Object
- HtmlConversionDocument
Usage
Explore 108 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 9
- Method HtmlConversionDocument.Edit
- Method HtmlConversionDocument.FromDocument
- Method HtmlConversionDocument.Load
- Method HtmlConversionDocument.LoadAsync
- Method HtmlConversionDocument.Parse
- Property HtmlSiteBundle.HtmlDocument
- Method HtmlVisibleContentResult.RequireNoLoss
- Method HtmlVisibleContentResult.RequireValue
- Property HtmlVisibleContentResult.Value
Accepted by parameters 99
- Method HtmlComputedStyleEngine.Compute
- Extension method HtmlConversionDocument.ExportImage
- Extension method HtmlConversionDocument.ExportImageAsync
- Extension method HtmlConversionDocument.ExportImages
- Extension method HtmlConversionDocument.ExportImagesAsync
- Extension method HtmlConversionDocument.RenderImages
- Extension method HtmlConversionDocument.RenderImagesAsync
- Extension method HtmlConversionDocument.RenderToPdfBytes
- Extension method HtmlConversionDocument.RenderToPdfBytesAsync
- Extension method HtmlConversionDocument.RenderToPdfDocumentResult
- Extension method HtmlConversionDocument.RenderToPdfDocumentResultAsync
- Extension method HtmlConversionDocument.RenderToPdfResult
- Extension method HtmlConversionDocument.RenderToPdfResultAsync
- Extension method HtmlConversionDocument.SaveAsJpeg
- Extension method HtmlConversionDocument.SaveAsJpegAsync
- Extension method HtmlConversionDocument.SaveAsPdf
- Extension method HtmlConversionDocument.SaveAsPdfAsync
- Extension method HtmlConversionDocument.SaveAsPdfResult
- Extension method HtmlConversionDocument.SaveAsPdfResultAsync
- Extension method HtmlConversionDocument.SaveAsPng
- Extension method HtmlConversionDocument.SaveAsPngAsync
- Extension method HtmlConversionDocument.SaveAsSvg
- Extension method HtmlConversionDocument.SaveAsSvgAsync
- Extension method HtmlConversionDocument.SaveAsTiff
- Extension method HtmlConversionDocument.SaveAsTiffAsync
- Extension method HtmlConversionDocument.SaveAsWebp
- Extension method HtmlConversionDocument.SaveAsWebpAsync
- Extension method HtmlConversionDocument.SaveRenderCapabilityGallery
- Extension method HtmlConversionDocument.ToImage
- Extension method HtmlConversionDocument.ToImages
- Extension method HtmlConversionDocument.ToJpeg
- Extension method HtmlConversionDocument.ToJpegAsync
- Extension method HtmlConversionDocument.ToPdfBytes
- Extension method HtmlConversionDocument.ToPdfBytesAsync
- Extension method HtmlConversionDocument.ToPdfDocument
- Extension method HtmlConversionDocument.ToPdfDocumentAsync
- Extension method HtmlConversionDocument.ToPdfDocumentResult
- Extension method HtmlConversionDocument.ToPdfDocumentResultAsync
- Extension method HtmlConversionDocument.ToPng
- Extension method HtmlConversionDocument.ToPngAsync
- Extension method HtmlConversionDocument.ToSvg
- Extension method HtmlConversionDocument.ToSvgAsync
- Extension method HtmlConversionDocument.ToTiff
- Extension method HtmlConversionDocument.ToTiffAsync
- Extension method HtmlConversionDocument.ToWebp
- Extension method HtmlConversionDocument.ToWebpAsync
- Method HtmlEditableLayoutProjector.Project
- Method HtmlImageExportExtensions.ExportImage
- Method HtmlImageExportExtensions.ExportImageAsync
- Method HtmlImageExportExtensions.ExportImages
- Method HtmlImageExportExtensions.ExportImagesAsync
- Method HtmlImageExportExtensions.RenderImages
- Method HtmlImageExportExtensions.RenderImagesAsync
- Method HtmlImageExportExtensions.SaveAsJpeg
- Method HtmlImageExportExtensions.SaveAsJpegAsync
- Method HtmlImageExportExtensions.SaveAsPng
- Method HtmlImageExportExtensions.SaveAsPngAsync
- Method HtmlImageExportExtensions.SaveAsSvg
- Method HtmlImageExportExtensions.SaveAsSvgAsync
- Method HtmlImageExportExtensions.SaveAsTiff
- Method HtmlImageExportExtensions.SaveAsTiffAsync
- Method HtmlImageExportExtensions.SaveAsWebp
- Method HtmlImageExportExtensions.SaveAsWebpAsync
- Method HtmlImageExportExtensions.ToImage
- Method HtmlImageExportExtensions.ToImages
- Method HtmlImageExportExtensions.ToJpeg
- Method HtmlImageExportExtensions.ToJpegAsync
- Method HtmlImageExportExtensions.ToPng
- Method HtmlImageExportExtensions.ToPngAsync
- Method HtmlImageExportExtensions.ToSvg
- Method HtmlImageExportExtensions.ToSvgAsync
- Method HtmlImageExportExtensions.ToTiff
- Method HtmlImageExportExtensions.ToTiffAsync
- Method HtmlImageExportExtensions.ToWebp
- Method HtmlImageExportExtensions.ToWebpAsync
- Method HtmlRenderEngine.Execute
- Method HtmlRenderEngine.ExecuteAsync
- Method HtmlRenderEngine.Render
- Method HtmlRenderEngine.RenderAsync
- Method HtmlRoundTripScorer.Compare
- Method HtmlRoundTripScorer.Compare
- Method HtmlPdfAccessibilityValidator.Validate
- Method HtmlPdfConverterExtensions.RenderToPdfBytes
- Method HtmlPdfConverterExtensions.RenderToPdfBytesAsync
- Method HtmlPdfConverterExtensions.RenderToPdfDocumentResult
- Method HtmlPdfConverterExtensions.RenderToPdfDocumentResultAsync
- Method HtmlPdfConverterExtensions.RenderToPdfResult
- Method HtmlPdfConverterExtensions.RenderToPdfResultAsync
- Method HtmlPdfConverterExtensions.SaveAsPdf
- Method HtmlPdfConverterExtensions.SaveAsPdfAsync
- Method HtmlPdfConverterExtensions.SaveAsPdfResult
- Method HtmlPdfConverterExtensions.SaveAsPdfResultAsync
- Method HtmlPdfConverterExtensions.ToPdfBytes
- Method HtmlPdfConverterExtensions.ToPdfBytesAsync
- Method HtmlPdfConverterExtensions.ToPdfDocument
- Method HtmlPdfConverterExtensions.ToPdfDocumentAsync
- Method HtmlPdfConverterExtensions.ToPdfDocumentResult
- Method HtmlPdfConverterExtensions.ToPdfDocumentResultAsync
- Method HtmlRenderCapabilityGalleryExtensions.SaveRenderCapabilityGallery
Methods
public HtmlConversionPreflight AnalyzeFor(HtmlConversionTarget target) #Returns:
HtmlConversionPreflightPredicts supported, approximated, and omitted source features for a target before artifact creation. Results are cached per prepared document and target.
Parameters
- target OfficeIMO.Html.HtmlConversionTarget
CreateDocumentForConversion 4 overloads
public HtmlDocument CreateDocumentForConversion() #Returns:
HtmlDocumentCreates an independent policy-normalized DOM for the conversion profile's default media context.
public HtmlDocument CreateDocumentForConversion(CancellationToken cancellationToken) #Returns:
HtmlDocumentCreates an independent policy-normalized DOM with cooperative cancellation.
Parameters
- cancellationToken System.Threading.CancellationToken
public HtmlDocument CreateDocumentForConversion(HtmlCssMediaContext mediaContext) #Returns:
HtmlDocumentCreates a policy-normalized DOM filtered for a target media context without reparsing source HTML or mutating shared state.
Parameters
- mediaContext OfficeIMO.Html.HtmlCssMediaContext
- Screen or print media context selected by the target adapter.
Returns
An independent DOM clone that the target adapter may safely mutate.
public HtmlDocument CreateDocumentForConversion(HtmlCssMediaContext mediaContext, CancellationToken cancellationToken) #Returns:
HtmlDocumentCreates an independent policy-normalized DOM for the selected media context with cooperative cancellation.
Parameters
- mediaContext OfficeIMO.Html.HtmlCssMediaContext
- Screen or print media context selected by the target adapter.
- cancellationToken System.Threading.CancellationToken
- Cancels normalization, cloning, media filtering and owned-DOM projection.
Returns
An independent DOM clone that the target adapter may safely mutate.
public Task<HtmlVisibleContentResult> CreateVisibleContentDocumentResultAsync(HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<HtmlVisibleContentResult>Creates an independent editable source without elements hidden by computed display: none, zero opacity, or a closed details element in the requested screen or print environment. The returned source keeps its original stylesheet links and bounded import contract. A supported computed image maximum width is retained as an inline hint so editable targets do not expand a captured image to its unconstrained intrinsic size.
Parameters
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public HtmlConversionDocument Edit(Action<HtmlDocument> edit) #Returns:
HtmlConversionDocumentEdits an independent source snapshot and retains this conversion's trust, resource and fidelity options.
Parameters
- edit System.Action<OfficeIMO.Html.Dom.HtmlDocument>
public String ExportSourceHtml() #Returns:
StringSerializes the source document with its effective absolute base URI so relative references still resolve against the original location when the HTML is saved elsewhere.
FromDocument 2 overloads
public static HtmlConversionDocument FromDocument(HtmlDocument document, HtmlConversionDocumentOptions? options = null) #Returns:
HtmlConversionDocumentCreates a conversion snapshot from an owned tree without reparsing its serialized markup.
Parameters
- document OfficeIMO.Html.Dom.HtmlDocument
- options OfficeIMO.Html.HtmlConversionDocumentOptions? = null
public static HtmlConversionDocument FromDocument(HtmlDocument document, HtmlConversionDocumentOptions? options, CancellationToken cancellationToken) #Returns:
HtmlConversionDocumentCaptures an owned tree with cooperative cancellation during validation, cloning, projection and serialization.
Parameters
- document OfficeIMO.Html.Dom.HtmlDocument
- options OfficeIMO.Html.HtmlConversionDocumentOptions?
- cancellationToken System.Threading.CancellationToken
Load 2 overloads
public static HtmlConversionDocument Load(String path, HtmlConversionDocumentOptions? options = null, Encoding? encoding = null) #Returns:
HtmlConversionDocumentLoads and parses an HTML file.
Parameters
- path System.String
- options OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- encoding System.Text.Encoding? = null
public static HtmlConversionDocument Load(Stream stream, HtmlConversionDocumentOptions? options = null, Encoding? encoding = null) #Returns:
HtmlConversionDocumentLoads and parses HTML from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- encoding System.Text.Encoding? = null
LoadAsync 2 overloads
public static async Task<HtmlConversionDocument> LoadAsync(String path, HtmlConversionDocumentOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Returns:
Task<HtmlConversionDocument>Asynchronously loads and parses an HTML file.
Parameters
- path System.String
- options OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<HtmlConversionDocument> LoadAsync(Stream stream, HtmlConversionDocumentOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Returns:
Task<HtmlConversionDocument>Asynchronously loads and parses HTML from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlConversionDocumentOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Parse 2 overloads
public static HtmlConversionDocument Parse(String html, HtmlConversionDocumentOptions? options = null) #Returns:
HtmlConversionDocumentParses HTML and builds a shared conversion document with logical, style, resource, and normalized-output evidence.
Parameters
- html System.String
- options OfficeIMO.Html.HtmlConversionDocumentOptions? = null
public static HtmlConversionDocument Parse(String html, HtmlConversionDocumentOptions? options, CancellationToken cancellationToken) #Returns:
HtmlConversionDocumentParses inert HTML with explicit cooperative cancellation.
Parameters
- html System.String
- options OfficeIMO.Html.HtmlConversionDocumentOptions?
- cancellationToken System.Threading.CancellationToken
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String SourceHtml { get; } #Original HTML supplied by the caller.
public HtmlDocument Document { get; } #Owned, immutable source DOM. Access does not normalize content, fetch resources or execute scripts.
public HtmlConversionProfileContract ProfileContract { get; } #Profile contract advertised to target adapters and galleries.
public HtmlInputTrust Trust { get; } #Caller-assigned input trust boundary used by downstream adapters.
public HtmlLogicalDocument LogicalDocument { get; } #Normalized logical structure used for semantic scoring and adapter planning.
public HtmlSemanticDocument SemanticDocument { get; } #Typed semantic structure interpreted once for generic native target adapters.
public HtmlComputedStyleSummary StyleSummary { get; } #Compact computed-style capability summary.
public HtmlResourceManifest ResourceManifest { get; } #Raw resource manifest discovered in document order.
public HtmlResourceDependencyPlan ResourcePlan { get; } #Resource dependency plan grouped for adapters, reports, and gallery manifests.
public Uri? BaseUri { get; } #Effective base URI used to resolve relative resources, including a document base element when present.
public String NormalizedHtml { get; } #Policy-aware normalized HTML, or an empty string when normalization was disabled.
public IReadOnlyList<HtmlDiagnostic> Diagnostics { get; } #Diagnostics emitted while lazily preparing shared conversion views.
public String HtmlForConversion { get; } #HTML text target adapters should use when no adapter-specific source preference is configured.
Extension Methods
public static OfficeImageExportResult ExportImage(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultRenders one selected surface to the requested image format with dimensions and diagnostics.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<OfficeImageExportResult> ExportImageAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously renders one selected surface to the requested image format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
ExportImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null) #Returns:
IReadOnlyList<OfficeImageExportResult>Renders all surfaces to the requested image format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
public static Void ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Returns:
VoidStreams rendered surfaces without retaining earlier encoded payloads.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- consumer OfficeIMO.Drawing.OfficeImageExportConsumer
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
ExportImagesAsync 2 overloads
public static async Task<IReadOnlyList<OfficeImageExportResult>> ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Asynchronously renders all surfaces to the requested image format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously streams rendered surfaces without retaining earlier encoded payloads.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static IReadOnlyList<OfficeImageExportResult> RenderImages(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
IReadOnlyList<OfficeImageExportResult>Executes an explicit request and encodes every retained image surface.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<IReadOnlyList<OfficeImageExportResult>> RenderImagesAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Executes an explicit request asynchronously and encodes every retained image surface.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] RenderToPdfBytes(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Byte[]Executes an explicit PDF render request and serializes the resulting document.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<Byte[]> RenderToPdfBytesAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Executes an explicit PDF render request and asynchronously serializes the result.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocumentConversionResult RenderToPdfDocumentResult(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConversionResultExecutes an explicit PDF render request and returns the PDF plus its conversion report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfDocumentConversionResult> RenderToPdfDocumentResultAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<PdfDocumentConversionResult>Asynchronously executes an explicit PDF render request and returns the PDF plus its conversion report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static HtmlPdfRenderRequestResult RenderToPdfResult(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
HtmlPdfRenderRequestResultExecutes an explicit request and returns its retained surfaces together with the PDF output.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<HtmlPdfRenderRequestResult> RenderToPdfResultAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<HtmlPdfRenderRequestResult>Asynchronously executes an explicit request and returns its retained surfaces with the PDF output.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
SaveAsJpeg 2 overloads
public static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a JPEG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as JPEG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsJpegAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a JPEG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes JPEG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdf 2 overloads
public static PdfSaveResult SaveAsPdf(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultConverts a parsed HTML document and saves it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdf(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultConverts a parsed HTML document and writes it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdfAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfAsync(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously converts a parsed HTML document and saves it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfAsync(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously converts a parsed HTML document and writes it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdfResult 2 overloads
public static PdfSaveResult SaveAsPdfResult(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to convert a parsed HTML document and save it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdfResult(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to convert a parsed HTML document and write it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPdfResultAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(HtmlConversionDocument document, String path, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously attempts to convert a parsed HTML document and save it as a PDF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(HtmlConversionDocument document, Stream pdfStream, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Asynchronously attempts to convert a parsed HTML document and write it as PDF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- pdfStream System.IO.Stream
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPng 2 overloads
public static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a PNG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as PNG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsPngAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a PNG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes PNG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsSvg 2 overloads
public static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as an SVG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as SVG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsSvgAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as an SVG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes SVG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsTiff 2 overloads
public static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a TIFF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as TIFF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsTiffAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a TIFF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes TIFF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsWebp 2 overloads
public static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a lossless WebP file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as lossless WebP to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsWebpAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a lossless WebP file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes lossless WebP to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveRenderCapabilityGallery 2 overloads
public static HtmlCapabilityGalleryManifest SaveRenderCapabilityGallery(HtmlConversionDocument document, String directoryPath, HtmlRenderCapabilityGalleryOptions options) #Returns:
HtmlCapabilityGalleryManifestWrites the exact HTML input, paged PDF, selected or all-page previews, and manifests with artifact-specific evidence.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- directoryPath System.String
- options OfficeIMO.Html.Pdf.HtmlRenderCapabilityGalleryOptions
public static HtmlCapabilityGalleryManifest SaveRenderCapabilityGallery(HtmlConversionDocument document, String directoryPath, HtmlRenderCapabilityGalleryOptions options, CancellationToken cancellationToken) #Returns:
HtmlCapabilityGalleryManifestWrites a gallery while observing cancellation and the shared rendering deadline and preview budgets.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- directoryPath System.String
- options OfficeIMO.Html.Pdf.HtmlRenderCapabilityGalleryOptions
- cancellationToken System.Threading.CancellationToken
ToImage 2 overloads
public static HtmlPageImageExportBuilder ToImage(HtmlConversionDocument document) #Returns:
HtmlPageImageExportBuilderStarts fluent image export for one rendered HTML surface.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
public static HtmlPageImageExportBuilder ToImage(HtmlConversionDocument document, HtmlRenderOptions options) #Returns:
HtmlPageImageExportBuilderStarts fluent image export for one rendered HTML surface using a cloned options snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions
ToImages 2 overloads
public static HtmlPageImageBatchExportBuilder ToImages(HtmlConversionDocument document) #Returns:
HtmlPageImageBatchExportBuilderStarts fluent image export for all rendered HTML pages.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
public static HtmlPageImageBatchExportBuilder ToImages(HtmlConversionDocument document, HtmlRenderOptions options) #Returns:
HtmlPageImageBatchExportBuilderStarts fluent image export for all rendered HTML pages using a cloned options snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions
public static Byte[] ToJpeg(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to JPEG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToJpegAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to JPEG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToPdfBytes(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Byte[]Converts a parsed HTML document to PDF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<Byte[]> ToPdfBytesAsync(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves HTML resources and converts a parsed HTML document to PDF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocument ToPdfDocument(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConverts a parsed HTML document to the first-party PDF document model.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfDocument> ToPdfDocumentAsync(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfDocument>Asynchronously converts a parsed HTML document to the first-party PDF document model.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocumentConversionResult ToPdfDocumentResult(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConversionResultConverts a parsed HTML document to PDF plus an immutable diagnostics snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<PdfDocumentConversionResult> ToPdfDocumentResultAsync(HtmlConversionDocument document, HtmlToPdfOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfDocumentConversionResult>Asynchronously converts a parsed HTML document to PDF plus an immutable diagnostics snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.Pdf.HtmlToPdfOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToPng(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to PNG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToPngAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to PNG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static String ToSvg(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
StringRenders a shared HTML conversion document to SVG text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<String> ToSvgAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<String>Asynchronously resolves resources and renders a shared HTML conversion document to SVG text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToTiff(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to TIFF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToTiffAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to TIFF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToWebp(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to lossless WebP bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToWebpAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to lossless WebP bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default