Loading...
Searching...
No Matches
ATAS.Indicators.Watchlist.WatchlistCellValue Class Reference

The content of one Watchlist cell, published by a WatchlistColumn through WatchlistColumn.Value. The platform draws it like the built-in cells (font, row height, selection), sorts the column by it and never calls the column while drawing or sorting. More...

Collaboration diagram for ATAS.Indicators.Watchlist.WatchlistCellValue:
[legend]

Public Member Functions

 WatchlistCellValue (string text, decimal? sortKey=null)
 
override string ToString ()
 

Static Public Member Functions

static WatchlistCellValue FromNumber (decimal value, string? format=null)
 A numeric cell: value formatted with format (current culture) and sorted by the value.
 

Static Public Attributes

static readonly WatchlistCellValue Empty = new(string.Empty)
 An empty cell (sorted like a cell without data).
 

Properties

string Text [get]
 The text shown in the cell.
 
decimal? SortKey [get]
 The number the column is sorted by, or null to sort the cell by its Text. Cells with a number come before text-only cells in ascending order.
 
Color? TextColor [get]
 Text color, or null for the regular text color of the Watchlist.
 
Color? BackgroundColor [get]
 Cell background, or null for the row background. Not drawn while the row is selected.
 

Detailed Description

The content of one Watchlist cell, published by a WatchlistColumn through WatchlistColumn.Value. The platform draws it like the built-in cells (font, row height, selection), sorts the column by it and never calls the column while drawing or sorting.

Immutable: publish a new instance to change the cell. A cell with a SortKey is right-aligned like the built-in numeric columns; a text-only cell is left-aligned.

Constructor & Destructor Documentation

◆ WatchlistCellValue()

ATAS.Indicators.Watchlist.WatchlistCellValue.WatchlistCellValue ( string  text,
decimal?  sortKey = null 
)
Parameters
textThe text shown in the cell.
sortKeyThe number the column is sorted by; null sorts by text .

Member Function Documentation

◆ FromNumber()

static WatchlistCellValue ATAS.Indicators.Watchlist.WatchlistCellValue.FromNumber ( decimal  value,
string?  format = null 
)
static

A numeric cell: value formatted with format (current culture) and sorted by the value.

◆ ToString()

override string ATAS.Indicators.Watchlist.WatchlistCellValue.ToString ( )

Member Data Documentation

◆ Empty

readonly WatchlistCellValue ATAS.Indicators.Watchlist.WatchlistCellValue.Empty = new(string.Empty)
static

An empty cell (sorted like a cell without data).

Property Documentation

◆ BackgroundColor

Color? ATAS.Indicators.Watchlist.WatchlistCellValue.BackgroundColor
get

Cell background, or null for the row background. Not drawn while the row is selected.

◆ SortKey

decimal? ATAS.Indicators.Watchlist.WatchlistCellValue.SortKey
get

The number the column is sorted by, or null to sort the cell by its Text. Cells with a number come before text-only cells in ascending order.

◆ Text

string ATAS.Indicators.Watchlist.WatchlistCellValue.Text
get

The text shown in the cell.

◆ TextColor

Color? ATAS.Indicators.Watchlist.WatchlistCellValue.TextColor
get

Text color, or null for the regular text color of the Watchlist.


The documentation for this class was generated from the following file: