ExportFluent
ConsoleMonster.Export
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
- ExportFluent
Methods
public static RecordingExportOptions AddMarker(RecordingExportOptions recordingExportOptions, RecordingMarker item) #Adds an item to RecordingExportOptions.Markers: Chapters and export instructions at source recording times.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- item ConsoleMonster.Export.RecordingMarker
- The item.
public static RecordingExportOptions AddMarkers(RecordingExportOptions recordingExportOptions, params RecordingMarker[] items) #Adds items to RecordingExportOptions.Markers: Chapters and export instructions at source recording times.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- items ConsoleMonster.Export.RecordingMarker[]
- The items, in order.
public static RecordingExportOptions AddMarkers(RecordingExportOptions recordingExportOptions, IEnumerable<RecordingMarker> items) #Adds items to RecordingExportOptions.Markers: Chapters and export instructions at source recording times.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Export.RecordingMarker>
- The items, in order.
public static RecordingExportOptions ChapterHold(RecordingExportOptions recordingExportOptions, TimeSpan value) #Sets RecordingExportOptions.ChapterHold: Extra time to freeze the screen at each chapter marker (default zero).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value System.TimeSpan
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { ChapterHold = value }; recordingExportOptions.ChapterHold(value);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
- The instance.
- value ConsoleMonster.Export.WindowChromeStyle
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { ChromeStyle = value }; exportOptions.ChromeStyle(value);public static RecordingExportOptions ChromeStyle(RecordingExportOptions recordingExportOptions, WindowChromeStyle value) #Sets RecordingExportOptions.ChromeStyle: The title bar style when WindowChrome is true (default MacOS). None hides chrome.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value ConsoleMonster.Export.WindowChromeStyle
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { ChromeStyle = value }; recordingExportOptions.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
- The instance.
- value ConsoleMonster.Capabilities.ColorDepth
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { ColorDepth = value }; 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
- The instance.
- value System.Globalization.CultureInfo?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Culture = value }; exportOptions.Culture(value);public static RecordingExportOptions Culture(RecordingExportOptions recordingExportOptions, CultureInfo? value) #Sets RecordingExportOptions.Culture: The culture for numbers and dates (default: the current culture).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value System.Globalization.CultureInfo?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Culture = value }; recordingExportOptions.Culture(value);public static RecordingExportOptions CustomTheme(RecordingExportOptions recordingExportOptions, ITheme? value) #Sets RecordingExportOptions.CustomTheme: A custom theme to render with (default: the built-in dark or light theme).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value ConsoleMonster.Styling.ITheme?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { CustomTheme = value }; recordingExportOptions.CustomTheme(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
- The instance.
- value ConsoleMonster.Styling.ITheme?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { DarkTheme = value }; 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
- The instance.
- value System.TimeSpan
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Elapsed = value }; 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
- The instance.
- value string
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { FontFamily = value }; exportOptions.FontFamily(value);public static RecordingExportOptions FontFamily(RecordingExportOptions recordingExportOptions, string value) #Sets RecordingExportOptions.FontFamily: The font stack (see ExportOptions.DefaultFontFamily).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value string
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { FontFamily = value }; recordingExportOptions.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
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { FontSize = value }; exportOptions.FontSize(value);public static RecordingExportOptions FontSize(RecordingExportOptions recordingExportOptions, double value) #Sets RecordingExportOptions.FontSize: The font size in pixels (default 14).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { FontSize = value }; recordingExportOptions.FontSize(value);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
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Fragment = value }; exportOptions.Fragment(value);public static ExportOptions Fragment(ExportOptions exportOptions) #Sets ExportOptions.Fragment to true.
Parameters
- exportOptions ConsoleMonster.Export.ExportOptions
- The instance to configure.
public static RecordingExportOptions FramesPerSecond(RecordingExportOptions recordingExportOptions, double value) #Sets RecordingExportOptions.FramesPerSecond: Frames per second sampled from the recording (default 10; identical frames are merged).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { FramesPerSecond = value }; recordingExportOptions.FramesPerSecond(value);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
- The instance.
- value ConsoleMonster.Capabilities.GlyphTier
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Glyphs = value }; exportOptions.Glyphs(value);public static RecordingExportOptions Glyphs(RecordingExportOptions recordingExportOptions, GlyphTier value) #Sets RecordingExportOptions.Glyphs: The glyph tier (default GlyphTier.Full).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value ConsoleMonster.Capabilities.GlyphTier
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Glyphs = value }; recordingExportOptions.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
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Height = value }; exportOptions.Height(value);public static RecordingExportOptions Height(RecordingExportOptions recordingExportOptions, int value) #Sets RecordingExportOptions.Height: Screen height in cells (default 30).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Height = value }; recordingExportOptions.Height(value);public static RecordingExportOptions HoldLastFrame(RecordingExportOptions recordingExportOptions, TimeSpan value) #Sets RecordingExportOptions.HoldLastFrame: How long the last frame stays before the animation loops or ends (default 2 seconds).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value System.TimeSpan
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { HoldLastFrame = value }; recordingExportOptions.HoldLastFrame(value);public static RecordingExportOptions IdleLimit(RecordingExportOptions recordingExportOptions, TimeSpan value) #Sets RecordingExportOptions.IdleLimit: Maximum source delay on an unchanged screen after speed scaling; zero disables capping (default 2 seconds). Reading and explicit holds are never capped.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value System.TimeSpan
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { IdleLimit = value }; recordingExportOptions.IdleLimit(value);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
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { IndividualTextElements = value }; exportOptions.IndividualTextElements(value);public static ExportOptions IndividualTextElements(ExportOptions exportOptions) #Sets ExportOptions.IndividualTextElements to true.
Parameters
- exportOptions ConsoleMonster.Export.ExportOptions
- The instance to configure.
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
- The instance.
- value ConsoleMonster.Styling.ITheme?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { LightTheme = value }; 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
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { LineHeight = value }; exportOptions.LineHeight(value);public static RecordingExportOptions LineHeight(RecordingExportOptions recordingExportOptions, double value) #Sets RecordingExportOptions.LineHeight: The cell height as a multiple of the font size (default 1.2).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { LineHeight = value }; recordingExportOptions.LineHeight(value);public static RecordingExportOptions Loop(RecordingExportOptions recordingExportOptions, bool value) #Sets RecordingExportOptions.Loop: SVG only: loops the animation (default true).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Loop = value }; recordingExportOptions.Loop(value);public static RecordingExportOptions Loop(RecordingExportOptions recordingExportOptions) #Sets RecordingExportOptions.Loop to true.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance to configure.
public static RecordingExportOptions MaxFrames(RecordingExportOptions recordingExportOptions, int value) #Sets RecordingExportOptions.MaxFrames: Regular sample limit; longer recordings are sampled less often (default 900). Exact marker and trim boundaries are also kept.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { MaxFrames = value }; recordingExportOptions.MaxFrames(value);public static RecordingExportOptions Pace(RecordingExportOptions recordingExportOptions, RecordingPace value) #Sets RecordingExportOptions.Pace: Reading pace. An explicitly assigned value overrides recorded pace directives.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value ConsoleMonster.Export.RecordingPace
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Pace = value }; recordingExportOptions.Pace(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
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Padding = value }; exportOptions.Padding(value);public static RecordingExportOptions Padding(RecordingExportOptions recordingExportOptions, int value) #Sets RecordingExportOptions.Padding: Space around the screen in pixels (default 12).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Padding = value }; recordingExportOptions.Padding(value);public static RecordingExportOptions Speed(RecordingExportOptions recordingExportOptions, double value) #Sets RecordingExportOptions.Speed: Playback speed multiplier baked into the export (default 1).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Speed = value }; recordingExportOptions.Speed(value);public static ExportOptions Theme(ExportOptions exportOptions, ExportTheme value) #Sets ExportOptions.Theme: The colours (default ExportTheme.Auto).
Parameters
- exportOptions ConsoleMonster.Export.ExportOptions
- The instance.
- value ConsoleMonster.Export.ExportTheme
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Theme = value }; exportOptions.Theme(value);public static RecordingExportOptions Theme(RecordingExportOptions recordingExportOptions, ExportTheme value) #Sets RecordingExportOptions.Theme: Dark (default) or Light. Auto is treated as Dark: a recording is played in one scheme.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value ConsoleMonster.Export.ExportTheme
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Theme = value }; recordingExportOptions.Theme(value);public static RecordingExportOptions Timestamp(RecordingExportOptions recordingExportOptions, DateTimeOffset? value) #Sets RecordingExportOptions.Timestamp: Asciicast only: the recording time written to the header (default: none).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value System.DateTimeOffset?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Timestamp = value }; recordingExportOptions.Timestamp(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
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Title = value }; exportOptions.Title(value);public static RecordingExportOptions Title(RecordingExportOptions recordingExportOptions, string? value) #Sets RecordingExportOptions.Title: The title (page title, title bar, asciicast title).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Title = value }; recordingExportOptions.Title(value);public static RecordingExportOptions TrimEnd(RecordingExportOptions recordingExportOptions, TimeSpan? value) #Sets RecordingExportOptions.TrimEnd: Exclusive source time at which to end; null includes the final screen.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value System.TimeSpan?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimEnd = value }; recordingExportOptions.TrimEnd(value);public static RecordingExportOptions TrimEndChapter(RecordingExportOptions recordingExportOptions, string? value) #Sets RecordingExportOptions.TrimEndChapter: End before this chapter's marker. Cannot be combined with TrimEnd.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimEndChapter = value }; recordingExportOptions.TrimEndChapter(value);public static RecordingExportOptions TrimStart(RecordingExportOptions recordingExportOptions, TimeSpan? value) #Sets RecordingExportOptions.TrimStart: Inclusive source time at which to begin; null begins at zero.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value System.TimeSpan?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimStart = value }; recordingExportOptions.TrimStart(value);public static RecordingExportOptions TrimStartChapter(RecordingExportOptions recordingExportOptions, string? value) #Sets RecordingExportOptions.TrimStartChapter: Begin at this chapter's marker. Cannot be combined with TrimStart.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { TrimStartChapter = value }; recordingExportOptions.TrimStartChapter(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
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { Width = value }; exportOptions.Width(value);public static RecordingExportOptions Width(RecordingExportOptions recordingExportOptions, int value) #Sets RecordingExportOptions.Width: Screen width in cells (zero detects, fallback 100).
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { Width = value }; recordingExportOptions.Width(value);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
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.ExportOptions { WindowChrome = value }; exportOptions.WindowChrome(value);public static ExportOptions WindowChrome(ExportOptions exportOptions) #Sets ExportOptions.WindowChrome to true.
Parameters
- exportOptions ConsoleMonster.Export.ExportOptions
- The instance to configure.
public static RecordingExportOptions WindowChrome(RecordingExportOptions recordingExportOptions, bool value) #Sets RecordingExportOptions.WindowChrome: Enables the chosen RecordingExportOptions.ChromeStyle. False always hides chrome; style None also hides it.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Export.RecordingExportOptions { WindowChrome = value }; recordingExportOptions.WindowChrome(value);public static RecordingExportOptions WindowChrome(RecordingExportOptions recordingExportOptions) #Sets RecordingExportOptions.WindowChrome to true.
Parameters
- recordingExportOptions ConsoleMonster.Export.RecordingExportOptions
- The instance to configure.