TradeStation Development Environment

https://help.tradestation.com/10_00/eng/tsdevhelp/
Admin
TradeStation Development Environment is an integrated development environment used to create, edit,...
Tokens:832,516
Snippets:8,210
Trust Score:9.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start[Filename,Arguments]

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class_el/environment_class.htm

Starts the process resource that is specified by the Filename string. Passes file Arguments in the second string.

```APIDOC
## Start[Filename,Arguments]

### Description
Starts the process resource that is specified by the Filename string. Passes file Arguments in the second string.

### Method
Start

### Endpoint
Environment.Start[Filename,Arguments]

### Parameters
#### Path Parameters
- **Filename** (string) - Required - The executable file name or URL address to start.
- **Arguments** (string) - Required - The arguments to pass to the process.

### Response
#### Success Response
- **Return Value** (void) - No return value.

#### Response Example
```
No response body.
```
```

--------------------------------

### Create and Play Video Clip Example

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/playmoviechain_reserved_word_.htm

Example demonstrating how to create a movie reference, add files to the chain, and play the movie on the last bar of the chart.

```EasyLanguage
Variable: ID(-1);  
If BarNumber = 1 Then Begin  
ID = MakeNewMovieRef;  
Print(AddToMovieChain(ID, "c:\MyMovie.avi"));  
Print(AddToMovieChain(ID, "c:\MyOtherMovie.avi"));  
End;
If LastBarOnChartEx Then  
Print(PlayMovieChain(ID));
```

--------------------------------

### Start[Filename]

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class_el/environment_class.htm

Starts the process resource (executable file name or URL address) that is specified by the Filename string.

```APIDOC
## Start[Filename]

### Description
Starts the process resource (executable file name or URL address) that is specified by the Filename string.

### Method
Start

### Endpoint
Environment.Start[Filename]

### Parameters
#### Path Parameters
- **Filename** (string) - Required - The executable file name or URL address to start.

### Response
#### Success Response
- **Return Value** (void) - No return value.

#### Response Example
```
No response body.
```
```

--------------------------------

### DateTime.Now and AddMinutes Example

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class_el/datetime_class.htm

Example showing how to create a new DateTime that is 15 minutes greater than the current computer clock time.

```APIDOC
## DateTime.Now and AddMinutes Example

### Description
Demonstrates using the Now property and AddMinutes method to create a new DateTime.

### Example
```
using elsystem;
var: DateTime newTime(null);
newTime = DateTime.Now;
newTime.AddMinutes(15);
print("Current Time: ",DateTime.Now.tostring()," New Time: ",newTime.tostring());
```
```

--------------------------------

### Timer.Start

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class_el/timer_class.htm

Starts the timer.

```APIDOC
## Timer.Start

### Description
Starts the timer.

### Method
Start

### Parameters
None

### Response
None
```

--------------------------------

### TL_SetBegin example: set start point to specific date/time/value

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/tl_setbegin_reserved_word_.htm

Sets the trendline referenced by Value99 to a start point of 107.225 on February 21, 1999 at 10:15 AM.

```EasyLanguage
Value1 = TL_SetBegin(Value99, 990221, 1015, 107.225);
```

--------------------------------

### Properties(idx1, idx2)

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/orderentrypreferences_class.htm

Gets the order entry preference for a given index range, starting at idx1 and ending with idx2.

```APIDOC
## Properties(idx1, idx2)

### Description
Gets the order entry preference for a given index range, starting at idx1 and ending with idx2.

### Parameters
#### Index Parameters
- **idx1** (integer) - Required - The starting index of the range.
- **idx2** (integer) - Required - The ending index of the range.

### Returns
- **object** - The order entry preference object for the specified index range.

```

--------------------------------

### PortfolioHost.Create Method

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/portfoliohost_class.htm

Initializes a new instance of the PortfolioHost class.

```APIDOC
## PortfolioHost.Create

### Description
Initializes a new instance of the PortfolioHost class.

### Method
Create

### Parameters
None.

### Returns
A new instance of the PortfolioHost class.

```

--------------------------------

