Zum Hauptinhalt springen

RenderHtmlPdfNodeConfiguration

Namespace: Meshmakers.Octo.MeshAdapter.Nodes.Transform

Configuration for RenderHtmlPdf@1. Renders an HTML (or plain-text) document into a single base64-encoded PDF using AngleSharp (HTML parsing) and QuestPDF (layout). Cross-platform and browser-free — a pragmatic subset of HTML is supported (headings, paragraphs, line breaks, bold/italic/underline, links, ordered/unordered lists, tables, blockquotes, preformatted text, horizontal rules and inline data:-URI images). Modern CSS layout (flexbox/grid) and remote images are intentionally not rendered.

The value at is the HTML or plain-text content. When it contains no markup it is rendered as preformatted text (line breaks preserved). Set RenderHtmlPdfNodeConfiguration.IsHtml / RenderHtmlPdfNodeConfiguration.IsHtmlPath to override the automatic detection. An optional RenderHtmlPdfNodeConfiguration.Title / RenderHtmlPdfNodeConfiguration.TitlePath is rendered as a heading above the content — used to put the mail subject on the receipt. The base64-encoded PDF is written to .

public record RenderHtmlPdfNodeConfiguration : SourceTargetPathNodeConfiguration, INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IPathNodeConfiguration, IEquatable<SourceTargetPathNodeConfiguration>, IEquatable<RenderHtmlPdfNodeConfiguration>

Inheritance Object → NodeConfiguration → TargetPathNodeConfiguration → SourceTargetPathNodeConfiguration → RenderHtmlPdfNodeConfiguration
Implements INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IPathNodeConfiguration, IEquatable<SourceTargetPathNodeConfiguration>, IEquatable<RenderHtmlPdfNodeConfiguration>

Properties​

Title​

Optional heading rendered above the content (e.g. the mail subject).

public string Title { get; set; }

Property Value​

String

TitlePath​

Optional JSONPath to read the heading from at runtime. Takes precedence over RenderHtmlPdfNodeConfiguration.Title when the path resolves to a non-empty value.

public string TitlePath { get; set; }

Property Value​

String

IsHtml​

Explicit hint whether the content at Path is HTML. When null (default) the node auto-detects markup; set true/false to force HTML or plain-text rendering.

public Nullable<bool> IsHtml { get; set; }

Property Value​

Nullable<Boolean>

IsHtmlPath​

Optional JSONPath to a boolean deciding whether the content is HTML. Takes precedence over RenderHtmlPdfNodeConfiguration.IsHtml when it resolves to a value.

public string IsHtmlPath { get; set; }

Property Value​

String

ContentLengthTargetPath​

Optional path to write the rendered PDF's byte length to (as a long), for feeding a following CreateFileSystemUpdate@1.

public string ContentLengthTargetPath { get; set; }

Property Value​

String

Path​

public string Path { get; set; }

Property Value​

String

TargetPath​

public string TargetPath { get; set; }

Property Value​

String

TargetValueWriteMode​

public TargetValueWriteModes TargetValueWriteMode { get; set; }

Property Value​

TargetValueWriteModes

TargetValueKind​

public ValueKinds TargetValueKind { get; set; }

Property Value​

ValueKinds

DocumentMode​

public DocumentModes DocumentMode { get; set; }

Property Value​

DocumentModes

Description​

public string Description { get; set; }

Property Value​

String

Constructors​

RenderHtmlPdfNodeConfiguration()​

public RenderHtmlPdfNodeConfiguration()