CodeGlyphX logo
CodeGlyphX

API Reference

Class

RenderExtensions

Namespace CodeGlyphX.Rendering
Assembly CodeGlyphX
Modifiers static

Convenience extension methods for rendered outputs.

Inheritance

  • Object
  • RenderExtensions

Methods

ReadBinary 2 overloads
public static Byte[] ReadBinary(Stream stream) #
Returns: Byte[]

Reads binary data from a file path.

Parameters

path System.String requiredposition: 0
ReadBinary(System.IO.Stream stream) #

Reads binary data from a stream.

Parameters

stream System.IO.Stream required
ReadText 2 overloads
public static String ReadText(Stream stream, Encoding encoding = null) #
Returns: String

Reads text from a file path.

Parameters

path System.String requiredposition: 0
encoding System.Text.Encoding = null optionalposition: 1
ReadText(System.IO.Stream stream, System.Text.Encoding encoding) #

Reads text from a stream.

Parameters

stream System.IO.Stream required
encoding System.Text.Encoding required
ToBase64 2 overloads
public static String ToBase64(Byte[] data) #
Returns: String

Encodes binary data as Base64.

Parameters

data System.Byte[] requiredposition: 0
public static String ToBase64(String text, Encoding encoding = null) #
Returns: String

Encodes text as Base64 (UTF-8 by default).

Parameters

text System.String requiredposition: 0
encoding System.Text.Encoding = null optionalposition: 1
public static String ToBmpDataUri(Byte[] data) #
Returns: String

Encodes BMP bytes as a Base64 data URI.

Parameters

data System.Byte[] requiredposition: 0
public static String ToDataUri(Byte[] data, String mimeType) #
Returns: String

Encodes binary data as a Base64 data URI.

Parameters

data System.Byte[] requiredposition: 0
mimeType System.String requiredposition: 1
public static String ToGifDataUri(Byte[] data) #
Returns: String

Encodes GIF bytes as a Base64 data URI.

Parameters

data System.Byte[] requiredposition: 0
public static String ToJpegDataUri(Byte[] data) #
Returns: String

Encodes JPEG bytes as a Base64 data URI.

Parameters

data System.Byte[] requiredposition: 0
public static String ToPngDataUri(Byte[] data) #
Returns: String

Encodes PNG bytes as a Base64 data URI.

Parameters

data System.Byte[] requiredposition: 0
public static String ToSvgDataUri(String svg, Encoding encoding = null) #
Returns: String

Encodes SVG content as a Base64 data URI.

Parameters

svg System.String requiredposition: 0
encoding System.Text.Encoding = null optionalposition: 1
public static String ToTiffDataUri(Byte[] data) #
Returns: String

Encodes TIFF bytes as a Base64 data URI.

Parameters

data System.Byte[] requiredposition: 0
public static String ToWebpDataUri(Byte[] data) #
Returns: String

Encodes WebP bytes as a Base64 data URI.

Parameters

data System.Byte[] requiredposition: 0
public static Boolean TryReadBinary(String path, out Byte[] data) #
Returns: Boolean

Attempts to read binary data from a file path.

Parameters

path System.String requiredposition: 0
data System.Byte[]@ requiredposition: 1
public static Boolean TryReadText(String path, out String text, Encoding encoding = null) #
Returns: Boolean

Attempts to read text from a file path.

Parameters

path System.String requiredposition: 0
text System.String@ requiredposition: 1
encoding System.Text.Encoding = null optionalposition: 2
public static String WrapHtml(String innerHtml, String title) #
Returns: String

Wraps HTML content in a minimal document shell.

Parameters

innerHtml System.String requiredposition: 0
title System.String requiredposition: 1
WriteBinary 3 overloads
public static Void WriteBinary(Byte[] data, Stream stream) #
Returns: Void

Writes binary data to a file.

Parameters

data System.Byte[] requiredposition: 0
path System.String requiredposition: 1
public static String WriteBinary(Byte[] data, String directory, String fileName) #
Returns: String

Writes binary data to a file under the specified directory.

Parameters

data System.Byte[] requiredposition: 0
directory System.String requiredposition: 1
fileName System.String requiredposition: 2
WriteBinary(System.Byte[] data, System.IO.Stream stream) #

Writes binary data to a stream.

Parameters

data System.Byte[] required
stream System.IO.Stream required
public static String WriteBinarySafe(Byte[] data, String directory, String fileName) #
Returns: String

Writes binary data to a file under the specified directory with a safe file name.

Parameters

data System.Byte[] requiredposition: 0
directory System.String requiredposition: 1
fileName System.String requiredposition: 2
WriteText 3 overloads
public static Void WriteText(String text, Stream stream, Encoding encoding = null) #
Returns: Void

Writes text to a file.

Parameters

text System.String requiredposition: 0
path System.String requiredposition: 1
encoding System.Text.Encoding = null optionalposition: 2
public static String WriteText(String text, String directory, String fileName, Encoding encoding = null) #
Returns: String

Writes text to a file under the specified directory.

Parameters

text System.String requiredposition: 0
directory System.String requiredposition: 1
fileName System.String requiredposition: 2
encoding System.Text.Encoding = null optionalposition: 3
WriteText(System.String text, System.IO.Stream stream, System.Text.Encoding encoding) #

Writes text to a stream.

Parameters

text System.String required
stream System.IO.Stream required
encoding System.Text.Encoding required
public static String WriteTextSafe(String text, String directory, String fileName, Encoding encoding = null) #
Returns: String

Writes text to a file under the specified directory with a safe file name.

Parameters

text System.String requiredposition: 0
directory System.String requiredposition: 1
fileName System.String requiredposition: 2
encoding System.Text.Encoding = null optionalposition: 3