EasyLanguage Object Reference

SymbolAttributesProvider Class (Component)

The SymbolAttributesProvider is used to access symbol information such as point value, minimum move, price scale, and session information. Note that the symbol need not appear in Charting or RadarScreen to access these fields.

Typically, you will use the Toolbox to add a component to your EasyLanguage document.  Click and drag the name SymbolAttributesProvider into your document from the Toolbox.  The name of the provider appears in the component tray at the bottom of your document followed by a number to identify multiple instances of the component.  You may also manually instantiate an instance of the class to access information for a specific symbol.

Open the Properties editor and locate the Symbol property. This is a required field. Set the Symbol name (eg. "CSCO" or symbol for the current symbol) and optionally assign a handler method to the Updated event. To reference a property value for a the provider object in EasyLanguage code, use SymbolAttributesP1 followed by a 'dot operator', and the property name. Available provider properties, including inherited properties, will appear in the Autocomplete list.

The following statement shows the type of security and exchange for the symbol in the print log.

Print(SymbolAttributesP1.SymbolType.tostring());
Print(SymbolAttributesP1.Exchange);

For general information about providers, refer to Provider Classes.

Namespace: tsdata.marketdata

Properties

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

	Name	Type	Description
	Country	string	Gets the country for the exchange trading for the selected symbol.
	DailyLimit	double	Gets a numeric double representing the daily limit.
	Data	object	Accesses the SymbolAttributes properties.
	DeliveryMonth	int	Gets an integer representing the delivery month for a futures contract. (1 = January, 2 = February, etc.)
	DeliveryYear	int	Gets an integer representing the delivery year for a futures contract. (eg. 2012, 2013, etc.)
	Description	string	Gets the description.
	Exchange	string	Gets the exchange name.
	ExpirationDate	object	Gets the datetime object representing the expiration date for a futures or options contract.
	Extension	string	Gets the text value of the extension.
	FirstNoticeDate	object	Gets the datetime of the first notice of a futures contract which is defined by the expiration rules.
	GMTExchangeOffset	double	Gets a numeric double representing the offset to GMT.
	GMTLocalOffset	double	Gets a numeric double representing the GMT to local time offset.
	MinMove	double	Gets a number representing the minimum move for the selected symbol. The minimum move is the smallest amount of price change allowed for a particular symbol.
	MinutesDelayed	int	Gets a number representing the minutes that the symbol is delayed.
	PointValue	double	Gets a number representing the point value.
	PriceScale	double	Gets a number representing the price scale. The price scale is the precision to which a security trades. For example, JDSU trades in 1/100, therefore its price scale 1/100.
	Sessions	object	Refers to session info from the SymbolSessions collection.
	StrikePrice	double	Gets a number representing the price of an option contract.
	Symbol	string	Gets and sets the name of the symbol for which attributes are to be provided.
	SymbolType	enum	Gets the type of security that the symbol represents.  See SecurityType for a list of possible values.

Methods

	Name	Description
	Create	Initializes a new instance of the class.

Events

	Name	Description
	Updated	Occurs whenever the SymbolAttributesProvider object is updated. See SymbolAttributesUpdatedEventArgs for the properties returned by the handler's args parameter.