-
Notifications
You must be signed in to change notification settings - Fork 4
/
classIBApi_1_1ComboLeg.html
222 lines (217 loc) · 14.7 KB
/
classIBApi_1_1ComboLeg.html
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
<!-- HTML header for doxygen 1.8.4-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>TWS API: ComboLeg Class Reference</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script>
$(document).ready(function(){
$("ul#tabs li").click(function(e){
if (!$(this).hasClass("active")) {
var tabNum = $(this).index();
var nthChild = tabNum+1;
$("ul#tabs li.active").removeClass("active");
$(this).addClass("active");
$("ul#tab li.active").removeClass("active");
$("ul#tab li:nth-child("+nthChild+")").addClass("active");
}
});
});
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="ib_theme.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="background-color:black;">
<table cellspacing="0" cellpadding="0" >
<tbody>
<tr>
<td id="projectlogo"><img alt="Logo" src="nav_iblogo.png"/></td>
<td style="padding: 0 0 0 1em;">
<ul id="tabs"><li class="active">C#</li><li>Java</li><li>VB</li><li>C++</li></ul>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classIBApi_1_1ComboLeg.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#properties">Properties</a> |
<a href="classIBApi_1_1ComboLeg-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComboLeg Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class representing a leg within combo orders.
<a href="classIBApi_1_1ComboLeg.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a392ec90e6475b5b0f168058e10c64ab5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a392ec90e6475b5b0f168058e10c64ab5"></a>
 </td><td class="memItemRight" valign="bottom"><b>ComboLeg</b> (int conId, int ratio, string action, string exchange, int openClose, int shortSaleSlot, string designatedLocation, int exemptCode)</td></tr>