### TL_SetBegin additional example: set start point to high price 10 bars ago

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/tl_setbegin_reserved_word_.htm

Sets the start point of the trendline referenced by Value99 to the high price 10 bars ago using Date[10], Time[10], and High[10].

```EasyLanguage
Value1 = TL_SetBegin(Value99, Date[10], Time[10], High[10]);
```

--------------------------------

### PlaySound example with file path

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/playsound_reserved_word_.htm

Plays the sound file Thatsabuy.wav from the c:\sounds directory. The file must be a .wav file.

```EasyLanguage
Condition1 = (PlaySound("c:\sounds\Thatsabuy.wav"));
```

--------------------------------

### ExtremesFC example: assign extreme value and bars ago

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/function/extremesfc_function_.htm

Example usage of ExtremesFC with High, length 20, and HiLo=1 to find the highest high. Assigns the extreme value to Value2 and the bars ago to Value3, while Value1 gets the function's return value of 1.

```EasyLanguage
vars: oExtremeVal(0), oExtremeBar(0);
Value1 = ExtremesFC(High, 20, 1, oExtremeVal, oExtremeBar);
Value2 = oExtremeVal;
Value3 = oExtremeBar;
```

--------------------------------

### Create()

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/platformclienthost_class.htm

Initializes a new instance of the PlatformClientHost class.

```APIDOC
## Create()

### Description
Initializes a new instance of the PlatformClientHost class.

### Method
Create

### Parameters
None.

### Returns
A new instance of the PlatformClientHost class.
```

--------------------------------

### Conditionally plot indicator based on EasyLanguageVersion

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/easylanguageversion_reserved_word_.htm

Use this syntax to display an indicator only when the user has EasyLanguage 4.0 or later installed. The example checks if EasyLanguageVersion is greater than or equal to 4.0 before plotting.

```EasyLanguage
If EasyLanguageVersion >= 4.0 Then  
Plot1(Value1, "Indicator");
```

--------------------------------

### StrategyHost.Create

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/strategyhost_class.htm

Initializes a new instance of the StrategyHost class.

```APIDOC
## Create

### Description
Initializes a new instance of the StrategyHost class.

### Method
Create

### Parameters
None

### Response
Returns a new instance of the StrategyHost class.
```

--------------------------------

### FundSetup Example: Check Momentum for Net Sales

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/function/fundsetup_function_.htm

Assigns Value1 a true value if the momentum setup conditions for "RNTS" (Net Sales) are positive and false if momentum conditions are negative.

```EasyLanguage
Value1 = FundSetup("RNTS", 0);
```

--------------------------------

### AB_Mode Example: Get Mode Count and Price

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/function/ab_mode_function_.htm

Assigns to Value2 the number of cells in the largest modal row and to Value3 the cell price on both sides of the current bar. Uses the AB_Mode function with Side=2 (both sides) and Type=1 (largest mode).

```EasyLanguage
vars: oModeCount(0), oModePrice(0);
Value1 = AB_Mode(2, 1, oModeCount, oModePrice);
Value2 = oModeCount;
Value3 = oModePrice;
```

--------------------------------

### SoundConfiguration.Create()

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/soundconfiguration_class.htm

Initializes a new instance of the SoundConfiguration class.

```APIDOC
## SoundConfiguration.Create()

### Description
Initializes a new instance of the SoundConfiguration class.

### Method
Create

### Parameters
None

### Returns
A new instance of the SoundConfiguration class.

```

--------------------------------

### GetFundPostDate Example

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/getfundpostdate_reserved_word_.htm

Assigns Value1 the date value of fundamental data "ONET" (Net Income) from one period ago. Use GetLastFundDataError to test the status of the previous 'Get' data call; a non-zero value indicates a data error.

```EasyLanguage
Value1 = GetFundPostDate("ONET", 1);
if GetLastFundDataError = fdrDataUnavailable then Print("Data Unavailable");
```

--------------------------------

### Create rectangle with BNPoint scrolling with bars

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/rectangle_class.htm

