TextMenu Class Reference

More...

Public Member Functions
	TextMenu ()
	Creates a new TextMenu class. More...
	TextMenu (byte ClassInstance)
	Creates a new TextMenu class for a specific WideClient class instance. More...
void	RefreshData ()
	Gets the latest text or menu displayed in the flight sim. More...
override string	ToString ()
	Returns the entire last message received in a single fixed-length string. More...
string	ToString (string RowDelimiter, bool IncludeMenuTitle, bool IncludeMenuPrompt, bool AddNumbersToMenuItem)
	Returns the entire last message received in a single fixed-length string. More...

Properties
float	Duration [get]
	Indicates how long in seconds the text should be displayed for. More...
bool	IsMenu [get]
	Indicates if the display text is a menu. If false it's a single line message. More...
bool	Changed [get]
	Indicates if the text has changed since the last Refrash() More...
string []	MenuItems [get]
	An array of strings representing each menu item More...
int	MenuItemCount [get]
	The number of lines in the menu. This is filled when IsMenu is true. More...
string	MenuTitleText [get]
	The title of the menu. This is filled when IsMenu is true. More...
string	MenuPromptText [get]
	The prompt text of the menu. This is the fist line displayed above the menu options. This is filled when IsMenu is true. More...
string	Message [get]
	The message text. This filled when IsMenu is false. More...
SimConnectMessageType	MessageType [get]
	The message type (static, scrolling, menu or window) More...
SimConnectMessageColor	MessageColor [get]
	The message color (applies to static and scrolling messages only) More...
int	ID [get]
	The ID of the SimConnect event More...

Detailed Description

Helper class for reading the SimConnect Menu Text displayed by other Add-Ons (e.g. Radar Contact)

Constructor & Destructor Documentation

TextMenu() [1/2]

TextMenu ( )

inline

Creates a new TextMenu class.

TextMenu() [2/2]

TextMenu ( byte  ClassInstance )

inline

Creates a new TextMenu class for a specific WideClient class instance.

Member Function Documentation

RefreshData()

void RefreshData ( )

inline

Gets the latest text or menu displayed in the flight sim.

ToString() [1/2]

override string ToString ( )

inline

Returns the entire last message received in a single fixed-length string.

The order is from left to right starting at the top row and going down.

Returns

ToString() [2/2]

string ToString ( string  RowDelimiter, bool  IncludeMenuTitle, bool  IncludeMenuPrompt, bool  AddNumbersToMenuItem  )

inline

Returns the entire last message received in a single fixed-length string.

The order is from left to right starting at the top row and going down.

Each row is seperated by the supplied RowDeimiter

Parameters

RowDelimiter	A string that will be used to mark the end of each row
IncludeMenuTitle	Pass true to include the title of the menu in the string
IncludeMenuPrompt	Pass true to include the menu prompt in the string
AddNumbersToMenuItem	Pass true to automatically add numbers to the menu items

Returns

Property Documentation

Changed

bool Changed

get

Indicates if the text has changed since the last Refrash()

Duration

float Duration

get

Indicates how long in seconds the text should be displayed for.

ID

int ID

get

The ID of the SimConnect event

IsMenu

bool IsMenu

get

Indicates if the display text is a menu. If false it's a single line message.

MenuItemCount

int MenuItemCount

get

The number of lines in the menu. This is filled when IsMenu is true.

MenuItems

string [] MenuItems

get

An array of strings representing each menu item

MenuPromptText

string MenuPromptText

get

The prompt text of the menu. This is the fist line displayed above the menu options. This is filled when IsMenu is true.

MenuTitleText

string MenuTitleText

get

The title of the menu. This is filled when IsMenu is true.

Message

string Message

get

The message text. This filled when IsMenu is false.

MessageColor

SimConnectMessageColor MessageColor

get

The message color (applies to static and scrolling messages only)

MessageType

SimConnectMessageType MessageType

get

The message type (static, scrolling, menu or window)