OrdersProvider Class (Component)
The OrdersProvider allows access to updated order information based
on user specified filters from a list of specified TradeStation
accounts. This information is similar to that found on the Orders tab
of the TradeManager. The Order class describes
the properties available for a specific order.
Typically, you will use the Toolbox
to add a component to your EasyLanguage document. Click and drag
the name OrdersProvider into your
document from the Toolbox. The name of the provider appears in the
component tray at the bottom of your document. By default, the name
is followed by a number to identify multiple instances of the component.
Open the Properties
editor and locate the From, To, Accounts, Symbols, States, and
Orders properties under "Filters".
By default, these fields are blank; all order objects will be in the collection.
Entries in any or all of these fields filter the order objects included
in the collection. A comma delimited list of dates, account numbers, symbols,
states, or order numbers (e.g. "4-0047-0217, 3-9606-0320") specifies
that only those listed are to be a part of the Orders collection queried
by the OrdersProvider.
To reference property values for a specific order object in EasyLanguage
code, use OrdersProvider1 followed by a 'dot operator' and the orders
provider property name. Available order properties included inherited
properties will appear in the autocomplete
list as soon as you type the 'dot' after ordersprovider1. properties are
also listed under Order class in the dictionary
and help. To get data for one of the field names entered in the Properties
editor, use the “Order” property, followed by the field name within square
brackets and double quotes[“field name”] or a numeric index (zero-based)
that represents an Orders object within the provider orders collection.
Value1=OrdersProvider1.Order[0].Commission;
//
gets the commission of first order [0] in the collection.
or
Value1=OrdersProvider1.Order["2-3105-2140"].LimitPrice; //
gets the Limit Price of a specific order id number.
The provider can only access orders that are associated with
the current TradeStation logon.
For general information about providers, refer to Provider
Classes.
Namespace: tsdata.trading
Additional
properties, methods, and events are described in the classes listed
under Inheritance Hierarchy (see below).
|
Name |
Type |
Description |
|
Accounts |
list |
Specifies an optional comma-delimited TokenList of trading accounts you want to query and monitor for
orders. When blank, no account filtering takes place. |
|
Count |
int |
The number of orders in the current instance of the provider. |
|
Data |
object |
Gets the Orders collection associated with the current instance. The Order objects included in the collection may be filtered based on items specified in the Accounts, Orders, States, Symbols, and From/To properties. |
|
ExtendedFilter |
object |
Specifies the DynamicProperties filter that may be applied to the data provider to select Orders to be retrieved based upon ExtendedProperties. |
|
From |
datetime |
The starting date for orders to be retrieved by the provider when RealTime = false (see DataProvider). |
|
Order[index] |
object |
Gets the Order object
associated with the specified index. |
|
Order[orderID] |
object |
Gets the Order object
based on the specified string. |
|
Orders |
list |
Specifies an optional comma-delimited TokenList of OrderID strings representing specific orders you want to query and monitor. When blank, no OrderID filtering takes place. |
|
States |
list |
Specifies an optional comma-delimited TokenList of order states associated with orders you want to query and monitor. When blank, no order state filtering takes place. See OrderState for a list of state names. |
|
Symbols |
list |
Specifies an optional comma-delimited TokenList of symbol names whose orders you want to query and monitor. When blank, no symbol filtering takes place. |
|
To |
datetime |
The ending date for orders to be retrieved by the provider when RealTime = false (see DataProvider). |
|
TryOrder[orderID] |
object |
Gets the Order object for the specified string, if available, otherwise returns a null. |
|
Name |
Description |
 |
Updated |
Occurs when an Order retrievable by the provider is updated. See OrderUpdatedEventArgs for the properties returned by the handler's args parameters. |
|
Name |
Description |
|
Create |
Initializes a new instance of the class. |
The following RadarScreen
example uses an OrdersProvider to display updated order status
information for any symbol row for which you have an order. By
default, this example shows orders from all accounts, symbols,
states.
- Click
on the Import Example link to import the example into TradeStation.
- Go
to the TradeStation platform and create a RadarScreen window
containing symbols with positions. Use the Insert -
Indicator menu sequence and Add !ex_OrdersProvider
to the RadarScreen window at the selected column location.
- To review
or modify the example code, go to the TS Development Environment
and open indicator!ex_OrdersProvider in the
EasyLanguage Editor.