CustomSymbol.Description

property · CustomSymbol · cAlgo.API Since 5.3

DesktopCLICloud

Gets / sets symbol description.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Definition

C#Python

string Description {get; set;}

customSymbol.Description: str

Returns string

Examples

C#Python

var customSymbol = CustomSymbols.Add("MYEURUSD", Symbols.GetSymbol("EURUSD"));
customSymbol.Description = "Euro vs US Dollar from my data feed";
Print("Description: {0}", customSymbol.Description);

customSymbol = api.CustomSymbols.Add("MYEURUSD", api.Symbols.GetSymbol("EURUSD"))
customSymbol.Description = "Euro vs US Dollar from my data feed"
api.Print(f"Description: {customSymbol.Description}")