ParameterAttribute.Description

property · ParameterAttribute · cAlgo.API Since 5.4

DesktopCLICloud

Gets or sets description for input parameter that will be shown in UI.

Definition

C#Python

public string Description {get; set;}

parameterAttribute.Description: str

Returns string

Examples

C#Pythonconfig.json

public partial class ParameterSample : Robot
{
    protected override void OnStart()
    {
        Print("Volume in units: {0}", Symbol.QuantityToVolumeInUnits(VolumeInLots));
    }
}

def on_start(self):
    api.Print(f"Volume in units: {api.Symbol.QuantityToVolumeInUnits(api.VolumeInLots)}")

{
  "AccessRights": "None",
  "Parameters": [
    {
      "Name": "VolumeInLots",
      "DisplayName": "Volume (Lots)",
      "Type": "Double",
      "DefaultValue": 0.01,
      "Description": "Volume of each new position in lots"
    }
  ]
}