Struct TooltipInfo

Namespace

OFT.Rendering.Context

Assembly

OFT.Rendering.dll

Contains tooltip display information for centralized rendering.

Added in ATAS 8.0.15.

public readonly struct TooltipInfo

Extension Methods

Extensions.ConvertToMyTrade<T>(T, Portfolio, Security, Action<MyTrade, T>)

Constructors

TooltipInfo(string, int, int, Color, Color, Color, RenderFont, bool, int, int)

Creates tooltip information. BorderWidth, OutlinePointer and Bounds are set with initializers.

public TooltipInfo(string text, int x, int y, Color borderColor, Color backgroundColor, Color textColor, RenderFont font, bool right = true, int xOffset = 20, int yOffset = 12)

Parameters

text string

Tooltip text.

x int

X coordinate of the target point.

y int

Y coordinate of the target point.

borderColor Color

Border and pointer color.

backgroundColor Color

Box fill color.

textColor Color

Text color.

font RenderFont

Text font.

right bool

Whether the box is placed to the right of the target point.

xOffset int

Horizontal gap between the target point and the box.

yOffset int

Vertical gap between the target point and the box.

Fields

BackgroundColor

Fill color of the tooltip box.

public readonly Color BackgroundColor

Field Value

Color

BorderColor

Color of the border and, unless OutlinePointer is set, of the filled pointer triangle.

public readonly Color BorderColor

Field Value

Color

Font

Font of the tooltip text.

public readonly RenderFont Font

Field Value

RenderFont

Right

true to place the box to the right of the target point, false to the left. With Bounds set, the side is switched when the box does not fit.

public readonly bool Right

Field Value

bool

Text

Tooltip text. Nothing is drawn when it is null, empty or "0"; lines are separated by \n.

public readonly string Text

Field Value

string

TextColor

Color of the tooltip text.

public readonly Color TextColor

Field Value

Color

X

X coordinate of the point the tooltip pointer targets, in render context pixels.

public readonly int X

Field Value

int

XOffset

Horizontal gap between the target point and the near edge of the box, in pixels.

public readonly int XOffset

Field Value

int

Y

Y coordinate of the point the tooltip pointer targets, in render context pixels.

public readonly int Y

Field Value

int

YOffset

Vertical gap between the target point and the bottom of the box, in pixels; the box is drawn above the point, or below it when it does not fit in Bounds.

public readonly int YOffset

Field Value

int

Properties

BorderWidth

Border thickness; the default preserves the existing tooltip style.

        <p>Not in ATAS 8.0.15 yet: available from the next version.</p>

public float BorderWidth { get; init; }

Property Value

float

Bounds

Optional drawing bounds for wrapping and keeping the tooltip visible.

        <p>Not in ATAS 8.0.15 yet: available from the next version.</p>

public Rectangle? Bounds { get; init; }

Property Value

Rectangle?

OutlinePointer

Draws a narrow, background-filled pointer with two outlined edges.

        <p>Not in ATAS 8.0.15 yet: available from the next version.</p>

public bool OutlinePointer { get; init; }

Property Value

bool