Skip to content
ConsoleMonster
Class

ExportOptionsFluent

ConsoleMonster.Export

Namespace
ConsoleMonster.Export
Assembly
ConsoleMonster
Modifiers
static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of ExportOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • ExportOptionsFluent

Methods

public static ExportOptions ChromeStyle(ExportOptions exportOptions, WindowChromeStyle value) #

Sets ExportOptions.ChromeStyle: The title bar style, used only when ExportOptions.WindowChrome is true. Default MacOS; None hides chrome.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value ConsoleMonster.Export.WindowChromeStyle required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Export.ExportOptions { ChromeStyle = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().ChromeStyle(value);
public static ExportOptions ColorDepth(ExportOptions exportOptions, ColorDepth value) #

Sets ExportOptions.ColorDepth: The colour depth widgets render with (default ColorDepth.TrueColor).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value ConsoleMonster.Capabilities.ColorDepth required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Export.ExportOptions { ColorDepth = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().ColorDepth(value);
public static ExportOptions Culture(ExportOptions exportOptions, CultureInfo? value) #

Sets ExportOptions.Culture: The culture for numbers and dates in widgets (default: the current culture).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value System.Globalization.CultureInfo? required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Culture = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Culture(value);
public static ExportOptions DarkTheme(ExportOptions exportOptions, ITheme? value) #

Sets ExportOptions.DarkTheme: A custom theme for the dark rendering (default Theme.Dark).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value ConsoleMonster.Styling.ITheme? required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Export.ExportOptions { DarkTheme = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().DarkTheme(value);
public static ExportOptions Elapsed(ExportOptions exportOptions, TimeSpan value) #

Sets ExportOptions.Elapsed: The session clock widgets show (header clocks, spinners) when a widget is exported; default zero.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value System.TimeSpan required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Elapsed = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Elapsed(value);
public static ExportOptions FontFamily(ExportOptions exportOptions, string value) #

Sets ExportOptions.FontFamily: The font stack (see ExportOptions.DefaultFontFamily).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value string required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Export.ExportOptions { FontFamily = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().FontFamily(value);
public static ExportOptions FontSize(ExportOptions exportOptions, double value) #

Sets ExportOptions.FontSize: The font size in pixels (default 14).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value double required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Export.ExportOptions { FontSize = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().FontSize(value);
Fragment 2 overloads
public static ExportOptions Fragment(ExportOptions exportOptions, bool value) #

Sets ExportOptions.Fragment: HTML only: writes a fragment (a styled element) instead of a whole page, for embedding.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value bool required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Fragment = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Fragment(value);
public static ExportOptions Fragment(ExportOptions exportOptions) #

Sets ExportOptions.Fragment to true.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance to configure.

Returns

ExportOptions The same instance.
public static ExportOptions Glyphs(ExportOptions exportOptions, GlyphTier value) #

Sets ExportOptions.Glyphs: The glyph tier widgets render with (default GlyphTier.Full).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value ConsoleMonster.Capabilities.GlyphTier required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Glyphs = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Glyphs(value);
public static ExportOptions Height(ExportOptions exportOptions, int value) #

Sets ExportOptions.Height: Height in cells for widgets; 0 (default) uses the height the widget measures at ExportOptions.Width.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value int required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Height = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Height(value);
IndividualTextElements 2 overloads
public static ExportOptions IndividualTextElements(ExportOptions exportOptions, bool value) #

Sets ExportOptions.IndividualTextElements: SVG: writes one text element per grapheme instead of compact x-coordinate lists, for consumers with a limited SVG text model.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value bool required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                                          // C# fluent
new global::ConsoleMonster.Export.ExportOptions { IndividualTextElements = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().IndividualTextElements(value);
public static ExportOptions IndividualTextElements(ExportOptions exportOptions) #

Sets ExportOptions.IndividualTextElements to true.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance to configure.

Returns

ExportOptions The same instance.
public static ExportOptions LightTheme(ExportOptions exportOptions, ITheme? value) #

Sets ExportOptions.LightTheme: A custom theme for the light rendering (default Theme.Light).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value ConsoleMonster.Styling.ITheme? required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Export.ExportOptions { LightTheme = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().LightTheme(value);
public static ExportOptions LineHeight(ExportOptions exportOptions, double value) #

Sets ExportOptions.LineHeight: The cell height as a multiple of the font size (default 1.2).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value double required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Export.ExportOptions { LineHeight = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().LineHeight(value);
public static ExportOptions Padding(ExportOptions exportOptions, int value) #

Sets ExportOptions.Padding: Space around the screen in pixels (default 12).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value int required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Padding = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Padding(value);
public static ExportOptions Theme(ExportOptions exportOptions, ExportTheme value) #

Sets ExportOptions.Theme: The colours (default ExportTheme.Auto).

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value ConsoleMonster.Export.ExportTheme required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Theme = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Theme(value);
public static ExportOptions Title(ExportOptions exportOptions, string? value) #

Sets ExportOptions.Title: The page title and, with ExportOptions.WindowChrome, the title bar text.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value string? required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Title = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Title(value);
public static ExportOptions Width(ExportOptions exportOptions, int value) #

Sets ExportOptions.Width: Width in cells for widgets (frames and snapshots keep their own size). Zero resolves the current target width, falling back to 100 cells.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value int required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Width = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().Width(value);
WindowChrome 2 overloads
public static ExportOptions WindowChrome(ExportOptions exportOptions, bool value) #

Sets ExportOptions.WindowChrome: Enables the chosen ExportOptions.ChromeStyle (default MacOS). False always hides chrome; style None also hides it.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance.
value bool required
The value.

Returns

ExportOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Export.ExportOptions { WindowChrome = value };    Ui.Options<global::ConsoleMonster.Export.ExportOptions>().WindowChrome(value);
public static ExportOptions WindowChrome(ExportOptions exportOptions) #

Sets ExportOptions.WindowChrome to true.

Parameters

exportOptions ConsoleMonster.Export.ExportOptions required
The instance to configure.

Returns

ExportOptions The same instance.