Creates a rectangle between bar numbers using BNPoint, so it scrolls with the bars. The example draws a rectangle from the highest high of the last 50 bars to the lowest low of the previous 50 bars, starting at CurrentBar = 50.

```easylanguage
If (Currentbar = 50) then 
Begin 
MyBNRectangle = Rectangle.Create(BNPoint.Create(CurrentBar + MaxBarsBack, Highest(High, 50)), BNPoint.Create(CurrentBar - 50 + MaxBarsBack, Lowest(Low, 50))); 
DrawingObjects.Add(MyBNRectangle); 
End;
```

--------------------------------

### Host.Create

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class_el/host_class.htm

Initializes a new instance of the Host class.

```APIDOC
## Host.Create

### Description
Initializes a new instance of the Host class.

### Method
Create

### Parameters
None

### Response
#### Success Response
- **Host** (Host) - The newly created Host object.

#### Response Example
```json
{
  "HostName": "string"
}
```
```

--------------------------------

### GetFundDataAsBoolean example with error check

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/getfunddataasboolean_reserved_word_.htm

Assigns Value1 the boolean value of fundamental data "Option" from two periods ago. Also uses GetLastFundDataError to test the status of the previous 'Get' data call, where a non-zero value indicates a data error.

```EasyLanguage
Value1 = GetFundDataAsBoolean("Option", 2);
if GetLastFundDataError = fdrDataUnavailable then Print("Data Unavailable");
```

--------------------------------

### PortfolioState.Create

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/portfoliostate_class.htm

Initializes a new instance of the PortfolioState class.

```APIDOC
## Create

### Description
Initializes a new instance of the PortfolioState class.

### Method
Create

### Syntax
`PortfolioState.Create()`

### Parameters
None.

### Returns
A new instance of the PortfolioState class.

### Example
```csharp
PortfolioState portfolioState = new PortfolioState();
```
```

--------------------------------

### Example of TLAngle plot

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/function/tlangle_function_.htm

Plots the trendline angle calculated from the high of one bar ago to the high of nine bars ago. Use this inside an indicator or strategy to display the angle. Requires the TLAngle function to have valid start and end prices and bar offsets.

```EasyLanguage
Plot1(TLAngle(High[1],1,High[9],9));
```

--------------------------------

### GetFundData Example with Error Handling

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/getfunddata_reserved_word_.htm

Assigns Value1 the numeric value of fundamental data "ONET" (Net Income) from one period ago. Use GetLastFundDataError to test the status of the previous 'Get' data call, where a non-zero value indicates a data error.

```EasyLanguage
Value1 = GetFundData("ONET", 1);
if GetLastFundDataError = fdrDataUnavailable then Print("Data Unavailable");
```

--------------------------------

### Window.Create

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/window_class.htm

Initializes a new instance of the Window class.

```APIDOC
## Window.Create

### Description
Initializes a new instance of the Window class.

### Method
Create

### Parameters
None

### Response
Returns a new Window object.

```

--------------------------------

### Create()

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/optionchainprovider_class.htm

Initializes a new instance of the OptionChainProvider.

```APIDOC
## Create()

### Description
Initializes a new instance of the OptionChainProvider.

### Method
Create

### Parameters
None

### Returns
A new OptionChainProvider instance.
```

--------------------------------

### Set All Trendlines to Yellow

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/tl_getnext_reserved_word_.htm

Sets the color of all trendlines in the chart to yellow. Starts with TL_GetFirst(3) to get the first trendline, then loops using TL_GetNext until -2 is returned, indicating no more trendlines. Note that once -2 is returned, the trading strategy, analysis technique, or function cannot draw any more trendlines.

```EasyLanguage
Value1 = TL_GetFirst(3);  
While Value1 <> -2   
Begin
Value2 = TL_SetColor(Value1, Yellow);  
Value1 = TL_GetNext(Value1, 3);
End;
```

--------------------------------

### GetFundPeriodEndDate Example

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/getfundperiodenddate_reserved_word_.htm

Assigns Value1 the period end date of the fundamental data field "ONET" (Net Income) from one period ago. The subsequent if statement uses GetLastFundDataError to test the status of the previous 'Get' data call, where a non-zero value indicates a data error.

