CodeGlyphX logo
CodeGlyphX

API Reference

Class

RenderedOutput

Namespace CodeGlyphX.Rendering
Assembly CodeGlyphX
Modifiers sealed

Represents rendered output (text or binary).

Inheritance

  • Object
  • RenderedOutput

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

public static RenderedOutput FromBinary(OutputFormat format, Byte[] data) #
Returns: RenderedOutput

Creates a binary output.

Parameters

format CodeGlyphX.Rendering.OutputFormat requiredposition: 0
data System.Byte[] requiredposition: 1
public static RenderedOutput FromText(OutputFormat format, String text, Encoding encoding = null) #
Returns: RenderedOutput

Creates a text output (UTF-8 bytes).

Parameters

format CodeGlyphX.Rendering.OutputFormat requiredposition: 0
text System.String requiredposition: 1
encoding System.Text.Encoding = null optionalposition: 2
public String GetText(Encoding encoding = null) #
Returns: String

Returns the text representation when this is a text output.

Parameters

encoding System.Text.Encoding = null optionalposition: 0

Properties

public OutputFormat Format { get; } #

Output format.

public OutputKind Kind { get; } #

Output kind.

public String MimeType { get; } #

MIME type when known.

public Byte[] Data { get; } #

Output bytes.

public Boolean IsText { get; } #

Returns true when this output is textual.