API Reference
ExportOptions
How a widget, a rendered frame or a live-session snapshot is exported to HTML, SVG or text: the size in cells, the theme, the font, and an optional window frame with a title bar.
Inheritance
- Object
- ExportOptions
Usage
Explore 6 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.
Accepted by parameters 6
- Method ConsoleExporter.Export
- Method ConsoleExporter.Render
- Method ConsoleExporter.Save
- Method ConsoleExporter.ToHtml
- Method ConsoleExporter.ToSvg
- Method ConsoleExporter.ToText
Constructors
public ExportOptions() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Int32 Width { get; set; } #Width in cells for widgets (frames and snapshots keep their own size). Default 100.
public Int32 Height { get; set; } #Height in cells for widgets; 0 (default) uses the height the widget measures at ExportOptions.Width.
public ITheme? DarkTheme { get; set; } #A custom theme for the dark rendering (default Theme.Dark).
public ITheme? LightTheme { get; set; } #A custom theme for the light rendering (default Theme.Light).
public String? Title { get; set; } #The page title and, with ExportOptions.WindowChrome, the title bar text.
public Boolean WindowChrome { get; set; } #Draws a window frame with a title bar around the screen.
public String FontFamily { get; set; } #The font stack (see ExportOptions.DefaultFontFamily).
public Double LineHeight { get; set; } #The cell height as a multiple of the font size (default 1.2).
public GlyphTier Glyphs { get; set; } #The glyph tier widgets render with (default GlyphTier.Full).
public ColorDepth ColorDepth { get; set; } #The colour depth widgets render with (default ColorDepth.TrueColor).
public CultureInfo? Culture { get; set; } #The culture for numbers and dates in widgets (default: the current culture).
public Int32 Padding { get; set; } #Space around the screen in pixels (default 12).
public TimeSpan Elapsed { get; set; } #The session clock widgets show (header clocks, spinners) when a widget is exported; default zero.
public Boolean Fragment { get; set; } #HTML only: writes a fragment (a styled element) instead of a whole page, for embedding.
Fields
public const String DefaultFontFamily #The font stack. The first fonts draw box drawing and block characters on the cell grid; braille needs a font that has the braille block (Cascadia Mono, DejaVu Sans Mono, Menlo do; Consolas does not and falls back to a system font). SVG exports draw box, block and braille characters as shapes, so they do not depend on the font.
'Cascadia Mono', 'Cascadia Code', 'DejaVu Sans Mono', Menlo, Consolas, 'Liberation Mono', 'Courier New', monospace