Show / Hide Table of Contents

Method osdText.showText


Overload

Shows a tooltip-like OSD window with text and optionally icon.

public static osdText showText(string text, int secondsTimeout = 0, PopupXY xy = null, object icon = null, ColorInt? textColor = null, ColorInt? backColor = null, FontNSS font = null, string name = null, OsdMode showMode = OsdMode.Auto, bool dontShow = false)
Parameters
text  (string)

Text in OSD window.
Sets osdText.Text.

secondsTimeout  (int)

Close the OSD window after this time, seconds. If 0 (default), depends on text length. Can be System.Threading.Timeout.Infinite (-1). Sets osdText.SecondsTimeout.

xy  (PopupXY)

Coordinates. Default: null (screen center). Sets osdText.XY.

icon  (object)

Icon or image at the left. Can be icon, System.Drawing.Icon or System.Drawing.Image. Any size. For example System.Drawing.SystemIcons.Information or icon.stock(StockIcon.INFO) or ImageUtil.LoadGdipBitmapFromXaml("XAML copied from the Icons tool. You can edit, Width, Height and Fill (color).", screen.primary.Dpi). Sets osdText.Icon.

textColor  (ColorInt?)

Text color. Default: osdText.defaultTextColor. Sets osdText.TextColor.

backColor  (ColorInt?)

Background color. Default: osdText.defaultBackColor. Sets osdText.BackColor.

font  (FontNSS)

Font. Default: osdText.defaultSmallFont. Sets osdText.Font.

name  (string)

OSD window name.
Sets OsdWindow.Name.

showMode  (OsdMode)

Sets osdText.ShowMode.

dontShow  (bool)

Don't call osdText.Show. The caller can use the return value to set some other properties and call Show.

Returns
osdText

Returns an osdText object that can be used to change properties or close the OSD window.

Remarks

Also sets these properties: osdText.ClickToClose=true, osdText.Shadow=true.