Frame

Summary

Base interface for chart frames.

Signature

1

public abstract interface Frame

Namespace

cAlgo.API

See Also

• cAlgo.API.CustomFrame

• cAlgo.API.ChartFrame

Methods

Attach (2)

Attach (1 of 2)

Summary

Occurs when frame is attached.

Signature

1

public abstract bool Attach()

Return Value

bool

Attach (2 of 2)

Summary

Attaches frame to main chart container.

Signature

1

public abstract bool Attach(ChartContainer targetContainer)

Parameters

Return Value

bool

Detach

Summary

Occurs when frame is detached.

Signature

1

public abstract bool Detach()

Return Value

bool

Activate

Summary

Brings the chart frame to the front.

Signature

1

public abstract void Activate()

Return Value

void

Properties

Id

Summary

Returns frame Id.

Signature

1

public abstract string Id {get;}

Return Value

string

ChartContainer

Summary

Returns frame container.

Signature

1

public abstract ChartContainer ChartContainer {get;}

Return Value

ChartContainer

Width

Summary

Returns current width of frame.

Signature

1

public abstract double Width {get;}

Return Value

double

Height

Summary

Returns current height of frame.

Signature

1

public abstract double Height {get;}

Return Value

double

IsAttached

Summary

Returns true if frame is attached otherwise false.

Signature

1

public abstract bool IsAttached {get;}

Return Value

bool

Index

Summary

Get / set frame index in container.

Signature

1

public abstract int Index {get; set;}

Return Value

int

Events

SizeChanged

Summary

Occurs when frame size changes.

Signature

1

public abstract event Action<FrameSizeChangedEventArgs> SizeChanged;

Attached

Summary

Occurs when frame is attached.

Signature

1

public abstract event Action<FrameAttachedEventArgs> Attached;

Detached

Summary

Occurs when frame is detached.

Signature

1

public abstract event Action<FrameDetachedEventArgs> Detached;

ContainerChanged

Summary

Occurs when frame container is changed.

Signature

1

public abstract event Action<FrameContainerChangedEventArgs> ContainerChanged;