SymbolLinking Class

Allows a TradingApp to initiate a symbol change in other symbol linked windows, as well as respond to symbol changes initiated by other symbol linked windows. This is very useful for TradingApps that offer the ability to change or select a symbol, where users may wish to quickly see that symbol displayed in a different window that has a matching symbol link selected. For more information about using symbol links, see Setting Up Window Links in the platform help.

To send a symbol change to other linked windows, you start by instantiating the SymbolContext class and setting its Symbol property. Once the SymbolContext is set, you can instantiate an instance of the SymbolLinking class and call its SetSymbolContext method passing the instance of the SymbolContext. This will cause all symbol-linked windows to receive the request to change to the new symbol. By handling the SymbolLinking SetContext event, you can programmatically determine when another window is requesting a symbol change.

Namespace: platform

[ Expand All ]

Methods

Additional properties, methods, and events are described in the classes listed under Inheritance Hierarchy (see below).

	Name	Description
	Create	Initializes a new instance of the class.
	GetSymbolContext	Gets the current SymbolContext.
	SetSymbolContext(SymbolCtx)	Sends a request to change to a new symbol for all symbol linked windows based on the specified SymbolContext parameter.

Events

	Name	Description
	GetContext	Occurs when the TradingApp obtains its symbol-link context. See SymbolLinkingEventArgs for the available args properties.
	SetContext	Occurs when a symbol is changed in a symbol linked window. You have the option of determining whether or not you want to recalculate the TradingApp. See SymbolLinkingEventArgs for the available args properties.

Example - Symbol Links From A Grid

The following TradingApp example uses a DataGridView control that allows you to populate cells with symbol names. The SymbolLinking objects allows you to initiate a symbol change in other symbol-linked windows by clicking on a cell in a manner similar to RadarScreen.

Import Example

SymbolLinkingGridSample TradingApp

Click on the Import Example link to import the example into TradeStation.
Go to the TradeStation platform. From the TradingApps tab, select and run !ex_SymbolLinkingGridSample to open the sample TradingApp.
To review or modify the example code, go to the TS Development Environment and open TradingApp !ex_SymbolLinkingGridSample in the EasyLanguage Editor.

Inheritance Hierarchy

elsystem.Object

platform.SymbolLinking