-
Notifications
You must be signed in to change notification settings - Fork 8
/
buttonloopexpansiontokens.htm
157 lines (156 loc) · 8.24 KB
/
buttonloopexpansiontokens.htm
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
<!DOCTYPE HTML>
<html id="hs-topic-p">
<!-- saved from url=(0025)http://www.helpsmith.com/ -->
<head>
<title>Button Loop Expansion Tokens</title>
<meta charset="windows-1252" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="generator" content="HelpSmith 9.8 (Build 23.1026)" />
<link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
<script type="text/javascript" src="../js/jquery-3.7.1.min.js"></script>
<style type="text/css" media="screen">
html {
height: 100%;
}
body {
margin: 0;
}
</style>
<script type="text/javascript" src="../js/settings.js?d3532453"></script>
<script type="text/javascript" src="../js/core.min.js?adb9c364"></script>
<script type="text/javascript" src="../js/topic.min.js?adb9c364"></script>
<script type="text/javascript">
var topicContext = 4280;
</script>
<!-- Web Help Topic -->
<!-- HTML Help (CHM) Topic -->
</head>
<body class="nsa-wrapper">
<div id="nsa-box" class="nsa-content0">
<h1 class="hd0"><span class="ts0">Button Loop Expansion Tokens</span></h1>
</div>
<div id="sa-box">
<div id="content-box" class="sa-content0">
<p> </p>
<p><span class="ts2">Button loop </span><a href="expansiontokens.htm" class="hs4">expansion tokens</a><span class="ts2"> are used to insert information about the current button being processed within the context of a button loop into the output stream. Button loop tokens can only be used inside a button loop.</span></p>
<p><span class="ts2"> </span></p>
<div class="block0">
<table class="tbl1">
<tr class="row0">
<td class="cell46">
<p class="ps1"><span class="ts5">Button Loop Token</span></p>
</td>
<td class="cell88">
<p class="ps1"><span class="ts5">Description</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell49">
<p><a id="BUTTON_CAPTION"></a><span class="ts3"><BUTTON_CAPTION></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell89">
<p><span class="ts2">Inserts the buttons caption. In UI Toolkit a button can have a caption, or an image, but not both. The </span><span class="ts3"><IF CAPTION></span><span class="ts2"> and </span><span class="ts3"><IF IMAGE></span><span class="ts2"> expressions will allow you to provide the appropriate code.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell49">
<p><a id="BUTTON_COLPX"></a><span class="ts3"><BUTTON_COLPX></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell90">
<p><span class="ts2">Inserts the calculated column position for the button in pixels. The column position is calculated by adding the sizes of all preceding buttons, with 15 pixels of space allowed before each button.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell49">
<p><a id="BUTTON_ELB"></a><span class="ts3"><BUTTON_ELB></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell89">
<p><span class="ts2">Inserts the name of the ELB containing the buttons method. Refer to the discussion relating to </span><span class="ts3"><BUTTON_METHOD></span><span class="ts2">. Methods are very rare, and specifying an external ELB is even rarer. You can use the expression </span><span class="ts3"><IF ELB></span><span class="ts2"> to determine if a button method ELB is specified.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell49">
<p><a id="BUTTON_IMAGE"></a><span class="ts3"><BUTTON_IMAGE></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell89">
<p><span class="ts2">Inserts the name of the buttons image file. In UI Toolkit a button can have a caption, or an image, but not both. The </span><span class="ts3"><IF CAPTION></span><span class="ts2"> and </span><span class="ts3"><IF IMAGE></span><span class="ts2"> expressions will allow you to provide the appropriate code.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell48">
<p><a id="BUTTON_METHOD"></a><span class="ts3"><BUTTON_METHOD></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell88">
<p><span class="ts2">Inserts the name of the buttons method. In UI Toolkit a button method may be specified as the event handler to be executed when the button is clicked. This is rare however, most applications relying on the fact that if a button method is not specified then the name of the button is signaled as a menu entry.</span></p>
<p class="ps1"><span class="ts2">Most buttons will not have a method specified. You can use the </span><span class="ts3"><IF METHOD></span><span class="ts2"> expression to determine if a method is specified.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell48">
<p><a id="BUTTON_NAME"></a><span class="ts3"><BUTTON_NAME></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell88">
<p><span class="ts2">Inserts the Name of the button. All buttons will have a name defined.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell48">
<p><a id="BUTTON_NUMBER"></a><span class="ts3"><BUTTON_NUMBER></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell88">
<p><span class="ts2">Inserts the one-based index number of the button in the windows Buttons collection.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell48">
<p><a id="BUTTON_QUICKSELECT"></a><span class="ts3"><BUTTON_QUICKSELECT></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell88">
<p><span class="ts2">Inserts the buttons explicitly specified quick-select character.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell49">
<p><a id="BUTTON_ROWPX"></a><span class="ts3"><BUTTON_ROWPX></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell89">
<p><span class="ts2">Inserts the calculated row position for the button in pixels. The calculation takes into account the pixel height of the window, as well as the additional space which will have been allowed in the window height when the window size was calculated. If code generation is based on an existing UI Toolkit window then the height of the source window is used to calculate the value, otherwise the number of fields in the structure is used.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell49">
<p><a id="BUTTON_WIDTHPX"></a><span class="ts3"><BUTTON_WIDTHPX></span></p>
<p><span class="ts3"> </span></p>
</td>
<td class="cell89">
<p><span class="ts2">Inserts the width of the button in pixels. The width is calculated by multiplying the number of characters in the buttons caption by 12 pixels per character, and this value can be overridden using the -cw option. If the calculated button width is less than 75 pixels then 75 pixels is used.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
</table>
</div>
<p><span class="ts2"> </span></p>
<p><span class="ts2"> </span></p>
<div class="hr-wrapper">
<hr class="hline1" />
</div>
<p class="ps8"><span class="ts10">Copyright © 2021 Synergex International, Inc.</span></p>
</div>
</div>
</body>
</html>