WidgetUpdate
ConsoleMonster.Live
A presence-aware update: omission, zero, null and empty text retain distinct meanings.
Inheritance
- object
- WidgetUpdate
Usage
Explore 117 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.
Returned or exposed by 50
- Extension method WidgetUpdate.Append
- Extension method WidgetUpdate.AppendCells
- Extension method WidgetUpdate.CellCount
- Extension method WidgetUpdate.ClearRows
- Extension method WidgetUpdate.Complete
- Extension method WidgetUpdate.Content
- Extension method WidgetUpdate.Count
- Extension method WidgetUpdate.Counter
- Extension method WidgetUpdate.Cut
- Extension method WidgetUpdate.Detail
- Extension method WidgetUpdate.EdgeKey
- Extension method WidgetUpdate.Increment
- Extension method WidgetUpdate.Index
- Extension method WidgetUpdate.Key
- Extension method WidgetUpdate.Label
- Extension method WidgetUpdate.NodeKey
- Extension method WidgetUpdate.ParentKey
- Extension method WidgetUpdate.Remaining
- Extension method WidgetUpdate.RemoveRow
- Extension method WidgetUpdate.Restart
- Extension method WidgetUpdate.Result
- Extension method WidgetUpdate.Row
- Extension method WidgetUpdate.Status
- Extension method WidgetUpdate.Total
- Extension method WidgetUpdate.Value
- Method WidgetUpdateFluent.Append
- Method WidgetUpdateFluent.AppendCells
- Method WidgetUpdateFluent.CellCount
- Method WidgetUpdateFluent.ClearRows
- Method WidgetUpdateFluent.Complete
- Method WidgetUpdateFluent.Content
- Method WidgetUpdateFluent.Count
- Method WidgetUpdateFluent.Counter
- Method WidgetUpdateFluent.Cut
- Method WidgetUpdateFluent.Detail
- Method WidgetUpdateFluent.EdgeKey
- Method WidgetUpdateFluent.Increment
- Method WidgetUpdateFluent.Index
- Method WidgetUpdateFluent.Key
- Method WidgetUpdateFluent.Label
- Method WidgetUpdateFluent.NodeKey
- Method WidgetUpdateFluent.ParentKey
- Method WidgetUpdateFluent.Remaining
- Method WidgetUpdateFluent.RemoveRow
- Method WidgetUpdateFluent.Restart
- Method WidgetUpdateFluent.Result
- Method WidgetUpdateFluent.Row
- Method WidgetUpdateFluent.Status
- Method WidgetUpdateFluent.Total
- Method WidgetUpdateFluent.Value
Accepted by parameters 67
- Method ConsoleUpdate.Apply
- Method ImmediateDispatcher.Update
- Method IWidgetUpdateDispatcher.Update
- Method LiveHandle.Update
- Method LiveSession.Update
- Extension method WidgetUpdate.Append
- Extension method WidgetUpdate.AppendCells
- Extension method WidgetUpdate.CellCount
- Extension method WidgetUpdate.ClearRows
- Extension method WidgetUpdate.Complete
- Extension method WidgetUpdate.Content
- Extension method WidgetUpdate.Count
- Extension method WidgetUpdate.Counter
- Extension method WidgetUpdate.Cut
- Extension method WidgetUpdate.Detail
- Extension method WidgetUpdate.EdgeKey
- Extension method WidgetUpdate.Increment
- Extension method WidgetUpdate.Index
- Extension method WidgetUpdate.Key
- Extension method WidgetUpdate.Label
- Extension method WidgetUpdate.NodeKey
- Extension method WidgetUpdate.ParentKey
- Extension method WidgetUpdate.Remaining
- Extension method WidgetUpdate.RemoveRow
- Extension method WidgetUpdate.Restart
- Extension method WidgetUpdate.Result
- Extension method WidgetUpdate.Row
- Extension method WidgetUpdate.Status
- Extension method WidgetUpdate.Total
- Extension method WidgetUpdate.Value
- Method WidgetUpdateFluent.Append
- Method WidgetUpdateFluent.AppendCells
- Method WidgetUpdateFluent.CellCount
- Method WidgetUpdateFluent.ClearRows
- Method WidgetUpdateFluent.Complete
- Method WidgetUpdateFluent.Content
- Method WidgetUpdateFluent.Count
- Method WidgetUpdateFluent.Counter
- Method WidgetUpdateFluent.Cut
- Method WidgetUpdateFluent.Detail
- Method WidgetUpdateFluent.EdgeKey
- Method WidgetUpdateFluent.Increment
- Method WidgetUpdateFluent.Index
- Method WidgetUpdateFluent.Key
- Method WidgetUpdateFluent.Label
- Method WidgetUpdateFluent.NodeKey
- Method WidgetUpdateFluent.ParentKey
- Method WidgetUpdateFluent.Remaining
- Method WidgetUpdateFluent.RemoveRow
- Method WidgetUpdateFluent.Restart
- Method WidgetUpdateFluent.Result
- Method WidgetUpdateFluent.Row
- Method WidgetUpdateFluent.Status
- Method WidgetUpdateFluent.Total
- Method WidgetUpdateFluent.Value
- Method FlowHandle.Update
- Method KeyValueHandle.Update
- Method LanesHandle.Update
- Method LiveTableHandle.Update
- Method LogHandle.Update
- Method PhasesHandle.Update
- Method ProgressHandle.Update
- Method RegionHandle.Update
- Method SparklineHandle.Update
- Method SpinnerHandle.Update
- Method StatusListHandle.Update
- Method SummaryBarHandle.Update
Constructors
public WidgetUpdate() #Inherited Methods
Properties
public string? NodeKey { get; set; } #The flow node to update; exclusive with EdgeKey.
public string? EdgeKey { get; set; } #The flow edge to update; exclusive with NodeKey.
public bool Cut { get; set; } #Whether to sever the selected edge; omission preserves its connection state.
public string? Label { get; set; } #The replacement label; null explicitly clears it.
public string? Detail { get; set; } #The replacement detail; null explicitly clears it.
public object? Value { get; set; } #The absolute value, retaining its original scalar type.
public double Total { get; set; } #The planned total; zero represents an unknown total.
public TimeSpan? Remaining { get; set; } #The estimated time remaining on an activity.
public IDictionary<string, int>? Counter { get; set; } #The summary counters, in enumeration order.
public int Count { get; set; } #The number of appended cells; the default is one.
public IWidget? Content { get; set; } #The replacement region content; null empties it.
Extension Methods
public static WidgetUpdate Append(WidgetUpdate widgetUpdate, bool value) #Sets WidgetUpdate.Append: Whether Value is a new numeric sample.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Append = value }; widgetUpdate.Append(value);public static WidgetUpdate Append(WidgetUpdate widgetUpdate) #Sets WidgetUpdate.Append to true.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance to configure.
public static WidgetUpdate AppendCells(WidgetUpdate widgetUpdate, bool value) #Sets WidgetUpdate.AppendCells: Whether to append cells.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { AppendCells = value }; widgetUpdate.AppendCells(value);public static WidgetUpdate AppendCells(WidgetUpdate widgetUpdate) #Sets WidgetUpdate.AppendCells to true.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance to configure.
public static WidgetUpdate CellCount(WidgetUpdate widgetUpdate, int value) #Sets WidgetUpdate.CellCount: The new number of cells.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { CellCount = value }; widgetUpdate.CellCount(value);public static WidgetUpdate ClearRows(WidgetUpdate widgetUpdate, bool value) #Sets WidgetUpdate.ClearRows: Whether to clear all table rows.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { ClearRows = value }; widgetUpdate.ClearRows(value);public static WidgetUpdate ClearRows(WidgetUpdate widgetUpdate) #Sets WidgetUpdate.ClearRows to true.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance to configure.
public static WidgetUpdate Complete(WidgetUpdate widgetUpdate, bool value) #Sets WidgetUpdate.Complete: Whether to complete an activity or lane.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Complete = value }; widgetUpdate.Complete(value);public static WidgetUpdate Complete(WidgetUpdate widgetUpdate) #Sets WidgetUpdate.Complete to true.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance to configure.
public static WidgetUpdate Content(WidgetUpdate widgetUpdate, IWidget? value) #Sets WidgetUpdate.Content: The replacement region content; null empties it.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value ConsoleMonster.Layout.IWidget?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Content = value }; widgetUpdate.Content(value);public static WidgetUpdate Count(WidgetUpdate widgetUpdate, int value) #Sets WidgetUpdate.Count: The number of appended cells; the default is one.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Count = value }; widgetUpdate.Count(value);public static WidgetUpdate Counter(WidgetUpdate widgetUpdate, IDictionary<string, int>? value) #Sets WidgetUpdate.Counter: The summary counters, in enumeration order.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value System.Collections.Generic.IDictionary<string, int>?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Counter = value }; widgetUpdate.Counter(value);public static WidgetUpdate Cut(WidgetUpdate widgetUpdate, bool value) #Sets WidgetUpdate.Cut: Whether to sever the selected edge; omission preserves its connection state.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Cut = value }; widgetUpdate.Cut(value);public static WidgetUpdate Cut(WidgetUpdate widgetUpdate) #Sets WidgetUpdate.Cut to true.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance to configure.
public static WidgetUpdate Detail(WidgetUpdate widgetUpdate, string? value) #Sets WidgetUpdate.Detail: The replacement detail; null explicitly clears it.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Detail = value }; widgetUpdate.Detail(value);public static WidgetUpdate EdgeKey(WidgetUpdate widgetUpdate, string? value) #Sets WidgetUpdate.EdgeKey: The flow edge to update; exclusive with NodeKey.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { EdgeKey = value }; widgetUpdate.EdgeKey(value);public static WidgetUpdate Increment(WidgetUpdate widgetUpdate, double value) #Sets WidgetUpdate.Increment: The additive change, including zero.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Increment = value }; widgetUpdate.Increment(value);public static WidgetUpdate Index(WidgetUpdate widgetUpdate, int[]? value) #Sets WidgetUpdate.Index: The zero-based cell positions.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value int[]?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Index = value }; widgetUpdate.Index(value);public static WidgetUpdate Key(WidgetUpdate widgetUpdate, string? value) #Sets WidgetUpdate.Key: The item key within the addressed widget.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Key = value }; widgetUpdate.Key(value);public static WidgetUpdate Label(WidgetUpdate widgetUpdate, string? value) #Sets WidgetUpdate.Label: The replacement label; null explicitly clears it.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Label = value }; widgetUpdate.Label(value);public static WidgetUpdate NodeKey(WidgetUpdate widgetUpdate, string? value) #Sets WidgetUpdate.NodeKey: The flow node to update; exclusive with EdgeKey.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { NodeKey = value }; widgetUpdate.NodeKey(value);public static WidgetUpdate ParentKey(WidgetUpdate widgetUpdate, string? value) #Sets WidgetUpdate.ParentKey: The parent activity key.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { ParentKey = value }; widgetUpdate.ParentKey(value);public static WidgetUpdate Remaining(WidgetUpdate widgetUpdate, TimeSpan? value) #Sets WidgetUpdate.Remaining: The estimated time remaining on an activity.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value System.TimeSpan?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Remaining = value }; widgetUpdate.Remaining(value);public static WidgetUpdate RemoveRow(WidgetUpdate widgetUpdate, bool value) #Sets WidgetUpdate.RemoveRow: Whether to remove the row addressed by Key.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { RemoveRow = value }; widgetUpdate.RemoveRow(value);public static WidgetUpdate RemoveRow(WidgetUpdate widgetUpdate) #Sets WidgetUpdate.RemoveRow to true.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance to configure.
public static WidgetUpdate Restart(WidgetUpdate widgetUpdate, bool value) #Sets WidgetUpdate.Restart: Whether to restart a spinner.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Restart = value }; widgetUpdate.Restart(value);public static WidgetUpdate Restart(WidgetUpdate widgetUpdate) #Sets WidgetUpdate.Restart to true.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance to configure.
public static WidgetUpdate Result(WidgetUpdate widgetUpdate, StatusKind value) #Sets WidgetUpdate.Result: The result of completed lane steps.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value ConsoleMonster.Styling.StatusKind
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Result = value }; widgetUpdate.Result(value);public static WidgetUpdate Row(WidgetUpdate widgetUpdate, ConsoleTableRow? value) #Sets WidgetUpdate.Row: A keyed table row with typed cells.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value ConsoleMonster.Live.ConsoleTableRow?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Row = value }; widgetUpdate.Row(value);public static WidgetUpdate Row(WidgetUpdate widgetUpdate, Action<ConsoleTableRow> configure) #Configures WidgetUpdate.Row in place (creating it when not set): A keyed table row with typed cells.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- configure System.Action<ConsoleMonster.Live.ConsoleTableRow>
- Configures the value.
public static WidgetUpdate Status(WidgetUpdate widgetUpdate, StatusKind value) #Sets WidgetUpdate.Status: The new state.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value ConsoleMonster.Styling.StatusKind
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Status = value }; widgetUpdate.Status(value);public static WidgetUpdate Total(WidgetUpdate widgetUpdate, double value) #Sets WidgetUpdate.Total: The planned total; zero represents an unknown total.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Total = value }; widgetUpdate.Total(value);public static WidgetUpdate Value(WidgetUpdate widgetUpdate, object? value) #Sets WidgetUpdate.Value: The absolute value, retaining its original scalar type.
Parameters
- widgetUpdate ConsoleMonster.Live.WidgetUpdate
- The instance.
- value object?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Value = value }; widgetUpdate.Value(value);