CustomControl.AddChild

method · CustomControl · cAlgo.API

DesktopCLICloud

Adds a child control.

Environment behaviour

CLI — not supported. Accepted without error but never displayed, so control events such as Click are never raised.

Cloud — not supported. Accepted without error but never displayed, so control events such as Click are never raised.

Definition

C#Python

protected void AddChild(ControlBase childControl)

customControl.AddChild(childControl: ControlBase) -> None

Parameters

Name	C# type	Python type	Description
`childControl`	`ControlBase`	`ControlBase`

Examples

C#Python

public class SpreadLabel : CustomControl
{
    private readonly TextBlock _textBlock = new TextBlock { Text = "Spread" };

    public SpreadLabel()
    {
        var border = new Border { BorderThickness = 1, BorderColor = Color.Gray, Padding = 5, Child = _textBlock };
        AddChild(border);
    }

    public void Update(double spreadInPips) => _textBlock.Text = "Spread: " + spreadInPips.ToString("F1");
}

# Not available in Python: CustomControl subclasses are C# classes, compose built-in controls instead
textBlock = TextBlock()
textBlock.Text = "Spread"
border = Border()
border.BorderThickness = Thickness(1)
border.BorderColor = Color.Gray
border.Child = textBlock
api.Chart.AddControl(border)