ChartManager.GetCustomFrame

method · ChartManager · cAlgo.API

DesktopCLICloud

Gets a custom frame by it is Id.

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

CustomFrame GetCustomFrame(string frameId)

api.ChartManager.GetCustomFrame(frameId: str) -> CustomFrame

Parameters

Name	C# type	Python type	Description
`frameId`	`string`	`str`	Frame Id

Returns CustomFrame — Returns matching custom frame.

Examples

C#Python

var addedFrame = ChartManager.AddCustomFrame("My Frame");
var customFrame = ChartManager.GetCustomFrame(addedFrame.Id);
if (customFrame != null)
    customFrame.Child = new TextBlock { Text = "Found my frame" };

addedFrame = api.ChartManager.AddCustomFrame("My Frame")
customFrame = api.ChartManager.GetCustomFrame(addedFrame.Id)
if customFrame is not None:
    textBlock = TextBlock()
    textBlock.Text = "Found my frame"
    customFrame.Child = textBlock