Skip to content

Window

What Is a Window?

Windows are a new addition to the cTrader Automate API. They allow for showing windows with custom content similarly to WinForms and WFP.

Admittedly, using WinForms and WPF is not easy. When using these tools, you also have to dispatch calls from the WPF/WinForms thread to the cBot/indicator thread, which is less than ideal. Using the Window class eliminates both of these issues.

When working with windows, you can use Automate controls as their contents. For example, you can create a Grid control and place it inside a window.

Similarly to message boxes, windows are innately styled analogously to other cTrader dialogue windows. You do not need to style them manually.

Note

The Window class only works on .NET 6 or later indicators and cBots.

How Do I Use Windows in cTrader?

First, instantiate the Window class. Afterward, assign a 'child' control as its content and call its Show() method.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
using cAlgo.API;

namespace cAlgo
{
    [Indicator(AccessRights = AccessRights.None)]
    public class WindowSample : Indicator
    {
        protected override void Initialize()
        {
            var window = new Window
            {
                Child = new TextBlock 
                {
                    Text = "Hi, This is my Window!",
                    VerticalAlignment = VerticalAlignment.Center,
                    HorizontalAlignment = HorizontalAlignment.Center,
                    FontSize = 20,
                    FontWeight = FontWeight.UltraBold
                },
                Title = "My Window",
                WindowStartupLocation = WindowStartupLocation.CenterScreen,
                Topmost = true
            };

            window.Show();
        }

        public override void Calculate(int index)
        {
        }
    }
}

Upon launching an instance of this indicator, you should see a new window automatically opened by cTrader.

Pros / Cons Of Windows vs WinForms/WPF

Pros

  • Windows do not require full access rights.
  • Windows already have the cTrader native look.
  • Windows are easy-to-use.
  • There is no need to dispatch calls between threads.

Cons

  • Windows can only contain Automate controls as contents.
  • Windows are not fully customizable in contrast to WinForms/WPF windows.

Additional Example of a Window

This sample indicator shows the instance info inside a separate window.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
using cAlgo.API;
using cAlgo.API.Internals;
using System;

namespace cAlgo
{
    [Indicator(AccessRights = AccessRights.None)]
    public class WindowSample : Indicator
    {
        private TextBlock _spreadTextBlock;
        private TextBlock _bidTextBlock;
        private TextBlock _askTextBlock;
        private TextBlock _unrealizedGrossProfitTextBlock;
        private TextBlock _unrealizedNetProfitTextBlock;
        private TextBlock _timeTillOpenTextBlock;
        private TextBlock _timeTillCloseTextBlock;
        private TextBlock _isOpenedTextBlock;
        private TextBox _symbolNameTextBox;
        private Button _updateButton;
        private Style _style;
        private Grid _mainGrid;
        private Grid _infoGrid;
        private Window _window;
        private Symbol _symbol;

        protected override void Initialize()
        {
            _mainGrid = new Grid(2, 2)
            {
                BackgroundColor = Color.Gold,
                Opacity = 0.6,
                HorizontalAlignment = HorizontalAlignment.Stretch,
                VerticalAlignment = VerticalAlignment.Stretch,
            };

            _mainGrid.Rows[0].SetHeightToAuto();
            _mainGrid.Rows[1].SetHeightInStars(1);

            _style = new Style();

            _style.Set(ControlProperty.Padding, 1);
            _style.Set(ControlProperty.Margin, 2);
            _style.Set(ControlProperty.BackgroundColor, Color.Black);
            _style.Set(ControlProperty.FontSize, 12);

            _symbol = Symbol;

            _symbolNameTextBox = new TextBox
            {
                Text = _symbol.Name,
                Style = _style,
            };

            _mainGrid.AddChild(_symbolNameTextBox, 0, 0);

            _updateButton = new Button
            {
                Text = "Update",
            };

            _updateButton.Click += OnUpdateButtonClick;

            _mainGrid.AddChild(_updateButton, 0, 1);

            _infoGrid = GetSymbolDataGrid(_symbol);

            _mainGrid.AddChild(_infoGrid, 1, 0, 1, 2);

            _window = new Window
            {
                Child = _mainGrid,
                Title = "Symbol Info",
                WindowStartupLocation = WindowStartupLocation.CenterScreen,
                Topmost = true
            };

            _window.Show();

            _symbol.Tick += Symbol_Tick;

            Timer.Start(TimeSpan.FromSeconds(1));
        }