```EasyLanguage
Value1 = GetFundPeriodEndDate("ONET", 1);
if GetLastFundDataError = fdrDataUnavailable then Print("Data Unavailable");
```

--------------------------------

### Create

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/chartwindow_class.htm

Initializes a new instance of the ChartWindow class.

```APIDOC
## Create

### Description
Initializes a new instance of the ChartWindow class.

### Method
Create

### Parameters
None

### Returns
A new ChartWindow instance.
```

--------------------------------

### GetFundDataAsString example with error check

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/getfunddataasstring_reserved_word_.htm

Assigns Value1 the string value of fundamental data "F_MGIND" (Industry Name) from two periods ago. Also demonstrates using GetLastFundDataError to test the status of the previous 'Get' data call, where a non-zero value indicates a data error.

```EasyLanguage
Value1 = GetFundDataAsString("F_MGIND", 2);
if GetLastFundDataError = fdrDataUnavailable then Print("Data Unavailable");
```

--------------------------------

### Basic #BeginCmtry Example

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/_begincmtry_reserved_word_.htm

Shows a simple commentary block that outputs the indicator value. The statements between #BeginCmtry and #End are only evaluated when commentary is generated.

```easylanguage
#BeginCmtry   
Commentary("The indicator value here is " + NumtoStr(Plot1, 2));  
#End
```

--------------------------------

### Get Fundamental Field Value with FundamentalQuotesP1.Quote

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/fundamentalquotesprovider_class.htm

Use this line to retrieve a fundamental field value from a FundamentalQuotesProvider. The Quote property takes the field name in square brackets and double quotes, followed by a dot operator and the value type. The comment in the source incorrectly says 'account number' but the example retrieves the Company Type.

```EasyLanguage
Value1=FundamentalQuotesP1.Quote["F_COMPTYPE"].StringValue[0]; // gets the Company Type of a specific account number.
```

--------------------------------

### PriceSeriesProvider Create() Method

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/priceseriesprovider_class.htm

Initializes a new instance of the PriceSeriesProvider class.

```APIDOC
## PriceSeriesProvider Create() Method

### Description
Initializes a new instance of the class.

### Method
- **Name**: Create()
- **Description**: Initializes a new instance of the class.
```

--------------------------------

### AccumDist example: assign and plot accumulation distribution

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/function/accumdist_function_.htm

Assigns the accumulation distribution value to Value1 using the Volume of Data1, then plots it with Plot1. This example is from the documentation's Example section.

```EasyLanguage
Value1 = AccumDist(Volume);
Plot1(Value1, "AccDist");
```

--------------------------------

### GetAccountID Example

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elword/word/getaccountid_reserved_word_.htm

Example of assigning the account ID returned by GetAccountID to a string variable.

```EasyLanguage
vars: str("");
str = GetAccountID();
```

--------------------------------

### OrdersProvider.Create Method

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/ordersprovider_class.htm

Initializes a new instance of the class.

```APIDOC
## OrdersProvider.Create Method

### Description
Initializes a new instance of the OrdersProvider class.

### Method
Create

### Parameters
None.

### Returns
A new instance of the OrdersProvider class.
```

--------------------------------

### ActivationRules.Create Method

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class/activationrules_class.htm

Initializes a new instance of the ActivationRules class.

```APIDOC
## ActivationRules.Create Method

### Description
Initializes a new instance of the ActivationRules class.

### Method
Create

### Syntax
Create()

### Parameters
None.

### Returns
A new ActivationRules object.
```

--------------------------------

### Get(name)

Source: https://help.tradestation.com/10_00/eng/tsdevhelp/elobject/class_el/namevalueollection_class.htm

Gets the value associated with the specified key. Returns the values as a comma-separated list.

```APIDOC
## Get(name)

### Description
Gets the value associated with the specified key _name_. Returns the values as a comma-separated list.

### Method
Get

### Parameters
- **name** (string) - Required - The key whose value to retrieve.

### Response
Returns a string containing the value(s) associated with the key, comma-separated if multiple.
```
Tokens:
Raw