class MAGES::MAGESTooltipStyles¶

Overview¶

MAGES Tooltip styling functions. More…

class MAGESTooltipStyles
{
public:
    // methods

    static string GetEnumTooltipFormat(
        System.Type enumType,
        string title,
        string remarks,
        params string[] optionDescription
    );

    static string GetDefaultTooltipFormat(string title, string remarks);
};

Detailed Documentation¶

MAGES Tooltip styling functions.

Methods¶

static string GetEnumTooltipFormat(
    System.Type enumType,
    string title,
    string remarks,
    params string[] optionDescription
)

Returns a rich text formatted string for an enum tooltip.

Parameters:

enumType	The enum type.
title	The enum description title.
remarks	Enum remarks. Use only when more explanation neeeded.
optionDescription	A short description of what each enum option does.

Returns:

The rich text formatted string, ready to be used in a tooltip.

static string GetDefaultTooltipFormat(string title, string remarks)

Returns a rich text formatted string for a default tooltip.

Parameters:

title	The variable short definition.
remarks	Remarks. Only use when extra explanation is needed.

Returns:

The rich formatted string, ready to be used in a tooltip.