        private void OnUpdateButtonClick(ButtonClickEventArgs obj)
        {
            var symbol = Symbols.GetSymbol(_symbolNameTextBox.Text);

            if (symbol != null)
            {
                _symbol.Tick -= Symbol_Tick;

                _symbol = symbol;

                _mainGrid.RemoveChild(_infoGrid);

                _infoGrid = GetSymbolDataGrid(_symbol);

                _mainGrid.AddChild(_infoGrid, 1, 0, 1, 2);

                _symbol.Tick += Symbol_Tick;
            }
            else
            {
                _symbolNameTextBox.Text = "Invalid Symbol Name";
            }
        }

        private Grid GetSymbolDataGrid(Symbol symbol)
        {
            var grid = new Grid(24, 2)
            {
                BackgroundColor = Color.Gold,
                Opacity = 0.6,
                HorizontalAlignment = HorizontalAlignment.Stretch,
                VerticalAlignment = VerticalAlignment.Stretch
            };

            grid.AddChild(new TextBlock
            {
                Text = "Name",
                Style = _style
            }, 1, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.Name,
                Style = _style
            }, 1, 1);

            grid.AddChild(new TextBlock
            {
                Text = "ID",
                Style = _style
            }, 2, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.Id.ToString(),
                Style = _style
            }, 2, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Digits",
                Style = _style
            }, 3, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.Digits.ToString(),
                Style = _style
            }, 3, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Description",
                Style = _style
            }, 4, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.Description,
                Style = _style
            }, 4, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Lot Size",
                Style = _style
            }, 5, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.LotSize.ToString(),
                Style = _style
            }, 5, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Pip Size",
                Style = _style
            }, 6, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.PipSize.ToString(),
                Style = _style
            }, 6, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Pip Value",
                Style = _style
            }, 7, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.PipValue.ToString(),
                Style = _style
            }, 7, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Tick Size",
                Style = _style
            }, 8, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.TickSize.ToString(),
                Style = _style
            }, 8, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Tick Value",
                Style = _style
            }, 9, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.TickValue.ToString(),
                Style = _style
            }, 9, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Volume In Units Max",
                Style = _style
            }, 10, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.VolumeInUnitsMax.ToString(),
                Style = _style
            }, 10, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Volume In Units Min",
                Style = _style
            }, 11, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.VolumeInUnitsMin.ToString(),
                Style = _style
            }, 11, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Volume In Units Step",
                Style = _style
            }, 12, 0);
            grid.AddChild(new TextBlock
            {
                Text = symbol.VolumeInUnitsStep.ToString(),
                Style = _style
            }, 12, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Ask",
                Style = _style
            }, 13, 0);

            _askTextBlock = new TextBlock
            {
                Text = symbol.Ask.ToString(),
                Style = _style
            };

            grid.AddChild(_askTextBlock, 13, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Bid",
                Style = _style
            }, 14, 0);

            _bidTextBlock = new TextBlock
            {
                Text = symbol.Bid.ToString(),
                Style = _style
            };

            grid.AddChild(_bidTextBlock, 14, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Spread",
                Style = _style
            }, 15, 0);

            _spreadTextBlock = new TextBlock
            {
                Text = symbol.Spread.ToString(),
                Style = _style
            };

            grid.AddChild(_spreadTextBlock, 15, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Unrealized Gross Profit",
                Style = _style
            }, 16, 0);

            _unrealizedGrossProfitTextBlock = new TextBlock
            {
                Text = symbol.UnrealizedGrossProfit.ToString(),
                Style = _style
            };

            grid.AddChild(_unrealizedGrossProfitTextBlock, 16, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Unrealized Net Profit",
                Style = _style
            }, 17, 0);

            _unrealizedNetProfitTextBlock = new TextBlock
            {
                Text = symbol.UnrealizedNetProfit.ToString(),
                Style = _style
            };

            grid.AddChild(_unrealizedNetProfitTextBlock, 17, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Time Till Open",
                Style = _style
            }, 18, 0);

            _timeTillOpenTextBlock = new TextBlock
            {
                Text = symbol.MarketHours.TimeTillOpen().ToString(),
                Style = _style
            };

            grid.AddChild(_timeTillOpenTextBlock, 18, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Time Till Close",
                Style = _style
            }, 19, 0);

            _timeTillCloseTextBlock = new TextBlock
            {
                Text = symbol.MarketHours.TimeTillClose().ToString(),
                Style = _style
            };

            grid.AddChild(_timeTillCloseTextBlock, 19, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Is Opened",
                Style = _style
            }, 20, 0);

            _isOpenedTextBlock = new TextBlock
            {
                Text = symbol.MarketHours.IsOpened().ToString(),
                Style = _style
            };

            grid.AddChild(_isOpenedTextBlock, 20, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Trading Sessions #",
                Style = _style
            }, 21, 0);

            grid.AddChild(new TextBlock
            {
                Text = symbol.MarketHours.Sessions.Count.ToString(),
                Style = _style
            }, 21, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Trading Session Week Days",
                Style = _style
            }, 22, 0);

            var weekDays = string.Empty;

            for (var iSession = 0; iSession < symbol.MarketHours.Sessions.Count; iSession++)
            {
                var currentSessionWeekDays = string.Format("{0}({1})-{2}({3})", symbol.MarketHours.Sessions[iSession].StartDay, symbol.MarketHours.Sessions[iSession].StartTime, symbol.MarketHours.Sessions[iSession].EndDay, symbol.MarketHours.Sessions[iSession].EndTime);

                weekDays = iSession == 0 ? currentSessionWeekDays : string.Format("{0}, {1}", weekDays, currentSessionWeekDays);
            }

            grid.AddChild(new TextBlock
            {
                Text = weekDays,
                Style = _style
            }, 22, 1);

            grid.AddChild(new TextBlock
            {
                Text = "Leverage Tier",
                Style = _style
            }, 23, 0);

            var leverageTiers = string.Empty;

            for (var iLeveragTier = 0; iLeveragTier < symbol.DynamicLeverage.Count; iLeveragTier++)
            {
                var currentLeverageTiers = string.Format("Volume up to {0} is {1}", symbol.DynamicLeverage[iLeveragTier].Volume, symbol.DynamicLeverage[iLeveragTier].Leverage);

                leverageTiers = iLeveragTier == 0 ? currentLeverageTiers : string.Format("{0}, {1}", leverageTiers, currentLeverageTiers);
            }

            grid.AddChild(new TextBlock
            {
                Text = leverageTiers,
                Style = _style
            }, 23, 1);

            return grid;
        }

        private void Symbol_Tick(SymbolTickEventArgs obj)
        {
            _askTextBlock.Text = obj.Symbol.Ask.ToString();
            _bidTextBlock.Text = obj.Symbol.Bid.ToString();
            _spreadTextBlock.Text = obj.Symbol.Spread.ToString();
            _unrealizedGrossProfitTextBlock.Text = obj.Symbol.UnrealizedGrossProfit.ToString();
            _unrealizedNetProfitTextBlock.Text = obj.Symbol.UnrealizedNetProfit.ToString();
        }

        protected override void OnTimer()
        {
            _timeTillOpenTextBlock.Text = _symbol.MarketHours.TimeTillOpen().ToString();
            _timeTillCloseTextBlock.Text = _symbol.MarketHours.TimeTillClose().ToString();
            _isOpenedTextBlock.Text = _symbol.MarketHours.IsOpened().ToString();
        }

        public override void Calculate(int index)
        {
        }
    }
}

Last update: December 5, 2022

Comments