<tr class="separator:a392ec90e6475b5b0f168058e10c64ab5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a989178c4f4716f84243831886d5d3b8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a989178c4f4716f84243831886d5d3b8e"></a>
static int </td><td class="memItemRight" valign="bottom"><b>SAME</b> = 0</td></tr>
<tr class="separator:a989178c4f4716f84243831886d5d3b8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af69fe9bc5c7790e7cd3bc698b3751268"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af69fe9bc5c7790e7cd3bc698b3751268"></a>
static int </td><td class="memItemRight" valign="bottom"><b>OPEN</b> = 1</td></tr>
<tr class="separator:af69fe9bc5c7790e7cd3bc698b3751268"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae626b5cfc9ec49313908dbc050e5a0b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae626b5cfc9ec49313908dbc050e5a0b5"></a>
static int </td><td class="memItemRight" valign="bottom"><b>CLOSE</b> = 2</td></tr>
<tr class="separator:ae626b5cfc9ec49313908dbc050e5a0b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a3f7f05081d274ef83ed669efc1c328"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a3f7f05081d274ef83ed669efc1c328"></a>
static int </td><td class="memItemRight" valign="bottom"><b>UNKNOWN</b> = 3</td></tr>
<tr class="separator:a3a3f7f05081d274ef83ed669efc1c328"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ad95ff82697b5dcfbf64f404b9ce0f750"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad95ff82697b5dcfbf64f404b9ce0f750"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#ad95ff82697b5dcfbf64f404b9ce0f750">ConId</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ad95ff82697b5dcfbf64f404b9ce0f750"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classIBApi_1_1Contract.html" title="class describing an instrument's definition ">Contract</a>'s IB's unique id. <br/></td></tr>
<tr class="separator:ad95ff82697b5dcfbf64f404b9ce0f750"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae60ddf1a9a3aa3fedf964e9bd8223a87"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae60ddf1a9a3aa3fedf964e9bd8223a87"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#ae60ddf1a9a3aa3fedf964e9bd8223a87">Ratio</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ae60ddf1a9a3aa3fedf964e9bd8223a87"><td class="mdescLeft"> </td><td class="mdescRight">Select the relative number of contracts for the leg you are constructing. To help determine the ratio for a specific combination order, refer to the Interactive Analytics section of the User's Guide. <br/></td></tr>
<tr class="separator:ae60ddf1a9a3aa3fedf964e9bd8223a87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cbcc18d725aac9ed8a4f9040221606c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#a6cbcc18d725aac9ed8a4f9040221606c">Action</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a6cbcc18d725aac9ed8a4f9040221606c"><td class="mdescLeft"> </td><td class="mdescRight">The side (buy or sell) of the leg:<br/>
. <a href="#a6cbcc18d725aac9ed8a4f9040221606c">More...</a><br/></td></tr>
<tr class="separator:a6cbcc18d725aac9ed8a4f9040221606c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a529401ecdd1b9f7f8a3b42c25dccdf5c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a529401ecdd1b9f7f8a3b42c25dccdf5c"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#a529401ecdd1b9f7f8a3b42c25dccdf5c">Exchange</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a529401ecdd1b9f7f8a3b42c25dccdf5c"><td class="mdescLeft"> </td><td class="mdescRight">The destination exchange to which the order will be routed. <br/></td></tr>
<tr class="separator:a529401ecdd1b9f7f8a3b42c25dccdf5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae225b119db4ba25d11095fd565c5fa3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae225b119db4ba25d11095fd565c5fa3"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#aae225b119db4ba25d11095fd565c5fa3">OpenClose</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aae225b119db4ba25d11095fd565c5fa3"><td class="mdescLeft"> </td><td class="mdescRight">Specifies whether an order is an open or closing order. For instituational customers to determine if this order is to open or close a position. 0 - Same as the parent security. This is the only option for retail customers.<br/>
1 - Open. This value is only valid for institutional customers.<br/>
2 - Close. This value is only valid for institutional customers.<br/>
3 - Unknown. <br/></td></tr>
<tr class="separator:aae225b119db4ba25d11095fd565c5fa3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8d2e2d8240ec305f5a02deef3808f0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8d2e2d8240ec305f5a02deef3808f0f"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#ac8d2e2d8240ec305f5a02deef3808f0f">ShortSaleSlot</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ac8d2e2d8240ec305f5a02deef3808f0f"><td class="mdescLeft"> </td><td class="mdescRight">For stock legs when doing short selling. Set to 1 = clearing broker, 2 = third party. <br/></td></tr>
<tr class="separator:ac8d2e2d8240ec305f5a02deef3808f0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e16ab90707927c67d5b35f03ae20bfd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e16ab90707927c67d5b35f03ae20bfd"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#a0e16ab90707927c67d5b35f03ae20bfd">DesignatedLocation</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a0e16ab90707927c67d5b35f03ae20bfd"><td class="mdescLeft"> </td><td class="mdescRight">When ShortSaleSlot is 2, this field shall contain the designated location. <br/></td></tr>
<tr class="separator:a0e16ab90707927c67d5b35f03ae20bfd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7da1a8a1d588259cecb1367adeb03d17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7da1a8a1d588259cecb1367adeb03d17"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1ComboLeg.html#a7da1a8a1d588259cecb1367adeb03d17">ExemptCode</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a7da1a8a1d588259cecb1367adeb03d17"><td class="mdescLeft"> </td><td class="mdescRight"><ul>
<li></li>
</ul>
<br/></td></tr>
<tr class="separator:a7da1a8a1d588259cecb1367adeb03d17"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class representing a leg within combo orders. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classIBApi_1_1Order.html" title="The order's description. ">Order</a> </dd></dl>
</div><h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a6cbcc18d725aac9ed8a4f9040221606c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Action</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The side (buy or sell) of the leg:<br/>
. </p>
<ul>
<li>For individual accounts, only BUY and SELL are available. SSHORT is for institutions. </li>
</ul>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Dev/IBAPI_Github/documentation/tws-api/source/csharpclient/client/ComboLeg.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.4-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceIBApi.html">IBApi</a></li><li class="navelem"><a class="el" href="classIBApi_1_1ComboLeg.html">ComboLeg</a></li>
<li class="footer">Copyright IB 2015 </li>
</ul>
</div>
</body>
</html>