The most powerful way

to develop
Web applications!

CodeCharge Studio 4
Component
Reference

8275 S. Eastern Ave. Suite 200 Las Vegas, NV 89123 USA

Telephone: + 1 (888) 241-7338 Fax: + 1 (866) 312-8049
[email protected]
http://www.yessoftware.com
Copyright © 2000-2008 YesSoftware, Inc.
All rights reserved.
This manual, as well as the software described in it, is furnished under license and may
be used or copied only in accordance with the terms of such license. The content of this
manual is furnished for informational use only, is subject to change without notice, and
should not be construed as a commitment by YesSoftware, Inc. YesSoftware, Inc
assumes no responsibility or liability for any errors or inaccuracies that may appear in
this documentation. Except as permitted by such license, no part of this publication may
be reproduced, stored in a retrieval system, or transmitted, in any form or by any
means, electronic, mechanical, recording, or otherwise, without the prior written
permission of YesSoftware, Inc.
Reproduction or translation of any part of this work beyond that permitted by Sections
107 and 108 of the 1976 United States Copyright Act without the permission of the
copyright owner is unlawful. Requests for permission or further information should be
addressed to YesSoftware Inc., 8275 S. Eastern Ave. Suite 200 Las Vegas, NV 89123 USA.
YesSoftware, the YesSoftware logo, CodeCharge and the CodeCharge Logo are either registered
trademarks or trademarks of YesSoftware, Inc in the United States and/or other countries. ASP,
IIS, Microsoft, Windows and Windows NT are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries. JavaScript and JSP are
trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other
countries. All other trademarks are the property of their respective owners.

2
Component Reference .................................................................................................. 16
Components .............................................................................................................. 16
Referencing Objects............................................................................................... 16
Button Control Reference....................................................................................... 20
Calendar Reference ............................................................................................... 21
Calendar Navigator Reference............................................................................... 25
Checkbox Control Reference ................................................................................. 26
CheckBox List Control Reference .......................................................................... 28
Connection Reference ........................................................................................... 32
Date Picker Component Reference........................................................................ 35
Directory Form Reference...................................................................................... 36
Editable Grid Form Reference ............................................................................... 41
File Upload Component Reference ........................................................................ 49
Grid Form Reference ............................................................................................. 53
Hidden Control Reference...................................................................................... 58
Image Control Reference ....................................................................................... 60
Image Link Reference ............................................................................................ 62
Include Page Reference......................................................................................... 64
Label Reference..................................................................................................... 65
Link Reference ....................................................................................................... 67
List Box .................................................................................................................. 69
Navigator Reference .............................................................................................. 73
Page Reference ..................................................................................................... 74
Panel Reference .................................................................................................... 78
Path Reference ...................................................................................................... 80
Project Reference .................................................................................................. 83
Radio Button Reference......................................................................................... 85
Record Form Reference......................................................................................... 88
Report Reference................................................................................................... 96
Report Label Reference ....................................................................................... 100
Report Section Reference.................................................................................... 103
Sorter Reference.................................................................................................. 104
Text Area Reference ............................................................................................ 105
Text Box Reference ............................................................................................. 108
Properties ................................................................................................................ 111
A - C..................................................................................................................... 111
.NET Debug Mode Property ............................................................................. 111
Access Denied Page Property.......................................................................... 111
Aliases Property ............................................................................................... 111
Allow Insert Property ........................................................................................ 111
Allow Update Property...................................................................................... 112
Allow Delete Property ....................................................................................... 112
Allowed File Masks Property ............................................................................ 112
Assemblies Property......................................................................................... 112
Bound Column Property ................................................................................... 113
Boolean Format Property ................................................................................. 113
Caption Property............................................................................................... 113
Catalog Property............................................................................................... 113
Category ID Field Property ............................................................................... 114
Charset Property .............................................................................................. 114

3
 Checked Value Property................................................................................... 114
Class Path Property.......................................................................................... 114
Code Language Property ................................................................................. 115
Code Page Property ......................................................................................... 115
ColdFusion Server Property ............................................................................. 115
Connect Cached Property ................................................................................ 116
Connection Property......................................................................................... 116
Connection String Property............................................................................... 116
Connection Type Property ................................................................................ 117
Content Property .............................................................................................. 117
Context Path Property ...................................................................................... 117
Control Source Property ................................................................................... 118
Control Source Property (Report) ..................................................................... 118
Control Source Type Property .......................................................................... 119
Control Source Property (Report) ..................................................................... 120
Convert URL To Property ................................................................................. 120
Control Property ............................................................................................... 121
Control Properties............................................................................................. 121
Create IIS Application Property ........................................................................ 124
Custom Delete Property ................................................................................... 124
Custom Delete Type Property .......................................................................... 125
Custom Insert Property..................................................................................... 125
Custom Insert Type Property............................................................................ 127
Custom Update Property .................................................................................. 127
Custom Update Type Property ......................................................................... 129
D - I ...................................................................................................................... 130
Data Source Property ....................................................................................... 130
Data Source Type............................................................................................. 130
Data Type Property .......................................................................................... 130
Database URL Property ................................................................................... 131
Date DB Format Property ................................................................................. 131
Date Field Property........................................................................................... 131
Date Format Property ....................................................................................... 132
DBFormat Property........................................................................................... 132
Default Boolean Format Property ..................................................................... 132
Default Button Property .................................................................................... 132
Default Date Format Property........................................................................... 133
Default Value Property ..................................................................................... 133
Default View Mode Property ............................................................................. 133
Delete Control Property .................................................................................... 134
"Deploy webapp as" Property ........................................................................... 134
Design Database Type Property....................................................................... 134
Disallowed File Masks Property........................................................................ 135
Email Component Property............................................................................... 135
EmptyRows Property........................................................................................ 135
Empty Weeks Property..................................................................................... 135
Enable Print Mode Property.............................................................................. 136
Enable Validation Property ............................................................................... 136
Encoding Extension Property ........................................................................... 136
Error Control Property ...................................................................................... 136
File Folder Property .......................................................................................... 136
File Size Limit Property..................................................................................... 137

4
 File Upload Component Property ..................................................................... 137
Format Property................................................................................................ 137
Number Format............................................................................................. 137
Using Date Format concept .......................................................................... 138
Date/Time Format ......................................................................................... 139
Date Formats Comparison ............................................................................ 140
Function Property ............................................................................................. 144
Groups Property ............................................................................................... 144
Height Property................................................................................................. 144
Hide Duplicates Property .................................................................................. 145
Home Page Property ........................................................................................ 145
Href Source Property........................................................................................ 145
Href Type Property ........................................................................................... 145
Includable Property........................................................................................... 146
#include type Property...................................................................................... 146
ID Field Property............................................................................................... 146
Improved HTTP Caching Property.................................................................... 146
Input Validation Property .................................................................................. 147
J - P...................................................................................................................... 147
JDBC Driver Property ....................................................................................... 147
Level of Logging Property................................................................................. 147
Library Prefix Property...................................................................................... 147
Lines Per Print Page Property .......................................................................... 148
Lines Per Web Page Property .......................................................................... 148
Locale Identifier Property.................................................................................. 148
Login Property .................................................................................................. 148
LongReadLen Property .................................................................................... 149
LongTruncOk Property ..................................................................................... 149
Manager login Property .................................................................................... 149
Manager password Property............................................................................. 149
Manager URL Property..................................................................................... 150
Max number of connections to DB Property ..................................................... 150
Name................................................................................................................ 150
Name Property ................................................................................................. 150
No of Columns Property ................................................................................... 151
No of Years Property ........................................................................................ 151
Number of Columns Property ........................................................................... 151
Number of Subcategories Property .................................................................. 151
Operation Property ........................................................................................... 152
Output File Format Property ............................................................................. 152
Page Property................................................................................................... 152
Page Links Property ......................................................................................... 153
Page Size Limit Property .................................................................................. 153
Parent field Property......................................................................................... 153
Password Property ........................................................................................... 153
Path to logfile Property ..................................................................................... 154
Percent Of Property.......................................................................................... 154
Perl Path Property ............................................................................................ 154
PHP Database Library Property ....................................................................... 154
PHP File Extension Property ............................................................................ 155
PHP Database Library Property ....................................................................... 155
PrintError Property............................................................................................ 155

5
 Preserve Parameters Property ......................................................................... 155
Publishing Property .......................................................................................... 156
R - S..................................................................................................................... 156
RaiseError Property.......................................................................................... 156
Records Per Page Property.............................................................................. 156
References Property......................................................................................... 157
RegExp API Property ....................................................................................... 157
Remove Parameters Property .......................................................................... 157
Required Property ............................................................................................ 158
Reset At Property ............................................................................................. 158
Restricted Property........................................................................................... 158
Return Page Property....................................................................................... 158
Reverse Order Property ................................................................................... 159
Runtime libraries Property ................................................................................ 159
Secured Server URL Property .......................................................................... 159
Security Type Property ..................................................................................... 159
Server API Property.......................................................................................... 160
Server Connection String Property ................................................................... 160
Server Connection Type Property .................................................................... 160
Server DataBase/Connection Type Property.................................................... 160
Server Database Name Property...................................................................... 161
Server Database Type Property ....................................................................... 161
Server Host Property ........................................................................................ 161
Server Login Property....................................................................................... 161
Server Password Property................................................................................ 162
Server Path Property (Java) ............................................................................. 162
Server Path Property (Perl) .............................................................................. 162
Server Persistent Connection Property ............................................................ 162
Server Port Property......................................................................................... 162
Server Same As Design Property..................................................................... 163
Sessions Files Clean Rate Property ................................................................. 163
Session Files Path Property ............................................................................. 163
Session Timeout Property ................................................................................ 163
Schema Property.............................................................................................. 163
Show nearby days Property.............................................................................. 164
Site Language Property.................................................................................... 164
Sort Order Property .......................................................................................... 164
SSL Access Only Property ............................................................................... 165
Style Property ................................................................................................... 165
Subcategory ID Field Property.......................................................................... 165
Synonyms Property .......................................................................................... 165
System Tables Property ................................................................................... 165
System Views Property .................................................................................... 166
T - Z ..................................................................................................................... 166
Target Schema Property .................................................................................. 166
Target Server Property ..................................................................................... 166
Target Version Property ................................................................................... 166
Temporary Folder Property............................................................................... 166
Text Column Property....................................................................................... 167
Text Is Empty Property ..................................................................................... 167
Time DB Format Property................................................................................. 167
Time Field Property .......................................................................................... 167

6
 Timeout of DB Connection Retrieval Property .................................................. 168
Type Property ................................................................................................... 168
Type Property ................................................................................................... 168
Unchecked Value Property ............................................................................... 169
Unique Property................................................................................................ 169
Use Data Source Extension Property ............................................................... 169
Use LIMIT/TOP Property .................................................................................. 169
Validation Rule Property................................................................................... 170
Validation Text Property ................................................................................... 171
Validate Request Property................................................................................ 171
Views Property ................................................................................................. 171
Visible Property ................................................................................................ 172
Events...................................................................................................................... 172
Client Side Events................................................................................................ 172
On Change event ............................................................................................. 172
On Click event .................................................................................................. 173
On Key Press ................................................................................................... 173
On Load event .................................................................................................. 174
On Unload event............................................................................................... 175
On Submit event............................................................................................... 175
Server Side Events .............................................................................................. 176
After Execute Delete Event .............................................................................. 176
After Execute Insert Event................................................................................ 176
After Execute Select Event ............................................................................... 176
After Execute Update Event ............................................................................. 176
After Delete Event ............................................................................................ 177
After Delete File Event...................................................................................... 177
After Initialize Event.......................................................................................... 177
After Insert Event.............................................................................................. 178
After Process File Event ................................................................................... 178
After Submit Event............................................................................................ 178
After Update Event ........................................................................................... 179
Before Build Delete Event ................................................................................ 179
Before Build Insert Event.................................................................................. 179
Before Build Select Event................................................................................. 179
Before Build Update Event ............................................................................... 180
Before Delete Event ......................................................................................... 180
Before Delete File Event................................................................................... 180
Before Execute Delete Event ........................................................................... 180
Before Execute Insert Event ............................................................................. 181
Before Execute Select Event ............................................................................ 181
Before Execute Update Event .......................................................................... 181
Before Insert Event........................................................................................... 181
Before Output Event ......................................................................................... 182
Before Process File Event ................................................................................ 182
Before Select Event.......................................................................................... 182
Before Show Event........................................................................................... 182
Before Show Category Event ........................................................................... 183
Before Show Row Event................................................................................... 183
Before Show Subcategory Event...................................................................... 183
Before Submit Event......................................................................................... 184
Before Unload Event ........................................................................................ 184

7
 Before Update Event ........................................................................................ 184
On Cache Event ............................................................................................... 184
On Calculate Event........................................................................................... 185
On Click Event.................................................................................................. 185
On Initialized Event........................................................................................... 185
On Initialize View Event.................................................................................... 185
On Validate Event............................................................................................. 186
Actions..................................................................................................................... 186
Client Side Actions ............................................................................................... 186
Attach FCKeditor .............................................................................................. 186
Convert Page to PDF ....................................................................................... 187
Custom Code.................................................................................................... 188
Confirmation Message...................................................................................... 188
Regular Expression Validation.......................................................................... 188
Set Focus ......................................................................................................... 188
Submit Form ..................................................................................................... 188
Validate Entry ................................................................................................... 189
Validate Form ................................................................................................... 189
Validate Maximum Length ................................................................................ 189
Validate Maximum Value.................................................................................. 190
Validate Minimum Length ................................................................................. 190
Validate Minimum Value................................................................................... 190
Validate Required Value................................................................................... 190
Server Side Actions.............................................................................................. 191
Change Number Of Columns ........................................................................... 191
Convert Page to PDF ....................................................................................... 191
Custom Code.................................................................................................... 192
Declare Variable ............................................................................................... 192
DLookup ........................................................................................................... 192
Gallery Layout .................................................................................................. 193
Get Original Filename....................................................................................... 193
Hide-Show Component .................................................................................... 193
Login................................................................................................................. 193
Logout .............................................................................................................. 194
Print Text .......................................................................................................... 195
Regular Expression Validation.......................................................................... 195
Retrieve Active Page ........................................................................................ 195
Retrieve Number Of Pages .............................................................................. 195
Retrieve Number Of Records ........................................................................... 195
Retrieve Value for Control ................................................................................ 195
Retrieve Value For Variable.............................................................................. 196
Save Control Value........................................................................................... 196
Save Variable Value ......................................................................................... 196
Send Email ....................................................................................................... 197
Set Active Page ................................................................................................ 197
Set Image Download Folder ............................................................................. 197
Set Link Destination Folder............................................................................... 197
Set Number Of New Records ........................................................................... 198
Set Page Size................................................................................................... 198
Set Row Style ................................................................................................... 198
Set Tag............................................................................................................. 199
Validate Email................................................................................................... 199

8
 Validate Maximum Length ................................................................................ 199
Validate Maximum Value.................................................................................. 200
Validate Minimum Length ................................................................................. 200
Validate Minimum Value................................................................................... 200
Validate Phone ................................................................................................. 200
Validate Required Value................................................................................... 201
Validate ZIP ...................................................................................................... 201
Programming Reference.......................................................................................... 201
ASP...................................................................................................................... 201
Functions.......................................................................................................... 201
CCAddParam Function (ASP)....................................................................... 201
CCDLookUp Function (ASP)......................................................................... 201
CCFormatDate Function (ASP)..................................................................... 203
CCGetFromGet Function (ASP).................................................................... 204
CCGetFromPost Function (ASP) .................................................................. 204
CCGetGroupID Function (ASP) .................................................................... 205
CCGetParam Function (ASP) ....................................................................... 205
CCGetUserID Function (ASP)....................................................................... 206
CCGetValue Function (ASP)......................................................................... 207
CCOpenRS Function (ASP).......................................................................... 207
CCParseDate Function (ASP)....................................................................... 208
CCProcessError Function (ASP)................................................................... 208
CCRemoveParam Function (ASP)................................................................ 208
IIf Function (ASP).......................................................................................... 209
Methods............................................................................................................ 209
AddComponents Run-Time Method (ASP) ................................................... 209
Close Method (ASP) ..................................................................................... 210
Execute Method (ASP) ................................................................................. 210
GetEvents Method (ASP).............................................................................. 211
GetOriginFileName Method (ASP)................................................................ 212
Open Method (ASP)...................................................................................... 212
SetEvent Method (ASP)................................................................................ 213
SetVar Methods (ASP).................................................................................. 213
ToSQL Method (ASP) ................................................................................... 213
Run-Time Properties ........................................................................................ 214
AllowedFileMasks Run-Time Property (ASP)................................................ 214
CalendarStyles Run-Time Property (ASP).................................................... 215
Components Run-Time Property (ASP)........................................................ 215
Connection Run-Time Property (ASP) .......................................................... 216
ConnectionString Run-Time Property (ASP)................................................. 216
CurrentDate Run-Time Property (ASP)......................................................... 217
CurrentProcessingDate Run-Time Property (ASP) ....................................... 217
CurrentStyle Run-Time Property (ASP) ........................................................ 218
DataSource Run-Time Property (ASP) ......................................................... 218
DataSource.CountSQL Run-Time Property (ASP)........................................ 219
DataSource.Order Run-Time Property (ASP) ............................................... 219
DataSource.SQL Run-Time Property (ASP) ................................................. 220
DataSource.Where Run-Time Property (ASP).............................................. 221
DeleteAllowed Run-Time Property (ASP) ..................................................... 221
DisallowedFileMasks Run-Time Property (ASP)........................................... 222
EditMode Run-Time Property (ASP) ............................................................. 223
EmptyRows Run-Time Property (ASP) ......................................................... 223

9
 EmptyText Run-Time Property (ASP) ........................................................... 224
ErrorMessages Run-Time Property (ASP).................................................... 224
Errors Run-Time Property (ASP) .................................................................. 225
Events Run-Time Property (ASP) ................................................................. 226
FileFolder Run-Time Property (ASP) ............................................................ 227
FileName Run-Time Property (ASP)............................................................. 227
FileSize Run-Time Property (ASP) ............................................................... 228
FileSizeLimit Run-Time Property (ASP)........................................................ 228
Format Run-Time Property (ASP)................................................................. 229
FormSubmitted Run-Time Property (ASP).................................................... 229
Height Run-Time Property (ASP).................................................................. 230
InsertAllowed Run-Time Property (ASP)....................................................... 230
IsFormSubmitted Run-Time Property (ASP) ................................................. 230
IsPercent Run-Time Property (ASP) ............................................................. 231
IsUploaded Run-Time Property (ASP) .......................................................... 232
Link Run-Time Property (ASP)...................................................................... 232
NextProcessingDate Run-Time Property (ASP)............................................ 233
NumberOfColumns Run-Time Property (ASP).............................................. 234
NumberOfSubCategories Run-Time Property (ASP) .................................... 234
Password Run-Time Property (ASP) ............................................................ 235
PageNumber Run-Time Property (ASP) ....................................................... 235
PageSize Run-Time Property (ASP)............................................................. 236
PressedButton Run-Time Property (ASP)..................................................... 236
PrevProcessingDate Run-Time Property (ASP)............................................ 236
ReadAllowed Run-Time Property (ASP) ....................................................... 237
Recordset Run-Time Property (ASP)............................................................ 237
Recordset.RecordCount Run-Time Property (ASP)...................................... 238
RowNumber Run-Time Property (ASP) ........................................................ 239
State Run-Time Property (ASP).................................................................... 239
TemporaryFolder Run-Time Property (ASP)................................................. 239
TotalFunction Run-Time Property (ASP) ...................................................... 240
UpdateAllowed Run-Time Property (ASP) .................................................... 241
User Run-Time Property (ASP)..................................................................... 242
Value Run-Time Property (ASP) ................................................................... 242
ViewMode Run-Time Property (ASP) ........................................................... 243
Visible Run-Time Property (ASP).................................................................. 243
Variables .......................................................................................................... 244
DB<connectionname> Variable (ASP).......................................................... 244
FileName Variable (ASP) .............................................................................. 245
HTMLTemplate Variable (ASP)..................................................................... 246
PathToCurrentPage Variable (ASP) ............................................................. 246
PathToRoot Variable (ASP) .......................................................................... 247
Redirect Variable (ASP)................................................................................ 247
ScriptPath Variable (ASP)............................................................................. 248
TemplateFileName Variable (ASP) ............................................................... 248
Tpl Variable (ASP) ........................................................................................ 249
PHP...................................................................................................................... 249
Functions.......................................................................................................... 249
CCAddParam Function (PHP) ...................................................................... 249
CCDLookUp Function (PHP) ........................................................................ 249
CCFormatDate Function (PHP) .................................................................... 250
CCGetCookie Function (PHP) ...................................................................... 251

10
 CCGetFromGet Function (PHP) ................................................................... 252
CCGetFromPost Function (PHP) .................................................................. 252
CCGetGroupID Function (PHP) .................................................................... 252
CCGetParam Function (PHP) ....................................................................... 253
CCGetQueryString Function (PHP) .............................................................. 253
CCGetSession Function (PHP)..................................................................... 254
CCGetUserID Function (PHP) ...................................................................... 254
CCGetUserLogin Function (PHP) ................................................................. 254
CCLoginUser Function (PHP) ....................................................................... 255
CCLogoutUser Function (PHP)..................................................................... 255
CCParseDate Function (PHP) ...................................................................... 255
CCRemoveParam Function (PHP) ............................................................... 256
CCSetCookie Function (PHP)....................................................................... 256
CCSetSession Function (PHP) ..................................................................... 257
Methods............................................................................................................ 257
connect Method (PHP).................................................................................. 257
f Method (PHP) ............................................................................................. 258
GetFileName Method (PHP) ......................................................................... 258
GetFileSize Method (PHP)............................................................................ 258
GetLink Method (PHP).................................................................................. 258
GetValue Method (PHP) ............................................................................... 259
next_record Method (PHP) ........................................................................... 259
num_rows Method (PHP).............................................................................. 259
query Method (PHP) ..................................................................................... 260
SetLink Method (PHP) .................................................................................. 260
SetValue Method (PHP)................................................................................ 261
ToSQL Method (PHP)................................................................................... 261
Run-Time Properties ........................................................................................ 262
AllowedFileMasks Run-Time Property (PHP) ............................................... 262
CalendarStyles Run-Time Property (PHP).................................................... 262
ComponentName Run-Time Property (PHP) ................................................ 262
Components Run-Time Property (PHP)........................................................ 263
ComponentType Run-Time Property (PHP).................................................. 263
CurrentDate Run-Time Property (PHP) ........................................................ 263
CurrentProcessingDate Run-Time Property (PHP)....................................... 264
CurrentStyle Run-Time Property (PHP) ........................................................ 264
DeleteAllowed Run-Time Property (PHP) ..................................................... 265
DisallowedFileMasks Run-Time Property (PHP)........................................... 266
ds Run-Time Property (PHP) ........................................................................ 266
DataSource->CountSQL Run-Time Property (PHP) ..................................... 267
DataSource->Order Run-Time Property (PHP)............................................. 268
DataSource->RecordsCount Run-Time Property (PHP) ............................... 268
DataSource->SQL Run-Time Property (PHP)............................................... 269
DataSource->Where Run-Time Property (PHP) ........................................... 270
EditMode Run-Time Property (PHP)............................................................. 270
EmptyRows Run-Time Property (PHP)......................................................... 271
EmptyText Run-Time Property (PHP)........................................................... 271
Events Run-Time Property (PHP) ................................................................. 272
Errors Run-Time Property (PHP) .................................................................. 272
FileFolder Run-Time Property (PHP) ............................................................ 273
FileSizeLimit Run-Time Property (PHP)........................................................ 273
FirstWeekDay Run-Time Property (PHP) ..................................................... 274

11
 Format Run-Time Property (PHP)................................................................. 274
FormSubmitted Run-Time Property (PHP).................................................... 275
Height Run-Time Property (PHP).................................................................. 275
InsertAllowed Run-Time Property (PHP) ...................................................... 275
IsPercent Run-Time Property (PHP)............................................................. 276
NextProcessingDate Run-Time Property (PHP) ........................................... 277
NumberOfColumns Run-Time Property (PHP) ............................................. 277
NumberOfSubcategories Run-Time Property (PHP)..................................... 277
Parent Run-Time Property (PHP) ................................................................. 278
PressedButton Run-Time Property (PHP) .................................................... 278
PrevProcessingDate Run-Time Property (PHP) ........................................... 279
ReadAllowed Run-Time Property (PHP) ....................................................... 279
TemporaryFolder Run-Time Property (PHP)................................................. 279
TotalFunction Run-Time Property (PHP) ...................................................... 280
Update Allowed Run-Time Property (PHP) ................................................... 280
ViewMode Run-Time Property (PHP) ........................................................... 281
Visible Run-Time Property (PHP) ................................................................. 282
Variables .......................................................................................................... 282
DB<connectionname> Variable (PHP).......................................................... 282
FileName Variable (PHP).............................................................................. 283
PathToRoot Variable (PHP) .......................................................................... 283
Redirect Variable (PHP)................................................................................ 284
RelativePath Constant (PHP)........................................................................ 284
TemplateFileName Variable (PHP)............................................................... 285
Tpl Variable (PHP) ........................................................................................ 285
Perl....................................................................................................................... 286
Fuctions............................................................................................................ 286
CCAddParam Function (Perl) ....................................................................... 286
CCDLookUp Function (Perl) ......................................................................... 286
CCFormatDate Function (Perl) ..................................................................... 287
CCGetCookie Function (Perl) ....................................................................... 288
CCGetFromGet Function (Perl) .................................................................... 288
CCGetFromPost Function (Perl) ................................................................... 289
CCGetGroupID Function (Perl) ..................................................................... 289
CCGetParam Function (Perl) ........................................................................ 289
CCGetQueryString Function (Perl) ............................................................... 290
CCGetSession Function (Perl)...................................................................... 290
CCGetUserID Function (Perl) ....................................................................... 291
CCGetUserLogin Function (Perl) .................................................................. 291
CCParseDate Function (Perl) ....................................................................... 291
CCRemoveParam Function (Perl) ................................................................ 292
CCSetCookie Function (Perl)........................................................................ 292
CCSetSession Function (Perl) ...................................................................... 293
ColdFusion........................................................................................................... 293
Variables .......................................................................................................... 293
<control>Item Run-Time Variable (ColdFusion)............................................ 293
<control>Items Run-Time Variable (ColdFusion) .......................................... 293
<control name>Rows Run-Time Variable (ColdFusion)................................ 294
arr_<control name> Run-Time Variable (ColdFusion) .................................. 294
blnDeleteAllowed<form> Run-Time Variable (ColdFusion)........................... 294
blnEditMode<form> Run-Time Variable (ColdFusion) .................................. 295
blnFormSubmitted<control name> Run-Time Property (ColdFusion) ........... 295

12
 blnInsertAllowed<form> Run-Time Variable (ColdFusion) ............................ 296
blnReadAllowed<form> Run-Time Variable (ColdFusion) ............................ 296
blnUpdateAllowed<form> Run-Time Variable (ColdFusion).......................... 296
CalendarEvents Run-Time Variable (ColdFusion) ........................................ 297
CalendarStyles Run-Time Variable (ColdFusion) ......................................... 297
CurrentDate Run-Time Variable (ColdFusion) .............................................. 298
CurrentProcessingDate Run-Time Variable (ColdFusion) ............................ 298
CurrentStyle Run-Time Variable (ColdFusion).............................................. 298
DB_<connection name>_DS Run-Time Variable (ColdFusion) .................... 299
DB_<connection name>_USER_PASSWORD; Run-Time Variable (ColdFusion) 299
DB_<connection name>_DB_TYPE; Run-Time Variable (ColdFusion) ........ 300
DB_<connection name>_USER_NAME Run-Time Variable (ColdFusion) ... 300
fld<control name> Run-Time Variable (ColdFusion) ..................................... 300
fld<control>Link Run-Time Variable (ColdFusion) ........................................ 301
hide<control> Run-Time Variable (ColdFusion) ............................................ 301
intEmptyRows Run-Time Variable (ColdFusion)........................................... 302
intPage Run-Time Variable (ColdFusion) ..................................................... 302
intPageSize Run-Time Variable (ColdFusion)............................................... 302
intShownRecords Run-Time Variable (ColdFusion)...................................... 303
NextProcessingDate Run-Time Variable (ColdFusion) ................................. 303
NumberOfColumns Run-Time Variable (ColdFusion) ................................... 303
NumberOfSubCategories Run-Time Variable (ColdFusion).......................... 304
par<control name>.FileFolder Run-Time Variable (ColdFusion)................... 304
par<control>.TemporaryFolder Run-Time Variable (ColdFusion) ................. 304
PathToCurrentPage Run-Time Variable (ColdFusion).................................. 305
PathToRoot Run-Time Variable (ColdFusion)............................................... 305
PrevProcessingDate Run-Time Variable (ColdFusion) ................................. 306
query<control> Run-Time Variable (ColdFusion).......................................... 306
FileName Run-Time Variable (ColdFusion) .................................................. 306
strErr<form> Run-Time Variable (ColdFusion).............................................. 307
strOperation Run-Time Variable (ColdFusion) .............................................. 307
strOrder Run-Time Variable (ColdFusion) .................................................... 308
strOrder<control> Run-Time Variable (ColdFusion)...................................... 308
strPressedButton Run-Time Variable (ColdFusion) ...................................... 308
strRedirect Run-Time Variable (ColdFusion) ................................................ 309
strSQL Run-Time Variable (ColdFusion) ...................................................... 309
strSQL<control> Run-Time Variable (ColdFusion)........................................ 310
strSQL Run-Time Variable (ColdFusion) ...................................................... 310
strTemplateFileName Run-Time Variable (ColdFusion) ............................... 310
strWhere Run-Time Variable (ColdFusion) ................................................... 311
strWhere<control> Run-Time Variable (ColdFusion) .................................... 311
ViewMode Run-Time Variable (ColdFusion)................................................. 311
Java ..................................................................................................................... 312
Methods............................................................................................................ 312
A - G ............................................................................................................. 312
H - Z.............................................................................................................. 341
.NET..................................................................................................................... 360
Common Classes ............................................................................................. 360
BooleanParameter Class (.NET)................................................................... 360
DateParameter Class (.NET) ........................................................................ 361
FieldBase Class (.NET)................................................................................. 362
FloatParameter Class (.NET)........................................................................ 363

13
 IntegerParameter Class (.NET)..................................................................... 363
public class ItemCollection:NameObjectCollectionBase, ICloneable (.NET) 364
public class LinkParameterCollection:NameObjectCollectionBase (.NET) ... 365
MemoParameter Class (.NET)...................................................................... 365
TextParameter Class (.NET)......................................................................... 366
Methods............................................................................................................ 367
CreateFromHttpRequest Method (.NET) ...................................................... 367
DataBind Method (.NET)............................................................................... 367
DeleteFile Method (.NET) ............................................................................. 368
DeleteItem Method (.NET) ............................................................................ 368
InsertItem Method (.NET).............................................................................. 368
FillItem Method (.NET).................................................................................. 369
GetResultSet Method (.NET) ........................................................................ 369
GetResultSet Method (.NET) ........................................................................ 369
Update Method (.NET).................................................................................. 369
UpdateItem Method (.NET) ........................................................................... 370
SaveFile Method (.NET)................................................................................ 370
Validate Method (.NET) ................................................................................ 370
ValidateFile Method (.NET)........................................................................... 371
Run-Time Properties ........................................................................................ 371
AllowedFileMasks Run-Time Property (.NET)............................................... 371
BoolFormat Run-Time Property (.NET)......................................................... 371
ConnectionCommands Run-Time Property (.NET)....................................... 372
Connection Run-Time Property (.NET) ......................................................... 372
ContentType Run-Time Property (.NET)....................................................... 373
CurrentDate Run-Time Property (.NET)........................................................ 374
CurrentDate Run-Time Property (.NET)........................................................ 374
DataSource Run-Time Property (.NET) ........................................................ 375
DataType Run-Time Property (.NET)............................................................ 375
DateFormat Run-Time Property (.NET) ........................................................ 375
Date Run-Time Property (.NET).................................................................... 376
Date Run-Time Property (.NET).................................................................... 376
DateLeftDelim Run-Time Property (.NET) .................................................... 377
DateRightDelim Run-Time Property (.NET) .................................................. 377
Day Run-Time Property (.NET)..................................................................... 378
Day Run-Time Property (.NET)..................................................................... 378
DisallowedFileMasks Run-Time Property (.NET).......................................... 379
EmptyText Run-Time Property (.NET) .......................................................... 379
errors Run-Time Property (.NET).................................................................. 380
Field Run-Time Property (.NET) ................................................................... 380
FileFolder Run-Time Property (.NET) ........................................................... 380
FileSizeLimit Run-Time Property (.NET)....................................................... 381
Format Run-Time Property (.NET)................................................................ 382
Function Run-Time Property (.NET) ............................................................. 382
Groups Run-Time Property (.NET) ............................................................... 383
Height Run-Time Property (.NET)................................................................. 383
IsDeleted Run-Time Property (.NET) ............................................................ 384
IsEmptyItem Run-Time Property (.NET) ....................................................... 384
IsNew Run-Time Property (.NET) ................................................................. 385
IsUpdated Run-Time Property (.NET)........................................................... 385
MaxPage Run-Time Property (.NET) ............................................................ 386
Mode Run-Time Property (.NET) .................................................................. 386

14
Month Run-Time Property (.NET) ................................................................. 387
MonthsInRow Run-Time Property (.NET) ..................................................... 387
Name Run-Time Property (.NET).................................................................. 388
NumberOfColumns Run-Time Property (.NET)............................................. 388
NumberOfSubCategories Run-Time Property (.NET) ................................... 388
Order Run-Time Property (.NET) .................................................................. 389
PageNumber Run-Time Property (.NET) ...................................................... 390
PagerSize Run-Time Property (.NET)........................................................... 390
PageSize Run-Time Property (.NET)............................................................ 391
PageSizeLimit Run-Time Property (.NET) .................................................... 391
PageNumber Run-Time Property (.NET) ...................................................... 392
PercentOf Run-Time Property (.NET) ........................................................... 392
PreviewPageNumber Run-Time Property (.NET) ......................................... 393
Quarter Run-Time Property (.NET) ............................................................... 393
RecordPerPage Run-Time Property (.NET).................................................. 393
Required Run-Time Property (.NET)............................................................. 394
ResetAt Run-Time Property (.NET) .............................................................. 394
RowNumber Run-Time Property (.NET) ....................................................... 395
ShowOtherMonthsDays Run-Time Property (.NET) ..................................... 395
Source Run-Time Property (.NET)................................................................ 396
SourceType Run-Time Property (.NET)........................................................ 397
State Run-Time Property (.NET)................................................................... 397
Style Run-Time Property (.NET) ................................................................... 398
TemporaryFolder Run-Time Property (.NET)................................................ 398
Text Run-Time Property (.NET) .................................................................... 399
Text Run-Time Property (.NET) .................................................................... 399
TotalPages Run-Time Property (.NET) ......................................................... 400
Type Run-Time Property (.NET) ................................................................... 400
ViewMode Run-Time Property (.NET) .......................................................... 401
Visible Run-Time Property (.NET)................................................................. 401
WebPageSize Run-Time Property (.NET) .................................................... 402
Year Run-Time Property (.NET).................................................................... 402
Year Run-Time Property (.NET).................................................................... 403
YearsRange Run-Time Property (.NET) ....................................................... 403

15
Component Reference

Components
Referencing Objects
The objects in the Web applications generated by CodeCharge Studio can be referenced in a
variety of ways. In many cases, to work with a specific object within a program you will need to
know its position within the program hierarchy. For example, an object that is placed directly on the
page may need to be addressed differently compared to an object placed within a form (which is
also an object).
ASP
Examples of working with objects Syntax
Form object placed on a page Page Events <form>.Visible = False
Form Events EventCaller.Visible = False
Control object placed within a Page Events <form>.<control>.Value = "123"
form
Form Events EventCaller.<control>.Value = "123"
Control Events EventCaller.Value = "123"
Control object placed on a page Page Events <control>.Value = "ABC"
Control Events EventCaller.Value = "ABC"
Control object placed on an Main Page <page>.<control>.Visible = False
included page Events
Includable Page EventCaller.<control>.Visible = False
Events
Control Events EventCaller.Visible = False
Form object placed on an Main Page <page>.<form>.Visible = False
included page Events
Includable Page EventCaller.<form>.Visible = False
Events
Form Events EventCaller.Visible = False
Control object placed in a form Main Page <page>.<form>.<control>.Visible = False
within an included page Events
Includable Page EventCaller.<form>.<control>.Visible = False
Events
Form Events EventCaller.<control>.Visible = False
Control Events EventCaller.Visible = False
Note: Using EventCaller is recommended when planning to reuse the event code since it doesn't
require referring to objects by name.
PHP

16
When using PHP you can address objects in a generic way as $Component to refer to the
component raising the event, and $Container to refer to the host form of $Component. This
method of referring to objects is recommended to make the event code reusable since it doesn't
require referring to objects by name. You can also refer to objects using global variables, for
example use $MyGrid to refer to 'MyGrid' grid.
Examples of
working with
Syntax
objects in a
generic way
Form Page $Component->form->visible = false;
object Events
placed
Form $Component->Visible = false;
on a
Events
page
Control Page $Component->form->control->SetValue($Component->form->PageNumber);
object Events
placed
Form $Component->control->SetValue($Component->PageNumber);
within a Events
form
Control $Component->SetValue($Container->PageNumber);
Events
Control Page $Component->control->SetValue("ABC");
object Events
placed Control $Component->SetValue("ABC");
on a Events
page
Control Main $Component->page->control->Visible = false;
object Page
placed Events
on an
Includable $Component->control->Visible = false;
included
Page
page Events
Control $Component->Visible = false;
Events
Form Main $Component->page->form->Visible = false;
object Page
placed Events
on an
Includable $Component->form->Visible = false;
included Page
page
Events
Form $Component->Visible = false;
Events
Control Main $Component->page->form->control->Visible = false;
object Page
placed in Events
a form
Includable $Component->form->control->Visible = false;
within
Page

17
an Events
included $Component->control->Visible = false;
Form
page
Events
Control $Component->Visible = false;
Events

Examples of working with objects using global

Syntax
variables
Form object placed on a page $form->Visible = false;
Control object placed within a form $form->control->SetValue("123");
Control object placed on a page $control->SetValue("ABC");
Control object placed on an included page $page->control->Visible = false;
Form object placed on an included page $page->form->Visible = false;
Control object placed in a form within an included page $page->form->control->Visible = false;
Perl
Examples of working with objects Syntax
Form object placed on a page $<form>->{Visible} = 0;
Control object placed within a form $<form>->{<control>}->SetValue("123");
Control object placed on a page $<control>->SetValue("ABC");
Control object placed on an included page $<page>->{<control>}->{Visible} = 0;
Form object placed on an included page $<page>->{<form>}->{Visible} = 0;
Control object placed in a form within an included $<page>->{<form>}->{<control>}->{Visible} = 0;
page
Assigning an object to a variable $<variable> = $<object>;
Java
Examples of working with
Syntax
objects
Form object placed on a page Page e.getPage().getComponent("<form>").setVisible(false);
Events
Form e.getComponent().setVisible(false);
Events
Control object placed within a Page e.getPage().getComponent("<form>").getControl("<control>").setVa
form Events
Form e.getComponent().getControl("<control>").setValue("123");
Events
Control e.getControl().setValue("123");
Events
Control object placed on a Page e.getPage().getControl("<control>").setValue("ABC");
page Events

18
 Control e.getControl().setValue("ABC");
Events
Assigning an object to a variable <variable> = <object>;
Note: The syntax for accessing objects in an included page from events within the same included
page is the same as specified above. The syntax for accessing objects in an included page from
events within the including page is not supported. The syntax for accessing objects in the including
page from events within the included page is also not supported.
C#
Examples of working with objects Syntax
Form object placed on a page Grid and Editable <form>Repeater.Visible = false;
Grid Events
Record Events <form>Holder.Visible = false;
Directory and Path <form>.Visible = false;
Events
Control object placed within a Record form <form><control>.Visible = false;
Control object placed within a Control's Before <form><control>.Visible = false;
Grid, Editable Grid, Directory Show Event
and Path form Form's Before Show Object reference should be retrieved from
and Before Show the FormControls collection.
Row Event See the ItemDataBound Event MSDN
example.
Control object placed on a page <control>.Visible = false;
Assigning an object to a variable <variable> = <object>;
Note: The syntax for accessing objects in an included page from events within the same included
page is the same as specified above. The syntax for accessing objects in an included page from
events within the including page is not supported. The syntax for accessing objects in the including
page from events within the included page is also not supported.
VB.Net
Examples of working with objects Syntax
Form object placed on a page Grid and Editable <form>Repeater.Visible = False
Grid Events
Record Events <form>Holder.Visible = False
Directory and Path <form>.Visible = False
Events
Control object placed within a Record form <form><control>.Visible = False
Control object placed within a Control's Before <form><control>.Visible = False
Grid, Editable Grid, Directory Show Event
and Path form Form's Before Show Object reference should be retrieved from
and Before Show the FormControls collection.
Row Event See the ItemDataBound Event MSDN
example.
Control object placed on a page <control>.Visible = False

19
Assigning an object to a variable <variable> = <object>
Note: The syntax for accessing objects in an included page from events within the same included
page is the same as specified above. The syntax for accessing objects in an included page from
events within the including page is not supported. The syntax for accessing objects in the including
page from events within the included page is also not supported.
ColdFusion
Examples of working with objects Syntax
Form variable placed on a page or within a form <CFSET blnReadAllowed<form>=false>
Control variable placed within a form or a page <CFSET fld<control> = "abc">
Note: The syntax for accessing objects in an included page from events within the same included
page is the same as specified above.

Button Control Reference

Design-Time Properties
Property Description
Name The name of the control.
Operation The type of operation performed when the button is clicked [Insert, Update,
Delete, Cancel or Search]. If the form does not have a Data Source, this
property can be set to 'Insert' in which case the button will simply submit the
form.
Return Page Use this property to specify the page that should be viewed after the button
has been clicked.
Remove Parameters Specify a semicolon-separated list of parameters that should be removed
from the query string
Convert URL to Specify whether the URL should be converted to an absolute URL or a
secure (https://) URL.
Default Button If this property is set to 'Yes', pressing the enter key while on the page will be
equivalent to clicking on this button.
Enable Validation [Yes/No] Specify whether validation should be enabled when the button is
clicked.
Events
Event Description
Server Side Events
On Click Occurs after the button has been clicked and the form is submitted. If the
button appears in a record or editable grid form, record operations such as
insert, update and delete occur after this event has been processed. In cases
where the form does not have a Data Source, this event is used to perform
post-submission operations such as sending emails messages based on the
submitted information.
Before Show Occurs before the control is rendered to the page. This event can be used to
influence the visibility or appearance of the control.
Client Side Events

20
On Click Occurs immediately after the button has been clicked and before the form is
submitted. This client event can be used to validate the contents of the form
on the client side before the values are submitted to the server.
On Load Occurs after the control has been rendered to the page and before the user
can perform any operations. This event can be used to bind validation rules
to the control.
Run-Time Properties (ASP)
Property Description
Visible This property controls the visibility of the control. If the property is set to false,
the control will not be displayed.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property controls the visibility of the button. If the property is set to false,
the button will not be displayed.
Run-Time Properties (.NET)
Property Description
Visible This property controls the visibility of the button. If the property is set to false,
the button will not be displayed.
Run-Time Variable (CF,CFT)
Property Description
hide<control name> This property controls the visibility of the button. If the property is set to true,
the button will not be displayed.

Methods (Servlets & JSP)

Method Description
isVisible Whether this control should be shown.
setVisible Specify whether this control or component should be shown.
getParent Get the parent component that contains this control or component.
See also:
Button Overview

Calendar Reference
Design-Time Properties
Property Description
Name The name of the form.
Connection The database connection to be used for information retrieval.

21
Data Source The type of data source or the method used to retrieve the data.
Type
Data Source The database column, SQL Query or other expression the data is to be retrieved
from.
Restricted Allow access only to authenticated and authorized users.
Type Type of the calendar, such as Annual, Quarterly, 3-Months, Monthly
Date Field Database field containing the date of the calendar event.
Date DB The database field format used with the date field.
Format
Time Field Database field containing the time of the calendar event, if time is stored in a
different field than the date.
Time DB The database field format used with the time field.
Format
Show nearby Whether to show days of the surrounding months if the 1st or last week of the
days month includes days of other months.
No of Columns The number of calendar columns.
Empty Weeks Specifies if an empty 6th week row should be added to monthly snapshots for
months that span only 5 weeks.
Run-Time Properties (ASP)
Property Description
CurrentDate Specify the current day.
CurrentProcessingDate Retrieves the current processing date.
PrevProcessingDate Retrieves the previous processing date.
NextProcessingDate Retrieves the next processing date.
CalendarEvents Contains the calendar events.
CalendarStyles Contains the calendar styles.
CurrentStyle Specifies the style for the current processing block.
Visible Specifies whether the calendar should be shown.
Run-Time Properties (PHP)
Property Description
ComponentType Specify the type of component. Have value "Calendar" for Calendar
component.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
ComponentName Specify the name of report.
FirstWeekDay Specify first weekday for calendar.
CurrentDate Specify the currently shown date.
CurrentProcessingDate Current processing date.
PrevProcessingDate Previvous processing date.

22
NextProcessingDate Next processing date.
CalendarStyles Contains the calendar styles.
CurrentStyle Specifies the style for the current processing block.
Events Contains the calendar events.
Visible Specifies whether the calendar should be shown.
Methods (ASP)
Method Description
SetEvent Adds new event.
GetEvents Returns events for the current date.
Methods (Servlets & JSP)
Method Description
isVisible Specifies whether this control is to be shown.
setVisible Specifies whether this control or component should be shown.
getParent Retrieves the parent component that contains this control or
component.
getCurrentStyle Returns the style (not style name) that will be applied to the current
Calendar section.
setCurrentStyle Specifies the style (not style name) that will be applied to the current
Calendar section. The method is used identically in the events.
getDateField Returns field name that points to the event's date. This field is required
if datasource is defined and allows to link calendar days with events.
setDateField Specifies the field name pointing to the Event Date. This field is
required if the Data Source is defined and allows to link events to the
Calendar days.
hasNextItem Indicates if the next calendar item is available. This method can be
used in the View mode only.
nextItem Returns the next calendar item if it is available. This method can be
used in the View mode only.
getCurrentItem Returns the current calendar item if it is available.
getMonths Retrieves the number of the displayed months
setMonths Specifies the number of the displayed months
getMonthsInRow Returns the number of months in the calendar row for the yearly and
quarterly calendars. If monthsInRows == 0 all months will be shown in
one row.
setMonthsInRow Specifies the number of months in the calendar row for the yearly and
quarterly calendars. If monthsInRows == 0 all months will be shown in
one row.
getTimeField Returns the field name pointing to the Event Time. If 'null,' the
calendar will retrieve the Event Time from the dateField field.
setTimeField Specifies the field name pointing to the Event Time. If 'null,' the

23
 calendar will retrieve the Event Time from the dateField field.
getVisualStyles Returns the map containing Styles that represent days of months,
weeks, etc.
setVisualStyles Specifies the map containing Styles that represent days of months,
weeks, etc.
getVisualStyle Returns the style with the specified name.
setVisualStyle Specifies the style with specified name to be used.
getCurrentProcessingDate Returns the currently processed date to be used in events.
getMonth Returns the month number to be shown. If it is not defined, the current
month will be used.
getYear Returns the year to be shown. If it is not defined, the current year is
used.
isShowOtherMonthsDays Returns 'true' if days of the neighbouring months should be shown,
otherwise - 'false'.
setShowOtherMonthsDays Specifies whether days of the neighbouring months should be shown.
Run-Time Variable (CF.CFT)
Variable Description
CurrentDate Specifies the current day.
CurrentProcessingDate Retrieves the current processing date.
PrevProcessingDate Retrieves the previous processing date.
NextProcessingDate Retrieves the next processing date.
CalendarEvents Contains the calendar events.
CalendarStyles Contains the calendar styles.
CurrentStyle Specifies the style for the current processing block.
hide<control> Specifies whether the calendar should be shown.
Run-Time Properties (.NET)
Calendar Interface object (Controls.Calendar class)
Property Description
CurrentDate Gets or sets the current date.
DataSource Gets or sets a reference to data source bound to the form.
Date Gets or sets date active date for the current calendar.
Day Gets or sets the day part of active date.
Mode Gets or sets the mode of the current calendar component.
Month Gets or sets the month part of active date.
MonthsInRow Gets or sets the number of displaing months in one row.
ShowOtherMonthsDays Gets or sets the showing of dates from other monthes for current month.
Visible Specifies whether the calendar should be shown.
WeekDayFormat Gets or sets the format for displaying name of week days.

24
Year Gets or sets the month part of active date.
Calendar Model Layer
Property Description
errors This property keeps a reference to the form’s errors
NameValueCollection. It is used to collect error messages generated
during the object’s execution.
<control name> For each control that is located within the form, a member property is
created with the same name as the control.
<field name>GroupField For each group of report, the member property is created.

Calendar Data Provider

Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member
property is created with the prefix (according to the parameter source
type) and parameter name (according to the parameter source).
See also
Calendar Navigator Reference

Calendar Navigator Reference

Design-Time Properties
Property Description
Name The name of the form.
No of Years Year range to be display in the Navigator.
Run-Time Properties (ASP)
Property Description
FileName Specifies the URL of the page to which the navigator is linked.
Visible Specify whether the calendar navigator should be shown.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies the type of component. Value "CalendarNavigator" is used for the
Calendar component.
ComponentName Specifies the name of Calendar Navigator.
Parent Specifies parent container of an object, for example a record form for a textbox
that is included within that form.
Visible Specifies whether the Calendar Navigator should be shown.
Methods (Servlets & JSP)
Method Description
isVisible Indicates whether this control is to be shown.

25
setVisible Specifies whether this control or component should be shown.
getYearsRange Returns the number of years to be displayed in the navigator.
setYearsRange Specifies the number of years to be displayed in the navigator.
Run-Time Properties (.NET)
CalendarNavigator
Property Description
Date Retrives the selected date.
Month Retrives the month part of selected date.
Order Retrives or specifies the order ow showing navigator parts.
Quarter Retrives the quarter number that contain selected date.
Year Retrives the year part of selected date.
YearsRange Retrives or specifies the range of displayed years.
See also
Calendar Reference

Checkbox Control Reference

Design-Time Properties
Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Checked Value The value submitted by a Checkbox Control when it is checked.
Unchecked Value The value submitted by a Checkbox Control when it is unchecked.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Error Control Specify the name of a control that will be used to display any error messages
pertaining to this control.
Validation Rule Specify an expression that will be used to check the validity of the data
entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does
not meet the validation rule.
Events
Event Description
Server Side Events

26
Before Show This event occurs before a component is rendered to the page.
Client Side Events
On Load Used for binding Validation rules to the control.
Run-Time Properties (ASP)
Property Description
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Value Holds a value of the control.
Visible This property determines whether the control is to be shown (parsed into
template) or not.
State Returns state of the object.
Run-Time Properties (PHP)
Property Description
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the control is to be shown (parsed into
template) or not.
Run-Time Properties (.NET)
Interface The System.Web.UI.WebControls.Checkbox is used
Property Description
Visible Gets or sets a value that indicates whether a server control is rendered as UI
on the page.
Checked Gets or sets a value indicating whether the CheckBox control is checked.
See .NET Framework SDK reference.
Model Layer
Property Description
<control name> Contains current value of control.
<control name>CheckedValue Contains checked value of control.
<control name>UncheckedValue Contains unchecked value of control.
Methods (PHP)
Method Description
GetValue Retrieves the value of the CheckBox control.
SetValue Sets the value for the CheckBox control.
Methods (Servlets & JSP)

27
Method Description
getPage Get the page that contains this control.
setValue This method sets the value for the control.
hasErrors Whether the control has (validation) errors.
addError Add error description to errors collection.
getErrorsAsString Get all errors formatted as String, separated by &lt;br&gt; elements.
isVisible Whether this control should be shown.
setVisible Specify whether this control or component should be shown.
getParent Get the parent component that contains this control or component.
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> Holds the value of the control.
hide<control name> This variable determines whether the control is to be shown or not.
See also
Checkbox Overview

CheckBox List Control Reference

Design-Time Properties
Property Description
Name The name of the control.
Caption The name used to refer to the control in an error message.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control.
Connection The database connection from where data will be retrieved.
List Source Type Specify the type of data source for the list of values to be shown in the
control.
List Data Source Specify the actual data source for the list of values to appear in the control.
The value entered here depends on the List Source Type property.
Bound Column When using database columns as the data source, specify the column
containing the values that will be submitted.
Text Column When using database columns as the data source, specify the column
containing the values that will be displayed.
Data Type The type of data that will be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Content Specify whether the data source content is plain text or HTML code.
Required [Yes/No] Select ‘Yes’ if a value must be entered for the control in order for

28
 the form to be submitted successfully.
Unique [Yes/No] Select ‘Yes’ if you want a check to be made to ensure that any
value entered in the control does not already exist in the database.
Error Control Specify the name of a control that will be used to display any error messages
pertaining to the control. If this value is not specified, all error messages are
displayed at the top of the form in which the control is contained.
Validation Rule Specify an expression that will be used to check the validity of the data
entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does
not satisfy the validation rule.
Events
Event Description
Server Side Events
On Validate This event occurs after standard validation operations have been
performed as a result of submitting values, but before any database
operations have been performed with the submitted values.
Before Show This event occurs before a component is rendered to the page.
Before Build Select This event occurs before the query that will be used to retrieve records
from the database is put together. This event can be used to modify the
different clauses that make up the query such as the WHERE clause or the
ORDER BY clause.
Before Execute Select This event occurs immediately before a row selection query is executed but
after the query has been composed. This event can be used to modify the
entire query before it is executed.
After Execute Select This event occurs after the row selection query has been executed and a
recordset containing the results is returned.
Client Side Events
On Click Occurs immediately after the control has been clicked. This event can be
used to provide interactive behavior when the control is clicked.
Run-Time Properties (ASP)
Property Description
DataSource A Data Source object created for the purpose of retrieving and holding the
IDs and values to be displayed in the control.
Errors This property keeps a reference to the object’s error collection. It is used to
collect error messages generated during the object’s execution.
Value This property stores the first selected checkbox value.
Visible This property controls the visibility of the control. If the property is set to false,
the control will not be displayed.
Data Source properties
Property Description
DataSource.SQL This property contains the main portion of the SQL query used to retrieve the

29
 records displayed within the control . In terms of SQL, this property defines
the SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the control. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource.SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
control.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
DataSource A Data Source object created for the purpose of retrieving and holding the
IDs and values to be displayed in the control.
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Visible This property controls the visibility of the control. If the property is set to false,
the control will not be displayed.
Data Source properties
Property Description
DataSource->SQL This property contains the main portion of the SQL query used to retrieve
the records displayed within the control. In terms of SQL, this property
defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the control. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource->SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
control.
Methods (PHP)
Method Description
GetValue Retrieves the value of the CheckBox List control. Only the first element of the
array of values is retrieved.
SetValue Sets the value of the CheckBox List control.
Run-Time Properties (.NET)
Interface System.Web.UI.WebControls.CheckBoxList class is used.
Property Description
Items Gets the collection of items in the list control. See the .NET Framework SDK
reference.
SelectedIndex Gets or sets the lowest ordinal index of the selected items in the list. See the

30
 .NET Framework SDK reference.
SelectedItem Gets the selected item with the lowest index in the list control. See the .NET
Framework SDK reference.
Visible This property controls the visibility of the control. If the property is set to false,
the control will not be displayed.
Model Layer
Property Description
<control name> Contains the current value of the control.
<control name>Items This is a Collection of the control items.
Run-Time Variables (CF,CFT)
Variable Description
arr_<owner name><control name> This variable contains the array of items in the control.
fld<control name> Holds the value of the control. This variable can contain a
semicolon separated list of values
hide<control name> This variable controls the visibility of the control. If the variable
is set to true, the control will not be displayed.
strOrder<control name> This property contains the ORDER BY clause portion of the
SQL query used to retrieve records for the control. The
ORDER BY clause determines the order of appearance of the
retrieved records. The value of this property is appended to
the value of the strSQL<control name> property to create the
final SQL query which is executed against the datasource to
retrieve the records for the control.
strSQL<control name> This property contains the main portion of the SQL query used
to retrieve the records displayed within the control. In terms of
SQL, this property defines the SELECT and FROM clauses of
the SQL query.
strWhere<control name> This property contains the WHERE clause portion of the SQL
query used to retrieve records for the control. The WHERE
clause provides the criteria which filters the records retrieved.
The value of this property is appended to the value of the
strSQL<control name> property to create the final SQL query
which is executed against the datasource to retrieve the
records for the control.
query<control name> This variable contains the query object associated with the
control.
Methods (Servlets & JSP)
Method Description
addValue In the case where the CheckBox List allows for the selection of multiple
values, this function is used to add a value to the list of selected values.
setValues Set the list of selected values from an enumeration of Strings.
setListOfValues Set the list of values to choose from. Used to populate list values from a
String.

31
getOptions Get the options list in the form of an enumeration of Strings.
setOptions Set the list of values to choose from. Used to populate list values from a
String.
getFormattedOptions Prepare list collection for output. This method marks those list values that
were selected by request.
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether this control should be shown.
getParent Get the parent component that contains this control.
See also
Checkbox List Overview

Connection Reference
Design-Time Properties
Property Description
Name The name of the connection. Has to be unique.
Design Database Type The type of database being accessed during design time. If your
database type is not listed, select the ANSI SQL-92 option.
Connection String Depending on the type of connection, this can be either an ODBC DSN
or a connection string.
Connection Type The type of connection. ODBC or Connection String.
Login The user login name needed to access the database.
Password The user password needed to access the database.
Server Database Type The type of database being accessed during the server (live) execution.
If your database type is not listed, select the ANSI SQL-92 option.
Date Format The format in which date values should be entered into the database.
Boolean Format The format in which Boolean values should be entered into the
database.
Catalog Specify a database catalog from which to display objects during design
time.
Schema Specify a database schema from which to display objects during design
time.

32
Views [Yes/No] Select 'Yes' to enable the display of database views during
design time.
Synonyms [Yes/No] Select 'Yes' to enable the display of database Synonyms
during design time.
System Tables [Yes/No] Select 'Yes' to enable the display of database System Tables
during design time.
System Views [Yes/No] Select 'Yes' to enable the display of database System Views
during design time.
Aliases [Yes/No] Select 'Yes' to enable the display of database aliases during
design time.
Use LIMIT/TOP [Yes/No] Select 'Yes' to enable the usage of LIMIT or TOP clause to
limit the size of SQL result sets.
Server Same As Design [Yes/No] Select 'Yes' if the same connection will be used for design time
as well as on the server.
Server Connection Type If the server connection is different from the design connection, specify
whether the server connection will use an ODBC DSN or connection
string.
Server Connection String If the server connection is different from the design connection, specify
the ODBC DSN or connection string to be used.
Server Login If the server connection is different from the design connection, enter
the user login name needed to access the server database.
Server Password If the server connection is different from the design connection, enter
the user password needed to access the server database.
Run-Time Properties (ASP)
Property Description
Connection Retrieves the Connection object used to access data for a given item. Since
a project can have several connections, this property stores the connection
used for a particular data bound object. The Connection object can be used
to perform various basic operations such as execution of an SQL query
against the database.
ConnectionString This property contains the connection string used to establish the database
connection. This string includes the connection type, user credentials,
database name or path and some other parameters. The connection string is
passed to an ADO connection object when a new connection is being made.
Errors This is a collection of errors pertaining to the object. Any errors which occur
during the course of the objects execution are registered in this collection.
Password This property contains the password used to establish a connection to the
database. In some cases, the user name and password are included within
ConnectionString property.
User This property contains the user name used to establish a connection to the
database. In some cases, the user name and password are included within
ConnectionString property.
Run-Time Properties (PHP)

33
Property Description
Errors This is a collection of errors pertaining to the object. Any errors which occur
during the course of the objects execution are registered in this collection.
Run-Time Properties (.NET)
public sealed class ConnectionString
Property Description
Connection The connection string that includes the database name, and other
parameters needed to establish the initial connection. The default value is
an empty string.
Type The type of .NET Managed Provider which will be used for the connection
ConnectionCommands The collection of commands which will be executed when the connection
is opened.
DateFormat Mask for formatting and parsing DateTime values.
BoolFormat Mask for formatting and parsing Boolean values.
DateLeftDelim Left delimeter for date values in an SQL command (for example '#' for MS
Access).
DateRightDelim Right delimeter for date values in an SQL command (for example '#' for
MS Access).
Methods (ASP)
Method Description
Close Closes the database connection.
Execute Executes an SQL query against the database connection. This method
returns a recordset object containing the query results.
Open Opens a database connection.
ToSQL Transforms values into SQL compatible format depending on the specified
data type.
Methods (PHP)
Method Description
connect Establishes a database connection.
f Retrieves the value of a field within a recordset.
next_record Moves the recordset pointer to the next row.
num_rows Retrieves the number of rows returned by the last executed query.
query Executes an SQL query and returns a recordset if applicable. In the
recordset, the row pointer is located before the first row so the next_record
method has to be used to move the pointer to the first row before it can be
read.
ToSQL Transforms values into SQL compatible format depending on the specified
data type.
Methods (Servlets & JSP)
class JDBCConnectionFactory

34
Method Description
getJDBCConnection Create new JDBCConnection with the specified connection name.

class JDBCConnection
Method Description
getPoolName Get the name of the connection pool. This name corresponds to the
Connection name configured within the CodeCharge Studio IDE.
setLocale Set the Locale. The locale is used to determine how to format data
before it is inserted, updated and when it is selected.
hasErrors Indicates whether the connection has registered any errors or not.
getErrorsAsString Returns a single string with all the errors that have been registered.
getConnection This method is used to obtain a connection from the pool of
connections. A new connection is created only if there are no other free
connections, otherwise existing connections are reused. You should
call the closeConnection method when done with a connection so as to
return the connection to the pool.
closeConnection Returns a connection to the pool. This method doesn't really close the
connection but returns it to the connection pool to be reused in the
future.
createCallableStatement Create a CallableStatement by preparing a procedure call provided by
the callString parameter.
createPreparedStatement Create a PreparedStatement from the sql indicated by the sql
parameter. A PreparedStatement differs from an ordinary Statement in
that you can use question marks in place of query parameters.
createStatement Create a Statement. The Statement object can then be used to query
the database with SQL (executeQuery).
closeStatement Free a Statement object when it is no longer needed.
executeUpdate Execute an INSERT/UPDATE/DELETE SQL-query.
execute Execute a Stored Procedure.
toSql Transforms values into SQL compatible format depending on the
specified data type.
getRows Returns an Enumeration of DbRows representing the records within a
ResultSet.
getOneRow Get one row from a SQL query result.

Date Picker Component Reference

Design-Time Properties
Property Description
Name The name of the control.
Style Specify the css style to be applied to the Date Picker.
Control Specify the control to which the selected date value will be automatically

35
 entered.
Run-Time Properties (ASP)
Property Description
Visible This property controls the visibility of the control. If the property is set to false,
the control will not be displayed.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property controls the visibility of the control. If the property is set to false,
the control will not be displayed.
Run-Time Properties (.NET)
Property Description
Visible This property controls the visibility of the control. If the property is set to false, the
control will not be displayed.
Run-Time Variables (CF,CFT)
Variable Description
hide<control name> This property controls the visibility of the control. If the property is set to true,
the control will not be displayed.
Methods (Servlets & JSP)
Method Description
isVisible Returns a value indicating whether this control is currently visible or not.
setVisible Specify whether this control should be shown.
getParent Get the parent component that contains this control.
See also
Date Picker Overview

Directory Form Reference

Design-Time Properties
Property Description
Name A unique name for the directory form.
Connection The database connection used by the form.
Data Source Type The type of database resource that provides the data for the form.
Data Source The table, SQL query or stored procedure that provides the data for the
form.
Category ID Field The database field which contains the IDs of the categories displayed in the
Path

36
Subcategory ID Field The database field which contains the ID of the subcategories. This is
essentially the same as the Category ID field but the field comes from an
alias table.
No. of Columns The directory form displays categories in columns. Use this property to set
the number of columns to be used.
No. of Subcategories Each category in the directory form can have a number of subcategories.
This property limits the number of subcategories that could be displayed. A
link is provided to access extra columns if they are more than the limit.
Restricted Specifies whether a user has to be authenticated in order to view the form.
Events
Event Description
Server Side Events
Before Select This event occurs at the onset of the operations performed to select
records from the database.
Before Show Occurs before the form is displayed and after the data for the form has
been retrieved from the database and saved to control variables. This
event can be used to populate custom template variables defined
within directory HTML block.
Before Show Category Occurs before each category in the form is shown. This event can be
used to alter category values or performing other operations using the
values of the categories.
Before Show Subcategory Occurs before each subcategory in the form is shown. This event can
be used to alter subcategory values or performing other operations
using the values of the subcategories.
Before Build Select This event occurs before the query that will be used to retrieve records
from the database is put together. This event can be used to modify the
different clauses that make up the query such as the WHERE clause or
the ORDER BY clause.
Before Execute Select This event occurs immediately before a row selection query is
executed but after the query has been composed. This event can be
used to modify the entire query before it is executed.
After Execute Select This event occurs after the row selection query has been executed and
a recordset containing the results is returned.
Run-Time Properties (ASP)
Property Description
DataSource This property stores a reference to the data source bound to the
specified object. The data source handles all data retrieval operations.
It serves as an abstraction layer that hides underlying data source
details, whether it is a database table, SQL query or stored procedure.
Errors This property keeps a reference to the form's error collection. It is used
to collect error messages generated during the form’s execution.
NumberOfColumns Number of columns over which the categories in the directory form are
spread.

37
NumberOfSubCategories Maximum number of subcategories to display per category.
Recordset This property contains the form’s recordset which contains the data
used to populate the form.
Visible This property determines whether the form will be shown or not.
Data Source properties
Property Description
DataSource.SQL This property contains the main portion of the SQL query used to retrieve the
records displayed within the control . In terms of SQL, this property defines
the SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the control. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource.SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
control.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
NumberOfColumns Number of columns over which the categories in the directory form are
spread.
DataSource This property stores a reference to data source bound to the form. Data
source handles all data retrieval and update operations. It serves as an
abstraction layer that hides underlying data source details, whether it is
a database table, SQL query or stored procedure.
Errors This property keeps a reference to the form’s error collection. It is used
to collect error messages generated during the form’s execution.
NumberOfSubcategories Maximum number of subcategories to display per category.
Visible This property determines whether the component will be shown or not.
Data Source properties
Property Description
DataSource->SQL This property contains the main portion of the SQL query used to retrieve
the records displayed within the control . In terms of SQL, this property
defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the control. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource->SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
control.
Run-Time Properties (.NET)
Interface

38
Property Description
DataSource This property stores a reference to data source bound to the form.
NumberOfColumns Number of columns over which the categories in the directory form are
spread.
NumberOfSubCategories Maximum number of subcategories to display per category.
Visible This property determines whether the component will be shown or not.
Model Layer
Property Description
errors This property keeps a reference to the object’s errors collection. It is used to
collect error messages generated during the object’s execution.
<control name> For each control that is located within a form, a member property is created
with the same name as the control.
Directory Data Provider
Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member
property is created with the prefix (according to parameter source
type) and parameter name (according to parameter source).
Methods (.NET)
Interface
Method Description
DataBind Binds a data source to the invoked server control and all its child controls.
Data Provider
Method Description
GetResultSet Executes an SQL command and returns results in an Items array.
Run-Time Variables (CF,CFT)
Variable Description
NumberOfColumns Number of columns over which the categories in the directory form are
spread.
hide<control name> This variable determines whether the control is to be shown or not.
NumberOfSubCategories Maximum number of subcategories to display per category.
strOrder This property contains the ORDER BY clause portion of the SQL query
used to retrieve records for the control. The ORDER BY clause
determines the order of appearance of the retrieved records.
strSQL This property contains the main portion of the SQL query used to
retrieve the records displayed within the control . In terms of SQL, this
property defines the SELECT and FROM clauses of the SQL query.
strWhere This property contains the WHERE clause portion of the SQL query
used to retrieve records for the control. The WHERE clause provides
the criteria which filters the records retrieved.
query<control name> This variable contains the query object associated with the control.

39
Methods (Servlets & JSP)
Method Description
getCurrentCategoryId Get the category ID of the currently selected category.
getNumberOfRows Get the total number of records at the current directory level.
isEmpty Returns a value indicating whether the categories list is empty.
getNumberOfCategories Get the number of categories.
getNumberOfSubCategories Get the number of subcategories shown for each category.
setNumberOfSubCategories Specify the number of subcategories to be shown for each
category.
getCurrentCategoryNumber Get the order number of the current category.
getCurrentSubCategoryNumber Get the order number of the current subcategory.
getNumberOfColumns Get the number of columns which should be shown in the
Directory form.
setNumberOfColumns Set the number of columns which should be shown in the
Directory form.
getCategoryNumberInColumn
isRestricted Returns a value indicating whether users must be logged in
before accessing the form.
setRestricted Specify whether users must be logged in before accessing the
form.
getPageModel Page to which the component belongs.
isProcessed Indicates whether a component has been processed (the
ccsForm parameter is equivalent to the name of the component).
hasNextRow Returns true if there are more elements in a collection.
currentRow Returns the current row.
getChild Specify a name to find a child control among the collection of
children controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection
of children controls.
getButton Specify a name to find a Button control among the collection of
children controls.
getListBox Specify a name to find a Listbox control among the collection of
children controls.
getRadioButton Specify a name to find a Radiobutton control among the
collection of children controls.
getCheckBoxList Specify a name to find a Checkbox List control among the
collection of children controls.
getLink Specify a name to find a Link control among the collection of

40
 children controls.
getDatePicker Specify a name to find a Date Picker control among the collection
of children controls.
isVisible Returns a value indicating whether this control should be
displayed or not.
setVisible Specify whether the form should be shown or not.
getParent Get the parent component that contains the form.
See also
Directory Form Overview

Editable Grid Form Reference

Design-Time Properties
Property Description
Name The name of the form.
Connection The database connection from where information will be retrieved.
Data Source Type The type of data source or the method used to retrieve the data.
Data Source The database column, SQL Query or other expression from where the data
will be retrieved.
Return Page The page to which the user is directed to after the form has been submitted
successfully.
Remove Parameters Specify a semicolon-separated list of parameters that should be removed
from the hyperlink.
Convert URL To Specify whether URLs should be automatically converted to absolute URLs
or secure URLs for the SSL protocol (https://).
Records Per Page The number of records to be displayed per page by default.
Page Size Limit The maximum number of records a user may opt to display per page if
using a search form that allows control over the number of records
displayed.
Restricted Specify whether users must be logged in before accessing the form.
Empty Row Number of empty rows.
Allow Insert Specify whether the form can be used to insert new data.
Allow Update Specify whether the form can be used to update existing data.
Allow Delete Specify whether the form can be used to delete existing data.
Delete Control Specifies the control value used as a deletion indicator for the rows of the
Editable Grid.
Preserve Parameters Specify whether Get or Post parameters should be preserved.
Custom Insert Type If you wish to override the default insert mechanism, select the type of
method to be used to perform the insert operation.
Custom Insert Specify the procedure to be used to insert data.

41
Custom Update Type If you wish to override the default update mechanism, select the type of
method to be used to perform the update operation.
Custom Update Specify the procedure to be used to update data.
Custom Delete Type If you wish to override the default delete mechanism, select the type of
method to be used to perform the delete operation.
Custom Delete Specify the procedure to be used to delete data.
Events
Event Description
Server Side Events
Before Select This event occurs at the onset of the operations performed to select
records from the database.
Before Show This event occurs before a component is rendered to the page.
Before Show Row This event occurs before each row in the form is displayed.
Before Build Select This event occurs before the creation of the query that will be used to
retrieve records from the database.
Before Execute Select This event occurs immediately before a row selection query is executed
but after the query has been composed.
After Execute Select This event occurs after the row selection query has been executed and a
recordset for the result is returned.
On Validate This event occurs after standard validation operations have been
performed as a result of submitting values, but before any database
operations have been performed with the submitted values.
Before Submit This event occurs at the onset of the operations performed to submit a
database record.
After Submit This event occurs after submitting an existing row in the data source.
Before Build Insert This event occurs before the creation of the query that will be used to
insert a new record into the database.
Before Execute Insert This event occurs immediately before a row insertion query is executed
but after the query has been composed.
After Execute Insert This event occurs after new row insert query has been executed.
Before Build Update This event occurs before the creation of the query that will be used to
update database content.
Before Execute Update This event occurs immediately before a row update query is executed but
after the query has been composed.
After Execute Update This event occurs after a row update query has been executed.
Before Build Delete This event occurs before the creation of the query that will be used to
deleted a database record.
Before Execute Delete This event occurs immediately before a row deletion query is executed but
after the query has been composed.
After Execute Delete This event occurs after a row deletion query has been executed.
Client Side Events

42
On Load Used for binding Validation rules to the control.
On Submit Occurs on the client side when the user submits the form, before the data
is sent to the server from the form.
Run-Time Properties (ASP)
Property Description
DataSource This property stores a reference to the data source bound to the form. The data
source handles all data retrieval and update operations. It serves as an
abstraction layer that hides underlying data source details, whether it is a
database table, SQL query or stored procedure.
DeleteAllowed This property determines whether the delete operation should proceed or not.
The value of this property is set automatically based on the value of the
Restricted property of the form. If the Restricted property is set to No, the value
of this property is always True unless it is modified using event code in the
Before Delete event.
EditMode This property specifies the mode in which a form currently is in. A form can
either be in Insert mode or Edit mode.
EmptyRows This property specifies the number of empty rows to be displayed for inserting
new data.
ErrorMessages This property contains any error messages pertaining to each of the rows in the
Editable Grid.
Errors This property contains any error messages pertaining to the entire form as a
whole.
InsertAllowed This property determines whether the insert operation can proceed or not.
IsFormSubmitted This property determines how a form is processed based on whether the form is
being shown for the first time or has been submitted for postback. In the initial
display, the form fields are assigned data values before being displayed.
Otherwise if the form has been submitted for postback, the submitted data is
processed based on the operation that was initiated upon submission.
PressedButton This property contains the name of the form submit button which was clicked to
initiate postback.
ReadAllowed This property determines whether the data read operation can proceed or not.
Recordset This property contains a recordset in which are all the records that will be shown
in the form.
UpdateAllowed This is a boolean property whose value determines whether the update
operation should proceed or not. The value of this property is set automatically
based on the value of the Restricted property of the form. If the Restricted
property is set to No, the value of this property is always True unless it is
modified using event code in the Before Update event.
Visible This property determines whether the form is to be shown or not.
Data Source properties
Property Description
DataSource.CountSQL This property contains the SQL query which is executed to determine
the total number of browseable rows in the Editable Grid form. The

43
 number retrieved as a result of executing this query is used during the
creation of the navigation controls for the form.
DataSource.SQL This property contains the main portion of the SQL query used to
retrieve the records displayed within the form. In terms of SQL, this
property defines the SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query
used to retrieve records for the form. The WHERE clause provides the
criteria which filters the records retrieved. The value of this property is
appended to the value of the DataSource.SQL property to create the
final SQL query which is executed against the datasource to retrieve
the records for the form.
DataSource.Order This property contains the ORDER BY clause portion of the SQL
query used to retrieve records for the control. The ORDER BY clause
determines the order of appearance of the retrieved records. The
value of this property is appended to the value of the DataSource.SQL
property to create the final SQL query which is executed against the
datasource to retrieve the records for the control.
DataSource.CmdExecution This property determines whether or not the Insert, Update or Delete
operation should proceed depending on the used
BeforeExecuteInsert, BeforeExecuteUpdate or BeforeExecuteDelete
event.
Recordset.RecordCount This property contains a count of all the records that have been
retrieved for the form.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a textbox
that is included within that form.
DataSource This property stores a reference to the data source bound to the specified object.
The data source handles all data retrieval and update operations. It serves as an
abstraction layer that hides underlying data source details, whether it is a
database table, SQL query or stored procedure.
DeleteAllowed This property determines whether the delete operation should proceed or not.
The value of this property is set automatically based on the value of the
Restricted property of the form. If the Restricted property is set to No, the value
of this property is always True unless it is modified using event code in the
Before Delete event.
EditMode This property specifies the mode in which a form currently is in. A form can either
be in Insert mode or Edit mode.
EmptyRows This property specifies the number of empty rows to be displayed for inserting
new data.
Errors This property contains any error messages generated during execution of the
form.
InsertAllowed This property determines whether the insert operation can proceed or not.
PressedButton This property contains the name of the form submit button which was clicked to

44
 initiate postback.
ReadAllowed This property determines whether data read operation can proceed or not.
UpdateAllowed This is a boolean property whose value determines whether the update
operation should proceed or not. The value of this property is set automatically
based on the value of the Restricted property of the form. If the Restricted
property is set to No, the value of this property is always True unless it is
modified using event code in the Before Update event.
Visible This property determines whether the component is to be shown or not.
Data Source properties
Property Description
DataSource->CountSQL This property contains the SQL query which is executed to
determine the total number of browseable rows in the Editable Grid
form. The number retrieved as a result of executing this query is
used during the creation of the navigation controls for the form.
DataSource->SQL This property contains the main portion of the SQL query used to
retrieve the records displayed within the form. In terms of SQL, this
property defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query
used to retrieve records for the form. The WHERE clause provides
the criteria which filters the records retrieved. The value of this
property is appended to the value of the DataSource->SQL property
to create the final SQL query which is executed against the
datasource to retrieve the records for the form.
DataSource->Order This property contains the ORDER BY clause portion of the SQL
query used to retrieve records for the control. The ORDER BY
clause determines the order of appearance of the retrieved records.
The value of this property is appended to the value of the
DataSource->SQL property to create the final SQL query which is
executed against the datasource to retrieve the records for the
control.
DataSource->CmdExecution This property determines whether or not the Insert, Update or Delete
operation should proceed depending on the used
BeforeExecuteInsert, BeforeExecuteUpdate or BeforeExecuteDelete
event.
DataSource->RecordsCount This property contains a count of all the records that have been
retrieved for the form.
Run-Time Variables (CF,CFT)
Variable Description
blnDeleteAllowed<control name> This variable determines whether the delete operation should
proceed or not. The value of this variable is set automatically
based on the value of the Restricted property of the form. If
the Restricted property is set to No, the value of this property
is always True unless it is modified using event code in the
Before Delete event.
blnEditMode<control name> This variable specifies the mode in which a form currently is

45
 in. A form can either be in Insert mode or Edit mode.
blnFormSubmitted<control_name> This variable determines how a form is processed based on
whether the form is being shown for the first time or has been
submitted for postback. In the initial display, the form fields
are assigned data values before being displayed. Otherwise if
the form has been submitted for postback, the submitted data
is processed based on the operation that was initiated upon
submission.
blnInsertAllowed<control name> This variable determines whether the insert operation can
proceed or not.
blnReadAllowed<control_name> This variable determines whether data read operation can
proceed or not.
blnUpdateAllowed<control_name> This is a boolean variable whose value determines whether
the update operation should proceed or not. The value of this
variable is set automatically based on the value of the
Restricted property of the form. If the Restricted property is
set to No, the value of this property is always True unless it is
modified using event code in the Before Update event.
<control name>Rows This variable contains an array of structures identified for
each grid's row. The structure has some keys such as
Error,Operation.
hide<control name> This variable determines whether the control is to be shown
or not.
intEmptyRows This variable specifies the number of empty rows to be
displayed for inserting new data.
strOrder This variable contains the ORDER BY clause portion of the
SQL query used to retrieve records for the control. The
ORDER BY clause determines the order of appearance of the
retrieved records. The value of this property is appended to
the value of the strSQL variable to create the final SQL query
which is executed against the datasource to retrieve the
records for the control.
strSQL This variable contains the main portion of the SQL query
used to retrieve the records displayed within the form. In
terms of SQL, this property defines the SELECT and FROM
clauses of the SQL query.
strWhere This variable contains the WHERE clause portion of the SQL
query used to retrieve records for the form. The WHERE
clause provides the criteria which filters the records retrieved.
The value of this property is appended to the value of the
strSQL variable to create the final SQL query which is
executed against the datasource to retrieve the records for
the form.
strError<control name> This variable contains any error messages generated during
execution of the form.
strPressedButton This variable contains the name of the form submit button
which was clicked to initiate postback.

46
query<control name> This variable contains the query object associated with the
form.
endOperation<control name> This property determines whether or not the Insert, Update or
Delete operation should proceed depending on the used
BeforeExecuteInsert, BeforeExecuteUpdate or
BeforeExecuteDelete event.
Methods (Servlets & JSP)
Method Description
setNumberEmptyRows Specify the number of empty rows to be displayed for inserting new data.
isShowEmptyRow
isAllowRead Returns a value indicating whether the data read operation can proceed or
not.
setAllowRead Use to toggle the value which determines whether the data read
operations can proceed or not.
isAllowInsert Returns a value indicating whether the insert operation can proceed or
not.
setAllowInsert Use to toggle the value which determines whether the insert operation can
proceed or not.
isAllowUpdate Returns a value indicating whether the update operation should proceed
or not.
setAllowUpdate Used to toggle the value which determines whether the update operation
should proceed or not.
isAllowDelete Returns a value indicating whether the delete operation should proceed or
not.
setAllowDelete Used to toggle the value which determines whether the delete operation
should proceed or not.
getPage Get the current page being shown in the Editable Grid.
setPage Set the page number to be shown in the Editable Grid.
getNumberOfRows Get the total number of rows.
getNavigator Use a name to find the Navigator among the collection of children
controls.
getSorter Use a name to find a Sorter among the collection of children controls.
getPageSize Get the number of records per page. Equivalent to getFetchSize.
setPageSize Set the number of records per page. Equivalent to setFetchSize.
isRestricted Returns a value indicating whether users must be logged in before
accessing the form.
setRestricted Specify whether users must be logged in before accessing the form.
getPageModel Get the page to which the component belongs
hasNextRow Returns true if there are more elements in a collection
nextRow Returns the next row. If the next row isn't available, this method returns an
empty HashMap; This method never returns a null.

47
currentRow Returns the current row.
getChild Specify a name to find a child control among the collection of children
controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection of
children controls.
getButton Specify a name to find a Button control among the collection of children
controls.
getListBox Specify a name to find a Listbox control among the collection of children
controls.
getRadioButton Specify a name to find a Radiobutton control among the collection of
children controls.
getCheckBoxList Specify a name to find a Checkbox List control among the collection of
children controls.
getLink Specify a name to find a Link control among the collection of children
controls.
getDatePicker Specify a name to find a Date Picker control among the collection of
children controls.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether the form should be shown or not.
isCmdExecution Returns a value indicating whether the operation should proceed or not.
setCmdExecution Specify whether the operation should be performed or not.
getParent Get the parent component that contains the form.
Run-Time Properties (.NET)
Editable Grid Interface objects
Property Description
System.Web.UI.WebControls.Repeater <control The Repeater object which holds all
name>Repeater. Editable Grid controls. See the .NET
Framework SDK reference
System.Collections.Specialized.NameValueCollection The collection of global critical errors,
<control name>Errors. such as DataProvider errors. See the
.NET Framework SDK reference.
<control name>DataProvider <control name>Data The Data Source Provider for the
Editable Grid.
Editable Grid Model Layer
Property Description
errors This property keeps a reference to the object’s errors NameValueCollection. It is
used to collect error messages generated during the object’s execution.
<control name> For each control that is located within the form, a member property is created
with the same name as the control.

48
IsNew This property indicates if an item created based on an insert row.
IsEmptyItem This property indicates if an item contains any data.
IsDeleted This property indicates if the Delete checkbox is checked for an item
IsUpdated This property indicates if an item has been successfully updated by the Data
Provider.
Editable Grid Data Provider
Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member
property is created with the prefix (according to parameter source
type) and parameter name (according to parameter source).
SortField Gets or sets the sort column for the Select command.
PageNumber Gets or sets the page number for the Select command.
RecordsPerPage Gets or sets the page size for the Select command.
CmdExecution This property altered in BeforeExecuteInsert, BeforeExecuteUpdate
or BeforeExecuteDelete events determines whether the Insert,
Update or Delete operation (respectively) for the current row should
proceed.
Methods (.NET)
Editable Grid Model Layer
Method Description
Validate Performs the item validation and returns true if validation is successful, otherwise false.
Editable Grid Data Provider
Method Description
Update Performs update operations for each item in the items array.
GetResultSet Execute a query against the database and return the items array.
See also
Editable Grid Form Overview

File Upload Component Reference

Design-Time Properties
Property Description
Name A unique name used to identify the instance of the control.
Caption You can use this property to set a name that will be used to refer to the
control within error messages. If a value is not specified for this property,
the value of the Name property above is used by default. Since control
names are often cryptic by nature, it is advisable to set a more readable
caption which will better help the user understand what the error message
is referring to.
Control Source Type The type of data source from which the control gets its value. This can be
one of the following:

49
 • Database Column – The control value will come from a column
within a database table.
• Code Expression – The control value will be derived from an
expression specific to the particular programming language being used.
This could be a function that returns a value, a pre-existing variable or
any other valid language construct that will evaluate to a definite value.
Typically, the control source is a database column where the names of the
uploaded files are stored.
Control Source This property depends on the value specified in the Control Source Type
property above. If the Control Source Type is a Database Column, use
this property to specify the database table column that will be used to
furnish the control value. Respectively, if the Control Source Type is a
Database Expression or a Code Expression, enter the expression to be
used to furnish the control value. This property can be left blank if the
control does not use a data source.
Required [Yes/No] This property specifies whether the control must submit a file
when the form is submitted. If the control does not submit a file, the form
will not be processed to completion but instead an error message will be
displayed.
Error Control Usually, error messages corresponding to a control are displayed at the
top of the form as plain text. However, you might want this error text to be
displayed within another existing control, for instance, in a Label field
placed adjacent to the control. Use this property to specify the name of a
control where you want the error message for the current control to be
displayed.
Temporary Folder Specify a file system path to a folder on the web server machine where the
upload component can temporarily place files while they are being
processed. The path specified can be an absolute path e.g.
c:\Inetpub\files\temp or a relative path e.g. .\files\temp
File Folder Specify a file system path to a folder on the web server machine where the
final uploaded files should be stored. The path specified can be an
absolute path e.g. c:\Inetpub\files\images or a relative path e.g.
.\files\images
Allowed File Masks Specify a semicolon separated list of file masks for files that the user is
allowed to upload e.g. *.jpg; *.png; *.gif; *.txt. You can enter an asterisk (*)
to allow all file types to be uploaded.
Disallowed FIle Masks Specify a semicolon separated list of file masks for files that the user is not
allowed to upload e.g. *.exe; *.dll; *.bat.
File Size Limit Specify the size limit in bytes of the files that the user can upload. Files
larger than the limit will not be uploaded.
Events
Event Description
Server Side Events
Before Process File This event occurs after an uploaded file is saved to the temporary directory
but before it is moved to the target folder. This event can be used to check

50
 additional conditions or to change the file location or name.
After Process File This event occurs after an uploaded file is moved to the target folder from the
temporary folder. It can be used to perform post processing on the file.
Before Delete File This event occurs before a file is deleted from the server. It can be used to
check additional permissions or conditions before deleting the file.
After Delete File This event occurs after a file has been deleted from the server. It can be
used to perform cleanup operations after removing the file.
Before Show This event occurs before the control is rendered to the page.
On Validate This event occurs after standard validation operations have been performed
as a result of submitting values, but before any database operations have
been performed with the submitted values.
Run-Time Properties (ASP)
Property Description
AllowedFileMasks This property contains a list of file masks for files that the user is allowed to
upload.
DisallowedFileMasks This property contains a list of file masks for files that the user is not
allowed to upload.
Errors This property keeps a reference to the object’s error collection. It is used to
collect error messages generated during the object’s execution.
FileFolder This property specifies a file system path to a folder on the web server
machine where the final uploaded files should be stored.
FileSize This property contains the actual size on an uploaded file.
FileSizeLimit This property specifies the size limit in bytes of the files that the user can
upload. Files larger than the limit will not be uploaded.
IsUploaded This property indicated the control's processing state. If true, the file has
been uploaded and is waiting for processing. If false, no file was selected
for uploading.
TemporaryFolder This property specifies a file system path to a folder on the web server
machine where the upload component can temporarily place files while they
are being processed.
Value This property contains the name of the uploaded file.
Visible This property determines whether the control is displayed or not. In order
for this property to work, the extended HTML comments have to be defined
for the control.
Run-Time Properties (PHP)
Property Description
AllowedFileMasks This property contains a list of file masks for files that the user is allowed to
upload.
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.

51
DisallowedFileMasks This property contains a list of file masks for files that the user is not
allowed to upload.
Errors This property keeps a reference to the object’s error collection. It is used to
collect error messages generated during the object’s execution.
FileSizeLimit This property specifies the size limit in bytes of the files that the user can
upload. Files larger than the limit will not be uploaded.
FileFolder This property specifies a file system path to a folder on the web server
machine where the final uploaded files should be stored.
TemporaryFolder This property specifies a file system path to a folder on the web server
machine where the upload component can temporarily place files while they
are being processed.
Visible This property determines whether the control is displayed or not.
Run-Time Properties (.NET)
Property Description
Text This property contains the name of the uploaded file.
AllowedFileMasks This property contains a list of file masks for files that the user is allowed to
upload.
DisallowedFileMasks This property contains a list of file masks for files that the user is not
allowed to upload.
FileSizeLimit This property specifies the size limit in bytes of the files that the user can
upload. Files larger than the limit will not be uploaded.
FileFolder This property specifies a file system path to a folder on the web server
machine where the final uploaded files should be stored.
TemporaryFolder This property specifies a file system path to a folder on the web server
machine where the upload component can temporarily place files while they
are being processed.
Required This property indicates whether a value must be specified in the control in
order for the form to be submitted successfully.
Visible This property determines whether the control is displayed or not.
Methods (.NET)
Method Description
ValidateFile Validate an uploaded file and if validation is successful, save the file to the
TemporaryFolder.
SaveFile Save a file to the specified FileFolder.
DeleteFile Delete a file from the server .
Methods (ASP)
Method Description
GetOriginFileName This method can be used to retrieve the original name of the uploaded file
i.e. without the unique timestamp appended to the filename.
Methods (PHP)

52
Method Description
GetFileName This method can be used to retrieve the original name of the uploaded file
i.e. without the unique timestamp appended to the filename.
GetFileSize This method can be used to retrieve the size of the uploaded file.
GetValue This method retrieves the name of the uploaded file.
SetValue This method sets the name of the uploaded file.
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> This variable contains the name of the uploaded file.
par<control name>.TemporaryFolder This variable specifies a file system path to a folder on the
web server machine where the upload component can
temporarily place files while they are being processed
par<control name>.FileFolder This variable specifies a file system path to a folder on the
web server machine where the final uploaded files should be
stored.
hide<control name> This variable determines whether the control is displayed or
not.
Methods (Servlets & JSP)
Method Description
getPage Get the page that contains this control.
getFormattedValue Get the control value formatted according to the control format.
setFormattedValue Set the control value using a String. The value is taken as is i.e. formatting
will not be applied to this value.
hasErrors Whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Whether this control should be shown or not.
setVisible Specify whether this control or component should be shown or not.
getParent Get the parent component that contains this control or component.
See also:
File Upload Overview

Grid Form Reference

Design-Time Properties
Property Description
Name The name of the form.
Connection The database connection from where information will be retrieved.
Data Source Type The type of data source or the method used to retrieve the data.

53
Data Source The database column, SQL Query or other expression from where the data
will be retrieved.
Restricted Specify where users must be logged in before accessing the form.
Records Per Page The numbers of records to be displayed per page by default.
Page Size Limit The maximum number of records a user may opt to display per page if using
a search form that allows control over the number of records displayed.
Events
Event Description
Server Side Events
Before Select Occurs before calling the select operation.
Before Show Occurs before showing (populating template with data) page component or
control.
Before Show Row Occurs before showing (populating template with data) each grid's row.
Before Build Select Occurs before processing parameters and building selecting query.
Before Execute Select Occurs just before initializing recordset with query data and parameters
and opening it for retrieving resulting rows.
After Execute Select Occurs after data source’s rows selection query has been executed and a
recordset for the result is returned.
Run-Time Properties (ASP)
Property Description
DataSource This property stores a reference to data source bound to the form. The data
source handles all data retrieval operations. It serves as an abstraction layer
that hides underlying data source details, whether it is a database table, SQL
query or stored procedure.
Errors This property keeps a reference to the form’s error collection. It is used to
collect error messages generated during the object’s execution.
Recordset This property contains the form’s recordset which contains the data used to
populate the form.
Visible This property determines whether the form will be shown or not.
Data Source properties
Property Description
DataSource.CountSQL This property contains the SQL query which is executed to determine the
total number of browseable rows in the Grid form. The number retrieved
as a result of executing this query is used during the creation of the
navigation controls for the form.
DataSource.SQL This property contains the main portion of the SQL query used to retrieve
the records displayed within the control . In terms of SQL, this property
defines the SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query used
to retrieve records for the control. The WHERE clause provides the
criteria which filters the records retrieved. The value of this property is

54
 appended to the value of the DataSource.SQL property to create the final
SQL query which is executed against the datasource to retrieve the
records for the control.
DataSource.Order This property contains the ORDER BY clause portion of the SQL query
used to retrieve records for the control. The ORDER BY clause
determines the order of appearance of the retrieved records. The value
of this property is appended to the value of the DataSource.SQL property
to create the final SQL query which is executed against the datasource to
retrieve the records for the control.
Recordset.RecordCount This property contains a count of all the records that have been retrieved
for the form.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
DataSource This property stores a reference to the data source bound to the form. The
data source handles all data retrieval and update operations. It serves as an
abstraction layer that hides underlying data source details, whether it is a
database table, SQL query or stored procedure.
Errors This property keeps a reference to the form’s error collection. It is used to
collect error messages generated during the form’s execution.
Visible This property determines whether the component will be shown or not.
Data Source properties
Property Description
DataSource->CountSQL This property contains the SQL query which is executed to determine
the total number of browseable rows in the Grid form. The number
retrieved as a result of executing this query is used during the
creation of the navigation controls for the form.
DataSource->SQL This property contains the main portion of the SQL query used to
retrieve the records displayed within the form. In terms of SQL, this
property defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query
used to retrieve records for the form. The WHERE clause provides
the criteria which filters the records retrieved. The value of this
property is appended to the value of the DataSource->SQL property
to create the final SQL query which is executed against the
datasource to retrieve the records for the form.
DataSource->Order This property contains the ORDER BY clause portion of the SQL
query used to retrieve records for the control. The ORDER BY
clause determines the order of appearance of the retrieved records.
The value of this property is appended to the value of the
DataSource->SQL property to create the final SQL query which is
executed against the datasource to retrieve the records for the
control.

55
DataSource->RecordsCount This property contains a count of all the records that have been
retrieved for the form.
Run-Time Properties (.NET)
Grid Interface objects
Property Description
System.Web.UI.WebControls.Repeater <control The Repeater object which holds all Grid
name>Repeater. controls. See the .NET Framework SDK
reference.
<control name>DataProvider <control name>Data The Data Source Provider for the Grid.
Grid Model Layer
Property Description
<control name> For each control that is located within the form, a member property is created
with the same name as the control.

Grid Data Provider

Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member
property is created with the prefix (according to parameter source
type) and parameter name (according to parameter source).
SortField Gets or sets the sort column for the Select command.
PageNumber Gets or sets the page number for the Select command.
RecordsPerPage Gets or sets the page size for the Select command.
Methods (.NET)
Grid Data Provider
Method Description
GetResultSet Execute a query against the database and return the items array.
Run-Time Variables (CF,CFT)
Variable Description
intShownRecords This variable contains number of the shown records on the page.
query<control name> This variable contains query object.
strOrder This variable contains the ORDER BY clause portion of the SQL query
used to retrieve records for the control. The ORDER BY clause determines
the order of appearance of the retrieved records. The value of this property
is appended to the value of the strSQL variable to create the final SQL
query which is executed against the datasource to retrieve the records for
the control.
strSQL This variable contains the main portion of the SQL query used to retrieve
the records displayed within the form. In terms of SQL, this property defines
the SELECT and FROM clauses of the SQL query.
strWhere This variable contains the WHERE clause portion of the SQL query used to
retrieve records for the form. The WHERE clause provides the criteria

56
 which filters the records retrieved. The value of this property is appended to
the value of the strSQL variable to create the final SQL query which is
executed against the datasource to retrieve the records for the form.
hide<control name> This variable determines whether the form is to be shown or not.
Methods (Servlets & JSP)
Method Description
getPage Get the current page being shown in the Grid.
setPage Set the page number to be shown in the Grid.
getNumberOfRows Get the total number of rows in the Grid.
getNavigator Use a name to find the Navigator among the collection of children controls.
getSorter Use a name to find a Sorter among the collection of children controls.
getPageSize Get number of records per page. Equivalent to getFetchSize.
setPageSize Set number of records per page. Equivalent to setFetchSize.
isAllowRead Returns a value indicating whether the data read operation can proceed or
not.
setAllowRead Use to toggle the value which determines whether the data read operations
can proceed or not.
isRestricted Returns a value indicating whether users must be logged in before accessing
the form.
setRestricted Specify whether users must be logged in before accessing the form.
getPageModel Get the page to which the component belongs.
isProcessed Indicates whether a component has been processed (the ccsForm parameter
is equivalent to the name of the component).
hasNextRow Returns true if there are more elements in a collection.
nextRow Returns the next row. If row isn't available returns empty HashMap; never
null.
currentRow Returns the current row.
getChild Specify a name to find a child control among the collection of children
controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection of children
controls.
getButton Specify a name to find a Button control among the collection of children
controls.
getListBox Specify a name to find a Listbox control among the collection of children
controls.
getRadioButton Specify a name to find a Radiobutton control among the collection of children
controls.
getCheckBoxList Specify a name to find a Checkbox List control among the collection of

57
 children controls.
getLink Specify a name to find a Link control among the collection of children
controls.
getDatePicker Specify a name to find a Date Picker control among the collection of children
controls.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether the form should be shown or not.
getParent Get the parent component that contains the form.
See also
Grid Form Overview

Hidden Control Reference

Design-Time Properties
Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Caption The name used to refer to the control in an error message.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Required [Yes/No] Select ‘Yes’ if a value must be entered for the control in order for
the form to be submitted successfully.
Unique [Yes/No] Select ‘Yes’ if you want a check to be made to ensure that any
value entered in the control does not already exist in the database.
Input Validation Select a regular expression to be used to check the validity of the data
entered in the control.
Error Control Specify the name of a control that will be used to display any error messages
pertaining to this control.
Validation Rule Specify an expression that will be used to check the validity of the data
entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does
not meet the validation rule.
DBFormat Specify the format in which you want the control value to be entered into the
database.

58
Events
Event Description
Server Side Events
On Validate This event occurs after standard validation operations have been performed
as a result of submitting values, but before any database operations have
been performed with the submitted values.
Before Show Occurs before the control is rendered to the page.
Client Side Events
On Load Occurs at the beginning of page processing and is used for binding
Validation rules to the control.
Run-Time Properties (ASP)
Property Description
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Value Holds the value of the control.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Run-Time Properties (.NET)
Interface The System.Web.UI.HtmlControls.HtmlInputHidden is used
Property Description
Visible Indicates whether the control is rendered on the page or not.
Value Gets or sets the value of the hidden control. See .NET Framework SDK
reference.
Model Layer
Property Description
<control name> Contains the current value of the control.
Methods (PHP)
Method Description
GetValue Retrieves the value of the Hidden control.
SetValue Sets the value for the Hidden control.
Run-Time Variables (CF,CFT)
Variable Description

59
fld<control name> Holds the value of the control.
Methods (Servlets & JSP)
Method Description
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Indicates whether this control should be shown or not.
setVisible Specify whether this control or component should be shown or not.
getParent Get the parent component that contains this control or component.
See also
Hidden Overview

Image Control Reference

Design-Time Properties
Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
DBFormat Specify the format in which you want the control value to be entered into the
database.
Events
Event Description
Server Side Events

60
BeforeShow Occurs before the control is rendered to the page. By placing code in this
event, the user can alter the URL of the image or hide the control.
Run-Time Properties (ASP)
Property Description
Value Specifies the location of the image.
Visible Specifies whether the image is visible. Setting this property to false will
prevent the object from being displayed (however the image icon will remain
in the generated page)
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible Specifies whether the component is to be shown or not.
Run-Time Properties (.NET)
Interface The System.Web.UI.WebControls.Image is used
Property Description
Visible Indicates whether the control is rendered on the page or not.
ImageUrl Gets or sets a image url. See .NET Framework SDK reference.
Model Layer
Property Description
<control name> Contains current value of control.
Methods (PHP)
Method Description
GetValue Retrieves the value of the Image control (the URL of the image).
SetValue Sets the value of the Image control (the URL of the image).
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> Specifies the location of the image.
hide<control name> Specifies whether the image is visible. If the variable is not defined or its
value is false then the components is visible, if the value is true then the
component is not visible. By default this variable is not defined, i.e. the
component is visible. Setting this variable to true will prevent the object from
being displayed (however the image icon will remain in the generated page)
Methods (Servlets & JSP)
Method Description
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.

61
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Indicates whether this control should be shown or not.
setVisible Specify whether this control or component should be shown or not.
getParent Get the parent component that contains this control or component.
See also
Image Overview

Image Link Reference

Design-Time Properties
Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Visible Specify whether the control should be displayed or not.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Href Type The type of source where the URL value will come from.
Href Source The page path, database column or other expression containing the URL of
the hyperlink.
Convert URL to Specify whether the URL should be converted to an absolute URL or a
secure (https://) URL.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Remove Parameters Specify a semicolon-separated list of parameters that should be removed
from the hyperlink.
Preserve Parameters Specify whether GET or Post parameters should be preserved.
DBFormat Specify the format in which you want the control value to be entered into the
database.

62
Events
Event Description
Server Side Events
Before Show Occurs before the control is rendered to the page. This event can be used to
change the URL of the ImageLink control or the path to the image displayed
in the control.
Run-Time Properties (ASP)
Property Description
Link Stores the URL to which the ImageLink links to.
Value Retrieves or sets the value of the ImageLink control, in this case, the path to the
image to be displayed.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a textbox
that is included within that form.
Methods (PHP)
Method Description
GetValue Retrieves the value of the ImageLink control, in this case, the path to the
image to be displayed.
SetValue Sets the value of the ImageLink control, in this case, the path to the image to
be displayed.
GetLink Retrieves the URL to which the ImageLink links to.
SetLink Sets the URL to which the ImageLink links to.
Run-Time Properties (.NET)
Interface System.Web.UI.WebControls.HyperLink class is used.
Property Description
ImageUrl Gets or sets the path to an image to display for the HyperLink control. See
.NET Framework SDK reference.
NavigateUrl Gets or sets the URL to link to when the HyperLink control is clicked. See
.NET Framework SDK reference.
Visible This property determines whether the control will be shown or not.
Model Layer
Property Description
<control name> Contains the current value of control.
<control name>Href Contains the URL to link to when the HyperLink control is clicked.
<control name>HrefParameters Contains the URL parameters to be appended to the URL of the
control.
Run-Time Variables (CF,CFT)
63
Variable Description
fld<control name> Retrieves or sets the value of the ImageLink control, in this case, the path
to the image to be displayed.
fld<control name>Link This variable contains the URL to which the ImageLink links to.
hide<control name> This variable determines whether the control is to be shown or not.
Methods (Servlets & JSP)
Method Description
addParameter Add a parameter to the collection of parameters.
getParameter Find a parameter from among the collection of parameters.
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Indicates whether this control should be shown or not.
setVisible Specify whether this control or component should be shown or not.
getParent Get the parent component that contains this control.
See also
Image Link Overview

Include Page Reference

Design-Time Properties
Property Description
Name The name of the control.
Page The page that will be included.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This variable determines whether the include page is to be shown or not.

Run-Time Properties (ASP)

64
Property Description
Visible This variable determines whether the include page is to be shown or not.

Run-Time Variables (CF,CFT)

Variable Description
hide<control name> This variable determines whether the include page is to be shown or not.
Methods (Servlets)
Method Description
isVisible Indicates whether the include page is to be shown or not.
setVisible Specify whether the include page is to be shown or not.
getParent Get the parent component that contains the Include Page.
See also
Include Page Overview

Label Reference
Design-Time Properties
Property Description
Name The name of the control.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Content Specify whether the content of the control is plain text or HTML code.
DBFormat Specify the format in which you want the control value to be entered into the
database.
Events
Event Description
Server Side Events
Before Show Occurs before the control is rendered to the page. This event can be used to
change the value of the control.
Run-Time Properties (ASP)
Property Description
Visible This property determines whether the component is to be shown or not.

65
Value Holds the value of the control.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the control will be shown or not.
Run-Time Properties (.NET)
Interface The System.Web.UI.WebControls.Literal is used
Property Description
Visible Gets or sets a value that indicates whether the control will be rendered on
the page.
Text Gets or sets the text for the Label. See .NET Framework SDK reference.
Model Layer
Property Description
<control name> Contains the current value of the control.
Methods (PHP)
Method Description
GetValue Retrieves the value of the Label control.
SetValue Sets the value of the Label control.
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> Holds the value of the control.
hide<control name> This variable determines whether the control is to be shown or not.If the
variable is set to true, the label will not be displayed.
Methods (Servlets & JSP)
Method Description
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.

66
isVisible Indicates whether this control should be shown or not.
setVisible Specify whether this control or component should be shown or not.
getParent Get the parent component that contains this control.
See also
Label Overview

Link Reference
Design-Time Properties
Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Content Specify whether the content of the control is plain text or HTML code.
Href Type The type of source where the URL value will come from.
Href Source This property opens the Href Source window where you can specify the
page to be linked to as well as any parameters that should be transmitted
via the URL.
Convert URL to Specify whether the URL should be converted to an absolute URL or a
secure (https://) URL.
Remove Parameters Specify a semicolon-separated list of parameters that should be removed
from the hyperlink.
Preserve Parameters Specify whether GET or Post parameters should be preserved.
DBFormat Specify the format in which you want the control value to be entered into the
database.
Events
Event Description
Server Side Events
Before Show Occurs before the control is rendered to the page. By placing code in this
event, the user can change the text or the URL of the Link control.
Run-Time Properties (ASP)
Property Description

67
Visible This property determines whether the component is to be shown or not.
Link This property contains the URL that will be linked to.
Value This property holds the text that will be displayed in the Link (this is the text
that appears between the <a> and </a> tags in the HTML code).
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the component is to be shown or not.
Methods (PHP)
Method Description
GetValue Retrieves the value of the Link control, in this case, the text displayed in the
Link.
SetValue Sets the value of the Link control, in this case, the text displayed in the Link.
GetLink Retrieves the URL to which the Link links to.
SetLink Sets the URL to which the Link links to.
Run-Time Properties (.NET)
Interface System.Web.UI.HtmlControls.HtmlAnchor class is used.
Property Description
InnerHtml Gets or sets the content found between the opening and closing tags of the
specified HTML server control.
InnerText Gets or sets the text between the opening and closing tags of the specified
HTML server control.
HRef Gets or sets the URL to link to when the HyperLink control is clicked. See
.NET Framework SDK reference.
Visible This property determines whether the control is to be shown or not.
Model Layer
Property Description
<control name> Contains the current value of the control.
<control name>Href Contains the URL to link to when the HyperLink control is clicked.
<control name>HrefParameters Contains the URL parameters to be appended to the URL of the
control.
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> This variable holds the text that will be displayed in the Link (this is the text
that appears between the <a> and </a> tags in the HTML code).
fld<control name>Link This variable contains the URL that will be linked to.

68
hide<control name> This variable determines whether the control is to be shown or not.
Methods (Servlets & JSP)
Method Description
addParameter Add a parameter to the collection of parameters.
getParameter Find a parameter from among the collection of parameters.
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Indicates whether this control should be shown or not.
setVisible Specify whether this control or component should be shown or not.
getParent Get the parent component that contains this control.
See also
Link Overview

List Box
Design-Time Properties
Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Caption The name used to refer to the control in an error message.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control.
Connection The database connection from where information will be retrieved.
Data Source Type Specify the type of source of data for the list of values to be shown in the
control.
Data Source Specify the actual source of data for the list of values depending on the List
Source Type.
Bound Column Refers to the data source for the values that are submitted.
Text Column Refers to the data source for the values that are displayed.
Data Type The type of data that will be contained in the control.

69
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Required Yes/No] Select ‘Yes’ if a value must be entered for the control in order for the
form to be submitted successfully.
Unique [Yes/No] Select ‘Yes’ if you want a check to be made to ensure that any
value entered in the control does not already exist in the database.
Error Control Specify the name of a control that will be used to display any error messages
pertaining to the control. If this value is not specified, all error messages are
displayed at the top of the form in which the control is contained.
Validation Rule Specify an expression that will be used to check the validity of the data
entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does
not meet the validation rule.
Events
Event Description
Server Side Events
On Validate This event occurs after standard validation operations have been
performed as a result of submitting values, but before any database
operations have been performed with the submitted values.
Before Show This event occurs before the control is rendered to the page.
Before Build Select This event occurs before the query that will be used to retrieve records
from the database is put together. This event can be used to modify the
different clauses that make up the query such as the WHERE clause or the
ORDER BY clause.
Before Execute Select This event occurs immediately before a row selection query is executed but
after the query has been composed. This event can be used to modify the
entire query before it is executed.
After Execute Select This event occurs after the row selection query has been executed and a
recordset containing the results is returned.
Client Side Events
On Change Occurs on the client side whenever the control's value is changed and
focus is lost.
On Load Used for binding Validation rules to control. A user can provide JavaScript
code that will be executed by the browser.
Run-Time Properties (ASP)
Property Description
DataSource A Data Source object created for the purpose of retrieving and holding the
IDs and values to be displayed in the control.
Errors This property keeps a reference to the object’s error collection. It is used to
collect error messages generated during the object’s execution.
Recordset This property contains object’s recordset used to iterate rows in the data
source result.

70
Value This property contains the value of the selected ListBox option.
Visible This property determines whether the control is visible or not.
Data Source properties
Property Description
DataSource.SQL This property contains the main portion of the SQL query used to retrieve the
records displayed within the control. In terms of SQL, this property defines
the SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the control. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource.SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
control.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
DataSource A Data Source object created for the purpose of retrieving the IDs and values
to be displayed in the List Box control.
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Visible This property determines whether the control is visible or not.
Data Source properties
Property Description
DataSource->SQL This property contains the main portion of the SQL query used to retrieve
the records displayed within the control . In terms of SQL, this property
defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the control. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource->SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
control.
Run-Time Properties (.NET)
Interface System.Web.UI.HtmlControls.HtmlSelect class is used.
Property Description
Items Gets the collection of items in the list control. See the .NET Framework SDK
reference.
SelectedIndex Gets or sets the lowest ordinal index of the selected items in the list. See
.NET Framework SDK reference.

71
Value Gets the value of the selected item in the HtmlSelect control or sets the
SelectedIndex property of the control to the index of the first item in the list
with the specified value. See .NET Framework SDK reference.
Visible This property determines whether the control is visible or not.
Model Layer
Property Description
<control name> Contains the current value of the control.
<control name>Items This is a Collection of the control items.
Methods (PHP)
Method Description
GetValue Retrieves the value of the List Box control.
SetValue Sets the value of the List Box control.
Run-Time Variables (CF,CFT)
Variable Description
arr_<owner name><control name> This variable contains the array of items in the list control.
fld<control name> Holds the value of the List Box control. This variable can
contain a semicolon separated list of values.
hide<control name> This variable determines whether the control is to be shown or
not.
strOrder<control name> This property contains the ORDER BY clause portion of the
SQL query used to retrieve records for the control. The
ORDER BY clause determines the order of appearance of the
retrieved records. The value of this property is appended to
the value of the strSQL<control name> property to create the
final SQL query which is executed against the datasource to
retrieve the records for the control.
strSQL<control name> This property contains the main portion of the SQL query used
to retrieve the records displayed within the control. In terms of
SQL, this property defines the SELECT and FROM clauses of
the SQL query.
strWhere<control name> This property contains the WHERE clause portion of the SQL
query used to retrieve records for the control. The WHERE
clause provides the criteria which filters the records retrieved.
The value of this property is appended to the value of the
strSQL<control name> property to create the final SQL query
which is executed against the datasource to retrieve the
records for the control.
hide<control name> This variable controls the visibility of the control. If the variable
is set to true, the control will not be displayed.
Methods (Servlets & JSP)
Method Description
getOptionsString Prepare HTML output for ListBox. The output consists of list of html option

72
 elements ready for output.
addValue In the case where the ListBox allows for the selection of multiple values, this
function is used to add a value to the list of selected values.
setValues Set the list of selected values from an enumeration of Strings.
setListOfValues Set the list of values to choose from. Used to populate list values from a
String.
getOptions Get the options list in the form of an enumeration of Strings.
setOptions Set the list of values to choose from. Used to populate list values from a
String.
getFormattedOptions Prepare list collection for output. This method marks those list values that
were selected by request.
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Set the control value from String. Value is taken as is, formatting will not be
applied to this value.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether this control should be shown.
getParent Get the parent component that contains this control.
See also
List Box Overview

Navigator Reference
Design-Time Properties
Property Description
Name The name of the Navigator component.
Page Links Specify the number of displayed page links (10 by default).
Type Specify the type of links used in the Navigator.
Events
Event Description
Server Side Events
Before Show Occurs before the component is rendered to the page.
Run-Time Properties (ASP)
Property Description
Visible This property determines whether the component is to be shown or not.

73
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the component is to be shown or not.
Run-Time Properties (.NET)
Interface
Property Description
Style Gets or sets the display style of the Navigator component.
PagerSize Gets or sets the number of pages that will be displayed by the Navigator.
PageNumber Gets or sets the current page number.
MaxPage Gets or sets the maximum number of pages.
Visible This property determines whether the component is to be shown or not.
Run-Time Variables (CF,CFT)
Variable Description
hide<control name> This variable determines whether the component is to be shown or not. If the
variable is set to true, the control will not be displayed.
Methods (Servlets & JSP)
Method Description
isVisible Indicates whether this control should be shown or not.
setVisible Specify whether this control should be shown or not.
getParent Get the parent component that contains this control.
See also
Navigator Overview

Page Reference
Design-Time Properties
Property Description
Restricted Specify if the Group Access authorization is used.
Access Denied Page Page used for redirection in case of denied access.
Convert URL To Specify if the Access Denied URL should be converted to different format.
Includable Specify of the Page is included in other pages
SSL Access Only If the page is not accessed via SSL then the connection error occurs.
Events
Event Description
Server Side Events

74
After Initialize Occurs after all page components have been initialized, before processing
submitted data or showing components. It can be used for defining code that
should be executed before any other event code. It can be used on pages
that don't contain any objects and are used only for processing data, without
outputting the rendered template (e.g. for pages that should output binary
data, like images or files). Another common application is conditional
redirecting (using Redirect global variable).
On Initialize View Occurs after handling submitted data and before loading templates for page
showing. A common application is changing template filename to use
different page templates conditionally.
Before Show Occurs after the template object has been initialized with the template page
contents and before showing (populating template with data) page
components and controls. This event can be used for putting dynamic
content into template variables (i.e. {var_name}, where var_name is the
name of the variable).
Before Output Occurs after page template is rendered and before output content to the
client.
Before Unload Occurs before disposing page’s components objects, after page output is
completed. It can be used for defining code that should be executed just
before the page execution is complete. Another application is closing
additional database connections or freeing other custom resources.
Client Side Events
On Load Used for binding Validation rules to control, initializing any JavaScript
functions. It is invoked when the page loading is completed by the browser. It
can be used to initialize some DHTML components like menus or trees
placed on page.
On Unload Invoked when the page is about to be closed, or the user navigates to
another page. It can be used to detect unsubmitted changes or ask for page
leaving confirmation.
Global variables (ASP)
Property Description
DB<connection name> For each connection used by page's components a global variable is
created to hold connection's functionality. Variable name consists of
constant DB prefix and variable suffix dependent on the name of the
connection.
FileName This global variable holds the name of the page that is currently
processed. This variable is useful to determine which page is currently
being processed from within included page. This variable can be used to
construct link on included pages too.
HTMLTemplate This variable holds template object that can be used to perform global
operations on the page's template.
PathToCurrentPage This variable contains path from site's root directory to currently executed
page's directory.
PathToRoot This variable holds relative path to access site's root directory from page's
parent directory. It is usually composed of number of .. parent paths
(depending on page's level).

75
Redirect This variable contains relative or absolute URL, or just page name to
redirect. This redirection is made just before On Initialize View event, so it
only makes sense to set variable's value in After Initialize event or some
submit processing event in page sub components.
ScriptPath This variable contains absolute filesystem path to current page's directory.
TemplateFileName This variable contains name of the template file. This file is loaded to
retrieve page and components rendering HTML blocks.
Tpl This variable holds a reference to root template block. It can be used to
access template variables defined in HTML code.
Global variables (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
DB<connectionname> For each connection used by page's components a global variable is
created to hold connection's functionality. Variable name consists of
constant DB prefix and variable suffix dependent on the name of the
connection.
FileName This global variable holds the name of the page that is currently processed.
This variable is useful to determine which page is currently being
processed from within included page. This variable can be used to
construct link on included pages too.
PathToRoot This variable holds relative path to access site's root directory from page's
parent directory. It is usually composed of number of .. parent paths
(depending on page's level).
Redirect This variable contains relative or absolute URL, or just page name to
redirect. This redirection is made just before On Initialize View event, so it
only makes sense to set variable's value in After Initialize event or some
submit processing event in page sub components.
TemplateFileName This variable contains name of the template file. This file is loaded to
retrieve page and components rendering HTML blocks.
Tpl An object that contains CCS internal representation of the template HTML
file used for the page's layout.
Global constants (PHP)
Property Description
RelativePath This constant contains path from site's root directory to currently executed
page's directory.
Methods (Servlets & JSP)
Method Description
getComponent Find Component in children collection by name.
getGrid Find Grid in children collection by name.
getRecord Find Record in children collection by name.

76
getEditableGrid Find EditableGrid in children collection by name.
getDirectory Find Directory in children collection by name.
getPath Find Path in children collection by name.
getRedirectString Returns redirection URL string.
setRedirectString Specify URL string for redirect. This redirection is made just before On
Initialize View event, so it only makes sense to set variable's value in After
Initialize event or some submit processing event in page sub components.
getRequest Returns the current request associated with this page.
getResponse Returns the current response associated with this page.
getHttpGetParameters
getHttpGetParameter Returns the value of a request GET parameter as a String, or null if
parameter does not exist.
getHttpPostParameters
getHttpPostParameter Returns the value of a request POST parameter as a String, or null if
parameter does not exist.
getParameter Returns the value of a request parameter as a String, or null if parameter
does not exist.
getFile Returns a UploadedFile object that present a uploaded file, or null if file
does not uploaded.
getTemplate Returns the Template object for the direct usage of the template library or
null for JSP.
isRestricted Whether users must be logged in before accessing the form.
setRestricted Specify whether users must be logged in before accessing the form.
getChild Specify a name to find a child control among the collection of children
controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection of
children controls.
getButton Specify a name to find a Button control among the collection of children
controls.
getListBox Specify a name to find a Listbox control among the collection of children
controls.
getRadioButton Specify a name to find a Radiobutton control among the collection of
children controls.
getCheckBoxList Specify a name to find a Checkbox List control among the collection of
children controls.
getLink Specify a name to find a Link control among the collection of children
controls.
getDatePicker Specify a name to find a Date Picker control among the collection of
children controls.

77
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether this control or component should be shown.
getParent Get the parent component that contains this control or component.
Run-Time Variables (CF,CFT)
Property Description
DB_<connection name>_USER_NAME For each connection a request scope variable is
created to hold connection's functionality.This
variable contains username value specified in the
connection
DB_<connectionname>_USER_PASSWORD For each connection a request scope variable is
created to hold connection's functionality.This
variable contains password value specified in the
connection
DB_<connectionname>_DB_TYPE For each connection a request scope variable is
created to hold connection's functionality.This
variable contains database driver type value
specified in the connection
DB_<connectionname>_DB_DS For each connection a request scope variable is
created to hold connection's functionality.This
variable contains name of the data source
connection
strFileName This variable holds the name of the page that is
currently processed. This variable is useful to
determine which page is currently being processed
from within included page. This variable can be
used to construct link on included pages too.
PathToCurrentPage This variable contains path from site's root directory
to currently executed page's directory.
PathToRoot This variable holds relative path to access site's
root directory from page's parent directory.
strRedirect This variable contains relative or absolute URL, or
just page name to redirect. This redirection is made
just before On Initialize View event, so it only
makes sense to set variable's value in After
Initialize event or some submit processing event in
page sub components.
strTemplateFileName (for CFT only) This variable contains name of the template file.
This file is loaded to retrieve page and components
rendering HTML blocks.

Panel Reference
Design-Time Properties
Property Description
Name The identifier used in the generated code and HTML template.

78
Visible Specify whether the panel should be shown on the page at run-time. If the value is "No"
the Panel and included components will be not displayed.
Note: this property specifies the default state of the panel, which can be changed
dynamically using the custom code or actions.

Events
Event Description
Before Show This event occurs before panel component is rendered within the page.
Run-Time Properties (ASP)
Property Description
Visible Determine whether the panel and included components should be shown.
Components The component collection included into the panel.

Methods (ASP)
Method Description
AddComponents This method can be used to add an array of controls.

Run-Time Properties (PHP)

Property Description
Components The component collection included into the panel.
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a textbox
that is included within that form.
Visible Specify if the form will be shown or not.
Run-Time Variables (CF,CFT)
Variable Description
hide<control name> Specify if the control will be shown or not. If the value is 'true' the control will
not be displayed.
Methods (Servlets & JSP)
Method Description
getComponents Returns all children controls as a collection.
getComponent Returns the children control with the specified name.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether the form should be shown or not.
getParent Retrieves the parent component that contains the form.
Run-Time Properties (.NET)
The System.Web.UI.WebControls.PlaceHolder is recommended to be used.
Property Description

79
Visible Retrieves or specifies the value indicating whether the control will be rendered on the
page.
See also
• Panel Control
• Placing an existing component within a new panel
• Restricting SQL Execution for Components Hidden Using a Panel
• Iterating Panel Controls
• Working with Panels

Path Reference
Design-Time Properties
Property Description
Name Name of the control.
Connection Select one of the project database connection names.
Data Source Type Specify the type of Data Source.
Data Source Specify the actual source of data for the list of values depending on the
Source Type.
ID Field Specify the field containing the unique ID that identifies the categories.
Parent Field Specify the field with primary key values of the parent categories.
Events
Event Description
Server Side Events
Before Select This event occurs at the onset of the operations performed to select
records from the database.
Before Show This event occurs before a component is rendered to the page.
Before Show Category This event occurs before each category in the Path is displayed.
Before Build Select This event occurs before the creation of the query that will be used to
retrieve records from the database.
Before Execute Select This event occurs immediately before a row selection query is executed
but after the query has been composed.
After Execute Select This event occurs after the row selection query has been executed and a
recordset for the result is returned.
Run-Time Properties (ASP)
Property Description
DataSource This property stores a reference to the data source bound to the component.
The data source handles all data retrieval and update operations. It serves
as an abstraction layer that hides underlying data source details, whether it is
a database table, SQL query or stored procedure.
Errors This property contains any error messages pertaining to the entire form as a

80
 whole.
Recordset This property contains a recordset in which are all the records that will be
shown in the form.
Visible This property determines whether the component is to be shown or not.
Data Source properties
Property Description
DataSource.SQL This property contains the main portion of the SQL query used to retrieve the
records displayed within the component. In terms of SQL, this property
defines the SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the component. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource.SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
component.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
DataSource This property stores a reference to the data source bound to the specified
object. The data source handles all data retrieval and update operations. It
serves as an abstraction layer that hides underlying data source details,
whether it is a database table, SQL query or stored procedure.
Errors This property keeps the reference to the object’s error collection. It is used to
collect error messages generated during the object’s execution.
Visible This property determines whether the component is to be shown or not.
Data Source properties
Property Description
DataSource->SQL This property contains the main portion of the SQL query used to retrieve
the records displayed within the component. In terms of SQL, this property
defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the component. The WHERE clause provides the criteria
which filters the records retrieved. The value of this property is appended to
the value of the DataSource->SQL property to create the final SQL query
which is executed against the datasource to retrieve the records for the
component.
Run-Time Properties (.NET)
Interface
Property Description
DataSource This property stores a reference to the data source bound to the component.

81
Visible This property determines whether the component will be shown or not.
Model Layer
Property Description
errors This property keeps a reference to the object’s error collection. It is used to
collect error messages generated during the object’s execution.
<control name> For each control that is located within a component, a member property is
created with the same name as the control.
Directory Data Provider
Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member
property is created with the prefix (according to parameter source
type) and parameter name (according to parameter source).
Methods (.NET)
Data Provider
Method Description
GetResultSet Executes an SQL command and returns results in an Items array.
Run-Time Variables (CF,CFT)
Property Description
query<control name> This variable contains the query object associated with the component.
strOrder This variable contains the ORDER BY clause portion of the SQL query
used to retrieve records for the control. The ORDER BY clause determines
the order of appearance of the retrieved records. The value of this property
is appended to the value of the strSQL variable to create the final SQL
query which is executed against the datasource to retrieve the records for
the control.
strSQL This variable contains the main portion of the SQL query used to retrieve
the records displayed within the component. In terms of SQL, this property
defines the SELECT and FROM clauses of the SQL query.
strWhere This variable contains the WHERE clause portion of the SQL query used to
retrieve records for the component. The WHERE clause provides the
criteria which filters the records retrieved. The value of this property is
appended to the value of the strSQL variable to create the final SQL query
which is executed against the datasource to retrieve the records for the
component.
hide<control name> This variable determines whether the control is to be shown or not.
Methods (Servlets & JSP)
Method Description
isRestricted Indicates whether users must be logged in before accessing the component.
setRestricted Specify whether users must be logged in before accessing the component.
getPageModel Get the page to which the component belongs.
isProcessed Indicate whether the component has been processed.

82
hasNextRow Returns true if there are more elements in a collection
nextRow Returns the next row. If the next row isn't available, this method returns an
empty HashMap; This method never returns a null.
currentRow Returns the current row.
getChild Specify a name to find a child control among the collection of children
controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection of children
controls.
getButton Specify a name to find a Button control among the collection of children
controls.
getListBox Specify a name to find a Listbox control among the collection of children
controls.
getRadioButton Specify a name to find a Radiobutton control among the collection of children
controls.
getCheckBoxList Specify a name to find a Checkbox List control among the collection of
children controls.
getLink Specify a name to find a Link control among the collection of children
controls.
getDatePicker Specify a name to find a Date Picker control among the collection of children
controls.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether this component should be shown.
getParent Get the parent component that contains this control or component.
See also
Path Overview

Project Reference
Properties
Property Description
Code Language Select the programming language in which the code will be generated.
Site Language Specify the spoken language for the site.
Server URL: The HTTP URL to be used to access the published pages.
Secured Server URL Specify the SSL HTTP URL to be used to access the published pages.
This option is only used if you want to access the pages over a SSL
connection and the server you are using supports SSL.
Server Path The file system path where the pages will be published.
Location: Specify whether the generated pages will be published to a local
computer or network or whether they will be published to a remote

83
 computer via FTP.
FTP Server The address of the FTP host machine.
FTP Folder The path to the folder in the FTP host machine where the pages will be
uploaded.
FTP Login The login name required to access the FTP host machine.
FTP Password The password required to access the FTP host machine.
FTP Server URL The HTTP URL that maps to the location on the FTP host where the
pages are uploaded.
FTP Passive Mode Whether or not the FTP session should use passive mode, for instance
if connecting from behind a firewall.
Default Date Format Select the format in which you want date values to be displayed in the
project. If no selection is made, date values will be displayed in the
default database format
Start Page Specify the starting page for your project.
Security Type • None: No site security is implemented
• Table: Security will be based on information contained in a
database table
• Database: The inbuilt database security will be used for the site
Login Page Select the project page that will be used to enter authentication details
by the users.
Convert URL To Specify whether URLs should be automatically converted to absolute
URLs or secure URLs for the SSL protocol (https://).
User ID Stored As Select the method to be used to store the User ID after a user logs in
(Session, URL, Cookies).
Security Connection Select the connection from where security information will be retrieved.
User Table Select the database table containing user security information.
User ID Field Select the database table field containing the unique ID that identifies
the users.
User Login Field Select the database table field containing the login usernames of the
users.
User Password Field Select the database table field containing the login passwords of the
users.
Level/Group Field If applicable, select the database table field containing the security level
of the users.
User ID Variable Enter a name to be used for the user ID variable for a logged in user.
User Login Variable Enter a name to be used for the user login name variable for a logged in
user.
User Password Variable Enter a name to be used for the user password variable for a logged in
user.
Group ID Variable Enter a name to be used for the group ID variable for a logged in user.
Level Inclusion If this option is selected, users with a higher security level will be able to

84
 access pages designated with a lower security level. Otherwise, an
exact match will be needed in order to access any page.
Character Set CodePage Set the value for the code page used for setting the body of the HTTP
request. This can be necessary when sending data in the body using a
character set other than the system default.
Geographic Local LCID The LCID is a locale identifier that identifies the language in use.

Radio Button Reference

Design-Time Properties
Property Description
Name Name of the control.
Caption Name used to refer to the control in an error message.
Control Source Type Type of data source that will provide data for the control: Database Column,
Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Connection The database connection from where information will be retrieved.
Data Source Type Specify the type of source of data for the list of values to be shown in the
control e.g. the name of a database column.
Data Source Specify the actual source of data for the list of values depending on the List
Source Type.
Bound Column The data source column containing the values that will be submitted.
Text Column The data source column containing the values that will be displayed.
Data Type The type of data that will be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Content The type of the content [Text or HTML].
Required [Yes/No] Select 'Yes' if a value must be entered for the control in order for
the form to be submitted successfully.
Unique Yes/No] Select 'Yes' if you want a check to be made to ensure that any value
entered in the control does not already exist in the database.
Error Control Specify the name of a control that will be used to display any error messages
pertaining to the control. If this value is not specified, all error messages are
displayed at the top of the form in which the control is contained..
Validation Rule Specify an expression that will be used to check the validity of the data
entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does
not meet the validation rule.
Events
Event Description

85
Server Side Events
On Validate Occurs after the control value have been submitted to the server and
before the submitted value is used to update any database content. This
event is meant to be used to specify any validation operations that should
be run against the submitted value to ensure that the value is valid. The
addErrors method of the form can be used to log an error if the validation
check fails.
Before Show Occurs before the control is rendered to the page. This event can be used
to set template variables placed within the control's HTML block. For
instance, the control can be disabled conditionally.
Before Build Select Occurs before the query used to retrieve the data for the control is built.
This event can be used to modify the data retrieval query e.g. set the value
of the where or order by clause.
Before Execute Select Occurs before the query used to retrieve the data for the control is
executed. This event can be used to modify the entire query before it is
executed.
After Execute Select Occurs after the query used to retrieve the data for the control has been
executed and the results of the query have been returrned in a recordset.
Client Side Events
On Click Occurs immediately after the control has been clicked. This event can be
used to provide interactive behavior when the control is clicked.
Run-Time Properties (ASP)
Property Description
DataSource This property stores a reference to the data source bound to the radio button.
The data source handles all data retrieval operations.
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Recordset This property contains a recordset with the data retrieved for the control.
Value This property contains the value of the selected radio button.
Visible This property determines whether the component is to be shown or not.
Components can only be hidden if they have Extended HTML generated. To
hide the component this property has to be set to false in some parent
component's Before Show event.
Data Source properties
Property Description
DataSource.SQL This property contains SQL query used to retrieve records displayed with grid
form.
DataSource.Where This property contains portion of SQL query containing expressions used to
filter the grid rows (WHERE clause).
Run-Time Properties (PHP)
Property Description

86
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
DataSource This property stores a reference to the data source bound to the radio button.
The data source handles all data retrieval operations.
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Visible This property determines whether the component is to be shown or not.
Components can only be hidden if they have Extended HTML generated. To
hide the component this property has to be set to false in some parent
component's Before Show event.
Data Source properties
Property Description
DataSource->SQL This property contains SQL query used to retrieve records displayed with
grid form.
DataSource->Where This property contains portion of SQL query containing expressions used to
filter the grid rows (WHERE clause).
Methods (PHP)
Method Description
GetValue Returns the value of the selected radio button.
SetValue Sets the selected radio button based on its value.
Run-Time Properties (.NET)
Interface System.Web.UI.WebControls.RadioButtonList class is used.
Property Description
Items Gets the collection of items in the list control. See .NET Framework SDK
reference.
SelectedIndex Gets or sets the lowest ordinal index of the selected items in the list. See
.NET Framework SDK reference.
SelectedItem Gets the selected item with the lowest index in the list control. See .NET
Framework SDK reference.
Visible This property determines whether the control is visible (parsed into template)
or not.
Model Layer
Property Description
<control name> Contains current value of control.
<control name>Items Collection of control items.
Run-Time Variables (CF,CFT)
Variable Description
arr_<owner name><control name> This variable contains the array of items in the list control.

87
fld<control name> Holds a value of the control.
hide<control name> This variable controls the visibility of the control. If the variable
is set to true, the control will not be displayed.
strOrder<control name> This variable contains the ORDER clause to be used with the
SQL query to execute for a query object (cfquery tag).
strSQL<control name> This variable contains the SQL query to execute for a query
object (cfquery tag) for gets data.
strWhere<control name> This variable contains the WHERE clause to be used with the
SQL query to execute for a query object (cfquery tag).
query<control name> This variable contains query object.
Methods (Servlets & JSP)
Method Description
addValue For Multiselect lists add value to selected values list.
setValues Set list selected values from Enumeration of Strings.
setListOfValues Set list of values to choose from. Used to populate list values from String.
getOptions Get Options list in form of Enumeration of Strings.
setOptions Set list of values to choose from. Used to populate list values from String.
getFormattedOptions Prepare list collection for output. This method marks those list values that
were selected by request.
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Set the control value from String. Value is taken as is, formatting will not be
applied to this value.
hasErrors Whether the control has (validation) errors.
addError Add error description to errors collection.
getErrorsAsString Get all errors formatted as String, separated by &lt;br&gt; elements.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether this control or component should be shown.
getParent Get the parent component that contains this control or component.
See also
Radio Button Overview

Record Form Reference

Design-Time Properties
Property Description
Name The name of the form.
Connection The database connection from which information will be retrieved.
Data Source Type The type of data source or the method used to retrieve the data.

88
Data Source The database column, SQL Query or other expression from where the data
will be retrieved.
Return Page The page to which the user is directed to after the form has been submitted
successfully.
Remove Parameters Specify a semicolon-separated list of parameters that should be removed
from the hyperlink.
Convert URL To Specify whether URLs should be automatically converted to absolute URLs
or secure URLs for the SSL protocol (https://).
Restricted Specify whether users must be logged in before accessing the form.
Allow Insert Specify whether the form can be used to insert new data.
Allow Update Specify whether the form can be used to update existing data.
Allow Delete Specify whether the form can be used to delete existing data.
Preserve Parameters Specify whether Get or Post parameters should be preserved.
Custom Insert Type If you wish to override the default insert mechanism, select the type of
method to be used to perform the insert operation.
Custom Insert Specify the procedure to be used to insert data.
Custom Update Type If you wish to override the default update mechanism, select the type of
method to be used to perform the update operation.
Custom Update Specify the procedure to be used to update data.
Custom Delete Type If you wish to override the default delete mechanism, select the type of
method to be used to perform the delete operation.
Custom Delete Specify the procedure to be used to delete data.
Events
Event Description
Server Side Events
Before Select This event occurs at the onset of the operations performed to select
records from the database.
Before Show This event occurs before a component is rendered to the page.
Before Build Select This event occurs before the creation of the query that will be used to
retrieve records from the database.
Before Execute Select This event occurs immediately before a row selection query is executed
but after the query has been composed.
After Execute Select This event occurs after the row selection query has been executed and a
recordset for the result is returned.
On Validate This event occurs after standard validation operations have been
performed as a result of submitting values, but before any database
operations have been performed with the submitted values.
Before Insert This event occurs at the onset of the operations performed to insert a new
record into the database.
Before Build Insert This event occurs before the creation of the query that will be used to

89
 insert a new record into the database.
Before Execute Insert Occurs directly before executing new row insertion query, after all its
components have been prepared.
After Execute Insert This event occurs after new row insert query has been executed.
After Insert This event occurs after inserting a new row into data source, but before
error processing.
Before Update This event occurs before preparing to update an existing record.
Before Build Update This event occurs before the creation of the query that will be used to
update database content.
Before Execute Update This event occurs immediately before a row update query is executed but
after the query has been composed.
After Execute Update This event occurs after a row update query has been executed.
After Update This event occurs after updating an existing row in the data source, but
before error processing.
Before Delete This event occurs before preparing for a row deletion.
Before Build Delete This event occurs before the creation of the query that will be used to
deleted a database record.
Before Execute Delete This event occurs immediately before a row deletion query is executed but
after the query has been composed.
After Execute Delete This event occurs after a row deletion query has been executed.
After Delete This event occurs after deleting a row from the data source, but before
error processing.

Client Side Events

On Load Used for binding Validation rules to control.
On Submit Occurs on the client side when the user submits the form, before the data
are sent to the server from the form.
Run-Time Properties (ASP)
Property Description
DataSource This property stores a reference to the data source bound to the form. The data
source handles all data retrieval and update operations. It serves as an
abstraction layer that hides underlying data source details, whether it is a
database table, SQL query or stored procedure.
DeleteAllowed This property determines whether the delete operation should proceed or not.
The value of this property is set automatically based on the value of the
Restricted property of the form. If the Restricted property is set to No, the value
of this property is always True unless it is modified using event code in the
Before Delete event.
EditMode This property specifies the mode in which a form currently is in. A form can either
be in Insert mode or Edit mode.
Errors This property keeps a reference to the form's error collection. It is used to collect
error messages generated during the form’s execution.

90
FormSubmitted This property determines how a form is processed based on whether the form is
being shown for the first time or has been submitted for postback. In the initial
display, the form fields are assigned data values before being displayed.
Otherwise if the form has been submitted for postback, the submitted data is
processed based on the operation that was initiated upon submission.
InsertAllowed This property determines whether the insert operation can proceed or not.
PressedButton This property contains the name of the form submit button which was clicked to
initiate postback.
ReadAllowed This property determines whether the data read operation can proceed or not.
Recordset This property contains a recordset in which is the database record that will be
shown in the form.
UpdateAllowed This is a boolean property whose value determines whether the update operation
should proceed or not. The value of this property is set automatically based on
the value of the Restricted property of the form. If the Restricted property is set
to No, the value of this property is always True unless it is modified using event
code in the Before Update event.
Visible This property determines whether the form is to be shown or not.
Data Source properties
Property Description
DataSource.SQL This property contains the main portion of the SQL query used to
retrieve the records displayed within the form. In terms of SQL, this
property defines the SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query
used to retrieve records for the form. The WHERE clause provides the
criteria which filters the records retrieved. The value of this property is
appended to the value of the DataSource.SQL property to create the
final SQL query which is executed against the datasource to retrieve
the records for the form.
DataSource.CmdExecution This property determines whether or not the Insert, Update or Delete
operation should proceed depending on the used
BeforeExecuteInsert, BeforeExecuteUpdate or BeforeExecuteDelete
event.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a textbox
that is included within that form.
DataSource This property stores a reference to the data source bound to the form. The data
source handles all data retrieval and update operations. It serves as an
abstraction layer that hides underlying data source details, whether it is a
database table, SQL query or stored procedure.
DeleteAllowed This property determines whether the delete operation should proceed or not.
The value of this property is set automatically based on the value of the
Restricted property of the form. If the Restricted property is set to No, the value

91
 of this property is always True unless it is modified using event code in the
Before Delete event.
EditMode This property specifies the mode in which a form currently is in. A form can either
be in Insert mode or Edit mode.
Errors This property keeps a reference to the form's error collection. It is used to collect
error messages generated during the form’s execution.
FormSubmitted This property determines how a form is processed based on whether the form is
being shown for the first time or has been submitted for postback. In the initial
display, the form fields are assigned data values before being displayed.
Otherwise if the form has been submitted for postback, the submitted data is
processed based on the operation that was initiated upon submission.
InsertAllowed This property determines whether the insert operation can proceed or not.
PressedButton This property contains the name of the form submit button which was clicked to
initiate postback.
ReadAllowed This property determines whether the data read operation can proceed or not.
UpdateAllowed This is a boolean property whose value determines whether the update
operation should proceed or not. The value of this property is set automatically
based on the value of the Restricted property of the form. If the Restricted
property is set to No, the value of this property is always True unless it is
modified using event code in the Before Update event.
Visible This property determines whether the form is to be shown or not.
Data Source properties
Property Description
DataSource->SQL This property contains the main portion of the SQL query used to
retrieve the records displayed within the form. In terms of SQL, this
property defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query
used to retrieve records for the form. The WHERE clause provides
the criteria which filters the records retrieved. The value of this
property is appended to the value of the DataSource->SQL property
to create the final SQL query which is executed against the
datasource to retrieve the records for the form.
DataSource->CmdExecution This property determines whether or not the Insert, Update or Delete
operation should proceed depending on the used
BeforeExecuteInsert, BeforeExecuteUpdate or BeforeExecuteDelete
event.
Run-Time Variables (CF,CFT)
Property Description
blnDeleteAllowed<control name> This variable determines whether the delete operation should
proceed or not. The value of this variable is set automatically
based on the value of the Restricted property of the form. If
the Restricted property is set to No, the value of this property
is always True unless it is modified using event code in the
Before Delete event.

92
blnEditMode<control name> This variable specifies the mode in which a form currently is
in. A form can either be in Insert mode or Edit mode.
blnFormSubmitted<control_name> This variable determines how a form is processed based on
whether the form is being shown for the first time or has been
submitted for postback. In the initial display, the form fields
are assigned data values before being displayed. Otherwise if
the form has been submitted for postback, the submitted data
is processed based on the operation that was initiated upon
submission.
blnInsertAllowed<control name> This variable determines whether the insert operation can
proceed or not.
blnReadAllowed<control name> This variable determines whether data read operation can
proceed or not.
blnUpdateAllowed<control name> This is a boolean variable whose value determines whether
the update operation should proceed or not. The value of this
variable is set automatically based on the value of the
Restricted property of the form. If the Restricted property is
set to No, the value of this property is always True unless it is
modified using event code in the Before Update event.
hide<control name> This variable determines whether the control is to be shown or
not.
strError<control name> This variable contains any error messages generated during
execution of the form.
strOperation This variable indicates the operation to be performed based
on the value of the submit button that was clicked to initiate
postback.
strPressedButton This variable contains the name of the form submit button
which was clicked to initiate postback.
strSQL This variable contains the main portion of the SQL query used
to retrieve the records displayed within the form. In terms of
SQL, this property defines the SELECT and FROM clauses of
the SQL query.
strOrder<control name> This variable contains the ORDER BY clause to be used in
the SQL query executed for a query object (cfquery tag).
strSQL<control name> This variable contains the SELECT and FROM clauses of the
SQL query to be used for a query object (cfquery tag).
strWhere<control name> This variable contains the WHERE clause of the SQL query to
be used for a query object (cfquery tag).
query<control name> This variable contains the query object associated with the
form.
endOperation<control name> This property determines whether or not the Insert, Update or
Delete operation should proceed depending on the used
BeforeExecuteInsert, BeforeExecuteUpdate or
BeforeExecuteDelete event.
Methods (Servlets & JSP)

93
Method Description
isEditMode Returns a value indicating whether Record form is in Edit mode.
isAllowRead Returns a value indicating whether the data read operation can proceed or not.
setAllowRead Use to toggle the value which determines whether the data read operations can
proceed or not.
isAllowInsert Returns a value indicating whether the insert operation can proceed or not.
setAllowInsert Use to toggle the value which determines whether the insert operation can
proceed or not.
isAllowUpdate Returns a value indicating whether the update operation should proceed or not.
setAllowUpdate Used to toggle the value which determines whether the update operation should
proceed or not.
isAllowDelete Returns a value indicating whether the delete operation should proceed or not.
setAllowDelete Used to toggle the value which determines whether the delete operation should
proceed or not.
setRestricted Specify whether users must be logged in before accessing the form.
getPageModel Get the page to which the component belongs
hasNextRow Returns true if there are more elements in a collection
nextRow Returns the next row. If the next row isn't available, this method returns an
empty HashMap; This method never returns a null.
currentRow Returns the current row.
getChild Specify a name to find a child control among the collection of children controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection of children
controls.
getButton Specify a name to find a Button control among the collection of children
controls.
getListBox Specify a name to find a Listbox control among the collection of children
controls.
getRadioButton Specify a name to find a Radiobutton control among the collection of children
controls.
getCheckBoxList Specify a name to find a Checkbox List control among the collection of children
controls.
getLink Specify a name to find a Link control among the collection of children controls.
getDatePicker Specify a name to find a Date Picker control among the collection of children
controls.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether the form should be shown or not.
isCmdExecution Returns a value indicating whether the operation should proceed or not.
setCmdExecution Specify whether the operation should be performed or not.

94
getParent Get the parent component that contains the form.
Run-Time Properties (.NET)
Record Interface objects
Property Description
<form name><control name> For each control that is located within
the form, a protected member
property is created with corresponding
name.
System.Collections.Specialized.NameValueCollection The collection of global critical errors,
<control name>Errors such as DataProvider errors. See the
.NET Framework SDK reference.
<control name>DataProvider <control name>Data The Data Source Provider for the
Record form.
System.Web.UI.WebControls.PlaceHolder <control PlaceHolder object which holds all
name>Holder Record controls. Refer to .NET
Framework SDK reference for more
information.
Record Model Layer
Property Description
errors This property keeps a reference to the form’s errors NameValueCollection. It is
used to collect error messages generated during the object’s execution.
<control name> For each control that is located within the form, a member property is created
with the same name as the control.
IsNew This property indicates if an item created based on an insert row.
IsDeleted This property indicates if a record has been submitted for deletion.

Record Data Provider

Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member
property is created with the prefix (according to the parameter source
type) and parameter name (according to the parameter source).
CmdExecution This property altered in BeforeExecuteInsert, BeforeExecuteUpdate
or BeforeExecuteDelete events determines whether the Insert,
Update or Delete operation (respectively) for the current row should
proceed.
Methods (.NET)
Record Model Layer
Method Description
CreateFromHttpRequest Returns an instance of an item whereby the values are initialized from
Http request values.
Validate Performs the item validation and returns true if validation is successful,
otherwise false.

95
Record Data Provider
Method Description
InsertItem Performs the insert operation for each item in the items array.
UpdateItem Performs the update operation for each item in the items array.
DeleteItem Performs the update operation for each item in the items array.
FillItem Execute a query against the database and return the results in an items array.
See also
Record Form Overview

Report Reference
Design-Time Properties
Property Description
Name The name of the form.
Connection The database connection from which information will be retrieved.
Data Source Type The type of data source or the method used to retrieve the data.
Data Source The database column, SQL Query or other expression from where the data
will be retrieved.
Groups Report groups that is used to manage repeating values and totals.
Restricted Specify whether users must be logged in before accessing the form.
Lines per Web Page The size of page in the Web show mode, measured in lines.
Page Size Limit The maximum number of lines per page for Web view mode.
Enable Print Mode Specify whether print mode can be enabled in runtime.
Lines per Print Page The size of page in the Print view mode, measured in lines.
Default View Mode Specify the default view mode, which will be used for report.
Events
Event Description
Server Side Events
Before Select This event occurs at the onset of the operations performed to select
records from the database.
Before Show This event occurs before a component is rendered to the page.
Before Build Select This event occurs before the creation of the query that will be used to
retrieve records from the database.
Before Execute Select This event occurs immediately before a row selection query is executed but
after the query has been composed.
After Execute Select This event occurs after the row selection query has been executed and a
recordset for the result is returned.
Run-Time Properties (ASP)
Property Description

96
ViewMode Specify the default view mode, which will be used for report.
PageSize Specify the page size for the print mode of report.
RowNumber Gets the current row number of report.
PageNumber Gets the current page number of report.
Data Source properties
Property Description
DataSource.SQL This property contains the main portion of the SQL query used to retrieve the
records displayed within the form. In terms of SQL, this property defines the
SELECT and FROM clauses of the SQL query.
DataSource.Where This property contains the WHERE clause portion of the SQL query used to
retrieve records for the form. The WHERE clause provides the criteria which
filters the records retrieved. The value of this property is appended to the
value of the DataSource.SQL property to create the final SQL query which is
executed against the datasource to retrieve the records for the form.
Run-Time Properties (PHP)
Property Description
ComponentType Specify the type of component. Have value "Report" for Report component.
ComponentName Specify the name of report.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the form is to be shown or not.
PageNumber Gets the current page number of report.
PageSize Specify the page size for the print mode of report.
ViewMode Specify the default view mode, which will be used for report.
Errors This property keeps a reference to the form's error collection. It is used to
collect error messages generated during the form's execution.
DataSource This property stores a reference to data source bound to the form. The data
source handles all data retrieval operations. It serves as an abstraction layer
that hides underlying data source details, whether it is a database table, SQL
query or stored procedure.
Data Source properties
Property Description
DataSource->CountSQL This property contains the SQL query which is executed to determine
the total number of browseable rows in the Grid form. The number
retrieved as a result of executing this query is used during the
creation of the navigation controls for the form.
DataSource->SQL This property contains the main portion of the SQL query used to
retrieve the records displayed within the form. In terms of SQL, this
property defines the SELECT and FROM clauses of the SQL query.
DataSource->Where This property contains the WHERE clause portion of the SQL query
used to retrieve records for the form. The WHERE clause provides
the criteria which filters the records retrieved. The value of this

97
 property is appended to the value of the DataSource->SQL property
to create the final SQL query which is executed against the
datasource to retrieve the records for the form.
DataSource->Order This property contains the ORDER BY clause portion of the SQL
query used to retrieve records for the control. The ORDER BY
clause determines the order of appearance of the retrieved records.
The value of this property is appended to the value of the
DataSource->SQL property to create the final SQL query which is
executed against the datasource to retrieve the records for the
control.
DataSource->RecordsCount This property contains a count of all the records that have been
retrieved for the form.
Run-Time Properties (.NET)
Report Interface object (Controls.Report class)
Property Description
DataSource Gets or sets the data source that provides data for populating the report.
Groups Gets the collection of grouping fields.
TotalPages Gets the number of pages in current report.
PageSizeLimit Gets or sets the page size limit for print mode of report.
PageSize Gets or sets the page size for the print mode of report.
PreviewPageNumber Gets or sets the page number for the web mode.
RowNumber Gets the current row number of report.
ViewMode Gets or sets the view mode of report.
WebPageSize Gets or sets the page size for the web mode of report.
Report Model Layer
Property Description
errors This property keeps a reference to the form’s errors
NameValueCollection. It is used to collect error messages generated
during the object’s execution.
<control name> For each control that is located within the form, a member property is
created with the same name as the control.
<field name>GroupField For each group of report, the member property is created.

Report Data Provider

Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member
property is created with the prefix (according to the parameter source
type) and parameter name (according to the parameter source).
Run-Time Variables (CF, CFT)
Variable Description
viewMode Specify the default view mode, which will be used for report.

98
<control name>Items Array contains report lines. Each array item contains structure with current
report elements.
<control name>Item Structure with current report elements. Structure include key for each report
control.
intPageSize Specify the page size for the print mode of report.
intPage Specify the page size for the print mode of report.
Methods (Servlets & JSP)
Method Description
getViewMode Returns Report view mode. If print view mode is disabled
Report.SHOW_MODE_WEB will always be returned.
setViewMode Set Report view mode.
nextReportRow Returns the next Report row.
getReportLabel Returns the ReportLabel component with specified name.
size Returns the number of the Report lines or zero if the Report is not populated
with data.
getRowNumber Returns the current report row number. Starting with one.
getTotalPages Returns number of the report pages
getPrintPageSize Returns the height of Report page in print view mode
setPrintPageSize Sets the height of Report page in print view mode
getWebPageSize Returns the height of Report page in web view mode
setWebPageSize Sets the height of Report page in web view mode
getPageNumber Get current Report page number.
getCurrentRow Get current Report detail row.
isDetailControl Returns true if the specified control belongs to Detail row (Detail section);
otherwise - false
isEnablePrintMode Returns true if print view mode is enabled for report component; otherwise -
false
setEnablePrintMode Sets enablePrintMode value
getPageSizeLimit Returns int value of page size limit if viewMode is
Report.VIEW_MODE_WEB; otherwise returns zero. Zero means that all
records should be displayed. PageSizeLimit is applied to web mode only.
setPageSizeLimit Sets maximal allowed size of the Report page in the web view mode
getSection Get section with given name.
getPage Get the current page being shown in the Report.
setPage Set the page number to be shown in the Report.
getNumberOfRows Get the total number of rows in the Report.
getNavigator Use a name to find the Navigator among the collection of children controls.
getSorter Use a name to find a Sorter among the collection of children controls.
getPageSize Get number of records per page.

99
setPageSize Set number of records per page.
isAllowRead Returns a value indicating whether the data read operation can proceed or
not.
setAllowRead Use to toggle the value which determines whether the data read operations
can proceed or not.
isRestricted Returns a value indicating whether users must be logged in before accessing
the form.
setRestricted Specify whether users must be logged in before accessing the form.
getPageModel Get the page to which the component belongs.
isProcessed Indicates whether a component has been processed (the ccsForm parameter
is equivalent to the name of the component).
hasNextRow Returns true if there are more elements in a collection.
getChild Specify a name to find a child control among the collection of children
controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection of children
controls.
getButton Specify a name to find a Button control among the collection of children
controls.
getListBox Specify a name to find a Listbox control among the collection of children
controls.
getRadioButton Specify a name to find a Radiobutton control among the collection of children
controls.
getCheckBoxList Specify a name to find a Checkbox List control among the collection of
children controls.
getLink Specify a name to find a Link control among the collection of children
controls.
getDatePicker Specify a name to find a Date Picker control among the collection of children
controls.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether the form should be shown or not.
getParent Get the parent component that contains the form.
See also
Report Form
Report Section
Report Section Reference
Report Label Reference

Report Label Reference

Design-Time Properties

100
Property Description
Name The name of the control.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression, Special Value.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Text if Empty Text to display, when the label's value is empty
Content Specify whether the content of the control is plain text or HTML code.
DBFormat Specify the format in which you want the control value to be entered into the
database.
Hide Duplicates Specify if the duplicated values will be shown.
Function Function to be used if the value is to be auto-calculated
Reset At Specify the group name, where value of control should be reseted
Percent Of Specify the dispalying of value as percentage of total value
Events
Event Description
Server Side Events
Before Show Occurs before the control is rendered to the page. This event can be used to
change the value of the control.
Run-Time Properties (ASP)
Property Description
TotalFunction Specify function for auto-calculated labels.
IsPercent Indicate that displaying report value is percentage of total value.
EmptyText Specify an text that will be displayed in case the label value is empty.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the control will be shown or not.
TotalFunction Specify function for auto-calculated labels.
IsPercent Indicate that displaying report value is percentage of total value.
EmptyText Specify an text that will be displayed in case the label value is empty.
Methods (PHP)

101
Method Description
GetValue Retrieves the value of the Label control.
SetValue Sets the value of the Label control.
Reset Reset value of the total function.
Run-Time Properties (.NET)
Interface (Controls.ReportLabel)
Property Description
Visible Gets or sets a value that indicates whether the control will be rendered on
the page.
Text Gets or sets the text for the ReportLabel.
Function Gets or sets the function to be used if the value is to be auto-calculated.
ContentType Gets or sets the content type for the ReportLabel.
DataType Gets or sets the data type of the ReportLabel.
EmptyText Gets or sets the text to display when the label's value is empty.
Format Gets or sets the format to be used when display label value.
PercentOf Gets or sets the name of report group, relative to percent value will be
calculated.
ResetAt Gets or sets the section, where value of control should be reseted.
Source Gets or sets the data source (field name or code expression).
SourceType Gets or sets the data source type for the ReportLabel.
Model Layer
Property Description
<control name> Contains the current value of the control.
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> Holds the value of the control.
hide<control name> This variable determines whether the control is to be shown or not.If the
variable is set to true, the label will not be displayed.
Methods (Servlets & JSP)
Method Description
getFunction Gets the function to be used if the value is to be auto-calculated.
setFunction Sets the function to be used if the value is to be auto-calculated.
getComputeAtFunction Gets the function to be used if the value is to be auto-calculated relative
value of the another group.
setComputeAtFunction Sets the function to be used if the value is to be auto-calculated relative
value of the another group.
getEmptyText Gets the text to display when the label's value is empty.
setEmptyText Sets the text to display when the label's value is empty.

102
getComputeAt Gets the name of report group, relative to percent value will be calculated.
setComputeAt Sets the name of report group, relative to percent value will be calculated.
getResetAt Gets the section, where value of control should be reseted.
setResetAt Sets the section, where value of control should be reseted.
isHideDuplicates Returns if the duplicated values will be shown.
setHideDuplicates Specify if the duplicated values will be shown.
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e.
formatting will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Indicates whether this control should be shown or not.
setVisible Specify whether this control or component should be shown or not.
getParent Get the parent component that contains this control.
isHtmlEncode Whether to encode control value before it is shown (so that html tags it
may contain will be shown as is).
setHtmlEncode Set whether to encode control value before it is shown (so that html tags it
may contain will be shown as is).
See also
Report Form
Report Sections
Report Section Reference

Report Section Reference

Design-Time Properties
Property Description
Name Identifier name used in the generated code and HTML template.
Visible Whether the section should be shown on the report page at run-time. Select "No" to
hide it.
Height The height of the section.
Events
Event Description
Server Side Events

103
On Initialized This event occurs at the initialization of section.
Before Show This event occurs before a component is rendered to the page.
On Calculate This event occurs after section component's values calculation is performed.
Run-Time Properties (ASP)
Property Description
Visible Specify if the Section will be displayed on the report. If the value is set to
False the Section is not shown.
Height Specify the height of the section.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the control will be shown or not.
Height Specify height of section.
Run-Time Properties (.NET)
Report Interface object (Controls.ReportSection class)
Property Description
Name Gets or sets the name of the section.
Height Gets or sets the height of section in lines.
Visible Gets or sets a value that indicates whether a server control is rendered as UI on the
page.
Methods (Servlets & JSP)
Method Description
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether the form should be shown or not.
getHeight Gets the height of section in lines.
setHeight Sets the height of section in lines.
See also
Report Form
Report Sections
Report Label Reference

Sorter Reference
Design-Time Properties
Setting Description
Name The name of the form.

104
Sort Order Specify the field to be used to sort by.
Reverse Order Optionally specify a field to be used to sort in the reverse order.
Visible [Yes/No] Specify whether the sorter should be displayed or not.
Events
Event Description
Server Side Events
Before Show Occurs before the control is rendered to the page. This event can be used to
influence the appearance of the Sorter.
Run-Time Properties (ASP)
Property Description
Visible This property determines whether the control is visible or not.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Visible This property determines whether the control is visible or not.
Run-Time Properties (.NET)
Interface
Property Description
State Gets or sets the state of the sorter control.
Field Gets or sets the name of database field on which the Sorter will operate.
Run-Time Variables (CF,CFT)
Variable Description
hide<control name> This variable determines whether the control is to be shown or not.
Methods (Servlets & JSP)
Method Description
isVisible Whether this control should be shown.
setVisible Specify whether this control or component should be shown.
getParent Get the parent component that contains this control or component.
See also
Sorter Overview

Text Area Reference

Design-Time Properties
Property Description
Name The name of the control.

105
Visible Specify whether the control should be displayed or not.
Caption The name used to refer to the control in an error message.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Required [Yes/No] Select 'Yes' if a value must be entered for the control in order for
the form to be submitted successfully.
Unique [Yes/No] Select 'Yes' if you want a check to be made to ensure that any
value entered in the control does not already exist in the database.
Input Validation Select a regular expression to be used to check the validity of the data
entered in the control.
Error Control Specify the name of a control that will be used to display any error messages
pertaining to the control. If this value is not specified, all error messages are
displayed at the top of the form in which the control is contained.
Validation Rule Specify an expression that will be used to check the validity of the data
entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does
not meet the validation rule.
DBFormat Specify the format in which you want the control value to be entered into the
database.
Events
Event Description
Server Side Events
On Validate Occurs after the control value have been submitted to the server and before
the submitted value is used to update any database content. This event is
meant to be used to specify any validation operations that should be run
against the submitted value to ensure that the value is valid. The addErrors
method of the form can be used to log an error if the validation check fails.
Before Show Occurs before the control is rendered to the page. This event can be used to
influence the visibility or appearance of the control or alter the value of the
control.
Client Side Events
On Key Press Occurs when the user presses an alphanumeric key within the control.
On Load Occurs after the control has been rendered to the page and before the user
can perform any operations. This event can be used to bind validation rules
to the control.

106
On Change Occurs when the value of the control is changed.
Run-Time Properties (ASP)
Property Description
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Format This property specifies a format to be applied to the value of the control.
Visible This property determines whether the component is to be shown or not.
Value Holds the value of the control.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Format This property specifies a format to be applied to the value of the control.
Visible This property determines whether the component is to be shown or not.
Run-Time Properties (.NET)
Interface The System.Web.UI.WebControls.TextBox is used
Property Description
Visible Gets or sets a value that indicates whether the server control is to be
rendered as UI on the page.
Text Gets or sets the text for the TextArea control. See .NET Framework SDK
reference.
Model Layer
Property Description
<control name> Contains the current value of the control.
Methods (PHP)
Method Description
GetValue Retrieves the value of the control.
SetValue Sets the value for the control.
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> Holds the value of the control.
hide<control name> This variable determines whether the control is to be shown or not.
Methods (Servlets & JSP)
107
Method Description
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Indicates whether this control should be shown.
setVisible Specify whether this control should be shown or not.
getParent Get the parent component that contains this control.
See also
Text Area Overview

Text Box Reference

Design-Time Properties
Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Caption The name used to refer to the control in an error message.
Control Source Type The type of data source that will provide data for the control: Database
Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database
column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will
be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise
specified.
Required [Yes/No] Select ‘Yes’ if a value must be entered for the control in order for
the form to be submitted successfully.
Unique [Yes/No] Select ‘Yes’ if you want a check to be made to ensure that any
value entered in the control does not already exist in the database.
Input Validation Select or enter a regular expression to be used to check the validity of the
data entered in the control.
Error Control Specify the name of a control that will be used to display any error messages

108
 pertaining to the control. If this value is not specified, all error messages are
displayed at the top of the form in which the control is contained.
Validation Rule Specify an expression that will be used to check the validity of the data
entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does
not satisfy the validation rule.
DBFormat Specify the format in which you want the control value to be entered into the
database.
Events
Event Description
Server Side Events
On Validate Occurs after the control value has been submitted to the server and before
the submitted value is used to update any database content. This event is
meant to be used to specify any validation operations that should be run
against the submitted value to ensure that the value is valid. The addErrors
method of the form can be used to log an error if the validation check fails.
Before Show Occurs before the control is rendered to the page. This event can be used to
influence the visibility or appearance of the control or alter the value of the
control.
Client Side Events
On Key Press Occurs when the user presses an alphanumeric key within the control.
On Load Occurs after the control has been rendered to the page and before the user
can perform any operations. This event can be used to bind validation rules
to the control.
On Change Occurs when the value of the control is changed.
Run-Time Properties (ASP)
Property Description
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.
Format This property specifies a format to be applied to the value of the control.
Visible This property determines whether the component is to be shown or not.
Value Holds the value of the control.
Run-Time Properties (PHP)
Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a
textbox that is included within that form.
Errors An object that contains the error messages generated during script execution
when submitted data fails verification or any other user defined condition is
not fulfilled.

109
Format This property specifies a format to be applied to the value of the control.
Visible This property determines whether the component is to be shown or not.
Run-Time Properties (.NET)
Interface The System.Web.UI.WebControls.TextBox is used
Property Description
Visible Gets or sets a value that indicates whether the server control is to be
rendered as UI on the page.
Text Gets or sets the text for the TextBox control. See .NET Framework SDK
reference.
Model Layer
Property Description
<control name> Contains the current value of the control.
Methods (PHP)
Method Description
GetValue Retrieves the value of the Text Box control.
SetValue Sets the value for the Text Box control.
Run-Time Variables (CF,CFT)
Variable Description
fld<control name> Holds the value of the control.
hide<control name> This variable determines whether the control is to be shown or not.
Methods (Servlets & JSP)
Method Description
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting
will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt;
tags.
isVisible Indicates whether this control should be shown.
setVisible Specify whether this control should be shown.
getParent Get the parent component that contains this control.
See also
Text Box Overview

110
Properties
A-C
.NET Debug Mode Property
Specify whether the debug option is added to the compiler.
Applies to
.NET Projects
Description
This property can be used to specify whether the debug option should be added to the compiler.
Valid values are as follows:
• Debug: Disables optimizations and enables attaching a debugger to the running program.
• Release: Enables optimizations and emits general debugging information.

Access Denied Page Property

Specify the page on which the unauthorized user is redirected.
Applies to
Page
Description
This property specifies the page used instead of Login Page for the unauthorized users.
Important: The value of this property is applied only if the value of the Restricted property is set to
'Yes'.
See also
Restricted property

Aliases Property
Specify if the display of database aliases is enabled during the design time.
Applies to
Connection
Description
You can use this property to specify if the display of database aliases is enabled during the design
time.
See Also
Connection Reference, Connecting to Databases

Allow Insert Property

Specify if the records be inserted with this form.
Applies to
Record, Editable Grid
Description
You can set this property value to 'No' to disallow the insertion of new records using the Record or
Editable Grid. The value of this property is set to 'Yes', if the Record was created using the Record

111
Builder, and 'Allow Insert' checkbox was checked on the 'Define Record Option' page of the
Record Builder.
See also
Allow Delete property, Allow Update property

Allow Update Property

Specify if the records be updated with this form.
Applies to
Record, Editable Grid
Description
You can set this property value to 'No' to disallow update the records using the Record or Editable
Grid. The value of this property is set to 'Yes', if the Record is placed on the page using the Record
Builder, and 'Allow Update' box is checked on 'Define Record Option' page of the Record Builder.
See also
Allow Delete property, Allow Insert property

Allow Delete Property

Specify if the records be deleted with this form.
Applies to
Record, Editable Grid
Description
You can set this property value to 'No' to disallow the deletion of records using the Record or
Editable Grid. The value of this property if set to 'Yes', if the Record is place on page by clicking on
the Record Builder, and 'Allow Delete' checkbox is checked on the 'Define Record Option' page of
the Record Builder.
See also
Allow Insert property, Allow Update property

Allowed File Masks Property

Specifies the list of file masks allowed to upload.
Applies to
File Upload
Description
The property contains the semicolon-separated list of file masks for files that the user is allowed to
upload e.g. *.jpg; *.png; *.gif; *.txt. By default, this property contains the "*" mask, i.e. all files are
allowed.
See also
Disallowed File Masks property

Assemblies Property
Specify the semicolon-separated list of the used assemblies.
Applies to
.NET Projects
Description

112
You can use this property to specify the semicolon-separated list of the assemblies linked to the
project.

Bound Column Property

Refers to the data source for the values that are submitted.
Applies to
Checkbox List, List Box, Radio Button
Description
If the Source Type property is set to Table/View, Procedure or SQL, use this property to specify
the database field that will provide the List Box or Radio Button values to be submitted.
See also
Text Column property, Data Source Type property, Data Source property

Boolean Format Property

Specify the format in which Boolean values should be entered into the database.
Applies to
Connection
Description
You can use this property to specify the boolean format of the data as it will appear in the
database.
See Also
Connection Reference, Connecting to Databases, DBFormat property

Caption Property
The name used to refer to the control in an error message.
Applies to
Hidden, List Box, Checkbox List, Radio Button, Text Area, Text Box
Description
This property is present in all form controls that are capable of submitting form values. If after
submission it is determined that the control submitted an invalid value, an error message is
displayed to indicate the problem. You can use this property to set a name that will be used to
refer to the control within the error message.
If a value is not specified for this control, the value of the Name property above is used by default.
However, since control names are often cryptic by nature, it is advisable to set a more readable
caption which will better help the user understand what the error message is referring to.

Catalog Property
Specify the Catalog for the database object display during the design time.
Applies to
Connection
Description
You can use this property to specify the Catalog for the database object display during the design
time. It is used for MSSQL databases.
See Also

113
Connection Reference, Connecting to Databases

Category ID Field Property

Specify the data field that contains category id of the first level categories.
Applies to
Directory
Description
Specify the data field that contains category id of the first level categories.
See also
Data Source property, Subcategory ID Field property

Charset Property
Specify the name of the character set.
Applies to
ASP, PHP Projects
Description
Charset project property is used to define the response encoding to be used by the programs.
Charset is deprecated starting with CCS 2.3 and will be removed in the next product release.
When possible, set Charset property to empty (blank) and Use the 'Default HTML Encoding'
project setting and META declarations within HTML pages instead.

Checked Value Property

The value submitted by a Checkbox Control when it is checked.
Applies to
Checkbox
Description
The default HTML checkbox always submits a value of 'on' when the checkbox is checked. This
property allows you to specify a different value to be associated with the checked state of the
checkbox.
Examples
The Checkbox can be linked to a database field of the "Text" type which stores "Yes" and "No"
values. To do that set the DataType property to "Text", and enter "Yes" for the Checked Value
Property and "No" for the Unchecked Value property obligatory in double quotes.
The following are the possible applications:
Data Type Checked Value Unchecked Value
Text "Y" "N"
Integer 1 0
Boolean True False
See also
DataType property, Unchecked Value property

Class Path Property

Specify the list of libraries required for the project compilation.

114
Applies to
Java Projects
Description
You can use this property to specify the list of libraries required for the project compilation. By
default, if this property is blank, the value of the %CLASSPATH% environment variable is used
otherwise the value is added to the classpath for the compilation.
Class Path requirements:
JSP
• Servlet 2.2 & JSP 1.1 API library
• JAXP 1.0 library
• SAX 2.0 parser (such as crimson or xerces)
• JDBC 2.0 extensions library if you use Data Sources Extension
• Jakarta ORO if you use regexp for validations
Servlets with Templates
• Servlet 2.2 API library
• JDBC 2.0 extensions library if you want to use Data Sources Extension
• Jakarta ORO if you use regexp for validations
See Also
Use Data Source Extension property

Code Language Property

Specify the programming language in which the project will be generated.
Applies to
Project
Description
You can use this property to specify the programming language in which the project will be
generated. You can always select other programming language for your, and all the project code
will be regenerated in the new programming language besides the custom code of the events or
properties.

Code Page Property

Specify the Code Page variable that sets the session.
Applies to
ASP Projects
Description
CodePage project property is deprecated starting with CCS 2.3, and will be removed in the next
product release. Use the 'File Encoding' project setting instead.
See Also
Locale Identifier property

ColdFusion Server Property

Specify the type of the ColdFusion Server.
Applies to

115
ColdFusion Projects
Description
You can use this property to specify the type of the ColdFusion Server. This property can take the
following values:
Value Description
CF 4.01 Specify if the ColdFusion Server version 4.01 is to be used
prior to Specify if the used ColdFusion Server version is higher than 4.01 but lower than
CFMX CFMX
CFMX Specify if the ColdFusion MX Server is to be used

Connect Cached Property

Specify the Connection Cached option.
Applies to
Connection
Description
You can use this property to specify the connection cached option. The Connection Cached option
is similar to an ordinary Connection, except that the returned database handle is also stored in a
hash associated with the given parameters. If another call is made to connect_cached (the cached
connection) with the same parameter values, then the corresponding cached $dbh (database
handle) will be returned if it is still valid. The cached database handle is replaced with a new
connection if it has been disconnected or if the ping method fails.
See Also
Connection Reference, Connecting to Databases

Connection Property
The database connection from where information will be retrieved.
Applies to
Checkbox List, Directory, Editable Grid, Grid, List Box, Radio Button, Record, Report, Path
Description:
You can use this property to specify a connection for retrieving control's data. You should specify
the value of this property even if only one connection is used in the project.
A List Box and Radio Button control are capable of containing values that are based on any
existing connections within the project. A connection can be from the Record's one. For this
reason, this property allows you to select the connection from where the List Box values will be
retrieved.
See also:
Connection Reference, Connecting to Databases,

Connection String Property

Specify the ADO connection string or ODBC Data Source Name.
Applies to
Connection
Description

116
You can use this property to specify ADO connection string or ODBC Data Source Name used for
the database connection.
See Also
Connection Reference, Connecting to Databases, Connection Type property

Connection Type Property

Specify the connection type.
Applies to
Connection
Description
You can use this property to specify the connection type which will be used, "Connection string" or
"ODBC Data Source".
See Also
Connection Reference, Connecting to Databases, Connection String property

Content Property
The type of the content.
Applies to
Checkbox List, Label, Label (Report), Link, Radio Button
Description
The following are the Data options of the Content Property:
Setting Description
Text The control value is composed of plain text. All HTML tags are converted into the
(default) corresponding escape (ESC) sequences. For example, ">" is converted into "&gt;".
Important: If the sourse text contains the line break symbol then it is converted into the
"<br>" HTML tag.
HTML The control value is composed of HTML markup. The source text is displayed without
converting. If the source text contains the HTML tags, then they are dispayed by the
browser as normal HTML.
Examples:
This following is an example of the Label outputs:
Setting Source Text Result after conversion Result in browser
Text <font color='Red'>First &lt;font color='Red'&gt;First <font color='Red'>First
line line<br> line
Second Line</font> Second Line&lt;/font&gt; Second Line</font>
HTML <font color='Red'>First <font color='Red'>First line First Line Second Line
line Second Line</font>
Second Line</font>

Context Path Property

Specify the context path of the web application.
Applies to
Java Projects

117
Description
You can use this property to specify the context path (including the leading slash) of the web
application you are dealing with. It is used only if the target server is Tomcat.
See Also
Target Server property

Control Source Property

Specify the source of data for the control, such as the name of a database column.
Applies to
Checkbox, Checkbox List, File Upload, Hidden, Image, Image Link, Label, Link, List Box, Radio
Button, Text Area, Text Box
Description
The usage of this property depends on the value specified in the Source Type property.
• If the Source Type is Database Column, specify the database table column that will be used
to furnish the control value.
• If the Source Type is Code Expression, enter the exact code expression to be used to
supply the control value.
• If the Source Type is Special Value (for Calendar controls), the control value should be one
of the following: NextProcessingDate, CurrentProcessingDate, PrevProcessingDate.

When using Control Source property within Reports please refer to Control Source property
(Report).
See Also
• Control Source Type property,
• Control Source Type property (Report),
• Control Source property (Report)

Control Source Property (Report)

Specify the source of data for the control, such as the name of a database column.
Applies to
Label (Report)
Description
This property depends on the value specified in the Source Type property. If the Source Type is a
Database Column, use this property to specify the database table column that will be used to
furnish the control value. Respectively, if the Source Type is a Code Expression, enter the exact
code expression to be used to furnish the control value.
Control Source Type Description
Database Column The control value will come from a column within a database table.
Code Expression The control value will be derived from an expression specific to the
particular programming language being used. This could be a function
that returns a value, a pre-existing variable or any other valid language
construct that will evaluate to a definite value.

118
 Examples:
• 1 assigns the value "1" to the control.
• now() assigns the current date and time to the control value.
Special Value The control value should be one of the following: CurrentPage,
TotalPages, RowNumber, CurrentDate, CurrentTime, CurrentDateTime
See Also
• Control Source Type property
• Using Special Values example

Control Source Type Property

Specify the type of data source that will provide data for the control.
Applies to
Checkbox, Checkbox List, File Upload, Hidden, Image, Image Link, Label, Link, List Box, Radio
Button, Text Area, Text Box
Description
The type of data source from which the control gets its value. This can be one of the following:
Setting Description
Database Column The control value will come from a column within a database table.
(default)
Datasource This setting is available if the Source Type of a form is Stored Procedure. The
Parameter control value is retrieved from the Data Source of a form. The supported
parameters have either the InputOutput or Output return type.
Code Expression The control value will be derived from an expression specific to the particular
programming language being used. This could be a function that returns a
value, a pre-existing variable or any other valid language construct that will
evaluate to a definite value.
Special Value This option is available only for controls located inside the Calendar or Report
components.
• For Report the Special Value is available only for the Label control,
please see Control Source Type property (Report).
• For Calendar the Special Value is available for the simple controls
(Label, Link, ImageLink, Image). The value of the Control Source property
should be one of the following: NextProcessingDate,
CurrentProcessingDate, PrevProcessingDate.
The value differs depending on the location in the Calendar blocks.
For example, if a control is located inside the main block of the Year
Calendar, then NextProcessingDate will be equal to January 1 of the next
year, CurrentProcessingDate will be equal to January 1 of the displayed
year and PrevProcessingDate will be equal to January 1 of the previous
year.
If a control is located inside the Month calendar then NextProcessingDate
will be equal to the 1 day of the next to the displayed month, etc.
If a control is located inside the Day block in any calendar then

119
 NextProcessingDate will be equal to the next date of the current month ,
CurrentProcessingDate will be equal to current date of the month, etc.
This type is applicable to the controls used to display Date (if the Data Type
property is equal to Date).

See Also
• Control Source property,
• Control Source property (Report),
• Control Source Type property (Report),
• Data Source property,
• Data Type property

Control Source Property (Report)

Specify the source of data for the control, such as the name of a database column.
Applies to
Label (Report)
Description
This property depends on the value specified in the Source Type property. If the Source Type is a
Database Column, use this property to specify the database table column that will be used to
furnish the control value. Respectively, if the Source Type is a Code Expression, enter the exact
code expression to be used to furnish the control value.
Control Source Type Description
Database Column The control value will come from a column within a database table.
Code Expression The control value will be derived from an expression specific to the
particular programming language being used. This could be a function
that returns a value, a pre-existing variable or any other valid language
construct that will evaluate to a definite value.
Examples:
• 1 assigns the value "1" to the control.
• now() assigns the current date and time to the control value.
Special Value The control value should be one of the following: CurrentPage,
TotalPages, RowNumber, CurrentDate, CurrentTime, CurrentDateTime
See Also
• Control Source Type property
• Using Special Values example

Convert URL To Property

Specify whether the URL should be converted to an absolute URL or a secure (https://) URL.
Applies to
Button, Editable Grid, Image Link, Link, Record
Description
The following are the possible value:

120
Setting Description
None The URL is not converted.
(default)
Absolute The URL is converted into the absolute URL based on 'Server URL' set in the Project
Settings.
SSL The URL is converted into the SSL based on 'Server URL' set in the Project Settings.
Example
For example, the page has a name name = 'my_page.asp', and 'Server URL' is set as
'www.domain.com/my_project/'.

Setting Result after conversion

None <a href='my_page.asp'>

Absolute <a href='http://www.domain.com/my_project/my_page.asp'>

SSL <a href='https://www.domain.com/my_project/my_page.asp'>

Control Property
Specify the name of a control to be used for return of the selected date.
Applies to
Date Picker
Description
Specify the name of a control, usually the Text Box in which the selected date of the Date picker is
returned. The date for this control will be returned in the format set in the Format property. If the
Format property is not defined then the date is returned in the format set in the Default Date
Format property for the project.
Important: The Text Box used as a control should be obligatory placed inside the Record or
Editable Grid, in which the Date Picker is located.
See Also
Format property, Default Date Format property

Control Properties
This section examines the properties for the various controls found under the Control tab of the
Toolbox. Many of the Controls share similar properties and the tale below presents all the
possible properties in alphabetic order. The third column indicates the controls that possess the
property.

Property Description Applicable

Controls
Bound Each option in a ListBox or RadioButton control is represented by ListBox,
Column a pair of values whereby one value is displayed to the user and RadioButton
another is submitted. Bound Column refers to the data source for
the values that are submitted.
Caption The name used to refer to the control in an error message. TextBox,
TextArea,
ListBox,

121
 RadioButton,
Hidden
Checked The value submitted by a Checkbox Control when it is checked. Checkbox
Value
Column For a Sorter control, this specifies the Grid column that the sorter Sorter
applies.
Connection The database connection from where information will be retrieved. ListBox,
RadioButton
Control Specify the source of data for the control e.g. the name of a TextBox,
Source database column TextArea,
ListBox,
Checkbox,
RadioButton,
Label,
Image,
Hidden,
Link,
ImageLink
Convert URL Specify whether the URL should be converted to an absolute URL Button,
To or a secure (https://) URL. ImageLink,
Link
Data Type The type of data that will be contained in the control: TextBox,
• Text TextArea,
Checkbox,
• Integer
RadioButton,
• Float ListBox,
• Date Label,
• Boolean Hidden,
Link,
• Memo ImageLink
DBFormat Specify the format in which you want the control value to be TextBox,
entered into the database e.g. the user may enter a date value in TextArea,
one format but you want it to be entered into the database in a Label,
different format. Hidden
Default [Yes/No] If you select ‘Yes' the button will be the default button on Button
Button the form so that clicking on the Enter key will be equivalent to
clicking on the button.
Default Specify a default value to be used for the control if no value is TextBox,
[Value] otherwise specified. TextArea,
Checkbox,
RadioButton,
ListBox,
Label,
Image,
Hidden,
Link,
ImageLink
Enable [Yes/No] Specify whether validation should be enabled when the Button

122
Validation button is clicked.
Error Control Specify the name of a control that will be used to display any error TextBox,
messages pertaining to the TextArea,
Checkbox,
RadioButton,
ListBox,
Hidden
Format Depending on the Data Type property, select the format of the TextBox,
data to be contained in the control. TextArea,
Label,
Hidden,
Link,
ImageLink
Href Source The page path, database column or other expression containing ImageLink
the URL of the hyperlink.
Href Type The type of source where the URL value will come from. ImageLink,
Link
Content [Text/HTML] If 'Text' is selected, All HTML tags are converted into Checkbox List,
the corresponding escape (ESC) sequences. For example, ">" is Label,
converted into "&gt;". Link,
If 'HTML' is selected, the control value will not be converted to text Radio Button
before being displayed. As such, if the value is HTML markup, it
will be appear as regular HTML markup on the page.
Input Select a regular expression to be used to check the validity of the TextBox,
Verification data entered in the control. Hidden
List Data Specify the actual source of data for the list of values depending ListBox,
Source on the List Source Type. RadioButton
List Source Specify the type of source of data for the list of values to be shown ListBox,
Type in the control e.g. the name of a database column. RadioButton
Name The name of the control. ALL
Operation The type of operation performed when the button is clicked [Insert, Button
Update, Delete, Cancel or Search]
Page Links Specify the number of page links to be shown on the Navigator. Navigator
The default is 10.
Preserve Specify whether GET or Post parameters should be preserved. ImageLink,
Parameters Link
Remove Specify a semicolon-separated list of parameters that should be ImageLink,
Parameters removed from the hyperlink. Link
Required [Yes/No] Select ‘Yes' if a value must be entered for the control in TextBox,
order for the form to be submitted successfully. TextArea,
RadioButton,
ListBox
Return Page Specify the page where the user should be directed after the Button
button operation has been performed.

123
Source Type The type of data source that will provide data for the control: TextBox,
• Database Column TextArea,
ListBox,
• Code Expression
Checkbox,
RadioButton,
Label,
Image,
Hidden,
Link,
ImageLink
Href Source This opens the Href Source window where you can specify the Link
page to be linked to as well as any parameters that should be
transmitted via the URL.
Text Column Each option in a ListBox or RadioButton control is represented by Listbox,
a pair of values whereby one value is displayed to the user and RadioButton
another is submitted. Text Column refers to the data source for the
values that are displayed.
Type Select the type of page links to be shown in the Navigator control. Navigator
Unchecked The value submitted by a Checkbox Control when it is unchecked. Checkbox
Value
Unique [Yes/No] Select ‘Yes' if you want a check to be made to ensure TextBox,
that any value entered in the control does not already exist in the TextArea,
database. RadioButton,
ListBox,
Hidden
Validation Specify an expression that will be used to check the validity of the TextBox,
Rule data entered in the control. TextArea,
Checkbox,
RadioButton,
ListBox,
Hidden
Validation Specify the text that will be displayed if the data entered in the TextBox,
Text control does not meet the validation rule. TextArea,
Checkbox,
RadioButton,
ListBox,
Hidden

Create IIS Application Property

Specify whether CCS will automatically create IIS Application during publishing.
Applies to
.NET Projects
Description
Specify whether CCS will automatically create IIS Application during publishing.

Custom Delete Property

Specify the table, procedure or SQL to be used to delete data.

124
Applies to
Record, Editable Grid
Description
Clicking on this property opens the Custom Delete window where you can specify the table, enter
the procedure with required parameters or SQL statement based on the Custom Delete Type
property used to perform the Delete operation.
See Also
Custom Delete Type property

Custom Delete Type Property

Select the type of method to be used to perform the delete operation.
Applies to
Record, Editable Grid
Description
If you wish to override the default delete mechanism, you can specify the type of method to be
used to perform the delete operation.
The list of available types:
• Table
• Procedure
• SQL
Important: If you set any value in this property you should specify the Custom Delete property,
otherwise the Delete operation will not be performed.
See Also
Custom Delete property

Custom Insert Property

Configure the process of inserting data.
Applies to
Record, Editable Grid
Description
This property opens a dialog where you can specify the table, procedure or SQL statement to be
used for inserting data submitted via the form. This method can be used when the standard insert
functionality based on the form's data source is insufficient. For example you may not want to
insert all fields, or replace field values submitted by the form.
The main part of the Custom Insert dialog is the Parameters section where you configure
parameters that construct the SQL query statement, or variables used in custom SQL statement,
or Stored Procedure parameters. To open the parameter configuration dialog click the plus button
([+]) or double click an existing parameter.
Parameter configuration for Table based custom insert:
When using Table type custom insert the following parameter dialog will appear:

125
The following table parameter configuration values are available:
Field
Name Provide the name of the data field you want to insert a value into.
Type Select the type of the data field.
Format Specify data field's format.
Parameter
Name Designate a parameter whose value will be assigned to the data field.
Type Select parameter type.
Format Specify parameter format.
Parameter is considered empty when parameter source collection does
If parameter not contain corresponding item. This may happen, for example, when
is empty the parameter is not submitted by the form or if the code expression it
is based on returns a null value.
Do not If parameter value is empty the corresponding field won't be inserted
insert (won't be included into the SQL INSERT statement).
field
Use If parameter value is empty the specified value will be used.
value

Parameter configuration for SQL based custom insert:

When configuring custom insert property you may specify your own SQL INSERT statement to be
executed after the form is submitted. The SQL statement can include variables in curly braces,
such as {variable_name}, which will be replaced at run-time by the corresponding parameter that
you must configure with the same name as each variable used in the SQL statement. For
example if an SQL statement is INSERT INTO departments(department_name)
VALUES('{name}') , then the corresponding name parameter must be created and configured.
To open the parameter configuration dialog click the plus button ([+]) or double click an existing
parameter.
The following SQL parameter configuration values are available:

126
Field
Name Provide the name of the data field you want to insert a value into.
Type Select the type of the data field.
Format Specify data field format.
Parameter
Name Designate a parameter whose value will be assigned to the data field.
Type Select parameter type.
Format Specify parameter format.
Default Value The default value to be used if parameter value is empty.

Parameter configuration for Stored Procedure based custom insert:

Parameter configuration options are similar to the above SQL parameters except for additional
properties, such as Data Size, Direction, Scale and Precision. Those additional options
corresponds to the stored procedure parameters within your database.

See Also
Custom Insert Type property

Custom Insert Type Property

Select the type of method to be used to perform the insert operation.
Applies to
Record, Editable Grid
Description
If you wish to override the default insert mechanism, you can specify the type of method to be
used to perform the Insert operation.
The list of available types:
• Table
• Procedure
• SQL
Important: If you set any value for this property you should also set the Custom Insert property,
otherwise the Insert operation will not be performed.
See Also
Custom Insert property

Custom Update Property

Configure the process of updating data.
Applies to
Record, Editable Grid
Description
This property opens a dialog where you can specify the table, procedure or SQL statement to be
used for updating data submitted via the form. This method can be used when the standard update

127
functionality based on the form's data source is insufficient. For example you may not want to
update all fields, or replace field values submitted by the form.
The main section of the Custom Update dialog contains parameters that construct the SQL query
statement, variables used in custom SQL statement, or Stored Procedure parameters. To open the
parameter configuration dialog click the plus button ([+]) or double click an existing parameter.

The following table parameter configuration values are available:

Field
Name The name of the data field to be updated.
Type The type of the data field.
Format The format of the data field.
Parameter
Name Designate a parameter whose value will be assigned to the data field.
Type Select parameter type.
Format Specify parameter format.
Parameter is considered empty when parameter source collection does
If parameter not contain corresponding item. This may happen, for example, when
is empty the parameter is not submitted by the form or if the code expression it
is based on returns a null value.
Do not If parameter value is empty the corresponding field won't be included
update into the SQL UPDATE statement.
field
Use value If parameter value is empty the specified value will be used during
update.

Parameter configuration for SQL based custom update:

When configuring custom update property you may specify your own SQL UPDATE statement to
be executed after the form is submitted. The SQL statement can include variables in curly braces,
such as {variable_name}, which will be replaced at run-time by the corresponding parameter that
you must configure with the same name as each variable used in the SQL statement. For
example if an SQL statement is UPDATE employees SET emp_name='{name}' , then the

128
corresponding name parameter must be created and configured.
To open the parameter configuration dialog click the plus button ([+]) or double click an existing
parameter.
The following SQL update parameter configuration values are available:
Field
Name The name of the data field to be updated.
Type The type of the data field.
Format The format of the data field.
Parameter
Name Designate a parameter whose value will be assigned to the data field.
Type Select parameter type.
Format Specify parameter format.
Parameter is considered empty when parameter source collection does
If parameter not contain corresponding item. This may happen, for example, when
is empty the parameter is not submitted by the form or if the code expression it
is based on returns a null value.
Do not If parameter value is empty the corresponding field won't be included
update into the SQL UPDATE statement.
field
Use value If parameter value is empty the specified value will be used during
update.

Parameter configuration for Stored Procedure based custom update:

Parameter configuration options are similar to the above SQL parameters except for additional
properties, such as Data Size, Direction, Scale and Precision. Those additional options
corresponds to the stored procedure parameters within your database.
See Also
Custom Update Type property

Custom Update Type Property

Select the type of method to be used to perform the update operation.
Applies to
Record, Editable Grid
Description
If you wish to override the default update mechanism, you can specify the type of method to be
used to perform the Update operation for this property.
The list of available types:
• Table
• Procedure
• SQL
Important: If you set any value for this property the Custom Update property should be also set,
otherwise the Update operation will not be performed.

129
See Also
Custom Update property

D-I
Data Source Property
Specify the actual source of data for the list of values depending on the Source Type.
Applies to
Checkbox List, Directory, Editable Grid, Grid, List Box, Record, Report, Path, Radio Button
Description
This property depends on the selection made in the Source Type property. If you selected a
Table/View, use this property to specify the table or view from where the List Box values will be
retrieved. If you selected a Procedure, specify the procedure to be used and likewise if you
selected SQL, enter the SQL statement. Lastly, if you selected ListOfValues, enter the semicolon
delimited list of pairs.
See Also
Data Source Type property, Text Column property, Bound Column property

Data Source Type

Specify the type of source of data for the list of values to be shown in the control.
Applies to
Checkbox List, Directory, Editable Grid, Grid, List Box, Record, Radio Button, Path
Description
The type of data source from which the control gets its value. This can be one of the following:
Setting Description
Table/View This is the most common method whereby the values come from a database
(default) table.
Procedure This option allows you to specify a procedure to be used to provide the values.
Bear in mind that List Box values come in pairs.The first value is the value
submitted by the control and the second is the value displayed to the user.
SQL With this option you can specify an SQL query to be used to provide the value.
Again, bear in mind that List Box values come in pairs.
ListOfValues This option allows you to specify a static set of values for the List Box. The
(for the List Box values should be in a semicolon delimited list of the form. The first value is the
and Radio Button value that would be submitted by the control while the second would be
only) displayed e.g. 1;Yes;2;No;3;Neutral.
See Also
Data Type property, Data Source property, Text Column property, Bound Column property

Data Type Property

The type of data that will be contained in the control.
Applies to
Checkbox, Checkbox List, Hidden, Image, Image Link, Label, Label(Report), Link, List Box, Radio
Button, Text Area, Text Box
130
Description
Specify the type of data that will be contained in the control:
• Text
• Integer
• Float
• Date
• Boolean
• Memo
Since Text Area fields are often used in conjunction with database fields that contain large
amounts of data such as MS Access Memo fields, the Data Type property is usually set to 'Memo'
instead of 'Text' to accommodate the special requirements of dealing with large amounts of data.
See Also
Format property, DBFormat property

Database URL Property

Specify the pointing URL to the database.
Applies to
Connection
Description
You can use this property to specify the pointing URL to the database to which the connection is
established (e.g., jdbc.odbc:intranet).
See Also
Connection Reference, Connecting to Databases

Date DB Format Property

Specifies the database format of the field containing event date.
Applies to
Calendar
Description
You can use this property to specify the database format of the field containing event date.
See also
• Date Field property
• Time DB Format property

Date Field Property

Specifies the field containing event date.
Applies to
Calendar
Description
You can use this property to specify the field containing event date. This field must contain valid
date value and it cannot be NULL. Date can be full date (date and time) or only date. In the latter
case you also need to specify the Time Field property).
See also

131
• Date DB Format property
• Time Field property

Date Format Property

Specify the format in which date values should be entered into the database.
Applies to
Connection
Description
You can use this property to specify the format of the data as it appears in the database for the
whole project. Some databases such as MySQL and PostgreSQL are particular about the format
used, so this property should be set to correspond to the format of the value as contained within
the database.
Note:
You can redefine the date format for controls using the DBFormat property.
See Also
Connection Reference, Connecting to Databases, Date/Time Format property, DBFormat property

DBFormat Property
Specify the format in which you want the control value to be entered into the database.
Applies to
Hidden, Image, Image Link, Label, Label (Report), Link, Text Area, Text Box
Description
This property specifies the format of the data as it appears in the database. The DBFormat
property determines the format that will be used to extract as well as place the control value into
the database. Some databases such as MySQL and PostgreSQL are particular about the format
used so this property should be set to correspond to the format of the value as contained within the
database.
Note: The Format property can be used to display the control value in a format different from the
database format.
See also:
Data Type property, Format property

Default Boolean Format Property

Specify the format in which you want boolean values to be displayed in the project.
Applies to
Project
Description
You can use this property to select the format in which you want boolean values to be displayed in
the project.

Default Button Property

If this property is set to 'Yes' then hitting the Enter key while on the page will be equivalent to
clicking on this button.
Applies to
Button

132
Description
If you select 'Yes' the button will be the default button on the form so that clicking on the Enter key
will be equivalent to clicking on the button. This property is applicable if you use the Microsoft
Internet Explorer and if there is only one field on the form that could be associated with the Enter
key hit. This property can be also used if the form is submitted by the DHTML method
form.submit().

Default Date Format Property

Specify the format in which you want date values to be displayed in the project.
Applies to
Project
Description
You can use this property to select the format in which you want date values to be displayed in the
project. If the Default Date Format is not specified, the standard mechanism of the programming
language is applied to convert the date to string. The results can differ depending on the used
language pattern and local settings.

Default Value Property

Specify a default value to be used for the control if no value is otherwise specified.
Applies to
Checkbox Checkbox List, Hidden, Image, Label, Link, Image Link, List Box, Radio Button, Text
Area, Text Box
Description
If specified, the default value will be assigned to the control in case the Control Source property
does not yield any value. The default property can be a literal such as a string e.g. "Default Value"
or it could be a numeral as an integer or it could be a language function e.g. functionName(). The
Default Value is a Code Expression returning a value of the corresponding type (Text -> String,
Integer -> Int, Long, etc.) or being brought to a certain type.
Important: If the value of the Data Type property is set to "Text" or "Memo" the value of Default
Value property should be entered in double quotes, besides the cases of using the language
function.
The following are the possible values:
Data Type property Default Value
Text "Bob",
GetString()
integer 5,
GetInteger(Param)
Date "10/01/2002",
Now()
Boolean True
See Also
Control Source property, Data Type property

Default View Mode Property

133
Specify the default view mode, which will be used for report
Applies to
Report
Description
The Report component supports two display modes: Print and Web. In Web mode the report
contains navigation links or buttons that users can click to navigate through multiple report pages.
In Print mode all report pages are shown at once in the Web browser, however, report pages are
separated by invisible page break tags that result in page breaks between printed pages when a
user prints the report.

Delete Control Property

Specifies the control value used as a deletion indicator for the rows of the Editable Grid.
Applies to
Editable Grid
Description
You can use this property to specify the control value used as a deletion indicator for the rows of
the Editable Grid. When the Editable Grid is submitted all rows for which the control value is not
empty will be deleted. Checkbox or hidden can be used as the Delete control. This property is not
required. If the value of this property is not set, the DELETE operation is not performed. The
Delete Control is shown only if rows with records exist.

"Deploy webapp as" Property

Specify how the application will bublished to the folder.
Applies to
Java Projects
Description
You can use this property to specify how the application will published to the folder. It has the
following two options:
• "as war file" - the standard WAR will be generated. This options works almost with all
modern application servers and handy with auto-deployment feature of several servers (see
deployment scenarios below).
• "unpacked" - the application will be published to folder unpacked. This option is helpful for
changes in one JSP page and its quick publish (when only one page is published). Some older
servers (that do not support WAR archive files) may need this options too.

Design Database Type Property

Specify the type of a database which is being accessed during the design time.
Applies to
Connection
Description
You can use this property to specify the type of a database which is being accessed during design
time. If your database type is not listed, you may select the 'ANSI SQL-92' option.
See Also
Connection Reference, Connecting to Databases

134
Disallowed File Masks Property
Specifies the list of file masks denied from uploading.
Applies to
File Upload
Description
The property contains the semicolon-separated list of file masks for files that the user is not
allowed to upload e.g. *.exe; *.dll; *.bat. The validation of the disallowed file masks is applied if the
file contains any of the allowed file masks.
See also
Allowed File Masks property

Email Component Property

Specifies the Email Component.
Applies to
ASP Projects
Description
You can use this property to specify the COM based components used by the Send Email action.
The CDONTS.NewMail supports only local SMTP servers. It is also no longer shipped with
Windows XP or Windows Server 2003. For Windows 2000 or above you can use CDO.Message.
Unlike CDONTS.NewMail it can be configured for a remote SMTP server.
See Also
Send Email action

EmptyRows Property
Specify the number of rows to be added on the Editable Grid.
Applies to
Editable Grid
Description
You can use this property to specify the number of rows to be added to the bottom of the Editable
Grid table. This value is set to 3 by default.
If the Allow Insert property is "No", the rows for the new records are not displayed.
See Also
Allow Insert property

Empty Weeks Property

Specifies if an empty 6th week row should be added to monthly snapshots for months that span
only 5 weeks.
Applies to
Calendar
Description
Enabling this feature provides more consistent layout for the multi-month calendar views since all
months will be shown with 6 weekly rows.

135
Enable Print Mode Property
Specify whether print mode should be enabled at runtime.
Applies to
Report

Enable Validation Property

Specify whether validation should be enabled when the button is clicked.
Applies to
Button
Description
You can set this property to 'Yes' so that submitted values are check for validity, otherwise the
form will not check to ensure that the submitted values conform to the validation rules assigned to
them. By default this property is set to 'Yes' for the 'Insert' and 'Update' buttons and 'No' for the
'Cancel' and 'Delete' buttons.
Important: If buttons are added by clicking on the button in the Forms tab of the Toolbox, the
value of this property is set to 'Yes'.

Encoding Extension Property

Specify the PHP extension module to be used for encoding conversion.
Applies to
PHP Projects
Description
You can use this property to specify which of the PHP extension modules is to be used for
encoding conversion. This property can take the following values:
Value Description
iconv Specify if the iconv function of the iconv Extension should be used
mb Specify if the mb_convert_encoding function of the Multibyte string module should be used

Error Control Property

Specify the name of a control that will be used to display any error messages pertaining to this
control.
Applies to
Checkbox, Checkbox List, Hidden, List Box, Radio Button, Text Area, Text Box
Description
Usually, error messages corresponding to a control are displayed at the top of the form as plain
text. However, you might want this error text to be displayed within another existing control, for
instance, in a Label field placed adjacent to the control. Use this property to specify the name of a
control where you want the error message for the current control to be displayed.
Important: The Label used as an Error control should be obligatory placed inside the Record or
Editable Grid form. This Property is applied only if the control is located inside the Record or
Editable Grid form.

File Folder Property

136
Specifies the target path used for storing uploaded file after processing.
Applies to
File Upload
Description
The property specifies the full path or the relative path to the target folder beginning from the
current page folder.
If the property value starts with "%", the environment variable specifies the path to the temporary
folder. If the language doesn't have functions for loading the environment variable content, the
following error message is shown: Invalid value of the File Folder property.

File Size Limit Property

Specifies the maximum allowed file size to upload.
Applies to
File Upload
Description
The property contains the numeric value of the maximum allowed file size in bytes for uploading.

File Upload Component Property

Specify the File Upload Component.
Applies to
ASP Projects
Description
You can use this property to specify the COM based components used by the File Upload control.
See Also
File Upload control

Format Property
Number Format
Sign Description Example Number Result
0 Digit placeholder with fixed (000) 000-00-00 121231212 (012) 123-12-12
length
# Digit placeholder. Insignificant #.00 123.1 123.10
zeros are not displayed.
. Decimal separator. #.00 123.1 123.10
, Group separator. #,###.00 1234.1 1,234.10
% Percent notation #.#% 0.123 12.3%
\c literal character "c" \#0 10.1 #10
; Section separator.
[Color] Specifies the color that will be #.#;[Red]#.# -1.45 <font color="Red">-
used for output. 1.45</font>
{} Condition formatting. {$ > 100.01 <font
10}[Red]#.#;#.# color="Red">100.01</font>

137
$ Represent the name of the
variable that will be used in
the code.
E.g. the condition {$ > 10}
specifies that the current
mask
will be applied only when the
amount is greater than 10.
Sections
The number formatting mask consists of four predefined sections.
positive number format;negative number format;zero number format;Null number
format;decimal separator;group separator

The default values for decimal separator and for the group separator will be taken from the
regional settigns in case the programming language supports the localized output of numbers. If
the group separator was not presented in the mask then the number would not be devided at the
groups. If the decimal separator not presented then will be displayed only the integer part of
number.
Condition formatting
You may use the condition formatting if want to specify the exact format for the range. Use the {} in
order to specify the condition that will be used for this mask. Note that in the condition you may
use the language specific operators and functions and the condition is not language independed. If
you have the masks with condition and without them then the first mask without condition is used
for default formatting for positive numbers, second mask without condition is used for for default
formatting of the negative numbers. If more than one mask can be applied then the leftmost mask
with condition will be applied.
Examples
Mask Numbers Results
{$ > 10}[Red]#.#;{0 =< $ < 10}#.#;{$ < 0}(#.#) 10.01 <font color="Red">10.01</font>
5 5
-20 (20)

Using Date Format concept

You can use different languages, databases and platforms that return and require different date
formats. Some of languages do not the have predefined functions that allow work with Date (e.g.
PHP or Perl). For such languages CodeCharge supports the custom functions based on the
language functionality (e.g. Java or C#). You can use the Date Format Compare table to see how
CC converts formats. For example, Java does not support the short month name and uses the full
name of the month. Date Format table shows CodeCharge formats.
You do not need to support the Date functionality in your code, you should set the properties:
Property Description
DBDateFormat Specify the format in which the control value will be entered into the database.
DefaultDateFormat The default date format for all fields
Field Format Set this property if you want to change default Date format
Later you can change the language, database or platform modifying the following parameters. You
do not need to change the code.
138
See Also
Date Format, Date Format Compare
Date/Time Format
You can set the Format property using the predefined date and time formats or use the custom
formats for the Date/Time data type setting.
Setting
Predefined Formats
The following table shows the predefined Format property settings for the Date/Time data type.
Setting Description
GeneralDate This format depends from regional settings.
If the value is a date only, no time is displayed; if the value is a time only, no date is
displayed. This setting is a combination of the Short Date and Long Time settings.
Examples: 4/3/93, 05:34:00 PM, and 4/3/93 05:34:00 PM.
LongDate This format depends from regional settings.
Example: Saturday, April 3, 1993.
ShortDate This format depends from regional settings.
Example: 4/3/93.
Warning: The Short Date setting assumes that dates between 1/1/00 and 12/31/29
are twenty-first century dates (that is, the years are assumed to be 2000 to 2029).
Dates between 1/1/30 and 12/31/99 are assumed to be twentieth century dates
(that is, the years are assumed to be 1930 to 1999).
LongTime This format depends from regional settings.
Example: 5:34:23 PM.
ShortTime This format depends from regional settings.
Example: 17:34.

Warning: Predefined Formats are valid only for languages which have the ability to formatting the
date in corresponding of the current LCID (ASP, Java). In the other languages this formats will be
equal to the standard US Date/Time formats.
Custom Formats
You can create custom date and time formats by using the following symbols.
Symbol Description
d Day of the month in one or two numeric digits, as needed (1 to 31).
dd Day of the month in two numeric digits (01 to 31).
ddd First three letters of the weekday (Sun to Sat).
dddd Full name of the weekday (Sunday to Saturday).
w Day of the week (1 to 7).
m Month of the year in one or two numeric digits, as needed (1 to 12).
mm Month of the year in two numeric digits (01 to 12).
mmm First three letters of the month (Jan to Dec).

139
mmmm Full name of the month (January to December).
q Date displayed as the quarter of the year (1 to 4). This format is supported only in
ASP, PHP and Perl.
yy Last two digits of the year (01 to 99).
yyyy Full year (0100 to 9999).
h 12-hour format without leading zeros (1 to 12).
hh 12-hour format with leading zeros (01 to 12).
H Hour in one or two digits, as needed (0 to 23).
HH Hour in two digits (0 to 23).
n Minute in one or two digits, as needed (0 to 59).
nn Minute in two digits (00 to 59).
s Second in one or two digits, as needed (0 to 59).
ss Second in two digits (00 to 59).
AM/PM Twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate.
am/pm Twelve-hour clock with the lowercase letters "am" or "pm", as appropriate.
A/P Twelve-hour clock with the uppercase letter "A" or "P", as appropriate.
a/p Twelve-hour clock with the lowercase letter "a" or "p", as appropriate.
ww Week of the year (1 to 53). The first week considered the week which has January
1.
Note: This parameter is not supported in .NET.

Example
The following are examples of custom date/time formats.
Setting Display
ddd, mmm d, yyyy Mon, Jun 2, 1997
mmmm dd, yyyy June 02, 1997
dddd Tuesday
See Also
Date Format Compare, Date format using concept
Date Formats Comparison
Access
CCS Java ColdFusion .NET PHP Description
(VBA)
GeneralDate c G General date predefined format
ShortDate ddddd d Short Date predefined format.
LongDate dddddd D Long Date predefined format.
ShortTime t Short Time predefined format.
LongTime ttttt T Long Time predefined format.

140
 f Full date and time predefined format
(long date and short time)
F Full date and time predefined format
(long date and long time)
g General date predefined format
(short date and short time)
B Swatch Internet time
r, R r RFC 1123(822) formatted date; i.e.
"Thu, 21 Dec 2000 16:01:07 +0200"
m, M Month and Day predefined format
s Sortable Date and Time predefined
format (ISO 8601) using local time
u Universal Sortable Date and Time
predefined format (ISO 8601) using
universal time
U Sortable date and time (long date
and long time) using universal time
y, Y Year and month predefined format
(yyyy MMMM)
Days
d d d d d j Day of the month in one or two
numeric digits, as needed (1 to 31).
dd dd dd dd dd d Day of the month in two numeric
digits (01 to 31).
ddd ddd EE ddd ddd D First three letters of the weekday
(Sun to Sat).
dddd dddd EEEE dddd dddd Full name of the weekday (Sunday to
Saturday).
w w w Day of the week.
l (lowercase "L") Full name of the
weekday (Sunday to Saturday).
y D z Day of the year (0 to 365)
Months
m m M m M n Month of the year in one or two
numeric digits, as needed (1 to 12).
mm mm MM mm MM m Two numeric digits (01 to 12) of
Month of the Year.
mmm mmm mmm MMM M First three letters of the month (Jan
to Dec).
mmmm mmmm MMM mmmm MMMM F Full name of the month (January to
December).
Years
141
yy yy yy yy yy y Last two digits of the year (01 to 99).
yyyy yyyy yyyy yyyy yyyy Y Full year (0100 to 9999).
y The two last digits of the year without
the leading zero (1 to 99).
Hours
H h H H H G Hour in one or two digits, as needed
(0 to 23).
HH hh HH HH HH H Hour in two digits (00 to 23).
h K h h g Hour in one or two digits, as needed
(0 to 11).
hh KK hh hh h Hour in two digits (00 to 11).
Minutes
n n m m m Minute in one or two digits, as
needed (0 to 59).
nn nn mm mm mm i Minute in two digits (00 to 59).
Seconds
s s s s s Second in one or two digits, as
needed (0 to 59).
ss ss ss ss ss s Second in two digits (00 to 59).
Milliseconds
S Milisecond in one or two digits, as
needed (0 to 99).
SS Milisecond in two digits (00 to 99).
Other
AM/PM AM/PM h/k + tt tt A Twelve-hour clock with the
a uppercase letters "AM" or "PM", as
appropriate.
am/pm am/pm a Twelve-hour clock with the
lowercase letters "am" or "pm", as
appropriate.
A/P A/P t t Twelve-hour clock with the
uppercase letter "A" or "P", as
appropriate.
a/p a/p Twelve-hour clock with the
lowercase letter "a" or "p", as
appropriate.
AMPM Twelve-hour clock with the
appropriate morning/afternoon
designator based on current regional
settings.
z The time zone offset (hour only).

142
 Single-digit hours will not have a
leading zero.
zz The time zone offset (hour only).
Single-digit hours will have a leading
zero.
zzz The full time zone offset (hour and
minutes). Single-digit hours and
minutes will have leading zeros.
L boolean for whether it is a leap year;
i.e. "0" or "1"
t number of days in the given month;
i.e. "28" to "31"
z T Timezone setting of this machine; i.e.
"MDT"
U seconds since the epoch
Z timezone offset in seconds (i.e. "-
43200" to "43200"). The offset for
timezones west of UTC is always
negative, and for those east of UTC
is always positive.
I (capital i) 1 if Daylight Savings Time,
"0" otherwise.
S English ordinal suffix, textual, 2
characters; i.e. "th", "nd"
" ' Escape for text (Delimiter), e.g. 'on'
MMM dd means "on July 25"
zzzz Time zone, full form e.g. "Pacific
Standard Time"
W Week in month (1-4)
F Day of week in month e.g. 2 (2nd
Wed in July)
G gg gg Era designator e.g. AD
: : : Time separator (taken from the
Regional settings)
/ / / Date separator (taken from the
Regional settings)
ww ww w Week of the year (1 to 53). The first
week considered the week which has
January 1.
Note: This parameter is not
supported in .NET.
q q Date displayed as the quarter of the
year (1 to 4). This format is
supported only in ASP, PHP and

143
 Perl.
\c \c Where c is any character. Displays
the character literally.
Access
CCS Java ColdFusion .NET PHP Description
(VBA)
See Also
Date Format, Date format using concept

Function Property
Specify the function for auto-calculated labels.
Applies to
ReportLabel
Description
This property is used to specify function for auto-calculated labels. This can be one of the
following:
Setting Description
(none) No function will be used.
Sum The report label value will be calculated as the sum of previous row values.
Count If the Control Source is empty the value will be calculated as the count of previous data
rows. Otherwise the value will be calculated as the count of previous data rows with non-
empty values.
Min The value will be calculated as the minimum of previous row values.
Max The value will be calculated as the maximum of previous row values.
Average The value will be calculated as the average of non-empty values from previous rows.
See Also
Reset At property
Percent Of property

Groups Property
Report groups that is used to manage repeating values and totals
Applies to
Report
Description
The list of report groupings and sections. Click the [...] button to maintain the report groups or view
its sections. When report groups are used, the data rows will be grouped into collections with the
same value of the grouped field in each collection. Each group also has a unique name,
associated group field, and the data sort order.

Height Property
The height of the section in abstract "line" units.
Applies to
Section

144
Description
The height can be equivalent to pixels or other units, as long as consistent units are used
throughout the report. You can imagine that a line is 1 pixel high and specify the true pixel height, if
known. In other cases you may decide to use data rows as a "line" and specify "1" as the section
height. Refer to report properties for more information.

Hide Duplicates Property

Specify if duplicated values will be shown.
Applies to
ReportLabel
Description
This property can be used to hide report labels when their value is the same as in the preceding
record.

Home Page Property

Specify the starting page for your project.
Applies to
Project
Description
You can use this property to set starting page for your project.

Href Source Property

The page path, database column or other expression containing the URL of the hyperlink.
Applies to
Link, Image Link
Description
The selection made in this property depends on the value of the Href Type property. If the Href
Type is a page, use this property to select the page to be linked to. Alternatively, if the Href Type is
a database column, use this property to select the database column that holds the URL of the
page to be linked to.
Clicking on this property opens the Href Source window where you can also specify Link
Parameters that will be transmitted to the linked page. This is often used when linking a grid form
to a record form and a parameter needs to be transferred to the record form to indicate the record
that will be retrieved.
See Also
Href Type property,
how to Create Mailto Hyperlink,
how to Configure Hyperlink

Href Type Property

The type of source where the URL value will come from.
Applies to
Image Link, Link
Description
Indicate whether the value of the page to be linked to will come from:

145
Setting Description
Page One of the existing project pages
(default)
Database The URL of the page to be linked to is contained within a database column
See Also
Href Source property

Includable Property
Specify if the page is included into other pages.
Applies to
Page
Description
You can set this property to 'Yes' to specify that the page is not used separately, it is used only an
includable to other pages. The following HTML tags are excluded from these pages:
<HTML><HEAD><BODY>. This page cannot be accessed regularly, it can be only included into
other pages.
For Header and Footer pages this property is always set to 'Yes'.
See Also
Page property

#include type Property

Specify the type of the path used to include the common files: the relative or absolute (starting
from the root) virtual path.
Applies to
ASP Projects
Description
You can use this property to specify the type of the path used to include the common files: relative
or absolute (starting from the root) virtual path.

ID Field Property
Specify the field containing the unique ID that identifies the categories.
Applies to
Path
Description
Specify the field containing the unique ID that identifies the categories. This field must contain a
unique value and the value cannot be NULL.
See also
Parent field property

Improved HTTP Caching Property

Specify if HTTP headers which disable browser caching will be removed.
Applies to
PHP Projects

146
Description
If this property is set to 'Yes' then all HTTP headers which disable browser caching will be
removed.

Input Validation Property

Select a regular expression to be used to check the validity of the data entered in the control.
Applies to
Hidden, Text Area, Text Box
Description
In this property, you can enter a Regular Expression that will be used to determine the validity of a
submitted value. A submitted value that fails to comply with the regular expression will cause an
error message to be displayed.
Within the property, there are two regular expressions; one for validating email addresses and
another for 5-digit zip codes. Besides these, you can type in your own regular expression.
Important: The regular expressions should be set taking into consideration the programming
language.

J-P
JDBC Driver Property
Specify the name of the driver to be used.
Applies to
Connection
Description
You can use this property to specify the name of the driver to be used, (e.g.,
sun.jdbc.odbc.JdbcOdbcDriver).
See Also
Connection Reference, Connecting to Databases

Level of Logging Property

Specify the level of logging.
Applies to
Java Projects
Description
You can use this property to specify the level of logging. The DEBUG will display all messages.

Library Prefix Property

Specify if mod_perl's prefix will be used.
Applies to
Perl Projects
Description
You can specify this property if you use mod_perl.

147
Setting this property will add the appropriate prefix to all classes/packages. For example, the
record form's clsUsers class on Page1 will have the following full name:
pagePrefix::Page1::clsUsers.

Server
Property Value
API
CGI Specify the unique prefix for the server. If the prefix is not used leave this property
blank.
mod_perl Specify the unique prefix for the server. If you leave this property blank the project's
name will be used as the prefix.

Lines Per Print Page Property

The size of page in the print view mode, measured in lines
Applies to
Report
Description
In Print mode the "Lines per Print page" value is used to determine where to end the page and
show the page footer and the page break tag.
See also
Lines Per Web Page property

Lines Per Web Page Property

The size of page in the Web view mode, measured in lines
Applies to
Report
Description
In Web mode the "Lines per Web page" value is used to determine where to end the page and
display the page footer and the navigator.
See also
Lines Per Print Page property

Locale Identifier Property

Specify the LCID variable that sets the session.
Applies to
ASP Projects
Description
You can use this property to specify the locale ID. It determines the formatting of certain
information, such as date and time values, currency, and so on. Each locale is identified by an
integer value and it’s defined in the operating system.
See Also
Code Page property

Login Property
Specify the Login used to establish a database connection.

148
Applies to
Connection
Description
You can use this property to specify Login used to establish a database connection during the
design time.
See Also
Connection Reference, Connecting to Databases

LongReadLen Property
Specify the DBI LongReadLen attribute.
Applies to
Connection
Description
You can use this property to control the maximum length of long fields ('blob', 'memo', etc.) which
the driver will read from the database automatically when it fetches each row of data. The
LongReadLen attribute only relates to fetching and reading long values; it is not involved in
inserting or updating them.
See Also
Connection Reference, Connecting to Databases, LongTruncOk property

LongTruncOk Property
Specify the DBI LongReadLen attribute.
Applies to
Connection
Description
You can use this property to control the effect of fetching a long field value which has been
truncated (typically because it's longer than the value of the LongReadLen attribute). For example,
if LongTruncOk is set to "Yes" the over-long value will be silently truncated to the length specified
by LongReadLen without an error.
See Also
Connection Reference,
Connecting to Databases,
LongReadLen property

Manager login Property

Specify the connection login for Tomcat application manager.
Applies to
Java Projects
Description
You can use this property to specify the connection login for the Tomcat application manager. It is
used only if the target server is Tomcat.
See Also
Target Server property

Manager password Property

149
Specify the connection password for Tomcat application manager.
Applies to
Java Projects
Description
You can use this property to specify the connection password for the Tomcat application manager.
It is used only if the target server is Tomcat.
See Also
Target Server property

Manager URL Property

Specify the Tomcat application manager URL.
Applies to
Java Projects
Description
You can use this property to specify the manager URL of the Tomcat application. It is used only if
the target server is Tomcat.
See Also
Target Server property.

Max number of connections to DB Property

Specify the maximum number of connections to the database.
Applies to
Connection
Description
You can use this property to specify the maximum number of connections to the database. (0 -
unlimited).
See Also
Connection Reference, Connecting to Databases

Name
The name of the control.
Applies to
Button, Checkbox, Checkbox List, Connection, Date Picker, Directory, Editable Grid, Grid, Hidden,
Image, Image Link, Include Page, Label, Label(Report), Link, List Box, Navigator, Panel, Radio
Button, Record, Report, Path, Sorter, Text Area, Text Box
Description
A unique name used to identify the instance of the control. It is used to specifically address the
control for getting and/or changing control properties.
Important: This is also the name used to reference the control within the programming code.

Name Property
The name of the control.
Applies to
Report Section

150
Description
A unique name used to identify the instance of the control. It is used to specifically address the
control for retrieving or specifying control properties. It is read-only.

No of Columns Property
Specifies the number of Calendar columns.
Applies to
Calendar
Description
You can use this property to specify the number of Calendar columns. One cell is allocated for
each month. The Annual Calendar can have from 1 to 12 columns, quarterly and 3-months
Calendars - from 1 to 3 columns.

No of Years Property
Specifies the range of years shown in the Calendar Navigator.
Applies to
Calendar Navigator
Description
You can use this property to specify the range of years shown in the Calendar Navigator. The
Calendar Navigator has the predefied layout with year counting. If the specified value equals to 1,
three numbers will be displayed: the previous year, current year and next year.

Number of Columns Property

Specifies the number of columns to output the list of the categories.
Applies to
Directory
Description
You can use this property to specify the number of columns to output the list of the categories. By
default the value of this property is equal to 1. The categories are output from up to down, from left
to right. If the number of the categories is not divisible by the number of columns, then the bigger
number of the categories will be output in the columns to the left. For example, you have 2
columns and 3 categories, then 2 categories will be output in the first column from the left and 1 in
the second one.
See also
Number of Subcategories property

Number of Subcategories Property

Specifies the number of subcategories displayed in one column.
Applies to
Directory
Description
You can use this property to specify the number of subcategories displayed in one column. If the
actual quantity of the subcategories is bigger then the value entered into this property, the number
of subcategories to be displayed will be equal to the number set in this property value the contents
of the 'SubcategoriesTail' template will be output below.

151
Note: If you want to see all subcategories the value of this property should be empty.
See Also
Number of Columns property

Operation Property
The type of operation performed when the button is clicked [Insert, Update, Delete, Cancel or
Search].
Applies to
Button
Description
Specify the operation that will be performed after the button has been clicked.
The list of available operations is provided by the parent component.
Record
• Insert
• Update
• Delete
• Cancel
• Search
Editable Grid
• Cancel
• Submit
Important: If you select of Insert, Update or Delete setting, the appropriate operation of the
Record form will not be automatically performed, the value of the appropriate Allow Delete, Allow
Insert or Allow Update property should be set to 'Yes'.
See Also
Allow Delete property, Allow Insert property, Allow Update property

Output File Format Property

Specify the output file format.
Applies to
PHP, Perl Projects
Description
You can use this property to specify the line feed symbol used in the output file: one-byte for
UNIX\Linux or two-byte for Windows.
See Also
Perl Path property

Page Property
Specify the page that will be included.
Applies to
Include Page
Description

152
This property is used to specify the page that will be is as includable. You can select the page as
the 'Page to Include' in the dialog box which will be displayed after you click on the corresponding
icon in the Forms Tab of the Toolbox.
Important: If you select a page as the Include Page, the Includable property for this page should
be obligatory set to 'Yes'.
See Also
Includable property

Page Links Property

Specify the number of page links to be shown on the Navigator.
Applies to
Navigator
Description
Specify the number of page links to be shown on the Navigator. The default is 10.
This property is applied only if the Type property has the 'Centered' or 'Moving' value.
See Also
Type property

Page Size Limit Property

Specify the maximum number of records a user may opt to display per page if using a search form
that allows control over the number of records displayed.
Applies to
Grid, Editable Grid
Description
Specify the maximum number of records a user may opt to display per page if using a search form
that allows control over the number of records displayed via URL. In combination with the Records
Per Page property it is used to set different output options for data into the grid.
See Also
Records Per Page property

Parent field Property

Specify the field with values pointing at the parent ID subcategory.
Applies to
Path
Description
Specify the field with values pointing at the parent ID subcategory.
See also
ID Field property

Password Property
Specify the Password used to establish a database connection.
Applies to
Connection
Description

153
You can use this property to specify Password used to establish a database connection during the
design time.
See Also
Connection Reference, Connecting to Databases

Path to logfile Property

Specify the full path to logfile.
Applies to
Java Projects
Description
You can use this property to specify the full path to the log file. It can have the following values:
'out' - System.out, 'err' - System.err.

Percent Of Property
Specify whether the report value should be output as percentage of the corresponding group's
total value.
Applies to
ReportLabel
Description
This property is used to specify the name of the report group for which the percent value will be
calculated.
See Also
Function property
Reset At property

Perl Path Property

Specify the Perl path.
Applies to
Perl Projects
Description
You can use this property to specify the absolute path to the Perl executable. Basically, this line
specifies the location of the Perl program and therefore the line changes based on whether a
Windows or Linux/Unix machine is being used. An example path for windows would
be#!c:\perl\bin\perl.exe while for Linux/Unix, a common path is #!/usr/local/bin/perl.
In Linux/Unix, you can find out the location of the Perl executable by typing the command 'which
perl' in the command prompt of a shell session.
For windows, the command Perl -h should produce information about the program including its
path.
See Also
Output File Format property

PHP Database Library Property

Specify the PHP Database Library used on the server side.
Applies to
Connection

154
Description
You can use this property to specify the PHP database library used for the database connection on
the server side.
See Also
Connection Reference, Connecting to Databases,

PHP File Extension Property

Specify PHP File Extension.
Applies to
PHP Projects
Description
You can use this property to specify the file extension of the generated code files. .php is set by
default.
Note: The value of this property should contain '.' - dot symbol in front of the extension.

PHP Database Library Property

Specify the PHP Database Library used on the server side.
Applies to
Connection
Description
You can use this property to specify the PHP database library used for the database connection on
the server side.
See Also
Connection Reference, Connecting to Databases,

PrintError Property
Specify if the warnings are generated in addition to returning error codes in the normal way.
Applies to
Connection
Description
You can use this property to force errors to generate warnings (using warn) in addition to returning
error codes in the normal way. When set 'Yes', any method which results in an error occurring will
cause the DBI to effectively do a warn('$class $method failed: $DBI::errstr') where $class is the
driver class and $method is the name of the method which failed.
See Also
Connection Reference, Connecting to Databases

Preserve Parameters Property

Specify whether GET or Post parameters should be preserved.
Applies to
Image Link, Link, Record, Editable Grid
Description
Specify the types of parameters that should be preserved by the Link and propagated to the linked
page.

155
Setting Description
None No parameters will be propagated by the link.
Get (default) All received Get parameters will be appended to the link.
Post All received Post parameters will be appended to the link.
All All received Get and Post parameters will be appended to the link.

• For the Grid form you can set this property to 'Post' to transfer all parameters via URL not
depending on "<form method=" value in the HTML file.
• For the Record form you can set this property to "Get" to return all URL parameters (e.g. the
search parameters) on the grid, after the form is submitted.
• If you set the value of this property to "None" no parameters will be propagated by the link
besides the ones entered with the link. For example, the ones specified using the Href Source
property.
See Also
Remove Parameters property, Href Source property

Publishing Property
Specify whether the generated pages will be published to a local computer to a remote computer
via FTP.
Applies to
Project
Description
Specify whether the generated pages will be published to a local computer or network or whether
they will be published to a remote computer via FTP.

R-S
RaiseError Property
Specify if an error raises an exception rather than return the error code.
Applies to
Connection
Description
You can use this property to force errors to raise exceptions rather than return error codes in the
normal way. It is 'NO' by default. Otherwise any method which results in an error will cause the DBI
to effectively do a die('$class $method failed: $DBI::errstr') where $class is the driver class and
$method is the name of the method that failed.
See Also
Connection Reference, Connecting to Databases

Records Per Page Property

Specify the number of records to be displayed per page by default.
Applies to
Grid, Editable Grid

156
Description
You can use this property to specify the number of records to be displayed per page by default.
The table below shows the datasource data in three modes depending on this property and the
Page Size Limit property:
Modes Record Per Page Page Size Limit
All records empty empty
By-the-page, with the fixed page size. set empty
By-the-page, with the some page size, but not greater than set set
set in the Page Size Limit property
Important: If the 'Record Per Page' property is not set, the page size is accepted as equal to the
value entered in the Page Size Limit property.
See Also
Page Size Limit property

References Property
Specify the semicolon-separated list of the project references.
Applies to
.NET Projects
Description
You can use this property to specify the semicolon-separated list of the external .dlls linked to the
project.

RegExp API Property

Specify the RegExp Library.
Applies to
Java Projects
Description
You can use this property to specify the RegExp library used in the project.

Remove Parameters Property

Specify a semicolon-separated list of parameters that should be removed from the hyperlink.
Applies to
Editable Grid, Image Link, Link
Description
Use this property to specify names of incoming Post or Get parameters that should not be
propagated via the link. If the Record form has the Preserve Parameters property set to 'Get', this
parameter will be applied to the 'Add record' link on the Grid form.
Examples:
The following are the property results for the page URL with parameters
my_page?page_id=3&emp_name=joe&emp_email=email@ com.com&object_id=26:

Setting Result after removing

page_id;object_id my_page.asp?emp_name=joe&[email protected]

157
See Also
Preserve Parameters property

Required Property
Specify if a value must be entered for the control in order for the form to be submitted successfully.
Applies to
Checkbox List, Hidden, File Upload, List Box, Radio Button, Text Area, Text Box
Description
You can set this property to 'Yes' to specify that the control must submit a value when the form is
submitted. If the control does not submit a value, the form will not be processed to completion but
instead an error message will be displayed.

Reset At Property
Specify when the value of auto-calculated label will be reset during calculations.
Applies to
ReportLabel
Description
This property is used to specify when the value of auto-calculated label should be reset. Possible
values are "Report", "Page" or name of any defined report group.
See Also
Function property
Percent Of property

Restricted Property
Specify whether users must be logged in before accessing the form.
Applies to
Page, Grid, Record, Report, Editable Grid, Directory
Description
The following is this property application to the Page and other controls:
Setting Description
Page If set to 'Yes', the login validation is performed, otherwise the users are redirected to
the Login page set in the Security Tab of the Project Settings. You can also set the
Security Groups for the page, and the unauthorized group users will be redirected to
the Login page. Additionally, you can specify the redirection page for unauthorized
users using the Access Denied Page property.
Others If set to 'Yes' and the Security Groups are not specified, the control is not shown to the
controls unauthorized users. If you specify the Security Groups you can additionally set the
available options for each group.
See Also
Access Denied Page property

Return Page Property

Specify the page where the user should be directed after the button operation has been performed
or the record has been submitted.

158
Applies to
Button, Editable Grid, Record
Description
Use this property to specify the page that should be viewed after the button has been clicked, or
the Record form has been submited.
If the Record form was created using the Record Builder, this property will be empty for all buttons.
The return page is used only for the Record form.

Reverse Order Property

Specify the reverse sorting order values.
Applies to
Sorter
Description
This property is used to specify fields for the reverse sorting. If the value of this property is not
specified than the reverse sorting is performed for the same field set in the Sort Order property.
If you select several fields in the Sort Order property you should also select the necessary fields
and set the sorting direction for this property. Otherwise, the sorting direction will be changed only
for the last field specified in the Sort Order property (the DESC parameter will be added to the SQL
statement).
See also
Sort Order property

Runtime libraries Property

Specify the Runtime libraries.
Applies to
Java Projects
Description
You can use this property to specify the semicolon separated file list of Runtime libraries. These
files will be copied to the WEB-INF\lib directory of your application.

Secured Server URL Property

Specify the SSL HTTP URL to be used to access the published pages.
Applies to
Project
Description
This option is only used if you want to access the pages over a SSL connection and the server
support SSL.

Security Type Property

Specify if the security is applied to the project.
Applies to
Project
Description
The following are the possible values:

159
Setting Description
None No site security is implemented
(default)
Table Security will be based on information contained in a database table

Server API Property

Specify the type of the Server API.
Applies to
Perl Projects
Description
You can use this property to specify the type of the used Server API. It can take the following
values:
Parameter Description
CGI Used by default
mod_perl version 1 Specify if mod_perl version 1 is used.
mod_perl version 2 Specify if mod_perl version 1 is used.
Please use the defaults if in doubt.

Server Connection String Property

Specify the ADO connection string or ODBC Data Source Name.
Applies to
Connection
Description
You can use this property to specify the ADO connection string or ODBC Data Source Name used
for the database connection if the server connection is different from the design connection.
See Also
Connection Reference, Connecting to Databases, Server Same As Design property

Server Connection Type Property

Specify the type of connection.
Applies to
Connection
Description
You can use this property to specify the ADO connection string or ODBC Data Source Name used
for the database connection if the server connection is different from the design connection.
See Also
Connection Reference, Connecting to Databases, Server Same As Design property

Server DataBase/Connection Type Property

Specify the Server Database Type used to establish a database connection.
Applies to
Connection

160
Description
You can use this property to specify the type of database accessed during the server (live)
execution. If your database type is not listed, you may select the 'ANSI SQL-92' option. This
property is used to determine database specific SQL features during run-time.
See Also
Connection Reference, Connecting to Databases

Server Database Name Property

Specify the server database name.
Applies to
Connection
Description
You can use this property to specify the server database name or DBI Data Source Name for Perl.
See Also
Connection Reference, Connecting to Databases

Server Database Type Property

Specify the Server Database Type used to establish database connection.
Applies to
Connection
Description
You can use this property to specify the type of database being accessed during the server (live)
execution. If your database type is not listed, select the ANSI SQL-92 option. This property is used
to determine database specific SQL features during Run-time.
See Also
Connection Reference, Connecting to Databases

Server Host Property

Specify the SQL server hostname .
Applies to
Connection
Description
You can use this property to specify the IP address or hostname of the machine where the SQL
server is located.
See Also
Connection Reference, Connecting to Databases

Server Login Property

Specify the Login used to establish database connection.
Applies to
Connection
Description
You can use this property to specify Login used to access the server database.
See Also
161
Connection Reference, Connecting to Databases

Server Password Property

Specify the Password used to establish a database connection.
Applies to
Connection
Description
You can use this property to specify Password used to access the server database.
See Also
Connection Reference, Connecting to Databases

Server Path Property (Java)

Specify the server path to the published files.
Applies to
Java Projects
Description
You can use this property to specify the server path to the published files. It is used only if the
target server is Tomcat.
See Also
Target Server property

Server Path Property (Perl)

Specify the path to the root of web folder where scripts should be run.
Applies to
Perl Projects
Description
You can use this property to specify the absolute path to the root of web folder where scripts
should be run. For example: /var/www/perl/Project1.
Note: If the value of this property is not specified, FindBin(CGI) or Apache::request(mod_perl)
modules will determine this value depending on the server's API.

Server Persistent Connection Property

Specify if the persistent server connection is used.
Applies to
Connection
Description
You can use this property to specify that opened connections are reused whenever available.
See Also
Connection Reference, Connecting to Databases

Server Port Property

Specify the SQL server port.
Applies to
Connection

162
Description
You can use this property to specify the SQL server port. If the default port is used this property
should be blank, for example the default port for MySQL is 3306.
See Also
Connection Reference, Connecting to Databases

Server Same As Design Property

Specify if the server connection matches the design connection.
Applies to
Connection
Description
You can use this property to specify if the server connection matches the design connection.
See Also
Connection Reference, Connecting to Databases

Sessions Files Clean Rate Property

Specify how often the session files will be checked for expiration.
Applies to
Perl Projects
Description
You can use this variable to specify how often the session files will be checked for expiration, and
the expired files will be deleted.
If 'Sessions Files Clean Rate' = 100, such check will be performed when each 100th page of your
application will be called. If your site is stressed enough you might want to increase this value to
improve the performance. And if you have only several visitors per day, you can decrease this
value without significant impact for the overall performance.

Session Files Path Property

Specify the path to the directory to store the temporary session files.
Applies to
Perl Projects
Description
You can use this property to specify the absolute or relative path to the folder where the session
variable information will be stored. This should be a folder with read/write access.

Session Timeout Property

Specify the session timeout (minutes).
Applies to
Perl Projects
Description
You can use this property to specify the time in minutes after which the session variables in an
inactive session will be terminated.

Schema Property

163
Specify a database schema for the object display during the design time.
Applies to
Connection
Description
You can use this property to specify a database schema for the object display during the design
time. It is used for Oracle and MSSQL databases.
The Schema is a collection of the related database objects, usually grouped by the database
userid. The Schema Objects include tables, views, sequences, stored program units, synonyms,
indexes, clusters, and database links.
See Also
Connection Reference, Connecting to Databases

Show nearby days Property

Specifies if the days of the surrounding months will be shown.
Applies to
Calendar
Description
You can use this property to specify whether to show days of the surrounding months if the 1st or
last week of the month includes days of other months.

Site Language Property

Specify the spoken language for the project pages.
Applies to
Project
Description
Specify the spoken language for the project pages. You can select a language from the list and all
the text of your site, i.e. the header, footer error messages, buttons etc., will be generated on this
spoken language.
Important: You will not be able to change the language on the earlier generated pages. Only the
text for the record error messages will be changed.

Sort Order Property

Specify the sorting order values.
Applies to
Sorter
Description
This property contains a field name (or comma-separated list of field names) used to sort data
source’s rows. Field names can be followed by 'ASC' or 'DESC' to alter sorting order.
Note: If there are several fields selected or "DESC" used for one of the fields you should select the
necessary fields and set the sorting direction in the Reverse Order property. Otherwise, the sorting
direction of the last field will be changed in the Reverse Order property.
See also
Reverse Order property

164
SSL Access Only Property
Specify if the SSL access is applied to the page.
Applies to
Page
Description
This property specifies that the SSL connection will be applied to the page. If the property value is
set to 'Yes', the SSL connection validation is performed. If you view the page without using the
secured connection, the following error message is displayed: "SSL connection error. This page
can be accessed only via secured connection."
By default the property value is set to 'No'.

Style Property
Specify the css style applied to the Date Picker/Selector.
Applies to
Date Picker
Description
You can use this property to specify the css style applied to the Date Picker/Selector.

Subcategory ID Field Property

Specify the data field that contains category id of the second level categories.
Applies to
Directory
Description
Specify the data field that contains category id of the second level categories.
See Also
Data Source property, Category ID Field property

Synonyms Property
Specify if the display of database synonyms is enabled during the design time.
Applies to
Connection
Description
You can use this property to specify if the display of database synonyms is enabled during the
design time.
See Also
Connection Reference,
Connecting to Databases

System Tables Property

Specify if the display of database system tables is enabled during the design time.
Applies to
Connection
Description

165
You can use this property to specify if the display of database system tables is enabled during the
design time.
See Also
Connection Reference, Connecting to Databases

System Views Property

Specify if the display of database system views is enabled during the design time.
Applies to
Connection
Description
You can use this property to specify if the display of database system views is enabled during the
design time.
See Also
Connection Reference, Connecting to Databases

T-Z
Target Schema Property
Specify the target schema for ASPX pages.
Applies to
.NET Projects
Description
You can use this property to specify the target schema for ASPX pages.

Target Server Property

Specify the host server.
Applies to
Java Projects
Description
You can use this property to specify the host server where your application will be deployed.
See Also
Server Path property, Context Path property, Manager Password property, Manager Login
property, Manager URL property

Target Version Property

Specify the target .NET framework version.
Applies to
.NET Projects
Description
You can use this property to specify the target .NET framework version.

Temporary Folder Property

Specifies the path used for storing the temporary uploaded file before processing and moving into
the target directory.

166
Applies to
File Upload
Description
The property specifies the full path or the relative path to the temporary folder beginning from the
current page folder.
If the property value starts with "%", the environment variable specifies the path to the temporary
folder. If the language doesn't have functions for loading the environment variable content, the
following error message is shown: Invalid value of the Temporary Folder property.

Text Column Property

Refers to the data source for the values that are displayed.
Applies to
Checkbox List, List Box, Radio Button
Description
If the Source Type property is set to Table/View, Procedure or SQL, this property is used to specify
the database field that will provide the List Box values to be displayed.
See Also
Bound Column property, Data Source Type property, Data Source property

Text Is Empty Property

Specify the text that will be displayed if the value of label is empty.
Applies to
ReportLabel
Description
This property is used to specify the text that will be displayed when the label value is empty.

Time DB Format Property

Specifies the database format of the field containing event time.
Applies to
Calendar
Description
You can use this property to specify the database format of the field containing event time.
See also
• Time Field property
• Date DB Format property

Time Field Property

Specifies the field containing event time.
Applies to
Calendar
Description
You can use this property to specify the field containing event time. You must use this property
when event's date and time are stored in saparate fields.
See also
167
• Time DB Format property
• Date Field property

Timeout of DB Connection Retrieval Property

Specify the duration of time after which a connection will be terminated.
Applies to
Connection
Description
You can use this property to specify the duration of time after which an idle or unresponsive
connection will be terminated (in milliseconds).
See Also
Connection Reference, Connecting to Databases

Type Property
Specify the type of page links to be shown in the Navigator control.
Applies to
Navigator
Description
The following are the possible values:
Setting Description
Simple Only the current page and the Number of Pages are displayed in the Navigator.
Centered The Number of Pages is shown as it is set in the Page Links property and the current
page is displayed in the center of the Navigator.
Moving The Number of Pages is shown as it is set in the Page Links property and the current
page is displayed moving on the page list of the Navigator.
If you like to change the value of this property from 'Simple' to "Centered" or "Moving" the HTML
should be modified.
See Also
Page Links property

Type Property
Specifies the Calendar type.
Applies to
Calendar
Description
The possible values are the following:
Setting Description
Annual Specifies that all 12 months of the year will be shown in the Calendar.
Quarterly Specifies that quarter (three months) of the year will be shown in the Calendar.
3-Months Specifies that any of 3 months of the year will be shown.
Monthly Specifies that one month Calendar will be shown.

168
Unchecked Value Property
The value submitted by a Checkbox Control when it is unchecked.
Applies to
Checkbox
Description
In conjunction to the Checked Value property, this property allows you to specify a value to be
associated with the unchecked state of the checkbox. Ordinarily, an unchecked HTML checkbox
does not submit any value, this property can be used to associate a value with the unchecked
state.
Examples
This control can be used to update a database field of the "Text" type, which stores the 'Yes' or
'No' value. In order to do that you can set the DataType property to 'Text', and enter "Yes" for the
Checked Value property and "No" for the Unchecked Value Property. The value should be
obligatory entered in double quotes.
The following are the possible applications:
Data Type Checked Value Unchecked Value
Text "Y" "N"
Integer 1 0
Boolean True False
See Also
Checked Value property, DataType property

Unique Property
Specify if it is validated that any value entered in the control does not already exist in the database.
Applies to
Checkbox List, Hidden, List Box, Radio Button, Text Area, Text Box
Description
Set "Yes" to ensure that a value submitted by the control does not match any other value that is
already in the database. If a duplicate is encountered, form processing will terminate and an error
message will be displayed stating the problem.

Use Data Source Extension Property

Specify if the JDBC 2.0 Standart Extension is used in the project.
Applies to
Java Projects
Description
You can use this property to specify if the JDBC 2.0 Standart Extension will be used in the project.
See Also
Class Path property

Use LIMIT/TOP Property

Specify if the LIMIT or TOP clause should be used to limit the size of SQL result sets.
Applies to
169
Connection
Description
Use this property to optimize the database performance by returning only the records that are used
within the form. If set to "Yes", the changes will be applied to the Data Source of the Grid, Editable
Grid and Record components when used with any of the following databases: MySQL,
PostgreSQL, Microsoft SQL Server and Microsoft Access.
The following table shows how the "Use LIMIT/TOP" property is utilized:
Component Database Description
Grid, Editable MySQL When using Table or SQL data source, "LIMIT offset,
Grid row_count" is applied to the Select SQL at the end of the SQL
statement.
PgSQL When using Table or SQL data source, "LIMIT row_count
OFFSET offset" is applied to the Select SQL at the end of the
SQL statement.
MS SQL Server, When using Table data source, "TOP row_count+offset" is
MS Access applied automatically.
When using SQL data source and the SQL begins with
SELECT, "TOP row_count+offset" is applied after "SELECT" or
"SELECT DISTINCT" or "SELECT ALL".
However, "TOP" is not applied to the SQL data source if SQL
already contains TOP or "UNION [ALL] SELECT" in the SQL
body.
Record MySQL, PgSQL LIMIT 1 is added to the Select SQL after ORDER BY.
MS SQL Server, When using Table or SQL data source, "TOP 1" is applied to the
MS Access Select SQL in the same manner as when using the Grid
component.

Notes:
• "row_count+offset" is a value calculated as the sum of starting row and the number of rows
to be returned.
• the LIMIT/TOP clause is applied even when using custom code that alters the DataSource.
• to disable LIMIT/TOP in individual forms create an alternative database connection that
doesn't utilize the "Use LIMIT/TOP" property.
See Also
Connection Reference, Connecting to Databases

Validation Rule Property

Specify an expression that will be used to check the validity of the data entered in the control.
Applies to
Checkbox, Checkbox List, Hidden, List Box, Radio Button, Text Area, Text Box
Description
This property presents you with the opportunity to enter a programming language specific
condition that will be used to determine the validity of the submitted value. If the requirement is not
satisfied the error message from Validation Text property is shown.

170
Important: If there is no text entered into the Validation Text property the message is not shown
and the following warning message appears in the Messages Window: "Warning: TextBox
DateFiled: The Validation Text property is empty." The property value depends on the
programming language of the project.
Example
For instance, if using ASP and you have a control that submits date values, you can enter a simple
condition to ensure that the date is later than the current date i.e. FieldName is the name of the
control being validated.
FieldName.Value > Date()

See Also
Validation Text property

Validation Text Property

Specify the text that will be displayed if the data entered in the control does not meet the validation
rule.
Applies to
Checkbox, Checkbox List, Hidden, List Box, Radio Button, Text Area, Text Box
Description
This property is related to the Validation Rule property and is used to specify an error message
that will be displayed in case the validation rule is not satisfied.
Important: If the Validation Rule property is not set, the property text is not shown and the
following warning message is shown in the Message Window: "Warning: TextBox DateFiled: The
Validation Rule property is empty."
See Also
Validation Rule property

Validate Request Property

Specify whether HTTP Request Validation enabled.
Applies to
.NET Projects
Description
Indicates whether request validation should occur. If true, request validation checks all input data
against a hard-coded list of potentially dangerous values. If a match occurs, an
HttpRequestValidationException exception is thrown. The default is true.

Views Property
Specify if the display of database views is enabled during the design time.
Applies to
Connection
Description
You can use this property to specify if the display of database views is enabled during the design
time.
See Also
Connection Reference, Connecting to Databases

171
Visible Property
Specifies whether the control is visible.
Available values
Yes, No, Dynamic.
Applies to
Components, Report Section
Description
Setting this property to "No" prevents the object from being displayed, usually by excluding it from
the HTML at runtime.
When set to "Dynamic", the component is wrapped within a special HTML template that allows it to
be hidden programmatically at runtime.

Events
Client Side Events
On Change event
Applies to
List Box, Text Area, Text Box
Description
This event occurs on the client side after the control's value is changed and focus is lost. It can be
used to change values of other controls and for validation of input values.
Examples
The following is an example of a Celsius-to-Fahrenheit temperature converter. In a Record form
called NewRecord1 with the text boxes TextBox1 and TextBox2, the Custom Code in the On
Change event converts the Celsius value entered in Textbox1 to a Fahrenheit value which is
displayed in Textbox2.
<script language="JavaScript">
function page_NewRecord1_TextBox1_OnChange()
{
var result;

document.NewRecord1.TextBox2.value = ((9/5) *
document.NewRecord1.TextBox1.value ) + 32;

return result;
}

function bind_events() {

check_and_bind('document.NewRecord1.TextBox1','onchange',page_NewRecord1_TextBo
x1_OnChange);
forms_onload();

172
 }

window.onload = bind_events;
</script>

On Click event
Applies to
Button, Check Box, Check Box List, Radio Button
Description
This event occurs when the user clicks the left mouse button on the object.
Possible applications: Handling button clicking. Executing custom button actions.
Examples
The following is an example usage of the On Click event. In this case, a Confirmation Message
action is added to the On Click event of a Delete button in a Record form called Record1. The
following is the code generated for the action (CodeCharge Studio comments are removed):
<script language="JavaScript">
function page_NewRecord1_Delete_OnClick() {
return confirm('Delete record?');
}

function bind_events() {
check_and_bind('document.NewRecord1.Delete','onclick',
page_NewRecord1_Delete_OnClick);
forms_onload();
}

window.onload = bind_events;
</script>

On Key Press
Applies to
Text Area, Text Box
Description
This event occurs when the user presses an alphanumeric key. It can be used to change the value
of other controls.
Examples
The following example shows how the On Key Press event can be used to set the value of a Text
Box called TextBox2 whenever a new value is entered in another Text Box called TextBox1.
<script language="JavaScript">
function page_NewRecord2_TextBox1_OnKeyPress()
{
var result;
//Custom Code
var maxlength = document.NewRecord2.TextBox1.value.length + 1;

173
 document.NewRecord2.TextBox2.value = maxlength;
//End Custom Code

return true;
}

function bind_events() {

check_and_bind('document.NewRecord2.TextBox1','onkeypress',page_NewRecord2_Text
Box1_OnKeyPress);
forms_onload();
}

window.onload = bind_events;
</script>

On Load event
Applies to
Button, Check Box, Editable Grid, Hidden, List Box, Page, Record, Text Area, Text Box
Description
• Page
This event occurs on the client side directly after the page is loaded into the browser. This
event is often used to setup the mechanism for validating controls within the page.
• Button, Check Box, Editable Grid, Hidden, List Box, Record, Text Area, Text Box
The On Load event does not apply directly to the above controls but is used to attach
validation criteria to controls when the page loads. This is mostly done for controls that reside
within Record or Editable Grid forms. For the above controls, On Load is not a native DHTML
event but is wired through the page On Load event.
Examples
The following is an example of the minimum length validation for a Text Box called Textbox2 which
is located within a Record form called NewRecord2. In this case, a Validate Entry action is added
to the On Load event with the following settings:

Validate Entry
Property Value
Required True
Minimum Length 8
Maximum Length
Input Mask
Regular Expression
Error Message Minimum length: 8
Validation Function

As a result the generated code will be as follows (CodeCharge Studio comments are removed):

174
 <script language="JavaScript">
function page_NewRecord2_TextBox2_OnLoad() {
var result;
this.ccsRequired = true;
this.ccsMinLength = 8;
this.ccsErrorMessage = "Minimum length is 8";
this.ccsCaption = "";
return result;
}

function bind_events() {

check_and_bind('document.NewRecord2','onLoad',page_NewRecord2_TextBox2_OnLoad);
forms_onload();
}

window.onload = bind_events;
</script>

On Unload event
Applies to
Page
Description
This event occurs immediately before the page is unloaded from the browser.
Examples

On Submit event
Applies to
Editable Grid, Record
Description
This event occurs on the client side when the user submits a form but before the data is sent to the
server from the form. It can be used for the validation, to confirm the submission or alter control
values.
Examples
In this example, a Confirmation Message action is added to the On Submit event of a Record
form called Record1. The action causes a message ("Submit form?" ) to be displayed whenever
the form is submitted.
<script language="JavaScript">
function page_NewRecord1_OnSubmit() {
return confirm('Submit form?');
}

function bind_events() {
check_and_bind('document.NewRecord1','onsubmit',page_NewRecord1_OnSubmit);
forms_onload();

175
 }

window.onload = bind_events;

</script>

Server Side Events

After Execute Delete Event
Applies to
Editable Grid, Record
Description
This event occurs after a row deletion query has been executed.
Possible applications:
• Checking operation status
• Processing query errors
• Changing parameters and re-executing the query
• Performing other transaction’s queries and closing the transaction

After Execute Insert Event

Applies to
Editable Grid, Record
Description
This event occurs after new row insert query has been executed.
Possible applications:
• Checking operation status
• Processing query errors
• Changing parameters and re-executing the query
• Performing other transaction’s queries and closing the transaction

After Execute Select Event

Applies to
Check Box List, Directory, Editable Grid, Grid, List Box, Path, Radio Button, Record, Report
Description
This event occurs after the row selection query has been executed and a recordset for the result is
returned.
Possible applications:
• Processing query errors
• Retrieving recordset’s state
• Changing parameters and re-executing the query

After Execute Update Event

176
Applies to
Editable Grid, Record
Description
This event occurs after a row update query has been executed.
Possible applications:
• Checking operation status
• Processing query errors
• Changing parameters and re-executing the query
• Performing other transaction’s queries and closing transaction
Examples
Execute Custom SQL

After Delete Event

Applies to
Record
Description
This event occurs after deleting a row from the data source.
Possible applications:
• Checking operation status
• Processing operation errors
• Altering returned error collection
• Performing cascading deletion of linked rows from other tables or updating item counters
• Modifying the redirect string
Examples
This example After Delete event shows how to perform a cascading delete of link records that are
related to a user record that has been deleted.

Function members_AfterDelete()
If members.DataSource.Errors.Count = 0 Then
DBInternet.Execute ("DELETE FROM links WHERE user_id_add_by = " &_

DBInternet.ToSQL(members.DataSource.Parameters("urluser_id"),ccsInteger))
End If
End Function

After Delete File Event

Applies to
FileUpload Control
Description
This event is executed if user submits upload form with delete checkbox selected, after performing
file delete operation.
Possible applications:

177
• removing any additional information kept about the file (database records)
• removing any other files related to the file

After Initialize Event

Applies to
Page
Description
This event occurs after all page components have been initialized but before dynamic database
content is processed.
Possible applications:
• Loading custom resources
• Setting session and application variables
• Altering component properties
• Preprocessing submitted data
• Creating custom objects and structures
Examples
Custom Error Message,
Add URL Parameters to a Page

After Insert Event

Applies to
Record
Description
This event occurs after inserting a new row into the data source.
Possible applications:
• Checking operation status
• Processing query errors
• Performing supplemental queries: updating item counters, propagating modification date
• Modifying the redirect string

After Process File Event

Applies to
FileUpload Control
Description
This event is executed after processing uploaded file (saving into target directory).
Possible applications:
• inserting additional file information into some table record

After Submit Event

Applies to
Editable Grid
Description

178
This event occurs after the data rows are modified.
Possible applications:
• Checking operation status
• Processing query errors
• Performing modification date propagation, logging user operation
• Modifying redirect string

After Update Event

Applies to
Record
Description
This event occurs after updating an existing row in the data source.
Possible applications:
• Checking operation status
• Processing query errors
• Performing modification date propagation, logging user operation
• Modifying the redirect string

Before Build Delete Event

Applies to
Editable Grid, Record
Description
This event occurs before the creation of the query that will be used to deleted a database record.
Possible applications:
• Setting custom query parameters or changing existing ones.

Before Build Insert Event

Applies to
Editable Grid, Record
Description
This event occurs before the creation of the query that will be used to insert a new record into the
database.
Possible applications:
• Setting custom query parameters or changing existing ones

Before Build Select Event

Applies to
Check Box List, Directory, Editable Grid, Grid, List Box, Path, Radio Button, Record, Report
Description
This event occurs before the creation of the query that will be used to retrieve records from the
database.
Possible applications:

179
• Altering the criteria used to select the database record.
Examples
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox,
Dynamically Modify the ORDER BY Clause,
Dynamically Modify the SQL Statement,
Dynamically Modify the WHERE Clause,
Retrieve Values From a Multi-Select ListBox

Before Build Update Event

Applies to
Editable Grid, Record
Description
This event occurs before the creation of the query that will be used to update database content.
Possible applications:
• Setting custom query parameters or changing existing ones

Before Delete Event

Applies to
Record
Description
This event occurs at the onset of the operations performed to delete an existing record.
Possible applications:
• Checking delete rights
• Preventing row deletion
• Setting query parameters

Before Delete File Event

Applies to
FileUpload Control
Description
This event is executed if user submits upload form with delete checkbox selected, before
performing file delete operation.
Possible applications:
• changing file name to delete
• backing up file for later undoing operation

Before Execute Delete Event

Applies to
Editable Grid, Record
Description
This event occurs after the query has been composed and immediately before a delete query is
executed.
180
Possible applications:
• Altering query components
• Opening a transaction
• Performing transaction operations

Before Execute Insert Event

Applies to
Editable Grid, Record
Description
This event occurs after the query has been composed and immediately before a row update query
is executed.
Possible applications:
• Altering query components
• Opening a transaction
• Performing transaction operations

Before Execute Select Event

Applies to
Check Box List, Directory, Editable Grid, Grid, List Box, Path, Radio Button, Record, Report
Description
This event occurs after the query has been composed and immediately before a row update query
is executed.
Possible applications:
• Altering query components

Before Execute Update Event

Applies to
Editable Grid, Record
Description
This event occurs after the query has been composed and immediately before a row update query
is executed.
Possible applications:
• Altering query parameters
• Opening a transaction
• Performing transaction operations

Before Insert Event

Applies to
Record
Description
This event occurs at the onset of the operations performed to insert a new record.
Possible applications:

181
• Checking insert rights
• Preventing row insertion
• Setting custom query parameters
• Modifying the data to be inserted
Examples
Replace Control Value Before Inserting

Before Output Event

Applies to
Page
Description
This event occurs after the current page is rendered and before the output is sent to the client
(Web browser).
Possible applications:
• Modify the HTTP entity body before transmission.

Before Process File Event

Applies to
FileUpload Control
Description
This event is executed before processing uploaded file (before moving file from temporary into
target directory).
Possible applications:
• changing target folder depending on a file extension

Before Select Event

Applies to
Directory, Editable Grid, Grid, Path, Record, Report
Description
This event occurs at the onset of the operations performed to select records from the database.
Possible applications:
• Modifying Select parameters
• Changing component properties

Before Show Event

Applies to
Button, Check Box, Check Box List, Directory, Editable Grid, Grid, Hidden, Image, Image Link,
Label, Label(Report), Link, List Box, Navigator, Page, Panel, Path, Radio Button, Record, Report,
Report Section, Sorter, Text Area, Text Box
Description
This event occurs before a component is rendered to the page.
Possible applications:
• Assigning custom template variables
182
• Altering data for populating the template
• Changing structure of the template
• Modifying component properties and visibility
Examples
• Change Control Value
• Changing Text Color
• Dynamic Login Field in a Registration Form
• Hiding a Grid If No Records are Found
• Hiding a Record Form Control
• Dynamically Modify the "List Of Values" of a ListBox
• Lookup Single Field Value in a Database
• Retrieve Multiple Field Values from a Database
• Dynamically Set the Default Value of a ListBox
• Add Custom HTML to a Page
• Utilize MySQL Enum Field Type
• Examine Form's Mode
• Working with Custom Template Blocks

Before Show Category Event

Applies to
Directory Path
Description
This event occurs before each top level category is displayed.
Possible applications:
• Altering the data to be displayed in each category
• Assigning custom template variables

Before Show Row Event

Applies to
Editable Grid, Grid
Description
This event occurs before each row in the form is displayed.
Possible applications:
• Altering the data to be displayed in each row
• Assigning custom template variables
Examples
Changing Table Cell Color,
Dynamically Modify a Hyperlink,
Create a Grid Column with a Calculated Value,
Simple Report With Group Headers,
Simple Report with Total,

183
Simple Report with Simple Grouping

Before Show Subcategory Event

Applies to
Directory
Description
This event occurs before showing a subcategory.
Possible application:
• Altering the data to be displayed in each subcategory
• Assigning custom template variables

Before Submit Event

Applies to
Editable Grid
Description
This event occurs before any database operations are performed with the submitted data.
Possible applications:
• Checking update rights
• Preventing row from updating
• Setting custom query parameters

Before Unload Event

Applies to
Page
Description
This event occurs before disposing page components and after the page has been composed.
Possible applications:
• Freeing custom resources and other structures
See also
Dynamically Redirect Users to Another Page

Before Update Event

Applies to
Record
Description
This event occurs at the onset of the operations performed to update a database record.
Possible applications:
• Checking update rights
• Preventing a row from updating
• Setting custom query parameters
Examples

184
Replace Control Value Before Inserting

On Cache Event
Applies to
Page
Description
This event occurs before adding an object into Cache or retrieving an objectfrom Cache.
Possible applications:
• Disabling cache operation
• Handling custom cache parameters

On Calculate Event
Applies to
ReportSection
Description
This event occurs after the totals of all function-based controls in the current section are
calculated.
Possible applications:
• Custom calculations.
• Change the total control value.

On Click Event
Applies to
Button
Description
This event occurs when a form’s button has been clicked but before any other operations have
been performed as a result of the submission.
Possible applications:
• Performing custom actions in response to button clicks.
Examples
Create Custom Session Variables,
Dynamically Redirect Users to Another Page

On Initialized Event
Applies to
ReportSection
Description
This event occurs on initialization of section instance.
Possible applications:
• Dynamically change the height of the current section.

On Initialize View Event

185
Applies to
Page
Description
This event occurs after handling submitted data and before loading templates for displaying the
page.
Possible applications:
• Altering the file name of the loaded template
• Changing the content type

On Validate Event
Applies to
Check Box List, Editable Grid, Hidden, List Box, Radio Button, Record, Text Area, Text Box
Description
This event occurs after standard validation operations have been performed as a result of
submitting values, but before any database operations have been performed with the submitted
values.
Possible applications:
• Performing custom validation
• Altering the validation result
Examples
Using the Control Validation Event,
Using the Form Validation Event

Actions
Client Side Actions
Attach FCKeditor
This action can be assigned to the On Load client event of a TextArea control to replace it with
FCKeditor (rich text editor). For this action to work properly the FCKeditor must be installed on the
server and "FCKeditor base Path" must be specified in Project Settings.
The following action settings are available:
Parameter Description
ToolbarSetName Name of an FCKeditor toolbar to be enabled.
Width Width of the editing area in pixels or percent. If left blank, FCKeditor will use it's
default value of 100%.
Height The height of the editing area in pixels or percent. If left blank, FCKeditor will
use it's default value of 200 pixels.
Config Opens the FCKeditor configuration dialog that allows configuring additional
Parameters properties available in FCKeditor. These values are not related to CodeCharge
Studio and are provided for convenience of configuring FCKeditor itself. Please

186
 refer to FCKeditor documentation for more information about FCKeditor
configuration.
Note: for this feature to work properly it is required that you enable the "Config"
option in your FCKeditor configuration file
(FCKeditor\editor\filemanager\browser\default\connectors\ext\Config.asp for
ASP and .NET, or Config.php for PHP), and uncomment proper connector lines
in FCKeditor\fckconfig.js

Please note that YesSoftware does not support FCKeditor itself. The documentation, configuration
parameters and FCKeditor feature list can be found on FCKeditor Website at FCKeditor.net.

Convert Page to PDF

Descriptiion
This action is used to convert the HTML output of a page to PDF or other formats. The action
requires an external conversion application (program) and can be used only in the Before Output
event of non-includable pages. YesSoftware offers a PDF printer driver, which can be used for
such purposes on Windows servers.
The action is activated by specifying any non-empty value for the "Parameter Name" parameter in
page URL. For example if "Parameter Name" property is set to "_convert" then the URL containing
the string "?_convert=yes" or "&_convert=yes" will activate the action. When activated the action
will save the output of the HTML page into a temporary file on the server, then execute the
specified HTML conversion program. Finally, the action will assume that the conversion program
created another file on the server, which it will read and output to the Web browser.
The Internet user, such as IUSR or ASPNET should have sufficient privileges to execute the PDF
conversion program or printer driver, to create files in the temporary folder specified for the action.
The server must also not use pop-up blockers that would prevent the conversion program from
accessing Internet Explorer.
Properties
Property Description
Command The name of the executable program which will perform the HTML conversion.
Options Provides option values for the conversion program. It is assumed that the
conversion program would have options to specify the input HTML file and
output PDF file names. These file names are generated dynamically by the
action and passed to the conversion program.
You specify option values in a template format, by replacing the input file name
with {InputFile} and the output file name with {ResultFile}. You can also specify
{Root} as one of the options, in which case the action will also provide to the
conversion program the server path used for resolving relative URLs in the input
file to the absolute ones.
Sample syntax specified in the Options property:
{InputFile} -f {ResultFile} -root {Root}

Parameter Name The name of the URL parameter which will activate the conversion action.
Temporary The path to be used for storing the temporary HTML and converted files. This
Folder parameter specifies the full server path, or the path relative folder to the current
page folder. If the property value begins with "%" the environment variable will

187
 be used to specify the temporary folder path. For example specifying "%TEMP"
would set the temporary folder to the Windows environment variable named
"TEMP".

Custom Code
This action allows you to enter your own code to be executed when the event occurs.
//Custom Code @41-2A29BDB7
// -------------------------
// Write your own code here.
// -------------------------
//End Custom Code

Confirmation Message
This action is used to confirm different operations. To perform this action the JavaScript's Confirm
function is applied. For instance, this action can be placed in the On Click event of a Delete button
withint a Record form so as to confirm the deletion.
Property Description
Message Specify the message to be shown in the confirmation dialog.

Regular Expression Validation

This action is used to validate the input in a control based on a specified regular expression.
The following are the properties that need to be configured for the action.
Property Description
Control Name Name of the control to be validated.
Regular Regular expression to be used for validation.
Expression
Error Message Error message to be displayed if the control value does not match the regular
expression.

Set Focus
This action is used to set focus to a particular object in the window. For a input field, focus means
that anything typed by the user will be entered into the field. For a button, focus means that
pressing the enter key is equivalent to clicking the button. Use this action to set focus to a
particular field for the convenience of the user or in cases where you want input to begin at a
particular field. When you add this action there are two properties you have to provide.
Property Description
Form Name of the form that the control to be focused on is located.
Control Name of the control to receive focus.

Submit Form
You can use this action to submit a form whose name is specified in the Form Name property. The
action can also be used to submit one form from another form or from elsewhere within the page.

188
Property Description
Form Name The name of the form that should be submitted.

Validate Entry
This action is used to setup one or more validation conditions for a field. Multiple fields within a
form can have their own Validate Entry actions. After the Validate Entry actions have been
setup, the Validate Form action is used to execute all the validations.
Property Description
Required Specify whether a field value is required or not.
Minimum Minimum acceptable field value size.
Length
Maximum Maximum acceptable field value size.
Length
Input Mask Input mask to be used to determine the validity of the field value. The following
symbols can be used for the mask:
• 0 - any digit,
• L - any character in the lower or upper case.
All other symbols should be the same as in the mask string. For example, mask
(000) 000-00-00 will allow entering the telephone in format (123) 123-45-67. Mask
LLLL-LL00 will allow outputting the alphanumeric code with the sign in the middle,
for example: ABCD-EF35.
Regular Regular expression to be used to determine the validity of the field value.
Expression
Error Error message to be displayed if an invalid entry is made.
Message
Validation Name of a custom validation function to be executed.
Function

Validate Form
This action makes use of the built-in CodeCharge Studio validation functionality contained in a
Jscript include file called functions.js. A function is called in the file to validate any conditions that
have been set for the fields within the forms using the Validate Entry action. The possible
conditions are:
• Required field value
• Minimum field value
• Maximum Field value
• Check against a regular expression
• Call a custom function to validate the field
If any of the conditions are not satisfied, the function displays an appropriate error message.

Validate Maximum Length

This action is typically used in conjunction with input fields and serves to ensure that the value
entered in a field does not exceed a specified number of characters. This action can be placed in

189
many places including the On Click event of a button in the form or the On Change event of the
field being validated.
The following are the properties that need to be configured for the action.
Property Description
Control Name Name of the control to be validated.
Maximum Length Maximum allowable length of input in the control.
Error Message Error message to be displayed if the maximum length is exceeded.

Validate Maximum Value

This action is usually used in conjunction with input fields that receive numeric values. The action
ensures that the value entered is less than a specified maximum value. This action can be placed
in many places including the On Click event of a button in the form or the On Change event of the
field being validated.
The following are the properties that need to be configured for the action.
Property Description
Control Name Name of the control to be validated.
Maximum Value Maximum allowable input value.
Error Message Error message to be displayed if the input value exceeds the maximum value.

Validate Minimum Length

This action is usually used in conjunction with input fields and serves to ensure that the value
entered in a field is at least a specified number of characters long. This action can be placed in
many places including the On Click event of a button in the form or the On Change event of the
field being validated.
The following are the properties that need to be configured for the action.
Property Description
Control Name Name of the control to be validated.
Minimum Length Minimum allowable length of input in the control.
Error Message Error message to be displayed if the input is less than the minimum length.

Validate Minimum Value

This action is usually used in conjunction with input fields that receive numeric values. The action
ensures that the value entered is more than a specified minimum value. This action can be placed
in many places including the On Click event of a button in the form or the On Change event of the
field being validated.
The following are the properties that need to be configured for the action.
Property Description
Control Name Name of the control to be validated.
Minimum Value Minimum allowable input value.
Error Message Error message to be displayed if the input value exceeds the maximum value.

190
Validate Required Value
This action is usually used for any control that accepts input and ensures that the control has a
value. The action can be placed in the On Click event of a button among other places.
The following are the properties that need to be configured for the action.
Property Description
Control Name Name of the control to be validated.
Error Message Error message to be displayed if the control has no value.

Server Side Actions

Change Number Of Columns
You can use this action in the Before Select event of a Directory form to change the number of
output columns.
Property Description
Expression A code expression which returns the number of columns to be displayed in the
Directory form.

Convert Page to PDF

Descriptiion
This action is used to convert the HTML output of a page to PDF or other formats. The action
requires an external conversion application (program) and can be used only in the Before Output
event of non-includable pages. YesSoftware offers a PDF printer driver, which can be used for
such purposes on Windows servers.
The action is activated by specifying any non-empty value for the "Parameter Name" parameter in
page URL. For example if "Parameter Name" property is set to "_convert" then the URL containing
the string "?_convert=yes" or "&_convert=yes" will activate the action. When activated the action
will save the output of the HTML page into a temporary file on the server, then execute the
specified HTML conversion program. Finally, the action will assume that the conversion program
created another file on the server, which it will read and output to the Web browser.
The Internet user, such as IUSR or ASPNET should have sufficient privileges to execute the PDF
conversion program or printer driver, to create files in the temporary folder specified for the action.
The server must also not use pop-up blockers that would prevent the conversion program from
accessing Internet Explorer.
Properties
Property Description
Command The name of the executable program which will perform the HTML conversion.
Options Provides option values for the conversion program. It is assumed that the
conversion program would have options to specify the input HTML file and
output PDF file names. These file names are generated dynamically by the
action and passed to the conversion program.
You specify option values in a template format, by replacing the input file name
with {InputFile} and the output file name with {ResultFile}. You can also specify
{Root} as one of the options, in which case the action will also provide to the

191
 conversion program the server path used for resolving relative URLs in the input
file to the absolute ones.
Sample syntax specified in the Options property:
{InputFile} -f {ResultFile} -root {Root}

Parameter Name The name of the URL parameter which will activate the conversion action.
Temporary The path to be used for storing the temporary HTML and converted files. This
Folder parameter specifies the full server path, or the path relative folder to the current
page folder. If the property value begins with "%" the environment variable will
be used to specify the temporary folder path. For example specifying "%TEMP"
would set the temporary folder to the Windows environment variable named
"TEMP".

Custom Code
This action allows you to enter your own code to be executed when the event occurs.
//Custom Code @41-2A29BDB7
// -------------------------
// Write your own code here.
// -------------------------
//End Custom Code

Declare Variable
The Declare variable action is used to create and initialize a new variable of the specified type.
Property Description
Name Name of the variable. The name should conform to the variable naming conventions of
the language used. If PHP or Perl is used, the "$" sign will automatically be added to
the name of the variable in the code.
Type Type property is ignored for type less languages: ASP, PHP, etc. If the exact type of
the variable is not known, you can use the standard CodeCharge Studio data type
which will be converted to the closest type for the language used.
Initial Value or expression which will evaluate to a value to be assigned to the variable.
value

DLookup
Use this action to retrieve the value of a single database field or expression. The retrieved
database value is then used to set the value of a target variable.
Property Description
Expression Field or expression to be used in the SELECT clause of the SQL statement to be
executed.
Domain Table or view name to be used in the FROM clause of the SQL statement to be
executed.
Criteria Criteria to be used in the WHERE clause of the SQL statement to be executed.
Connection Connection from which the database value will be retrieved.

192
Convert Data type to which the retrieved value should be converted. The type specified must
result to comply with the nature of the value to be retrieved i.e. a string cannot be converted
to an integer. The possible data types are Text, Integer, Float, Date, Boolean and
Memo.
Type Of Type of variable which will receive the retrieved database value [Control, variable,
Target expression, session, application, cookie].
Target Name of the variable which will receive the retrieved database value.

Gallery Layout
This action is added into the Before Show Row event by the Gallery Builder and is used to control
visibility of 'RowOpenTag', RowComponents' and 'RowCloseTag' panels. These panels are also
automatically created by the Gallery Builder and allow for properly opening and closing table cells.
Gallery Layout action uses the value of "numberOfColumns" attribute, which is created by the
Gallery Builder as well, and later can be found in the "Attributes" property of the gallery grid.
The Gallery Layout action extends the functionality of a standard grid, so that it can display rows
horizontally. It is recommended to use the Gallery Builder to create proper grid that utilizes this
action and related elements.

Get Original Filename

Use this action to get the original filename of the uploaded file (i.e. without the prefix that is added
to ensure that the file name is unique). This action can be used to display the original file name to
the user.
The action can be used only in the Before Show event of the Label and Link controls.

Hide-Show Component
You can use this action to manage the visibility of the component based on the specified condition.
Property Description
Component The name of the component.
Name
Hide/Show Performed Action. The default value is 'Hide'.
Condition Type Specify the Type of calculated expression for the Action to be performed. Valid
values: Parameter, Expression. The default value is 'Parameter'.
Condition Comparison Condition. If 'true' the specified action will be performed.
Compare As Data type of compared parameters. This property is valid if the Condition Type is
'Parameter'. The default value is 'Text'.
Parameter1(2) Comparison parameters.
Name Parameter name or expression.
Source Type Parameter source. This property is valid if the Condition Type is 'Parameter'.
Format Format used for parameter parsing and formatting before comparison.

Login
The Login action is used to authenticate users after they submit their username and password.
Upon successful verification of user login credentials the action redirects the user to the return

193
page provided in the URL (if enabled in the action properties and the user was redirected here
from another page), or to the destination page specified in the "Return Page" property of the login
form. Additionally, when the Remember Me option is enabled included on the login form, and
selected by a user, the action also stores the encrypted user credentials in a cookie so that the
login process can be skipped in the future.
When building a login form, CodeCharge Studio automatically assigns the Login action to the On
Click (Server) event of the login button.
Login action properties:
Property Description
Login Control Name of the input field (textbox control) where the user will enter their
username.
Password Name of the input field (textbox control) where the user will enter their
Control password.
Auto Login Name of the checkbox control that enables the "remember me" option.
Control
Redirect To Prev Specifies whether the user should be redirected back to the page they wanted
Page to view before they were directed to the Login page.
See also
Logout action

Logout
This action works opposite of the Login action as it terminates the currently authenticated user
session. The action does this by clearing the values of session variables and the optional auto-
login cookie that hold details of the authenticated user.
The Logout action can be assigned to the After Initialize event of any page, either manually or by
invoking the "Authentication Builder". You can then execute the action and logout a user by calling
the page with a non-empty parameter specified in the action properties. For example if the
Parameter Name is set to "Logout" and the action is placed on the Login.php page, you'd logout
users by redirecting them to http://www.mywebsite.com/Login.php?Logout=true or
http://www.mywebsite.com/Login.php?Logout=yes, etc. You can also create a "Logout" link on
any page by configuring it to execute such URL.
Logout action properties:
Property Description
Parameter Name of a URL parameter which indicates that the Logout action should be
Name performed. If the parameter name is set, the Logout action is performed only if this
parameter is received.
Return Page Page to which the user is redirected after logging out.
Note: If there is no value entered into this property, then the redirect will not be
performed after logout.
Page If set to False the redirect is performed in this Action to the Return Page. If set to
Redirect True the redirect is performed after closing all connections and clearing the memory
on the page level.
Note for .NET users: As the .NET has an improved Garbage Collection
Mechamism all redirects are performed directly. Setting this property to True has no

194
 redirect effect.

See also
Login action

Print Text
Use this action to print out some variable or literal text to the screen.
Property Description
Expression Enter the variable or literal to be printed out. Literals such as strings must be properly
specified, i.e. within quotation marks in the case of a string literal.

Regular Expression Validation

This action is used to validate the value of a control based on a specified regular expression.
Property Description
Control Name Name of the control whose value is to be validated. If empty then the current
control is used.
Regular Regular expression to be used for validation.
Expression
Error Message Error message to be displayed if an invalid entry is made.

Retrieve Active Page

Specify this action to retrieve the active page within a Grid or Editable Grid form. The action can be
used only in the Before Show event of a control within a Grid or Editable Grid form. If the Grid or
the Editable Grid form is empty, a value of "1" is returned.

Retrieve Number Of Pages

Use this action to retrieve the number of available pages in a Grid or Editable Grid form. The
number of pages depends on the total number of records to be displayed and the number of
records displayed per page. The action can be used only in the Before Show event of a control
within a Grid or Editable Grid form such that the control will hold the retrieved number of pages.

Retrieve Number Of Records

Use this action to retrieve the total number of records to be displayed within a Grid or Editable Grid
form. The action can be used only in the Before Show event of a control within a Grid or Editable
Grid form such that the control will hold the retrieved number of records.

Retrieve Value for Control

This action is used to retrieve a value from a specified source and assigning it to a form control.
The retrieved value can be an expression, session, URL, form, application or cookie variable.

Property Description
Control The name of the control for which the value is specified.
Name

195
Source Type The type of the source from which the value is retrieved.
Possible values:
• Variable
• Expression
• URL
• Form
• Session
• Application
• Cookie
• Translation
Source The name of the source variable which contains the value to be assigned to the
Name form control.
For example if the URL contains "abc=123" then the value "123" can be retrieved by specifying the
"Source Name" = "abc". The value can be then assigned to a control (field) on the page.
See also
Using Action to Dynamically Translate Control Value

Retrieve Value For Variable

This action is used to set the value of a variable using another source which can be an expression,
session, URL, Form, application or cookie variable.
Property Description
Variable Name of the variable whose value will be set.
Name
Source Type Type of source from where the variable value will be retrieved [Expression, URL,
form, application, session or cookie].
Source Actual name of the source variable containing the value to be assigned to the
Name variable.

Save Control Value

This action is used to store a control value in another variable, session variable, application
variable or cookie.
Property Description
Control Name Name of the control whose value is to be saved.
Destination Type Type of the variable which will receive the value of the control.
Destination Name Actual name of the variable where the control value will be saved.

Save Variable Value

This action is used to store the value of a variable into another variable, session variable,
application variable or cookie.
Property Description

196
Variable Name Name of the variable whose value is to be saved.
Destination Type Type of the variable which will receive the value of variable being saved.
Destination Name Actual name of the variable where the value will be saved.

Send Email
The Send Email action is used in a Record form to send information based on the value of fields
within the form.
Property Description
From Name of a control which will provide the 'From' field of the email. If the value starts
with '=', then the expression coming after this symbol is used in it's literal form. For
example, the expression ="[email protected]" will strictly define the value
of the 'From' field as [email protected].
To Name of a control that will provide the 'To' field of the email. If the value starts with
'=', then the expression coming after this symbol is used in it's literal form.
Subject Name of a control that will provide the 'Subject' field of the email. If the value starts
with '=', then the expression coming after this symbol is used in it's literal form.
Message Name of a control which will provide the email's body. If the value starts with '=',
Body then the expression coming after this symbol is used in it's literal form.
HTML Format in which to send the email. If set to True, the massage is sent in HTML
format, otherwise it is sent as plain text.
SMTP Server Address of a SMTP server which will be used to send the email.
Messagebox Full path to the pickup directories for the SMTP service.
Path

Set Active Page

Use this action to set the active page of a Grid or Editable Grid form. The action can be used in the
Before Select event of the Grid or Editable Grid form.
Property Description
Expression Expression which returns the page number to be set.

Set Image Download Folder

This action can be used in the Before Show event of an image component to specify the location
of the folder where the image is located. Although the image download folder is usually specified in
the HTML, this action can be helpful to dynamically specify different folders for image files.
Property Description
Download The path to the image folder on the server, either absolute or relative to the current
Folder folder. A dynamic path can be specified in the form of the equal sign followed by a
function or variable, for example: =$FolderName

Set Link Destination Folder

197
This action can be used in the Before Show event of a link component to specify the location of the
destination file to be opened or downloaded via the link. Although the download folder is usually
specified in the HTML, this action can be helpful to dynamically point to files in different folders.
Property Description
Destination The path to the link's destination folder on the server, either absolute or relative to
Folder the current folder. A dynamic path can be specified in the form of the equal sign
followed by a function or variable, for example: =$FolderName

Set Number Of New Records

Use this action to set the number of empty rows to be used for adding new records in an Editable
Grid form. The action is used in the Before Select event of the Editable Grid form.
Property Description
Expression Expression that returns the number of empty rows to be used for adding new records.

Set Page Size

Use this action to set the page size of a Grid or Editable Grid form. The action is only used in the
Before Select event of the Grid or Editable Grid.
Property Description
Expression Expression that returns the number of records per page to be displayed in the Grid or
Editable Grid. This should be a positive integer or -1 if all records should be shown on
one page.

Set Row Style

The "Set Row Style" action can be use in the Before Show Row event of a grid and is used to
assign different styles to subsequent grid rows. A row within the grid will appear in a style different
from the preceding one until the last style in the predefined list is reached, at which time row styles
will be repeated again. For example a grid with two row styles will display two alternate rows, while
a grid with three row styles will display three alternate rows. This action can utilize inline CSS
syntax or an external CSS class to provide full flexibility for changing text size, font type, margin
width, background color, etc.
"Set Row Style" requires the corresponding grid to include an attribute, which should be placed in
the <tr> tag within the "Row" block of the grid.
For example:
<!-- BEGIN Row -->
<tr {ages:rowStyle}>
<td style="text-align:right;">{age_id}&nbsp;</td>
<td>{age_name}&nbsp;</td>
</tr>
<!-- END Row -->

Property Description
Attribute Name of grid's attribute that will be used for applying the style.
name
Row Styles Open the property dialog to maintain a list of alternating style classes or inline css

198
 styles.
The 'Row Styles' list can contain names of classes, style expressions or style attributes.

Additionally:
• A Row Style that doesn't contain symbols ":" and "=" is interpreted as a style class and the
corresponding attribute will be set to "class='[specifiedClassName]'".
• A Row Style that doesn't contain the symbol "=" but contains ":" is interpreted as a style
expression and the corresponding attribute will be set to
"style='[specifiedStyleExpression]'".
• A Row Style that contains the symbol "=" will be assigned to the attribute as is.

Sample list of Row Styles:

1. Row
2. AltRow
3. style="color: red"
4. font-weight: bold

The above example defines four alternating styles that will be applied to grid rows as follows:
Row #1 will use CSS class 'Row'.
Row #2 will use CSS class 'AltRow'.
Row #3 will use CSS style 'style="color: red"'.
Row #4 will use CSS style 'style="font-weight: bold"'.
Row #5 will use CSS class 'Row'.
Etc.

Set Tag
The Set Tag action is used to set the value of a template variable. This action cannot be used in
the non-template languages such as C#, JSP and ColdFusion without Templates.
Property Description
Tag Name Name of the template variable whose value is to be set.
Expression Expression that will be used to set the value of the tag.

Validate Email
This action is typically used in conjunction with input fields that receive text values. The action
ensures that the value entered is in the valid format of an email address. This action can only be
used in the On Validate event.
Property Description
Control Name of the control that will contain the email address.
Name
Error Error message to be displayed if the input value does not correspond with the
Message format of an email address.

Validate Maximum Length

199
This action is typically used in conjunction with input fields and serves to ensure that the value
entered in a field does not exceed a specified number of characters. This action can be used only
in the On Validate event.
Property Description
Control Name Name of the control to be validated.
Maximum Length Maximum allowable length of input in the control.
Error Message Error message to be displayed if the maximum length is exceeded.

Validate Maximum Value

This action is typically used in conjunction with input fields that receive numeric values. The action
ensures that the value entered is less than a specified maximum value. This action can only be
used in the On Validate event.
Property Description
Control Name Name of the control to be validated.
Maximum Value Maximum allowable input value.
Error Message Error message to be displayed if the input value exceeds the maximum value.

Validate Minimum Length

This action is typically used in conjunction with input fields and serves to ensure that the value
entered in a field is at least a specified number of characters long. This action can only be used in
the On Validate event.
Property Description
Control Name Name of the control to be validated.
Minimum Length Minimum allowable length of input in the control.
Error Message Error message to be displayed if the input is less than the minimum length.

Validate Minimum Value

This action is typically used in conjunction with input fields that receive numeric values. The action
ensures that the value entered is more than a specified minimum value. This action can only be
used in the On Validate event.
Property Description
Control Name Name of the control to be validated.
Minimum Value Minimum allowable input value.
Error Message Error message to be displayed if the input value is less than the minimum value.

Validate Phone
This action is typically used in conjunction with input fields that receive text values. The action
ensures that the value entered corresponds with the specified phone number format. This action
can only be used in the On Validate event.
Property Description

200
Control Name Name of the control to be validated.
Format Phone number format used for validation. Default value is (000) 000-0000.
Error Error message to be displayed if the input value does not match the phone number
Message format.

Validate Required Value

This action is can be used for any control that accepts input and ensures that the control has a
value. This action can only be used in the On Validate event.
Property Description
Control Name Name of the control to be validated.
Error Message Error message to be displayed if the control has no value.

Validate ZIP
This action ensures that the value entered in an input control corresponds with a specified ZIP
code format. This action can only be used in the On Validate event.
Property Description
Control Name Name of the control to be validated.
Format Format used for the validation. Default value is 00000.
Error Message Error message to be displayed if the input value does not match the ZIP format.

Programming Reference
ASP
Functions
CCAddParam Function (ASP)
Description
Add the parameter with specified value into the GET query string. If the parameter with given
name exist its value will be changed for ParameterValue.
Syntax
CCAddParam(QueryString, ParameterName, ParameterValue)

Return value
String
Parameters
Name Type Description Required
QueryString String Query string to which the parameter is added. Yes

201
ParameterName String Name of the parameter. Yes
ParameterValue Variant Value of the parameter. Yes
See also:
CCRemoveParam function
CCDLookUp Function (ASP)
Description
Looks up a value from the database by executing a database query against a connection. It
queries a database table based on a specified filter and returns the value of the first retrieved field.
Syntax
CCDLookUp(ColumnName, TableName, Where, Connection)

Return value
variant
Parameters
Name Type Description Required
ColumnName string Database expression to evaluate. In most cases a Yes
field name.
TableName string Name of the database table or view to query. Yes
Where string WHERE clause to filter the returned records. Yes
Connection clsDB<name> Connection object to use for executing the query. Yes
object
Example 1
This code would usually be placed in the Before Show event of a Record form.

if tasks.EditMode then
tasks.user_id_assign_by.Value = CCDLookUp("emp_name", "employees", "emp_id="
&_
DBIntranetDB.ToSQL(tasks.user_id_assign_by.Value, ccsInteger) ,
DBIntranetDB)
else
tasks.user_id_assign_by.Value = CCDLookUp("emp_name", "employees", "emp_id="
&)_
DBIntranetDB.ToSQL(CCGetUserID(), ccsInteger), DBIntranetDB)
end if

Example 2
The following code uses the CCDLookUp function to lookup the sender's name and email address,
and the receiver's email address for sending an email using the ASPEmail component. This code
would usually be placed in the After Insert event of a Record form.

Dim Mailer

202
 Set Mailer = Server.CreateObject("Persits.MailSender")
Mailer.From = CCDLookUp("email", "employees", "emp_id=" &_
DBIntranetDB.ToSQL(CCGetUserID(), ccsInteger), DBIntranetDB)
Mailer.FromName = CCDLookUp("emp_name", "employees", "emp_id=" &_
DBIntranetDB.ToSQL(CCGetUserID(), ccsInteger), DBIntranetDB)
Mailer.AddAddress = CCDLookUp("email", "employees", "emp_id=" &_

DBIntranetDB.ToSQL(tasks.user_id_assign_to.Value, ccsInteger),
DBIntranetDB)
Mailer.Host = "mysmtphost.com"
Mailer.IsHTML = True
Mailer.Subject = "New task for you"
Mailer.Body = "A new task was assigned to you. "
Mailer.Send
set Mailer = Nothing

CCFormatDate Function (ASP)

Description
Formats a date value according to the specified format mask.
Syntax
CCFormatDate(DateToFormat,FormatMask)

Return value
String
Parameters
Name Type Description Required
DateToFormat Date Date value to format. Yes
FormatMask Array of Each string is one of the following components (all other Yes
strings components are left unchanged when building formatted
value):
d day
w week
m month
q quarter
y day of the year
h hour in 12-hour format
H hour in 24-hour format
n minute
s second
dd zero-filled day
ww week of year

203
 mm zero-filled month
yy two-digit year
hh zero-filled hour in 12-hour format
HH zero-filled hour in 24-hour format
nn zero-filled minute
ss zero-filled second
ddd short weekday name
mmm short month name
A/P A or P according to AM/PM
a/p a or p according to AM/PM
dddd weekday name
mmmm month name
yyyy year
AM/PM AM or PM
am/pm am or pm
LongDate long date format
LongTime long time format
ShortDate short date format
ShortTime short time format
GeneralDate general date format

Example

CCFormatDate(CDate("2002-05-01"),array("LongDate")) -> "May 1, 2002"

CCFormatDate(CDate("2002-05-01 20:12"),array("mmm"," ","d",", time is
","hh",":","nn","","AM/PM")) -> "May 1, time is 8:12 PM"

CCGetFromGet Function (ASP)

Description
Retrieves a value of the GET input parameter. If there is no value returned, the function returns the
default value specified in the function call.
Syntax
CCGetFromGet(ParameterName, DefaultValue)

Return value
String
Parameters
Name Type Description Required
ParameterName String Name of the parameter to retrieve. Yes
DefaulfValue Variant Value to return if parameter is not set. Yes

204
See also:
CCGetParam function,
CCGetFromPost function
CCGetFromPost Function (ASP)
Description
Retrieves a value of the POST input parameter. If there is no value returned, the function returns
the default value specified in the function call.
Syntax
CCGetFromPost(ParameterName, DefaultValue)

Return value
String
Parameters
Name Type Description Required
ParameterName String Name of the parameter to retrieve. Yes
DefaulfValue Variant Value to return if parameter is not set. Yes
See also:
CCGetParam function,
CCGetFromGet function
CCGetGroupID Function (ASP)
Description
Retrieves the security group ID value of the currently logged in user.
Syntax
CCGetGroupID()

Return Value
Integer
CCGetParam Function (ASP)
Description
Retrieves a value of the GET or POST input parameter. The function first attempts to retrieve the
parameter from the GET query string and if no value is returned, then the function checks for a
POST input parameter with the same name. If no value is returned by a GET or POST input
parameter, the function returns the default value specified in the function call.
Syntax
CCGetParam(ParameterName, DefaultValue)

Return value
String
Parameters
Name Type Description Required

205
ParameterName String Name of the parameter to retrieve. Yes
DefaulfValue Variant Value to return if parameter is not set. Yes
Example 1
This code would usually be placed in the After Initialize event of a Page.

If NOT IsEmpty(CCGetParam("Logout", Empty)) Then

CCLogoutUser
Redirect = "Login.asp"
End If

Example 2
The following code disables record updates if a task is not assigned to the current user.
CCGetParam function is used to retrieve the current task id from the GET or POST data being
submitted. This code would usually be placed in the Before Update event of a Record form.

Dim current_task
Dim assigned_user
current_task = CCGetParam("task_id", Empty)
assigned_user = CCDLookUp("user_id_assign_to", "tasks", "task_id=" &_
DBIntranetDB.ToSQL(current_task, ccsInteger), DBIntranetDB)
if current_task <> 0 and CCGetUserID <> assigned_user Then
tasks.UpdateAllowed = False
end if

See also:
CCGetFromGet function,
CCGetFromPost function
CCGetUserID Function (ASP)
Description
Retrieves the primary key value that uniquely identifies the currently logged in user.
Syntax
CCGetUserID()

Return Value
String
Example 1
This code would usually be placed in the Before Show event of a Record form.

If tasks.EditMode Then
tasks.user_id_assign_by.Value = CCDLookUp("emp_name", "employees", "emp_id="
&_
DBIntranetDB.ToSQL(tasks.user_id_assign_by.Value, ccsInteger),
DBIntranetDB)

206
 Else
tasks.user_id_assign_by.Value = CCDLookUp("emp_name", "employees", "emp_id="
&_
DBIntranetDB.ToSQL(CCGetUserID(), ccsInteger), DBIntranetDB)
End if

Example 2
The following code uses the CCGetUserID function to lookup the current user's name and email
address which is then used for sending an email using the ASPEmail component.
This code would usually be placed in the After Insert event of a Record form.

Dim Mailer
Set Mailer = Server.CreateObject("Persits.MailSender")
Mailer.From = CCDLookUp("email", "employees", "emp_id=" &_
DBIntranetDB.ToSQL(CCGetUserID(), ccsInteger), DBIntranetDB)
Mailer.FromName = CCDLookUp("emp_name", "employees", "emp_id=" &_
DBIntranetDB.ToSQL(CCGetUserID(), ccsInteger), DBIntranetDB)
Mailer.AddAddress = CCDLookUp("email", "employees", "emp_id=" &_
DBIntranetDB.ToSQL(tasks.user_id_assign_to.Value, ccsInteger) ,
DBIntranetDB)
Mailer.Host = "mysmtphost.com"
Mailer.IsHTML = True
Mailer.Subject = "New task for you"
Mailer.Body = "A new task was assigned to you. "
Mailer.Send
set Mailer = Nothing

CCGetValue Function (ASP)

Description
Retrieves the specified field value from the current row of a recordset.
Syntax
CCGetValue(RecordSet,FieldName)

Return Value
String
Parameters
Name Type Description Required
RecordSet ADODB.Recordset Recordset to retrieve the value from. Yes
FieldName String or Integer Field name or field index whose value is to be Yes
retrieved.

CCOpenRS Function (ASP)

Description
Opens a new recordset based on a specified SQL query.

207
Syntax
CCOpenRS(RecordSet,SQL, Connection,ShowError)

Parameters
String (error message)
Parameters
Name Type Description Required
RecordSet Variant (ADODB.Recordset after call) Variable in which the recordset Yes
will be returned.
SQL String The SQL query to be used to Yes
select records for the recordset.
Connection ADODB.Connection or Connection object to execute the Yes
clsDB<name>.connection object query against.

CCParseDate Function (ASP)

Description
Parses the specified date string into a date value according to the specified date format.
Syntax
CCParseDate(ParsingDate,FormatMask)

Return value
Date
Parameters
Name Type Description Required
ParsingDate String Date to parse. Yes
FormatMask Array of strings (see CCFormatDate for Format mask to parse the Yes
available patterns) date with.
Example
CCParseDate("2002 May 1",array("yyyy"," ","mmm"," ","d")) -> #2002-05-01#

CCProcessError Function (ASP)

Description
Returns a text description of the last error for the current connection or 'Empty' if the error
collection is empty.
Syntax
CCProcessError(Connection)

Return value
208
String
Parameters
Name Type Description Required
Connection ADODB.Connection or Connection object to get Yes
clsDB<name>.connection object the errors.

CCRemoveParam Function (ASP)

Description
Removes a parameter from the GET query string.
Syntax
CCRemoveParam(QueryString, ParameterName)

Return value
String
Parameters
Name Type Description Required
QueryString String Query string from which the parameter is removed. Yes
ParameterName String Name of the parameter to remove. Yes
See also:
CCAddParam function
IIf Function (ASP)
Description
Evaluates an expression and returns one of two results, depending on whether the expression is
True or False.
Syntax
IIf(Expression,TrueResult,FalseResult)

Parameters
Name Type Description Required
Expression Boolean Expression to be evaluated. Yes
TrueResult Variant Result to be returned if the expression is True. Yes
FalseResult Variant Result to be returned if the expression is False. Yes
Example
IIf(2>1,"yes","no") -> "yes"

Methods
AddComponents Run-Time Method (ASP)
Applies to
Panel

209
Syntax
object.AddComponents(Components)

Parameters
Name Type Description Required
Components Array Array contains components. Yes
Description
This method binds components to the panel object.
Example
Panel1.AddComponents(Array(Label1,TextBox1,Grid1))

Close Method (ASP)

Applies to
Connection Object
Syntax
<connection>.Close

Description
This method closes a database connection and releases its resources. This method should always
be called after a currently open database connection is no longer needed. However, this should be
done with connections that were created manually only or if page processing is finished because
of user's redirection for instance.
Examples
This example closes database connection and redirects to a root website URL. This may be used
if some fatal page requirement is not met (required parameter for instance).
It assumes connection is called Connection1.
DBConnection1.Close
Response.Redirect "/"
Response.End

See also
Redirect Variable
Before Unload Event
Execute Method (ASP)
Applies to
Connection Object
Syntax
<connection>.Execute query
Set <recordset> = <connection>.Execute(query)

Return value
ADODB.Recordset
Parameters
Name Type Description Required

210
query string or String containing an SQL query to be executed Yes
ADODB.Command against the database or an ADODB.Command object
object to execute.
Description
This method executes a specified SQL query against the database connection.
The first syntax shown above is used when the query will not return a recordset (e.g.
INSERT/UPDATE/DELETE queries). The second syntax is used when the query will return a
recordset object (e.g. SELECT query).
Examples
The following example opens a custom recordset to build a list of groups the user belongs to
(comma-separated). Recordset is iterated, string built and assigned to record's label control.
It assumes groups and group_users tables exist. Connection is called Connection1. UserProfile
form and UserGroups label are assumed to exist. This code may be inserted into label's Before
Show event.
Dim rsGroups
Dim strGroups
Dim SQL
strGroups = ""
SQL = "SELECT group_name FROM group_users gu LEFT JOIN groups g ON gu.group_id
= g.group_id "&_
"WHERE gu.user_id = " & DBConnection1.ToSQL(CCGetUserID(),ccsInteger)
Set rsGroups = DBConnection1.Execute(SQL)
While rsGroups.EOF
strGroups = IIf(strGroups = "", rsGroups("group_name"), ", " &
rsGroups("group_name"))
rsGroups.MoveNext
Wend
UserProfile.UserGroups.Value = strGroups

See also
DataSource.SQL Property
GetEvents Method (ASP)
Applies to
Calendar Form
Syntax
Set ev = object.GetEvents DateEvents

Return value
object
Parameters
Name Type Description Required
DateEvents date Specifies the date for which the events should be returned. Yes
Description
This method returns calendar events for the specified date.

211
Examples
The following example shows how to retrieve events for current date.
Dim DayEvents
Set DayEvents = Calendar1.GetEvents(Calendar1.CurrentProcessingDate))
If DayEvents Is Nothing Then
Calendar1.label1.Value=""
Else
Calendar1.label1.Value=DayEvents.Count

End If

See also
CalendarSetEvent
GetOriginFileName Method (ASP)
Applies to
FileUpload Control
Syntax
object.GetOriginFileName

Description
This method retrieves the original file name of an uploaded file (i.e. without the prefix that is added
to ensure that the file name is unique).
This function can be used to display the original file name to the user or construct alternative save
names.
Examples
The following example constructs an uploaded file download link with a specific label containing
original file name and size.
It assumes the form is named Form1 and the upload control is named FileUpload1.
DownloadLink is a link control.

If Form1.FileUpload1.IsUploaded Then
Form1.DownloadLink.Link = Form1.FileUpload1.Value
Form1.DownloadLink.Value = "download " &
Form1.FileUpload1.GetOriginFileName(Form1.FileUpload1.Value) & " [" &
Form1.FileUpload1.FileSize & "]"
End If

See also
Value Property
FileFolder Property
Get Original Filename Action
Open Method (ASP)
Applies to
Connection Object
Syntax

212
 <connection>.Open

Description
This method establishes a database connection. If the user creates a custom connection object,
this method should be called to initialize the database connection.
Examples
This example creates a custom connection.
Dim customConn
customConn.ConnectionString = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" &
Server.MapPath("database.mdb")
customConn.Open

See also
ConnectionString Property
SetEvent Method (ASP)
Applies to
Calendar Form
Syntax
object.SetEvent DateEvent, CalendarEvent

Parameters
Name Type Description Required
DateEvent date Specifies the date of the event Yes
CalendarEvent object Specifies a event. Yes
Description
This method adds a new event to the Calendar events collection.
See also
CalendarEvents
SetVar Methods (ASP)
Applies to
Template object
Syntax
<object>.SetVar VariableName,Value

Return value
None
Parameters
Name Type Description Required
VariableName string Specifies the template block or variable name in the template file Yes
bound to the template object.
Value string Specifies a value that should replace the template block or Yes
variable provided as the first argument.

213
Description
This method replaces a template block or a variable defined in the template file with the value
provided as the second argument. A template variable is an identifier surrounded by curly braces
(i.e. {templ_variable}. A template block is a part of the template file surrounded by two special
HTML comments. One that starts the block: <!-- BEGIN block_name --> and the other that ends
the block: <!-- END block_name -->.
Note: If there are multiple template blocks or variables with the same name, SetVar will replace all
of them with the same value.
ToSQL Method (ASP)
Applies to
Connection Object
Syntax
<connection>.ToSQL(Value, DataType)

Return value
string
Parameters
Name Type Description Required
Value any A value to be converted Yes
to SQL compatible
format.
Data The data type the value will be converted to. You Desired data type. Yes
Type can use any of the predefined constants: ccsDate,
ccsBoolean, ccsInteger, ccsFloat, ccsText,
ccsMemo
Description
This method converts values to the specified data type in order to make them SQL compatible.

Run-Time Properties
AllowedFileMasks Run-Time Property (ASP)
Applies to
FileUpload Control
Type
string
Access
read/rite
Syntax
object.AllowedFileMasks [= value]

Description
Specifies a list of file masks (separated with semicolon) that are allowed by the FileUpload
component. If a user tries to upload a file with a mask that matches one of the masks specified in
this property, the file will be uploaded (unless the mask is also listed in the DisallowedFileMasks
property). Otherwise, the upload will fail and an error message will be displayed. The

214
AllowedFileMasks property corresponds to the "Allowed File Masks" Design-Time property of the
FileUpload component.
Example
The AfterInitialize event procedure shown below alters the AllowedFileMasks property for
logged and not logged in users. Anonymous users are allowed to upload only text files (txt), logged
in users may upload any file.

Function Page_AfterInitialize()

If CCGetUserID() = Empty Then

attachments.fu.AllowedFileMasks = "*.txt"

Else
attachments.fu.AllowedFileMasks = "*"
End if

End Function

See also
DisallowedFileMasks Property
CalendarStyles Run-Time Property (ASP)
Applies to
Calendar Form
Type
dictionary
Access
read/write
Syntax
object.CalendarStyles

Description
Contains the calendar styles that depend on the builder settings.
Note: This property can be modified in the Before Show event.
Examples
The following example shows how to change some styles.
Calendar1.CalendarStyles("Day") = "class = 'CellWithBlackText'";
Calendar1.CalendarStyles("Today") = "class = 'CellWithRedText'";

See also
CurrentStyle property
Components Run-Time Property (ASP)
Applies to
Panel
Type
dictionary

215
Access
read/write
Syntax
object.Components

Description
Contains all children of the current panel. Can be used to iterate through all children.
Example
The following example iterates through panel controls and sets their Visible property to False.
Dim Ctrl, Key
For Each Key in Panel1.Components
Set Ctrl = Panel1.Components(Key)
Ctrl.Visible = False
Next

Connection Run-Time Property (ASP)

Applies to
Connection Object
Type
object (ADODB.Connection)
Access
Read-only
Syntax
object.Connection.<member>...

Description
Retrieves ADO Connection object used to access underlying database. This object can be used to
perform some low-level database operations not exposed by wrapping Connection Object. They
may include extracting some database-specific settings and attributes or starting and closing
transactions for instance.
For complete listing of properties and methods for this object refer to ActiveX Data Objects
Reference available from Microsoft's website.
Examples
The following ADO Connection object's methods can be used to start transaction, rollback it or
commit the results. Transaction is a set of database operations that have to be executed as a
whole, if one fails previous ones should be reverted.

DBInternetDB.Connection.BeginTrans
DBInternetDB.Connection.RollbackTrans
DBInternetDB.Connection.CommitTrans

Note: Some database types or drivers may not support transactions

See also
Execute Method
ConnectionString Property

216
ConnectionString Run-Time Property (ASP)
Applies to
Connection Object
Type
string
Access
read/write
Syntax
object.ConnectionString [=value]

Description
This property contains connection string used to establish database connection. This string
includes connection type, user credentials, database name or path and some other parameters.
The connection string is passed to ADO Connection object when opening.
This property can be modified if some database connection properties are determined during run-
time.
For complete connection string syntax refer to ActiveX Data Objects Reference available from
Microsoft's website.
Note: For property change to take effect connection object has to be closed and reopened.
Examples
This example modifies connection's ConnectionString property to use MS Access driver and
database path extracted from a session variable.
DBConnection1.ConnectionString = "Provider=Microsoft.Jet.OLEDB.4.0;Data
Source=" & Session("DatabasePath")
DBConnection1.Close
DBConnection1.Open

See also
Connection Property
CurrentDate Run-Time Property (ASP)
Applies to
Calendar Form
Type
date
Access
read/write
Syntax
object.CurrentDate [= value]

Description
Specifies the date shown in the calendar. For example, for the Monthly calendar the date can be
any date of this month.
Note: The value of this property can be modified in the Page's Before Show event.
Examples
217
The following example shows how to make the calendar always show January 2005.

Calendar1.CurrentDate = DateSerial(2005, 1, 1)

CurrentProcessingDate Run-Time Property (ASP)

Applies to
Calendar Form
Type
date
Access
read
Syntax
object.CurrentProcessingDate

Description
Specifies the current processing date. The value of this property can be modified in the Before
Show Day, Before Show Week, Before Show Month, and Before Show events.
See also
PrevProcessingDate property,
NextProcessingDate property
CurrentStyle Run-Time Property (ASP)
Applies to
Calendar Form
Type
string
Access
read/write
Syntax
object.CurrentStyle [= value]

Description
Contains the calendar style of the currently processed block.
Note: The value of this property can be modified in the Before Show Day, Before Show Week,
Before Show Month, and Before Show events.
Examples
The following example shows how to change style.
Calendar1.CurrentStyle = "class = 'CellWithBlackText'"

See also
CalendarStyles property
DataSource Run-Time Property (ASP)
Applies to

218
Grid Form, ListBox Control, RadioButton Control, CheckboxList Control, Navigator Control, Record
Form, EditableGrid Form, Directory Form, Path Form
Type
Data Source Object
Access
read/write
Syntax
object.DataSource [= value]

Description
This property stores reference to data source bound to the specified object. Data source handles
all data retrieval and update operations. It serves as an abstraction layer that hides underlying data
source details, whether it is a database, a list of values or even a web service. It is common to use
this property to access field values from within bound objects. DataSource object provides
properties (i.e. SQL, Where, Order) that can be used to modify the SQL query that is executed in
order to provide data for the object.
Examples
This example shows how the SQL property of the DataSource object can be modified to alter the
list of values extracted from the database.
Note: the syntax used to concatenate two fields (firstname and lastname) into the name field is not
recognized by the standard of SQL language (here it is used for Access database only).
Function customers_DataSource_BeforeBuildSelect()

customers.DataSource.Sql = "SELECT customer_id, (firstname & ' ' & lastname)

AS name, city FROM customers"

End Function

See also
Connection Property
DataSource.SQL
DataSource.Where
DataSource.Order
Related Examples
Dynamically Modify the SQL Statement
Dynamically Modify the WHERE Clause
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox
Dynamically Modify the ORDER BY Clause
DataSource.CountSQL Run-Time Property (ASP)
Applies to
DataSource Object
Type
string
Access
read/write
Syntax

219
 object.DataSource.CountSQL [=value]

Description
Stores the main part of the SQL query that is used to find the number of records fetched by
DataSource object.
This property does not include the WHERE clause. Before the query is executed, conditions from
the Where and WhereParameters properties are used instead.
Note: The usual content of this property includes the COUNT aggregate function: SELECT
COUNT(*) FROM ...
See Also
DataSource.SQL Property
DataSource.Where Property
Recordset.RecordCount Property
DataSource.Order Run-Time Property (ASP)
Applies to
DataSource object
Type
string
Access
read/write
Syntax
object.DataSource.Order [=value]

Description
This property holds the list of fields that are used in the ORDER BY clause of the SELECT query.
CCS initializes this property internally, for example if an order option has been specified in the
properties of the form. Modification of this field (before the query is executed) will change the order
of the results.
Example
The sample code below assigns default sorting field to the Order property if the property has not
been initialized earlier.
Function Page_AfterInitialize()
If articles.DataSource.Order = Empty Then
articles.DataSource.Order = "date_add"
End if
End Function

See also
DataSource.SQL property
DataSource.Where property
Related Examples
Dynamically Modify the ORDER BY Clause
DataSource.SQL Run-Time Property (ASP)
Applies to
DataSource object
Type
220
string
Access
read/write
Syntax
object.DataSource.SQL [=value]

Description
This property stores the main part of a query that retrieves data for the form. The main part usually
includes the actual SQL command (SELECT), list of fields to be retrieved and a list of tables from
which the data will be retrieved (FROM).
The SQL query is eventually built as concatenation of SQL, Where and Order properties.
To modify the SQL property (alter the SQL query), you should use the BeforeBuildSelect event
procedure of the form.
Examples
This example shows how the SQL property of the DataSource object can be modified to alter the
list of values extracted from the database.
Note: The syntax used to concatenate two fields (firstname and lastname) into the name field is not
recognized by the standard of SQL language (here it is used for Access database only).
customers.DataSource.SQL = "SELECT customer_id, (firstname & ' ' & lastname) AS
name, city FROM customers"

See also
DataSource property
DataSource.Where property
DataSource.Order property
DataSource.Where Run-Time Property (ASP)
Applies to
DataSource Object
Type
string
Access
read/write
Syntax
object.DataSource.Where [=value]

Description
This property stores all conditions that are eventually used in the WHERE clause of a query that
selects, updates or deletes data from the database. Programmers can add their own conditions
(preserving the SQL syntax) in one of the events triggered before the final query is built and
executed (i.e. BeforeBuildSelect, BeforeBuildDelete, BeforeBuildUpdate).
See also
DataSource.SQL property
DataSource.Order property
Related Examples

221
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox
Dynamically Modify the WHERE Clause
Retrieve Values From a Multi-Select ListBox
DeleteAllowed Run-Time Property (ASP)
Applies to
Record Form, EditableGrid Form
Type
Boolean
Access
read/write
Syntax
object.DeleteAllowed [= value]

Description
This property contains a Boolean value that determines if the form has record delete operation
enabled. This affects Delete button displaying and database delete operations.
If security is configured for the site and the form's Restricted property has been set to "Yes", the
default delete operation permission depends on current user's group permissions. If Restricted
property is set to “No” then DeleteAllowed property is set to True unless modified in Before Delete
event event.
This property may be set according to a custom permissions checking scheme to enable or disable
delete record operation. The delete button is hidden only if the value is set before the form's
Before Show event (for instance in the parent component). Requested delete operation may be
cancelled in Before Delete event if the DeleteAllowed property is set to false.
Examples
The following example checks if the order record that is requested to be removed belongs to the
currently logged in user. If it does, the operation is carried out. Otherwise, the delete database
operation is not performed.
The example assumes DeleteOrder form exists and user_id hidden field to store the owner's
identifier is inserted. This code may be inserted into Before Delete event.
If DeleteOrder.user_id.Value = CCGetUserID() Then
DeleteOrder.DeleteAllowed = True
Else
DeleteOrder.DeleteAllowed = False
End If

See also
Before Delete Event
ReadAllowed Property
InsertAllowed Property
UpdateAllowed Property
DisallowedFileMasks Run-Time Property (ASP)
Applies to
FileUpload Control
Type

222
string
Access
read/write
Syntax
object.DisallowedFileMasks [= value]

Description
Specifies a list of file masks (separated by semicolons) that are not allowed by the FileUpload
component. File mask item may contain * and ? characters for matching any characters.
If a user provides a file with a name that matches one of the masks specified in this property, the
file will not be uploaded and an error message will be displayed. The verification is performed
during control validation, before calling the control's On Validate event. The result of the check
may be reset during this event.
The DisallowedFileMasks property corresponds to the "Disallowed File Masks" Design-Time
property of the FileUpload component.
Note: The DisallowedFileMasks property has higher priority than AllowedFileMasks property. In
other words, if a mask is mentioned in both properties (AllowedFileMasks and
DisallowedFileMasks) the upload will fail.
Examples
The following example resets disallowed file masks if the user's security level is higher than 1.
Otherwise, HTML, ASP and ZIP files are restricted.
If CCGetGroupID() > 1 Then
Record1.FileUpload1.DisallowedFileMasks = ""
Else
Record1.FileUpload1.DisallowedFileMasks = "*.html;*.asp;*.zip"
End If

See also
OnValidate event
AllowedFileMasks property
EditMode Run-Time Property (ASP)
Applies to
Record Form, EditableGrid Form
Type
Boolean
Access
read-only
Syntax
object.EditMode

Description
This property determines whether given record form is currently in edit or insert mode. In edit
mode all data source parameters need to have values assigned (including row identifier). In insert
mode some data items may be empty.
See also

223
Errors property
Example
The following code (placed in the OnValidate event procedure ) checks the state of the
modified_by form field and generates an error message if the field is empty. Thanks to the
EditMode property, custom verification takes place only if the record is updated (not inserted).
Function articles_OnValidate()

If articles.EditMode and IsEmpty(articles.modified_by.Value) Then

articles.Errors.AddError("The modified_by field cannot be empty when
updating.")
End if

End Function

EmptyRows Run-Time Property (ASP)

Applies to
EditableGrid Form
Type
number
Access
read/write
Syntax
object.EmptyRows [=value]

Description
Specifies the number of empty rows displayed at the bottom of the editable grid. Each empty row
allows the user to insert a new record into the database. The more empty rows, the more records
can be inserted at once.
Users may modify this property to change the number of empty rows according to their
preferences, or to display a constant number of rows (editable and empty ones) on the form.
Examples
The following code sets the number of empty rows according to session variable that stores the
preferred number of insertable rows. This code should be placed in editable grid's Before Show
event.
Dim RowsNum
RowsNum = Session("NoRowsToInsert")
If IsNumeric(RowsNum) AND NOT IsEmpty(RowsNum) Then
InvoiceRowsGrid.EmptyRows = RowsNum
Else
InvoiceRowsGrid.EmptyRows = 1
End If

EmptyText Run-Time Property (ASP)

Applies to
ReportLabel Control

224
Type
string
Access
read/write
Syntax
object.EmptyText

Description
Specifies the text to be output when the label value is empty.
Example
ReportLabel1.EmptyText = "xxx"

ErrorMessages Run-Time Property (ASP)

Applies to
EditableGrid Form
Type
array of strings
Access
read/write
Syntax
object.ErrorMessages(<index>) [=value]

Description
This property is used to collect error messages from all rows of the editable grid. The index of the
ErrorMessages array corresponds to the row number in the editable grid (on the given page).
Messages are inserted to the table while each row values are validated. If the validation is
successful (all data is correct) - the property is empty, otherwise its content is used to display error
messages above the rows that did not pass the validation.
Users may modify this array by either resetting existing messages or replacing the existing with
custom ones. Either grid's Before Show or On Validate events can be used for this modification.
Examples
The following code replaces all specific validation error messages in the editable grid with plain
"This line needs to be corrected".
Dim i
For i = 1 To UBound(OrderItems.ErrorMessages)
If Not IsEmpty(OrderItems.ErrorMessages(i)) Then
OrderItems.ErrorMessages(i) = "This line needs to be corrected"
End If
Next

See also
Errors property
OnValidate event
Errors Run-Time Property (ASP)

225
Applies to
Label Control, TextBox Control, TextArea Control, Checkbox Control, Image Control, ImageLink
Control, DatePicker Control, Hidden Control, Connection Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, EditableGrid Form, Path Control,
Directory Control, FileUpload Control
Type
object (clsErrors)
Access
read-only
Syntax
object.Errors.<member>...

Description
This property keeps the reference to the object's errors collection. This collection is used to collect
error messages generated during the object's execution.
Errors collection exposes three important members:
Member Description
Errors.Count This property returns the number of errors the collection contains. It
can be used for testing if the collection is empty or contains any
error messages.
Errors.AddError <message> This method adds specified error message to the collection. It can
be used to insert error messages when performing custom
validation.
Errors.Clear This method resets the collection removing all previously added
error messages. It can be used to force successful form submit
processing despite validation errors or to clear error messages
before replacing them with custom ones.
Examples
The following code checks if the errors collection is empty. If there are any error messages, all of
them are replaced with a customized one.
The code assumes OrderForm form exists on the page. This code may be inserted into On
Validate event.
If OrderForm.Errors.Count > 0 Then
OrderForm.Errors.Clear
OrderForm.Errors.AddError "This order cannot be processed. Please fix it."
End If

See also
On Validate event
Related Examples
Using the Control Validation event
Using the Form Validation event
Retrieve Multiple Field Values from a Database
Events Run-Time Property (ASP)

226
Applies to
Calendar Form
Type
object
Access
read/write
Syntax
object.Events

Description
Contains the calendar events. This value can be manually modified.
Note: The value of this property can be also modified in Before Show event.
Examples
The following example shows how to add new event.
Dim CustomEvent, CustomEventDateTime
Set CustomEvent = New clsEventCalendar1
CustomEventDateTime = DateSerial(2005, 10, 31)
CustomEvent.EventTime = TimeSerial(12, 30, 0)
CustomEvent.EventDescription = "Some text"
AddEvent CustomEventDateTime, CustomEvent

FileFolder Run-Time Property (ASP)

Applies to
FileUpload Control
Type
string
Access
read/write
Syntax
object.FileFolder [=value]

Description
Specifies a folder on the web server where uploaded files will be eventually stored. The initial
value of this property comes from the "File Folder" design-time property of the FileUpload
component.
This property may be used to specify different target folders for keeping different file types or to
sort uploads in different folders for different users. The property should be set in Before Process
File event.
Note: The property's value is set only if the pointed folder exists. Absolute filesystem paths should
be used to avoid context ambiguities. Server.MapPath method can be used to determine the
absolute folder path.
Examples
The following example checks if the uploaded file extension is JPG. If so, the file will be saved into
images subdirectory. Otherwise, the file will saved into uploads subdirectory.
227
The code assumes Form1 form exists and it contains FileUpload1 control. This code can be
inserted into control's Before Process File event.
If UCase(Right(Form1.FileUpload1.Value, 4)) = ".JPG" Then
Form1.FileUpload1.FileFolder = Server.MapPath("./images/")
Else
Form1.FileUpload1.FileFolder = Server.MapPath("./uploads/")
End If

See also
TemporaryFolder property
Value property
Before Process File event
FileName Run-Time Property (ASP)
Applies to
CalendarNavigator
Type
String
Access
read/write
Syntax
object.FileName [=value]

Description
Specifies the URL of the page to which the navigator is linked.
Note 1: This property can be used in the Before Show event of the CalendarNavigator or Calendar
components.
Note 2: The value of this property contains/specifies only the file name (without paramemters).
FileSize Run-Time Property (ASP)
Applies to
FileUpload Component
Type
number
Access
read-only
Syntax
object.FileSize

Description
Specifies the size (in bytes) of the file that has been uploaded to the server. Value of this property
is set while the file is processed by the server and it is used later on to verify if the size of the file is
not greater than the specified file size limit (held in the FileSizeLimit property).
Example
The following AfterProcessFile event procedure adds the file size value (as the GET parameter)
to the redirection URL (see the Redirect variable reference):

228
 Function attachments_fu_AfterProcessFile()

Redirect = Redirect & "filesize=" & attachments.fu.FileSize

End Function

See also
FileSizeLimit property
FileSizeLimit Run-Time Property (ASP)
Applies to
FileUpload Component
Type
number
Access
read/write
Syntax
object.FileSizeLimit [=value]

Description
Specifies the maximum size (in bytes) of a file that can be uploaded to the server. If the size of the
uploaded file is greater than value of this property, the upload fails and appropriate error message
is displayed.
Note: the initial value of this property comes from the "File Size Limit" design-time property of the
FileUpload component.
Example
The sample code below (inside the AfterInitialize event procedure of the page) sets a new file
size limit for the file upload control (fu). The new value of the limit is taken from maxfilesize
session variable. (Such variable can be set, for example, in the OnClick server-side event
procedure of the Login button, after the user has been successfully authenticated):
Function Page_AfterInitialize()
Dim mfs
mfs = Session("maxfilesize")
If Not IsEmpty(mfs) Then
attachments.fu.FileSizeLimit = mfs
End if

End Function

See also
FileSize property
Format Run-Time Property (ASP)
Applies to
Label Control, TextBox Control, TextArea Control, Checkbox Control, Image Control, ImageLink
Control, DatePicker Control, Hidden Control,
Type
array of variants

229
Access
read-write
Syntax
object.Format [=value]

Description
Holds constraints used to translate the control's value from its internal state to the required public
representation.
FormSubmitted Run-Time Property (ASP)
Applies to
Record Form
Type
Boolean
Access
read-only
Syntax
object.FormSubmitted

Description
This property determines whether record processing is performed in initial show or in postback
mode. In show mode, the record’s fields are assigned data source’s value (or none). In postback
mode, user provided data is available for processing.
Height Run-Time Property (ASP)
Applies to
Section Control
Type
number
Access
read/write
Syntax
object.Height

Description
Specifies the height of the section in abstract "line" units.
Example
Report_Footer.Height = 1.2

InsertAllowed Run-Time Property (ASP)

Applies to
Record Form, EditableGrid Form
Type
Boolean
Access
read/write
230
Syntax
object.InsertAllowed [=value]

Description
This property contains a Boolean flag that if true, allows insert database operations. This property
should be changed to false in Before Insert (or On Validate) event to prevent a form from creating
a new record in the database if the user's custom data verification fails.
See also
UpdateAllowed property
DeleteAllowed property
ReadAllowed property
IsFormSubmitted Run-Time Property (ASP)
Applies to
EditableGrid Form
Type
Boolean
Access
read-only
Syntax
object.IsFormSubmitted

Description
This property determines whether editable grid processing is performed in show or in postback
mode. In show mode, the grid’s fields are assigned values from the data source (or none when
inserting). In postback mode, user provided data is available for processing.
This property may be used to specify different behavior in show and in postback mode. Using this
property in combination with EditMode property allows to determine all possible form states.
Note: Usually, the browser is redirected (using Return Page property setting) after successful
submit processing and any modifications made to form's view depending on IsFormSubmitted =
true condition will be visible only if validation fails.
Examples
The following example displays specific warning message when the form is in failed validation
mode. If validation succeeds, no visible effects are output and the browser is redirected.
The code assumes the grid is called EditableGrid1, the label which will display the error message
is called Label1. This code may be used in form's Before Show event.
If EditableGrid1.IsFormSubmitted Then
EditableGrid1.Label1.Value = "Please don't use browser's Refresh
button.<br>Correct validation errors and resubmit."
End If

See also
EditMode property
IsPercent Run-Time Property (ASP)
Applies to

231
Report Form,
Type
boolean
Access
read
Syntax
object.IsPercent

Description
Specifies whether the report label value should be output as the percentage of corresponding total
value.
Example
If ReportLabel1.IsPercent Then _
ReportLabel1.Text "<b>" & ReportLabel1.Text & "</b>"

See also
TotalFunction property
IsUploaded Run-Time Property (ASP)
Applies to
FileUpload Control
Type
Boolean
Access
read-only
Syntax
object.IsUploaded

Description
This property holds upload control's state. If a file is being processed after submitting the form, or a
file has been previously uploaded, this property is set to true. If no file has been uploaded, the
property is set to false.
This property may be used to handle different file upload component behavior when it is populated
and when it is empty. For instance, the FileUpload component may be hidden if a file has been
previously uploaded and the user has no permissions to delete it. In case a file exists, additional
information may be extracted from the filesystem to be displayed by another control (modification
date for instance).
Examples
The following example retrieves the file's creation date and assigns it to a label if upload control is
populated.
This example assumes Form1 record contains FileUpload1 upload control. Label1 control is
assigned a value depending on the file's date.
If Form1.FileUpload1.IsUploaded Then
Dim fso
Set fso = Server.CreateObject("Scripting.FileSystemObject")

232
 Form1.Label1.Value = "uploaded on " &
fso.getFile(Form1.FileUpload1.FileFolder & Form1.FileUpload1.Value).DateCreated
End If

See also
FileSize property
FileFolder property
Value property
GetOriginFileName method
Link Run-Time Property (ASP)
Applies to
Link Control, ImageLink Control
Type
string
Access
read/write
Syntax
object.Link [=value]

Description
The Link property stores the URL (including the query string) that is assigned to the HREF attribute
of the HTML link (<a...> tag). This property is used only by the Link and Image Link controls. When
read, the link value is constructed as concatenation of two components: one that holds the bare
URL (Page property) and the other one that stores the query string (Parameters property). When
written, the new value is split into the URL part and query string part. After the assignment, new
URL is available through the Page property and new query string is available through the
Parameters property.
Important: The assigned value must be a proper link. For example the query string must not
include question marks (?). Such corrupt query string will be ignored.
Examples
The following example changes the link's label and hyperlink depending on whether hidden field is
set or not. Either link to parent category edit page is provided, or if edited category is top level, the
link points to categories listing page.
The example assumes EditCategoryForm exists on EditCategory page. There is ParentLink link
control inserted and parent_id hidden field. Categories is a page that lists all top-level categories
navigated if no parent category is specified in the record.
If Not IsEmpty(EditCategoryForm.parent_id.Value) Then
EditCategoryForm.ParentLink.Value = "go to parent category"
EditCategoryForm.ParentLink.Link = "EditCategory.asp?parent_id=" &
EditCategoryForm.parent_id.Value
Else
EditCategoryForm.ParentLink.Value = "root category (go to listing)"
EditCategoryForm.ParentLink.Link = "Categories.asp"
End If

233
Another example changes the link's target address depending on whether the user is logged in or
not. Either link to login page or to the user's profile page is given.
This example assumes there is WelcomeLink control inserted within common includable page
called Header. If the user is logged in, a link to EditProfile page is provided (and the link's label is
changed). If the user is not logged in, a login prompt is displayed and Login page link is provided.
If CCGetUserID() Then
Header.WelcomeLink.Value = "Welcome " & CCGetUserLogin()
Header.WelcomeLink.Link = "EditProfile.asp"
Else
Header.WelcomeLink.Value = "Please log in"
Header.WelcomeLink.Link = "Login.asp"
End If

See also
Value property
NextProcessingDate Run-Time Property (ASP)
Applies to
Calendar Form
Type
date
Access
read
Syntax
object.NextProcessingDate

Description
Specifies the next processing date to the current one. This property can be modified in the Before
Show Day, Before Show Week, Before Show Month and Before Show events.
See also
CurrentPrevDate property,
CurrentProcessingDate property
NumberOfColumns Run-Time Property (ASP)
Applies to
Directory Form
Type
number
Access
read/write
Syntax
object.NumberOfColumns [=value]

Description
This property contains the number of columns the directory should be split into. Depending on the
property's value, categories are split into a number of columns containing similar number of
categories.

234
This property can be used to enable directory layout selection depending on user's preference or
on the total number of categories.
Example
The following example sets the number of columns depending on the number of subcategories
listed by the directory. The number of columns is increased with each 50 subcategories listed.
Actual number of columns depends on the number of categories. There cannot be more columns
than categories.
The example assumes Directory1 form exists. The code can be put into directory's Before Show
event.
Directory1.NumberOfColumns = Directory1.Recordset.RecordCount \ 50

See also
NumberOfSubCategories Property
Recordset.RecordCount Property
Change Number Of Columns Action
NumberOfSubCategories Run-Time Property (ASP)
Applies to
Directory Form
Type
number
Access
read/write
Syntax
object.NumberOfSubCategories [=value]

Description
This property contains the maximum number of subcategories displayed for each category. If the
number of subcategories is greater than the value of this property, the remaining subcategories will
be listed only after navigating their parent category.
This property can be used to allow directory layout selection depending on user's preference.
See also
NumberOfColumns property
Password Run-Time Property (ASP)
Applies to
Connection Object
Type
string
Access
read/write
Syntax
object.Password [=value]

Description

235
This property contains the password used to authenticate database access together with a user
name. In some cases user name and password are included within ConnectionString property.
See also
User property
PageNumber Run-Time Property (ASP)
Applies to
Report Form,
Type
Number
Access
read
Syntax
object.PageNumber

Description
Retrieves the current page number of the report.
Example
label1.Value = Report1.PageNumber

PageSize Run-Time Property (ASP)

Applies to
Report Form,
Type
Number
Access
read/write
Syntax
object.PageSize

Description
Specifies the page size for the report in print mode.
Example
Report1.PageSize = 100

PressedButton Run-Time Property (ASP)

Applies to
Record Form, EditableGrid Form
Type
string
Access
read/write
Syntax

236
 object.PressedButton [=value]

Description
This property contains the name of the button pressed to submit the form being processed. This
value is only set when operating in postback processing mode (it is not set when navigating page
without submit). The name of the button pressed is the same as the record’s member variable
handling button requests (if the button name is “Update” there is a record’s member variable
Update of type clsButton).
See also
EditMode property
PrevProcessingDate Run-Time Property (ASP)
Applies to
Calendar Form
Type
date
Access
read
Syntax
object.PrevProcessingDate

Description
Specifies the previous processing date to the current one. The property can be modified in the
Before Show Day, Before Show Week, Before Show Month and Before Show events.
See also
CurrentProcessingDate and NextProcessingDate properties
ReadAllowed Run-Time Property (ASP)
Applies to
EditableGrid Form, Record Form
Type
Boolean
Access
read/write
Syntax
object.ReadAllowed [=value]

Description
This property contains a Boolean flag that if set to true, prevents displaying record's data. If the
property is set to true, the form is working in insert mode regardless of the passed parameters.
This property may be used to prevent users from viewing particular records. Personal entries can
be protected using custom code that resets this property.
The property's value has to be set in the form's Before Select event or earlier.
Examples
The following example allows users to browse only their own records.
The example assumes DiaryEntry form exists and there is author_id hidden field to keep record's

237
author identifier. This code may be inserted into Before Select event or earlier (form's Before Show
is called after property checking).
If DiaryEntry.author_id.Value = CCGetUserID() Then
DiaryEntry.ReadAllowed = True
Else
DiaryEntry.ReadAllowed = False
End If

See also
Before Select event
UpdateAllowed property
DeleteAllowed property
InsertAllowed property
Recordset Run-Time Property (ASP)
Applies to
Grid Form, ListBox Control, CheckboxList Control, RadioButton Control, Record Form,
EditableGrid Form, Directory Form, Path Form
Type
clsDataSource or ADODB.Recordset
Access
read-only
Syntax
object.Recordset.<member>...

Description
This property contains object’s recordset used to iterate rows in the data source result.
This property isn't accessed directly. Only its members are useful for retrieving data set
information.
For complete listing of properties and methods for this object refer to ActiveX Data Objects
Reference available from Microsoft's website.
Example
The following example retrieves the number of records of the grid and assigns the value to a page-
level Label control.
The example assumes articles grid and page-level articles_count Label to store the message
exist on the page. This code may be used in form's After Execute Select event or in label's Before
Show event.
articles_count.Value = "Articles in total: " & articles.Recordset.RecordCount

See also
Recordset.RecordCount property
Recordset.RecordCount Run-Time Property (ASP)
Applies to
Recordset Object
Type
number

238
Access
read/write
Syntax
object.Recordset.RecordCount [=value]

Description
This property provides the total number of records fetched from the database. After the database
operation has been performed (for example in the After Execute Select event), the property's value
can be modified to limit the number of records displayed on the page. (Assigning value to the
property before the database operation is executed gives no effect - the property is overwritten
after selecting data from the database).
Example
The following example retrieves the number of records of the grid and assigns the value to a page-
level Label control.
The example assumes articles grid and page-level articles_count label to store the message
exist on the page. This code may be used in form's After Execute Select event or in the Label's
Before Show event.
articles_count.Value = "Articles in total: " & articles.Recordset.RecordCount

See Also
CountSQL property
Recordset property
Retrieve Number Of Records action
RowNumber Run-Time Property (ASP)
Applies to
Report Form,
Type
Number
Access
read
Syntax
object.RowNumber

Description
Retrieves the current row number of the report.
Example
label1.Value = Report1.RowNumber

State Run-Time Property (ASP)

Applies to
Checkbox Control
Type
Boolean
Access
read/write

239
Syntax
object.State [=value]

Description
This property stores the current state of the control (it may hold one of the two values that
correspond to checked and unchecked state of the control).
Examples
The sample code below sets the "checked" state of the control (in the BeforeShow event
procedure of the checkbox control) if a new article is edited (no article_id value has been passed
to the page):
If not Len(CCGetParam("article_id","")) > 0 Then
articles.Verified_cb.State = articles.Verified_cb.CheckedValue
End if

See also
Value property
TemporaryFolder Run-Time Property (ASP)
Applies to
FileUpload Control
Type
string
Access
read/write
Syntax
object.TemporaryFolder [=value]

Description
This property specifies the temporary directory the uploaded file will be stored into before being
moved to the target directory defined in FileFolder property.
This property may be changed if some specific conditions happen. For instance, if there is not
enough space in the default temporary directory, the alternate location can be used.
Note: The value for the property is set only if the pointed folder exists. Absolute filesystem paths
should be used to avoid context ambiguities.
Examples
The following example checks if the uploaded file is bigger than 1MB and selects the temporary
folder depending on this condition.
This code assumes Form1 form exists and it contains FileUpload1 upload control. The code may
be inserted into parent form's Before Update or Before Insert events.
If Form1.FileUpload1.FileSize > 1024*1024 Then
Form1.FileUpload1.TemporaryFolder = "c:\temp\"
Else
Form1.FileUpload1.TemporaryFolder = "c:\windows\temp\"
End If

See also
FileFolder property
240
TotalFunction Run-Time Property (ASP)
Applies to
ReportLabel Control,
Type
string
Access
read
Syntax
object.TotalFunction

Description
Specifies the function to be used if the value is to be auto-calculated. The default value is empty
string.
Type Description
(none) No function will be used.
Sum The report label value will be calculated as the sum of previous row values.
Count If the Control Source is empty the value will be calculated as the count of previous data
rows. Otherwise the value will be calculated as the count of previous data rows with non-
empty values.
Min The value will be calculated as the minimum of previous row values.
Max The value will be calculated as the maximum of previous row values.
Avg The value will be calculated as the average of non-empty values from previous rows.
Example
If ReportLabel1.TotalFunction = "Sum" Then _
ReportLabel1.Text "<b>" & ReportLabel1.Text & "</b>"

See also
IsPercent property
UpdateAllowed Run-Time Property (ASP)
Applies to
Record Form, EditableGrid Form
Type
Boolean
Access
read/write
Syntax
object.UpdateAllowed [=value]

Description
This property contains record update permission flag. If set to True, record update operation is
permitted.

241
This property is set depending on the user's group permissions if the form's Restricted property is
set to “Yes” during design time. If Restricted property is set to “No”, UpdateAllowed property is
always True unless modified in the Before Update event.
This property may be set according to some custom permission checking scheme to enable or
disable record update operation. The update button is hidden only if the value is set before form's
Before Show event is called (for instance in parent component's or Before Select event). Database
update operation may be cancelled if the property is set to false in Before Update event.
Examples
The following example checks if the ad that is edited belongs to the currently logged in user. If it
does, the update operation is carried out. Otherwise, the update operation is not performed.
The example assumes EditAd form exists and user_id hidden field that stores the owner's
identifier is inserted. This code may be inserted into Before Update event.
If EditAd.user_id.Value = CCGetUserID() Then
EditAd.UpdateAllowed = True
Else
EditAd.UpdateAllowed = False
End If

See also
InsertAllowed property
DeleteAllowed property
ReadAllowed property
User Run-Time Property (ASP)
Applies to
Connection Object
Type
string
Access
read/write
Syntax
object.User [=value]

Description
This property contains a user name used to authenticate database connection access. For some
providers both user name and password are included in a connection string.
Examples
The following example opens database connection to the database file located in the current
directory using specified user account data.
This code may be inserted into the page's After Initialize event to open additional page-specific
connection object.
Dim DBConnection1
DBConnection1.ConnectionString = "Provider=Microsoft.Jet.OLEDB.4.0;Data
Source=" & Server.MapPath("database.mdb")
DBConnection1.User = "admin"
DBConnection1.Password = "SeCrEt"
DBConnection1.Open

242
See also
ConnectionString property
Password property
Value Run-Time Property (ASP)
Applies to
Label Control, TextBox Control, TextArea Control, Checkbox Control, Image Control, ImageLink
Control, DatePicker Form, Hidden Control, ListBox Control, CheckboxList Control, RadioButton
Control, FileUpload Control
Type
variant
Access
read/write
Syntax
object.Value [=value]

Description
Holds the raw value of the control. When written, converts the new value to the data type
corresponding to the DataType property. For ccsDate, ccsBoolean, ccsInteger, ccsFloat, ccsText
and ccsMemo in ASP, the following VBScript conversion functions are used repectively: CDate,
CBool, CLng, CDbl, CStr. Since the checkbox control (ControlType = ccsCheckBox) value is
stored in the State variable, special processing is required for this type of control. The checkbox
control may store only one of two values defined in CheckedValue and UncheckedValue
properties. Any value assigned to the checkbox control that does not match the CheckedValue
property is automatically converted to the UncheckedValue value.
Example
This example shows the code placed in the BeforeShowRow event procedure that forces the grid
field (income) to display the sum of all fields' values before the currently processed one (including
the current one). The sum variable must be declared and initialized as a global variable at the
beginning of the script module.
Function freport_BeforeShowRow()

sum = sum + freport.income.Value

freport.income.Value = sum

End Function

See also
Link property
Related Examples
Displaying Output
Add Custom HTML to a Page
Change Control Value
Changing Table Cell Color
Create a Grid Column with a Calculated Value
ViewMode Run-Time Property (ASP)
Applies to
Report Form,
243
Type
String
Access
read/write
Syntax
object.ViewMode

Description
Retrieves or specifies the report's view mode.
Type Description
Print The report will be displayed in print view mode.
Web The report will be displayed in Web view mode.
Example
Report1.ViewMode = "Print"

Visible Run-Time Property (ASP)

Applies to
Button Control, Label Control, TextBox Control, TextArea Control, Checkbox Control, Image
Control, ImageLink Control, DatePicker Form, Hidden Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, Sorter Control, EditableGrid Form, Path
Form, Directory Form, FileUpload Control, Panel
Type
Boolean
Access
read/write
Syntax
object.Visible [=value]

Description
Specifies whether the control is visible. Setting this field to false will prevent the object from being
displayed.
Note: Property is tested before calling Before Show event. In order for the property change to be
taken into consideration it should be set before Before Show event is called, for instance in the
parent component's Before Show event.
Note: Most of the controls need Extended HTML property checked in order to be hidden. This
property is available after selecting Edit ... from the context menu of the control during design-
time.
Example
The sample code below (placed in the AfterInitialize event procedure of the page) hides the
articles grid if the web page is displayed by an anonymous (not logged in) user.
Function Page_AfterInitialize()

If IsEmpty(CCGetUserID()) Then
articles.Visible = false

244
 End if

End Function

Related Examples
Hiding a Grid If No Records are Found
Hiding a Record Form Control

Variables
DB<connectionname> Variable (ASP)
Applies to
Page Context
Type
object (clsDB<connectionname>)
Access
read-only
Syntax
DB<connectionname>.<member>...

Description
This global variable is declared at the beginning of the page to represent each database
connection used within the page. The Connection object encapsulates the implementation details
used to establish a database connection (i.e. database name, location, user login/password, etc).

The database connection variable can be used to perform custom database operations (e.g. it is
used as the fourth argument of the CCDLookUp function). The name of the database connection
object is created by prepending the connection name (configured in the CCS environment) with the
prefix "DB". (e.g. for a connection called Internet within CodeCharge Studio, the corresponding
variable name for the connection object will be DBInternet).
Example
This code executes custom SQL query against the database connection. It inserts a row into
logging table with the current user's identifier and a date. This code can be used in any event
(such as login form's On Click).
Dim SQL
SQL = "INSERT INTO login_log(user_id, login_date) VALUES (" &
DBConnection1.ToSQL(CCGetUserID(), ccsInteger) & "," &
DBConnection1.ToSQL(Now(), ccsDate) & ")"
DBConnection1.Execute (SQL)

See also
Connection Object
Execute Method
FileName Variable (ASP)
Applies to
Page Context
Type
string

245
Access
read/write
Syntax
FileName [=value]

Description
This variable contains the name of the current page and is used to create links in the Navigator
and Sorter components. For instance, the First, Next, Previous and Last links in the Navigator link
to the page specified in this variable.
It is also useful for building local links on includable pages.
Examples
The following code builds refresh link pointing to current page with additional parameter attached.
It assumes RefreshLink is inserted on Header includable page.
Header.RefreshLink.Page = FileName
Header.RefreshLink.Parameters = CCAddParam(Header.RefreshLink.Parameters,
"data", "refresh")

See Also
TemplateFileName Variable
Link Property
HTMLTemplate Variable (ASP)
Applies to
Page Context
Type
object (clsTemplate)
Access
read-only
Syntax
HTMLTemplate.<member>...

Description
HTMLTemplate is a global variable that stores a reference to a template object which is an
instance of clsTemplate class.
clsTemplate

The template object is responsible for loading the template file related to the current page, building
the hierarchical structure of the template blocks/variables and finally replacing the template
variables with dynamic values. This variable can be used to set the value of custom template
blocks or template variables using the SetVar method.
Examples
The example below shows an extract from an HTML template file with a template variable called
user_state.

<input name="user" {user_state}>

246
The following programming code uses the SetVar method of the HTMLTemplate object to set the
value of the user_state template variable. When the page is rendered for the browser, the
user_state template variable will be replaced by the value disabled and as a result of this, the input
control will appear disabled.

HTMLTemplate.SetVar "@user_state","disabled"

See also
TemplateFileName Variable
PathToCurrentPage Variable (ASP)
Applies to
Page Context
Type
string
Access
read/write
Syntax
PathToCurrentPage [=value]

Description
This variable contains the relative path from the site's root directory to the location of the current
page.
See also
PathToRoot Variable
PathToRoot Variable (ASP)
Applies to
Page Context
Type
string
Access
read/write
Syntax
PathToRoot [=value]

Description
This variable contains a relative path to the root directory of the site from the location of the current
page. This property is usually used to reference common files generated by CodeCharge Studio in
the site's root directory. This includes JavaScript file paths.
See also
FileName Variable
TemplateFileName Variable
Redirect Variable (ASP)
Applies to
Page Context

247
Type
string
Access
read/write
Syntax
Redirect [=value]

Description
If not empty, the browser is redirected to the URL specified by the contents of this variable.The
Redirect variable is declared as a global variable at the top of the page and can therefore be
accessed in most of the events that occur later on in the page.
Note: The Redirect variable can be modified in the Button's onClick event, if the Return Page
property of this Button is empty.
Example
The example below (placed in the After Execute Insert event) redirects the browser using a URL
that specifies a URL parameter called article_id.
Dim max_id
max_id = CCDLookup("max(article_id)","articles","",DBInternet)
Redirect = "articles.asp?article_id=" & max_id

See Also
PathToRoot Variable
PathToCurrentPage Variable
Related Examples
Add URL Parameters to a Page
Dynamically Redirect Users to Another Page
ScriptPath Variable (ASP)
Applies to
Page Context
Type
string
Access
read/write
Syntax
ScriptPath [=value]

Description
This variable contains the absolute file system path to the current page. The variable is used to
load the template file for the current page and can be altered to load the template file from a
different location.
Examples
The following example sets script path to a site's templates directory. All templates will be loaded
from that directory (assuming code is inserted on every page in On Initialize View event).
ScriptPath = Server.MapPath("./templates/")

248
See also
TemplateFileName Variable
FileName Variable
TemplateFileName Variable (ASP)
Applies to
Page Context
Type
string
Access
read/write
Syntax
TemplateFileName [=value]

Description
Stores the name of the HTML template file used by the current page. This variable can be altered
to load an alternate template file (for instance depending on language choice or style preference).
See also
FileName Variable
ScriptPath Variable
HTMLTemplate Variable
Tpl Variable (ASP)
Applies to
Page Context
Type
object
Access
read
Syntax
Tpl.<member>...

Description
This variable represents the template file for the current page. It can be used to handle custom
template variables ({tag_name}) and template blocks.
See Also
HTMLTemplate Variable
Related Examples
Working with Custom Template Blocks

PHP
Functions
CCAddParam Function (PHP)
Description
249
Adds a parameter with the specified value into the GET query string. If the parameter with the
specified name exists then its value is changed for ParameterValue.
Syntax
CCAddParam(QueryString, ParameterName, ParameterValue)

Return value
String
Parameters
Name Type Description Required
QueryString String Query string to which the parameter is added. Yes
ParameterName String Name of the parameter. Yes
ParameterValue String Value of the parameter. Yes
See also:
CCRemoveParam function, CCGetQueryString function
CCDLookUp Function (PHP)
Description
Retrieves a single database value which can be a field or an expression. The arguments passed to
the function determine the value to be retrieved. Execution of this function causes any previously
retrieved records in the connection object to be overwritten with the new recordset.
Syntax
CCDLookUp(field, table, where_clause, connection)

Return value
string
Parameters
Name Type Description Required
field string Name of the database table field to be retrieved or an SQL Yes
expression whose value is to be retrieved.
table string The name of the table from which the value is to be retrieved Yes
(SQL JOIN directives are possible).
where_clause string SQL WHERE clause: the part of the SQL query that states the Yes
criteria for selecting the value.
connection cls Connection object against which the query will be executed. Yes
object

CCFormatDate Function (PHP)

Description
Formats a date value according to the specified format mask.
Syntax
CCFormatDate(DateToFormat,FormatMask)

250
Example
CCFormatDate(CCParseDate("2002 May 1",array("yyyy"," ","mmm"," ","d")),
array("LongDate")) -> "May 1, 2002"
CCFormatDate(CCParseDate("2002-05-01 20:12",
array("yyyy", "-", "mm", "-", "dd", " ", "HH", ":", "nn")),
array("mmm"," ","d",", time is ","hh",":","nn","","AM/PM")) -> "May 1,
time is 8:12 PM"

Return value
None
Parameters
Name Type Description Required
DateToFormat Array The date value which will be formatted Yes
FormatMask Array of Each string is one of the following components (all other Yes
strings components are left unchanged when building formatted
value):
d day
w week
m month
q quarter
y day of the year
h hour in 12-hour format
H hour in 24-hour format
n minute
s second
dd zero-filled day
ww week of year
mm zero-filled month
yy two-digit year
hh zero-filled hour in 12-hour format
HH zero-filled hour in 24-hour format
nn zero-filled minute
ss zero-filled second
ddd short weekday name
mmm short month name
A/P A or P according to AM/PM
a/p a or p according to AM/PM
dddd weekday name
mmmm month name
yyyy year

251
 AM/PM AM or PM
am/pm am or pm
LongDate long date format
LongTime long time format
ShortDate short date format
ShortTime short time format
GeneralDate general date format

CCGetCookie Function (PHP)

Description
Retrieves the value of a specified cookie.
Syntax
CCGetCookie(name)

Return value
string
Parameters
Name Type Description Required
name string Name of the cookie whose value is to be returned. Yes
See Also:
CCSetCookie function
CCGetFromGet Function (PHP)
Description
Retrieves a value of the GET input parameter. The function first attempts to retrieve the parameter
from the GET query string and if no value is returned the function returns the default value
specified in the function call.
Syntax
CCGetFromGet(ParameterName, DefaultValue)

Return value
string
Parameters
Name Type Description Required
ParameterName string Name of the parameter to retrieve. Yes
DefaultValue string The value to be assigned if the given parameter has no value. Yes
It can be an empty string.
See also:
CCGetParam function, CCGetFromPost function
CCGetFromPost Function (PHP)
Description

252
Retrieves a POST input parameter value. The function first attempts to retrieve the parameter from
the POST query string and if no value is returned the function returns the default value specified in
the function call.
Syntax
CCGetFromPost(ParameterName, DefaultValue)

Return value
string
Parameters
Name Type Description Required
ParameterName string Name of the parameter to retrieve. Yes
DefaultValue string The value to be assigned if the given parameter has no value. Yes
It can be an empty string.
See also:
CCGetParam, function CCGetFromGet function
CCGetGroupID Function (PHP)
Description
Retrieves the security group ID value of the currently logged in user.
Syntax
CCGetGroupID()

Return value
number
Parameters
Name Type Description Required
none
See Also:
CCGetUserID function, CCGetUserLogin function, CCLoginUser function, CCLogoutUser function
CCGetParam Function (PHP)
Description
Retrieves a value of the GET or POST input parameter. The function first attempts to retrieve the
parameter from the GET query string and if no value is returned, the function checks for a POST
input parameter with the same name. If no value is returned by the GET or POST input parameter,
the function returns the default value specified in the function call.
Syntax
CCGetParam(name, value)

Return value
string
Parameters
Name Type Description Required
name string Name of the GET or POST parameter whose value is to be returned. Yes

253
value string The value to be assigned of the given parameter has no value. It can be Yes
an empty string.
See also:
CCGetFromGet function, CCGetFromPost function
CCGetQueryString Function (PHP)
Description
Retrieves a value from the GET, POST or both (depending on the specified parameter) input
parameters value. If the RemoveParameters array contains parameter names then they will be
removed from the resulting string.
Syntax
CCGetQueryString(CollectionName, RemoveParameters)

Return value
String
Parameters
Name Type Description Required
CollectionName String Name of the parameter to retrieve. Possible values: Yes
"Form" Retrieves a POST input parameter value
"QueryString" Retrieves a GET input parameter value
"All" Retrieves a GET and POST input
parameter value
RemoveParameters Array Array of names which will be removed from the resulting Yes
string.

CCGetSession Function (PHP)

Description
Retrieves the value of a specified session variable, or returns the default value specified in the
function call.
Syntax
CCGetSession(Name [, DefaultValue])

Parameters
Name Type Description Required
Name string Name of the session variable which value is to be returned. Yes
DefaultValue string Value to return if the session variable is not set No
See Also:
CCSetSession function
CCGetUserID Function (PHP)
Description
Retrieves the primary key value that uniquely identifies the currently logged-in user.

254
Syntax
CCGetUserID()

Return value
number
Parameters
Name Type Description Required
none
See Also:
CCGetUserLogin function, CCLoginUser function, CCLogoutUser function, CCGetGroupID
function
CCGetUserLogin Function (PHP)
Retrieves the login name (or username) of the currently logged in user.
Syntax
CCGetUserLogin()

Return value
string
Parameters
Name Type Description Required
none
Description
See Also:
CCGetUserID function, CCLoginUser function, CCLogoutUser function, CCGetGroupID function
CCLoginUser Function (PHP)
Description
Authenticates a user by comparing the login and password values against the values stored in the
database. If a successful match is made, session variables containing the information of the
logged in user are created to indicate an authenticated session.
Syntax
CCLoginUser(login, password)

Return value
Boolean
Parameters
Name Type Description Required
login string The username of the user to be logged in. Yes
password string The password of the user to be logged in. Yes
See Also:
CCGetUserID function, CCGetUserLogin function, CCLogoutUser function, CCGetGroupID
function

255
CCLogoutUser Function (PHP)
Description
This function terminates an authenticated session by clearing the session variables that hold the
information of a logged in user. After this function executes, a user must login again in order to
access any restricted pages.
Syntax
CCLogoutUser()

Return value
none
Parameters
Name Type Description Required
none
See Also:
CCGetUserID function, CCGetUserLogin function, CCLoginUser function, CCGetGroupID function
CCParseDate Function (PHP)
Description
Parses the specified date string into an array according to the specified date format.
Syntax
CCParseDate(ParsingDate,FormatMask)

Example
CCParseDate("2002 May 1",array("yyyy"," ","mmm"," ","d")) -> 2002-05-01

Return value
Date
Parameters

Name Type Description Required

ParsingDate String The date which will be Yes
parsed.
FormatMask Array of strings (see CCFormatDate for The format mask to parse the No
available patterns) date with.
Return Date The returned date. No
Value
See also
CCFormatDate function
CCRemoveParam Function (PHP)
Description
Removes a parameter from the GET query string.

256
Syntax
CCRemoveParam(QueryString, ParameterName)

Return value
String
Parameters
Name Type Description Required
QueryString String Query string from which the parameter is removed. Yes
ParameterName String Name of the parameter to remove Yes
See also:
CCAddParam function
CCSetCookie Function (PHP)
Description
Creates a new cookie and assigns the specified value to it or sets the specified value to the named
cookie if it already exists.
Syntax
CCSetCookie(Name, Value[, ExpireTime])

Parameters
Name Type Description Required
Name string Name of the cookie whose value is to be set. Yes
Value string The value to be assigned to the cookie. Yes
ExpireTime integer The number of seconds before the cookie expires. If the No
parameter is not specified the cookie will be destroyed after 1
year.

CCSetSession Function (PHP)

Description
Creates a session variable and assigns it the specified value or sets the specified value to the
session variable if it already exists.
See Also:
Syntax
CCSetSession(name, value)

Return value
none
Parameters
Name Type Description Required
name string Name of the session variable to be created or set. Yes
value string The value to be assigned to the session variable. Yes

257
See Also:
CCGetSession function

Methods
connect Method (PHP)
Applies to
Connection Object
Syntax
<connection>->connect(database, host, port, user, password)

Return value
link identifier
Parameters
Name Type Description Required
database string Name of the database instance to connect to. No
host string Address of the host machine where the database resides. No
port string Port to connect to. No
user string User name to authenticate with. No
password string User password to authenticate with. No
Description
This method establishes a database connection using the specified parameters. This method can
be used to establish a database connection at runtime, for instance when the connection
parameters are not known at design-time.
f Method (PHP)
Applies to
Connection Object
Syntax
<connection>->f(field)

Return value
string
Parameters
Name Type Description Required
field string or Name of a field to be retrieved from the current record, or its Yes
number numerical index.
Description
This method retrieves the value of the specified field from the current connection's recordset.
See also
query Method
GetFileName Method (PHP)
Applies to
258
FileUpload Control
Syntax
<control>->GetFileName()

Description
This method extracts the name of an uploaded file (without the unique suffix). It can be used to
check the original file extension or construct an alternative filename for saving the file.
GetFileSize Method (PHP)
Applies to
FileUpload Control
Syntax
<control>->GetFileSize()

Description
This method retrieves the size of an uploaded file. It can be used to reject or accept files based on
their size.
GetLink Method (PHP)
Applies to
ImageLink Control, Link Control
Syntax
<control>->GetLink()

Return value
string
Description
This method returns the hyperlink value of a control. The returned value is the actual URL which is
used when the Link or Image Link control is clicked.
See also
SetLink Method
GetValue Method (PHP)
Applies to
Checkbox Control, CheckboxList Control, FileUpload Control, Hidden Control, Image Control,
ImageLink Control, Label Control, Link Control, ListBox Control, RadioButton Control, TextArea
Control, TextBox Control
Syntax
<control>->GetValue()

Return value
Depends on control data type
Description
This method returns the current value of the specified control. The returned value depends on the
control's format and data type.
See also
SetValue Method

259
next_record Method (PHP)
Applies to
Connection Object
Syntax
<connection>->next_record()

Return value
boolean
Description
This method is used to traverse a retrieved recordset by moving the record pointer to the next
record.
See also
query Method
f Method
num_rows Method (PHP)
Applies to
Connection Object
Syntax
<connection>->num_rows(field)

Return value
number
Description
This method returns the number of rows accessible in the currently active recordset for a particular
connection.
Note:
This method is not applied (it always returns 0) if the the Oracle OCI database library is used.
See also
query Method
query Method (PHP)
Applies to
Connection Object
Syntax
<connection>->query(query)

Return value
result identifier
Parameters
Name Type Description Required
query string String containing the SQL query to be executed against the database. Yes
Description
This method executes a specified SQL query against the database connection.

260
See also
f Method
num_rows Method
next_record Method
SetLink Method (PHP)
Applies to
ImageLink Control, Link Control
Syntax
<control>->SetLink(url)

Parameters
Name Type Description Required
url string A URL to the target resource which the control should point to. Yes
Description
This method sets the URL of a Link or Image Link control.
This method can be used to change the URL dynamically or to append additional parameters to an
existing URL.
See also
GetLink Method
SetValue Method (PHP)
Applies to
Checkbox Control, CheckboxList Control, FileUpload Control, Hidden Control, Image Control,
ImageLink Control, Label Control, Link Control, ListBox Control, RadioButton Control, TextArea
Control, TextBox Control
Syntax
<control>->SetValue(value)

Parameters
Name Type Description Required
value Depends on the Data Type of the Control Value to be assigned to the control. Yes

Description
This method sets the value of a control. The value is influenced by the data type as well as format
of the control. This method is often used to dynamically assign or alter the value of a control at
runtime.
See also
GetValue Method
ToSQL Method (PHP)
Applies to
Connection Object
Syntax

261
 <connection>->ToSQL(Value, DataType)

Return value
Depends on the specifed Data Type
Parameters
Name Type Description Required
Value any Value to be converted Yes
to SQL compatible
format.
DataType The data type to which the value will be formatted. Desired data type. Yes
You can use any one of the predefined constants:
ccsDate, ccsBoolean, ccsInteger, ccsFloat, ccsText,
ccsMemo
Description
This method formats values based on the specified data type in order to make them SQL
compatible.

Run-Time Properties
AllowedFileMasks Run-Time Property (PHP)
Applies to
FileUpload Form
Type
string
Access
read/write
Syntax
object->AllowedFileMasks [= value]

Description
Specifies a list of file masks (separated with semicolon) that are allowed by the FileUpload
component. If user specifies a file with a mask that matches one of the masks specified in this
property, the file will be uploaded (unless the mask is also listed in the DisallowedFileMasks
property). Otherwise, the upload will fail and an error message will be displayed. The
AllowedFileMasks property corresponds to the "Allowed File Masks" Design-Time property of the
FileUpload component.
See also
DisallowedFileMasks Property
CalendarStyles Run-Time Property (PHP)
Applies to
Calendar Form
Type
array
Access
read/write

262
Syntax
object->CalendarStyles [= value]

Description
Contains the calendar styles that depend on the builder settings.
Note: This property can be modified in the Before Show event.
Examples
The following example shows how to change some styles.
$Calendar1->CalendarStyles["Day"] = "class = 'CellWithBlackText'";
$Calendar1->CalendarStyles["ToDay"] = "class = 'CellWithRedText'";

See also
CurrentStyle property
ComponentName Run-Time Property (PHP)
Applies to
Button Control, Label Control, TextBox Control, TextArea Control, Checkbox Control, Image
Control, ImageLink Control, DatePicker Control, Hidden Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, Sorter Control, EditableGrid Form, Path
Control, Directory Form, FileUpload Control Calendar Form, CalendarNavigator, Includable Page,
Link, Navigator, Panel, Report Form, Report Label, Report Section, Panel
Type
String
Access
read
Syntax
object->ComponentName

Description
Specifies Name of object i.e. "TextBox1"
Components Run-Time Property (PHP)
Applies to
Panel
Type
Array
Access
read
Syntax
object->Components

Description
Contains all children of the current panel. Can be used to iterate through all children.
ComponentType Run-Time Property (PHP)
Applies to
263
Button Control, Label Control, TextBox Control, TextArea Control, Checkbox Control, Image
Control, ImageLink Control, DatePicker Control, Hidden Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, Sorter Control, EditableGrid Form, Path
Control, Directory Form, FileUpload Control Calendar Form, CalendarNavigator, Includable Page,
Link, Navigator, Panel, Report Form, Report Label, Report Section, Panel
Type
String
Access
read
Syntax
object->ComponentType

Description
Specifies type of an object, such as "TextBox", "Record", etc.
CurrentDate Run-Time Property (PHP)
Applies to
Calendar Form
Type
array
Access
read/write
Syntax
object->CurrentDate [= value]

Description
Specifies the date shown in the calendar. For example, for the Monthly calendar the date can be
any date of this month.
Note: The value of this property can be modified in the Page's After Initialize event.
Examples
The following example shows how to make the calendar always show January 2005.
$Format = array("yyyy", "-", "mm", "-", "dd");
$Date = CCParseDate("2005-01-01", $Format);
$Calendar1->CurrentDate = $Date;

CurrentProcessingDate Run-Time Property (PHP)

Applies to
Calendar Form
Type
array
Access
read
Syntax
object->CurrentProcessingDate

264
Description
Specifies the currently processed date. The value of this property can be modified in the Before
Show Day, Before Show Week, Before Show Month, and Before Show events.
See also
PrevProcessingDate property,
NextProcessingDate property
CurrentStyle Run-Time Property (PHP)
Applies to
Calendar Form
Type
string
Access
read/write
Syntax
object->CurrentStyle [= value]

Description
Contains the calendar style of the currently processed block.
Note: The value of this property can be modified in the Before Show Day, Before Show Week,
Before Show Month, and Before Show events.
Examples
The following example shows how to change style.
$Calendar1->CurrentStyle = "class = 'CellWithBlackText'";

See also
CalendarStyles property
DeleteAllowed Run-Time Property (PHP)
Applies to
Record Form, EditableGrid Form
Type
boolean
Access
read/write
Syntax
object->DeleteAllowed [= value]

Description
This property contains boolean flag that if set, prevents record deletion operation from executing.
This property is set automatically by the Record form to True or False if the access to the form is
restricted by setting its “Restricted” property to “Yes” in the IDE. If “Restricted” is set to “No”, then
DeleteAllowed property is always True unless modified in the Before Delete event. The value of
this property can be changed in the After Initialize event of the Page.
Note: Setting this property to 'False' in the On Validate event or the Page's After Initialize event
results in hiding of the Delete button.
265
Examples
The following example shows how to prevent a logged in user from deleting an item that does not
belong to him/her. Additionally, the form displays an error message.

global $items;
if ($items->user_id->GetValue() != CCGetUserID())
{
$items->DeleteAllowed = false;
$items->Errors->addError("You are not allowed to delete this item.");
}

where $items is the name of the form.

See also
InsertAllowed Property
UpdateAllowed Property
ReadAllowed Property
DisallowedFileMasks Run-Time Property (PHP)
Applies to
FileUpload Control
Type
string
Access
read/write
Syntax
object->DisallowedFileMasks [= value]

Description
Stores a regular expression that is used to check if the filename mask is on the list of disallowed
filename masks. If the filename mask is included in this property, the upload operation fails and an
appropriate error message is displayed.
DisallowedMasks property has higher priority than the AllowedFileMasks property. In other
words, if a mask is mentioned in both properties (AllowedFileMasks and DisallowedFileMasks)
the upload will fail.
Note: The initial value of this variable is built based on the contents of the "Disallowed File Masks"
design-time property.
See also
AllowedFileMasks Property
ds Run-Time Property (PHP)
Applies to
Navigator Control, Record Form, EditableGrid Form, Path Control, Directory Form, Label Control,
TextBox Control, TextArea Control, Checkbox Control, Image Control, ImageLink Control,
DatePicker Control, Hidden Control, ListBox Control, CheckboxList Control, RadioButton Control
Type
object (cls<name>DataSource)
Access
read/write
266
Syntax
object->ds->...

Description
Note: This syntax is retained for compatibility reasons.
This property contains a reference to the data source associated with the given object. This data
source can be used to perform additional queries and to access query results.
The properties of the ds object (SQL, CountSQL, Where, Order) can be changed in the Events
code so that the programmer can alter the properties conditionally (e.g. change the SQL query
used to retrieve ListBox object's elements).
A programmer can instantiate a new ds object by constructing a connection object. Additional
queries on this object can be performed in the events code, or the ds object's reference can be
passed as the connection reference parameter to CCDLookUp function.
Examples

$db = new clsDB<connection_name>();

$db->query("SELECT article_id,article_title FROM articles");
$articles = array();
while ($db->next_record())
{
$a = array();
$a["article_id"] = $db->f("article_id");
$a["article_title"] = $db->f("article_title");
$articles[] = $a;
}

where <connection_name> is the name of the connection, e.g. for "Intranet" connection the first
line of the example should read:

$db = new clsDBIntranet();

Other examples
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox,
Dynamically Modify the ORDER BY Clause,
Dynamically Modify the SQL Statement,
Dynamically Modify the WHERE Clause
See also
DataSource Property
CCDLookUp Function
SQL Property
CountSQL Property
Order Property
Where Property
ListBox Object
Grid Form
DataSource->CountSQL Run-Time Property (PHP)
Applies to

267
DataSource Object
Type
string
Access
read/write
Syntax
object->ds->CountSQL [=value]

Description
Stores the main part of the SQL query that is used to retrieve the number of records returned by a
SELECT database query.
This property does not include the WHERE clause, before the query is executed conditions from
the Where property are appended.
Note: The usual content of this property includes the COUNT aggregate function: SELECT
COUNT(*) FROM ...
Examples
Dynamically Modify the SQL Statement,
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox,
Dynamically Modify the ORDER BY Clause,
Dynamically Modify the WHERE Clause
See Also
DataSource Property
DataSource->SQL Property
DataSource->Where Property
DataSource->Order Property
DataSource->RecordsCount Property
DataSource->Order Run-Time Property (PHP)
Applies to
DataSource Object
Type
string
Access
read/write
Syntax
object->DataSource->Order [=value]

Description
This property holds the list of fields that are used in the ORDER BY clause of the SELECT query.
CCS initializes this property internally, for example if an order option has been specified in the
properties of the form. Modification of this field (before the query is executed) will change the order
of the results.
Examples
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox,
Dynamically Modify the ORDER BY Clause,
Dynamically Modify the SQL Statement,
Dynamically Modify the WHERE Clause

268
See Also
DataSource Property
DataSource->SQL Property
DataSource->CountSQL Property
DataSource->Where Property
DataSource->RecordsCount Property
DataSource->RecordsCount Run-Time Property (PHP)
Applies to
DataSource Object
Type
number
Access
read/write
Syntax
object->DataSource->RecordsCount [=Value]

Description
Contains the number of records retrieved by DataSource's SELECT SQL query.
Examples
The following example shows how to hide a form if there are no records retrieved from the
database.

global $items;
if ($items->DataSource->RecordsCount == 0)
{
$items->Visible = false;
}

where $items is the name of the form.

Other examples
Hiding a Grid If No Records are Found
See Also
DataSource Property
DataSource->SQL Property
DataSource->CountSQL Property
DataSource->Where Property
DataSource->Order Property
DataSource->SQL Run-Time Property (PHP)
Applies to
DataSource Object
Type
string
Access
read/write
Syntax
269
 object->DataSource->SQL [=value]

Description
This property stores the main part of a query that retrieves, inserts, updates, or removes data for
the form. The main part usually includes the actual SQL command (SELECT, INSERT, UPDATE,
DELETE), a list of fields to be retrieved, inserted, or updated and a list of tables from which the
data will be retrieved or deleted (FROM) or the name of the table the insert or update operations
are to be executed against.
The SQL query is eventually built as the concatenation of SQL, Where and Order properties.
To modify the SQL property (alter the SQL query), you should use the BeforeBuildSelect event
procedure of the form.
Examples
Dynamically Modify the SQL Statement,
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox,
Dynamically Modify the ORDER BY Clause,
Dynamically Modify the WHERE Clause
See Also
DataSource Property
DataSource->CountSQL Property
DataSource->Where Property
DataSource->Order Property
DataSource->Where Run-Time Property (PHP)
Applies to
DataSource Object
Type
string
Access
read/write
Syntax
object->DataSource->Where [=value]

Description
This property stores all conditions that are eventually used in the WHERE clause of a query that
selects, updates or deletes data from the database. Programmers can add their own conditions
(preserving the SQL syntax) in one of the events triggered before the final query is built and
executed (i.e. BeforeBuildSelect, BeforeBuildDelete, BeforeBuildUpdate).
Examples
Dynamically Modify the WHERE and ORDER BY Clauses of a ListBox,
Dynamically Modify the ORDER BY Clause,
Dynamically Modify the SQL Statement,
Retrieve Values From a Multi-Select ListBox,
Dynamically Modify the WHERE Clause
See Also
DataSource Property
DataSource->SQL Property
DataSource->CountSQL Property
DataSource->Order Property

270
EditMode Run-Time Property (PHP)
Applies to
Record Form, EditableGrid Form
Type
boolean
Access
read-only
Syntax
object->EditMode

Description
This property determines whether given record form is currently in edit or insert mode. In edit
mode all data source parameters need to have values assigned (including row identifier). In insert
mode not all have to be assigned values.
Examples
The following example shows how to hide a dependent form on a page when the main form is not
in EditMode.
global $items;
global $item_prices;
if (! $items->EditMode)
{
$item_prices->Visible = false;
}

where $items is the name of the main form, and $item_prices is the name of the form that shows
elements that depend on the data in the main form.
Other examples
Examine Form's Mode,
Dynamic Login Field in a Registration Form
See also
Errors Property
FormSubmitted Property
PressedButton Property
EmptyRows Run-Time Property (PHP)
Applies to
EditableGrid Form
Type
Number
Access
read/write
Syntax
object->EmptyRows [= value]

Description

271
Specifies the number of empty rows displayed at the bottom of the editable grid. Each empty row
allows the user to insert a new record into the database.
EmptyText Run-Time Property (PHP)
Applies to
ReportLabel Control,
Type
string
Access
read/write
Syntax
object->EmptyText

Description
Specifies the text to be displayed when label value is empty.
Example
$Report1->ReportLabel1->EmptyText = "xxx";

Events Run-Time Property (PHP)

Applies to
Calendar Form
Type
array
Access
read/write
Syntax
object->Events [= value]

Description
Contains the calendar events. This value can be manually modified.
Note: The value of this property can be also modified in Before Show event.
Examples
The following example shows how to add new event.
$CustomEventDateStr = "20050101";
$CustomEventTime = CCParseDate("12:00", array("HH", ":", "nn"));
$CustomEvent = new clsEventNewCalendar1();
$CustomEvent->_Time = $CustomEventTime;
$CustomEvent->EventTime = $CustomEventTime;
$CustomEvent->EventDescription = "Some text";
$Calendar1->Events[$CustomEventDateStr][] = $CustomEvent;

Errors Run-Time Property (PHP)

Applies to

272
Label Control, TextBox Control, TextArea Control, Checkbox Control, Image Control, ImageLink
Control, DatePicker Control, Hidden Control, Connection Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, EditableGrid Form, Path Control,
Directory Control, FileUpload Control
Type
object (clsErrors)
Access
read-only
Syntax
object->Errors-><property>->...

Description
This property keeps the reference to the object’s errors collection. It is used to collect error
messages generated during the object’s execution.
Examples
The following example shows how to display an error message on the form if the logged in user
tries to delete an item that does not belong to him/her.

global $items;
if ($items->user_id->GetValue() != CCGetUserID())
{
$items->DeleteAllowed = false;
$items->Errors->addError("You are not allowed to delete this item.");
}

where $items is the name of the form.

Other examples
Display Custom Error Messages,
Using the Control Validation Event,
Using the Form Validation Event
FileFolder Run-Time Property (PHP)
Applies to
FileUpload Control
Type
string
Access
read/write
Syntax
object->FileFolder [= value]

Description
Stores the name of the folder where the uploaded files will be stored on the web server.
Examples
The following example shows how to change the upload file folder depending on the login name of
the logged in user. The form or page with the FileUpload component should be restricted.

273
 global $files;
$files->file->FileFolder = "/www/files/" . CCGetUserLogin() . "/";
where $files is the name of the form and file is the name of the FileUpload component.
See also
FileSizeLimit Property
TemporaryFolder Property
FileSizeLimit Run-Time Property (PHP)
Applies to
FileUpload Component
Type
number
Access
read/write
Syntax
object->FileSizeLimit [= value]

Description
Specifies the maximum size (in bytes) of a file that can be uploaded to the server. If the size of the
file is greater than value of this property, the upload fails and appropriate error message is
displayed.
Note: the initial value of this property is retrieved from the "File Size Limit" design-time property of
the FileUpload component.
See also
GetFileSize Method
FirstWeekDay Run-Time Property (PHP)
Applies to
Calendar Form
Type
integer
Access
read/write
Syntax
object->FirstWeekDay [= value]

Description
Specifies the weekday shown first in the week. The '0' identifies Sunday, '1' - Monday, etc.
Note: The value of this property can be modified in the Before Show event.
Examples
The following example shows how to change property value to Monday.
$Calendar1->FirstWeekDay = 1;

Format Run-Time Property (PHP)

274
Applies to
Label Control, TextBox Control, TextArea Control, Checkbox Control, Image Control, ImageLink
Control, DatePicker, Hidden Control, ListBox Control, CheckboxList Control, RadioButton Control
Type
array of variants
Access
read-write
Syntax
object->Format [= value]

Description
Holds constraints used to translate control's value from its internal state to the required public
representation.
FormSubmitted Run-Time Property (PHP)
Applies to
Record Form, EditableGrid Form
Type
boolean
Access
read-only
Syntax
object->FormSubmitted

Description
This property determines whether record processing is performed in initial show or in postback
mode. In show mode, the record’s fields are assigned data source’s value (or none). In postback
mode user provided data is available for processing.
See also
Errors Property PressedButton Property EditMode Property
Height Run-Time Property (PHP)
Applies to
Section Control
Type
number
Access
read/write
Syntax
object->Height

Description
Specifies the height of the section in abstract "line" units.
Example
$Report1->Report_Footer->Height = 1.2;

275
InsertAllowed Run-Time Property (PHP)
Applies to
Record Form, EditableGrid Form
Type
boolean
Access
read/write
Syntax
object->InsertAllowed [= value]

Description
This property contains a boolean flag that if true, allows insert database operations. This property
should be changed in Page AfterInitialize, Form Before Insert (or On Validate) Event to prevent a
form from creating a new record in the database.
Note: Setting this property to False in the On Validate event or the Page's After Initialize event
results in hiding of the Insert button.
Examples
The following example shows how to prevent a user from inserting an item into database if the
provided email address can be found in emails table of the database. Additionally, the form
displays an error message.

global $items;
if (CCDLookUp("email_address","emails","email_address="
. $items->DataSource->ToSQL($items->email_address->GetValue()),$items-
>DataSource))
{
$items->InsertAllowed = false;
$items->Errors->addError("Provide another email adress.");
}

where $items is the name of the form.

See also
UpdateAllowed Property
DeleteAllowed Property
ReadAllowed Property
IsPercent Run-Time Property (PHP)
Applies to
Report Form,
Type
boolean
Access
read
Syntax
object->IsPercent

276
Description
Specifies whether the report label value should be output as the percentage of corresponding total
value.
Example
if ($Report1->ReportLabel1->IsPercent) {
$Report1->ReportLabel1->SetText("<b>" . $Report1->ReportLabel1->GetText()
. "</b>");
}

See also
TotalFunction property
NextProcessingDate Run-Time Property (PHP)
Applies to
Calendar Form
Type
array
Access
read
Syntax
object->NextProcessingDate

Description
Specifies the next date to the currently processing one. This property can be modified in the
Before Show Day, Before Show Week, Before Show Month and Before Show events.
See also
CurrentPrevDate property,
CurrentProcessingDate property
NumberOfColumns Run-Time Property (PHP)
Applies to
Directory Form
Type
number
Access
read/write
Syntax
object->NumberOfColumns [= value]

Description
Specifies a number of columns the directory form is split into. Value of this run-time property is
initialized from the "No. of columns" design-time property of the directory.
See also
NumberOfSubcategories Property
NumberOfSubcategories Run-Time Property (PHP)

277
Applies to
Directory Form
Type
number
Access
read/write
Syntax
object->NumberOfSubcategories [= value]

Description
This property contains maximum number of subcategories displayed for each category. No more
then property value subcategories are displayed. If there are more, they will be listed only after
navigating given category (so they become categories).
This property can be used to allow directory layout selection depending on user's preference.
See also
NumberOfColumns Property
Parent Run-Time Property (PHP)
Applies to
Button Control, Label Control, TextBox Control, TextArea Control, Checkbox Control, Image
Control, ImageLink Control, DatePicker Control, Hidden Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, Sorter Control, EditableGrid Form, Path
Control, Directory Form, FileUpload Control Calendar Form, CalendarNavigator, Includable Page,
Link, Navigator, Panel, Report Form, Report Label, Report Section,
Type
Reference
Access
read
Syntax
object->Parent

Description
Specifies parent container of an object, for example a record form for a textbox that is included
within that form.
Note: does not apply to panels.
PressedButton Run-Time Property (PHP)
Applies to
Record Form, EditableGrid Form
Type
string
Access
read/write
Syntax

278
 object->PressedButton [= value]

Description
This property contains the name of the button pressed to submit the form being processed. This
value is only set when operating in postback processing mode (it is not set when navigating page
without submit). The name of the button pressed is the same as record’s member variable
handling button requests (if the button name is “Update” there is a record’s member variable
Update of type clsButton).
See also
Errors Property
FormSubmitted Property
EditMode Property
PrevProcessingDate Run-Time Property (PHP)
Applies to
Calendar Form
Type
array
Access
read
Syntax
object->PrevProcessingDate

Description
Specifies the previous date to the currently processing one. The property can be modified in the
Before Show Day, Before Show Week, Before Show Month and Before Show events.
See also
CurrentProcessingDate and NextProcessingDate properties
ReadAllowed Run-Time Property (PHP)
Applies to
EditableGrid Form, Record Form
Type
boolean
Access
read/write
Syntax
object->ReadAllowed [= value]

Description
This property contains a boolean flag that if set to true, prevents data read operations from
executing.
See also
UpdateAllowed Property
DeleteAllowed Property
InsertAllowed Property

279
TemporaryFolder Run-Time Property (PHP)
Applies to
FileUpload Control
Type
string
Access
read/write
Syntax
object->TemporaryFolder [= value]

Description
This property contains the path used for storing temporary uploaded files before processing and
moving into target directory.
See also
AllowedFileMasks Property
DisallowedFileMasks Property
FileFolder Property
FileSizeLimit Property
TotalFunction Run-Time Property (PHP)
Applies to
ReportLabel Control,
Type
string
Access
read
Syntax
object->TotalFunction

Description
Specifies the function to be used if the value is to be auto-calculated. The default value is empty
string.
Type Description
(none) No function will be used.
Sum The report label value will be calculated as the sum of previous row values.
Count If the Control Source is empty the value will be calculated as the count of previous data
rows. Otherwise the value will be calculated as the count of previous data rows with non-
empty values.
Min The value will be calculated as the minimum of previous row values.
Max The value will be calculated as the maximum of previous row values.
Avg The value will be calculated as the average of non-empty values from previous rows.
Example
if ($Report1->ReportLabel1->TotalFunction == "Sum") {

280
 $Report1->ReportLabel1->SetText("<b>" . $Report1->ReportLabel1->GetText()
. "</b>");
}

See also
IsPercent property
Update Allowed Run-Time Property (PHP)
Applies to
Record Form, EditableGrid Form
Type
boolean
Access
read/write
Syntax
object->UpdateAllowed [= value]

Description
This property contains boolean flag that if set, prevents record update operation from executing.
This property is set automatically to False by the Record form if the access to the form is restricted
by setting its "Restricted" property to "Yes" in the IDE. If "Restricted" is set to "No", then
UpdateAllowed property is always True unless modified in the Before Update event. The value of
this property can be changed in the After Initialize event of the Page.
Note: Setting this property to False in the On Validate event or the Page's After Initialize event
results in hiding of the Update button.
Examples
The following example shows how to prevent a logged in user from updating an item that does not
belong to him/her. Additionally, the form displays an error message.

global $items;
if ($items->user_id->GetValue() != CCGetUserID())
{
$items->UpdateAllowed = false;
$items->Errors->addError("You are not allowed to edit this item.");
}

where $items is the name of the form.

See also
InsertAllowed Property
DeleteAllowed Property
ReadAllowed Property
ViewMode Run-Time Property (PHP)
Applies to
Repord Form,
Type
String

281
Access
read/write
Syntax
object->ViewMode

Description
Retrieves or specifies the report's view mode.

Type Description
Print The report will be displayed in print view mode.
Web The report will be displayed in Web view mode.
Example
$Report1->ViewMode = "Print";

Visible Run-Time Property (PHP)

Applies to
Button Control, Label Control, TextBox Control, TextArea Control, Checkbox Control, Image
Control, ImageLink Control, DatePicker Control, Hidden Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, Sorter Control, EditableGrid Form, Path
Control, Directory Form, FileUpload Control, Panel
Type
boolean
Access
read/write
Syntax
object->Visible [= value]

Description
Specifies whether the control is visible. Setting this field to false will prevent the object from being
displayed.
Note: Property is tested before calling Before Show Event. In order for the property change to be
taken into consideration it should be set earlier. For instance in parent component's Before Show
Event.
Note: Most of the controls need Extended HTML property checked, which allows them to be
hidden. This property is available after selecting Edit ... from the context menu of the control
during design-time.
Examples
The following example shows how to hide a form if there are no records retrieved from the
database.
global $items;
if ($items->DataSource->RecordsCount<1)
{
$items->Visible = false;
}

282
where $items is the name of the form.
Other examples
Hiding a Grid If No Records are Found,
Hiding a Record Form Control

Variables
DB<connectionname> Variable (PHP)
Applies to
Page Context
Type
object (clsDB<connectionname>)
Access
read-only
Syntax
global $DB<connectionname>
$DB<connectionname>->...

Description
This property is a global variable declared at the beginning of the page and represents each
database connection used within the page. The connection object encapsulates the
implementation details used to establish the connection with the database (i.e. database name,
location, user login/password, etc).

The database connection variable can be used to perform custom database operations (e.g. it is
used as the fourth argument of the CCDLookup function). The name of the database connection
object is created by prepending the connection name (configured in the CCS environment) with the
prefix "DB" (e.g. for a connection called Internet within CodeCharge Studio, the corresponding
variable name for the connection object would be DBInternet).
Examples
Lookup Single Field Value in a Database,
Create Custom Session Variables,
Execute Custom SQL,
Retrieve Multiple Field Values from a Database,
Utilize MySQL Enum Field Type
See also
ds Property
FileName Variable (PHP)
Applies to
Page Context
Type
string
Access
read-only
Syntax

283
 global $FileName;
$FileName = [value]

Description
This variable contains the name of the current page and is used to create links in the Navigator
and Sorter components. For instance, the First, Next, Previous and Last links in the Navigator link
to the page specified in this variable.
Examples
Add URL Parameters to a Page
PathToRoot Variable (PHP)
Applies to
Page Context
Type
string
Access
read/write
Syntax
global $PathToRoot;
$PathToRoot [= value]

Description
This variable contains a relative path to the root directory of the site from the location of the current
page. This property is usually used to reference common files generated by CodeCharge Studio in
the site's root directory. This includes JavaScript file paths.
See also
FileName Variable
TemplateFileName Variable
Redirect Variable (PHP)
Applies to
Record Form, Grid Form, EditableGrid Form
Type
string
Access
read/write
Syntax
global $Redirect;
$Redirect [= value]

Description
If not empty, the browser is redirected to the URL specified by the contents of this variable.The
Redirect variable is declared as a global variable at the top of the page and can therefore be
accessed in most of the events that occur later on in the page.
Note: The Redirect variable can be modified in the Button's onClick event, if the Return Page
property of this Button is empty.
Examples
Dynamically Redirect Users to Another Page

284
RelativePath Constant (PHP)
Applies to
Global constant
Type
string
Access
read/write
Syntax
define("RelativePath", [value])
RelativePath

Description
This constant variable contains the relative path of the current file based on its location on the web
server. This variable is used when loading the template file for the page and can also be used to
specify an alternate template file from a different location.

Note: Since this variable is a constant, you can refer to it without declaring it as global in your
event code and the dollar sign prefix is not needed.
See also
TemplateFileName Variable
FileName Variable
TemplateFileName Variable (PHP)
Applies to
Page Context
Type
string
Access
read/write
Syntax
global $TemplateFileName;
$TemplateFileName [= value]

Description
Stores the name of the HTML template file used by the current page. This variable can be altered
to load an alternate template file (for instance depending on language choice or style preference).
See also
FileName Variable
Tpl Variable (PHP)
Applies to
Page Context
Type
object
Access
read-only
Syntax
285
 global $Tpl;
$Tpl->...

Description
This variable represents the template file for the current page. It can be used to handle custom
template variables ({tag_name}) and template blocks.
Examples
global $Tpl;
$Tpl->SetVar("tag_name",$value);

Other examples
Working with Custom Template Blocks

Perl
Fuctions
CCAddParam Function (Perl)
Description
Adds a parameter with the specified value into the GET query string. If the parameter exists, its
value will be changed for ParameterValue.
Syntax
CCAddParam(QueryString, ParameterName, ParameterValue)

Return value
String
Parameters
Name Type Description Required
QueryString String Query string to which a parameter is added. Yes
ParameterName String Name of the parameter. Yes
ParameterValue String Value of the parameter. Yes
See also:
CCRemoveParam function,
CCGetQueryString function
CCDLookUp Function (Perl)
Description
Retrieves a single database value which can be a field or an expression. The arguments passed to
the function determine the value to be retrieved. Execution of this function causes any previously
retrieved records in the connection object to be overwritten with the new recordset.
Syntax
CCDLookUp(field, table, where_clause, connection)

286
Return value
string
Parameters
Name Type Description Required
field string Name of the database table field to be retrieved or an SQL Yes
expression whose value is to be retrieved.
table string The name of the table from which the value is to be retrieved Yes
(SQL JOIN directives are possible).
where_clause string SQL WHERE clause: the part of the SQL query that states the Yes
criteria for selecting the value.
connection cls Connection object against which the query will be executed. Yes
object

CCFormatDate Function (Perl)

Description
Formats a date value according to the specified format mask.
Syntax
CCFormatDate(DateToFormat,FormatMask)

Specification
Name Type Description Required
DateToFormat Array or Unix Date value to format. Yes
timestamp
FormatMask Array of Each string is one of the following components (all Yes
strings other components are left unchanged when building
formatted value):
d day
w week
m month
q quarter
y day of the year
h hour in 12-hour format
H hour in 24-hour format
n minute
s second
dd zero-filled day
ww week of year
mm zero-filled month
yy two-digit year

287
 hh zero-filled hour in 12-hour format
HH zero-filled hour in 24-hour format
nn zero-filled minute
ss zero-filled second
ddd short weekday name
mmm short month name
A/P A or P according to AM/PM
a/p a or p according to AM/PM
dddd weekday name
mmmm month name
yyyy year
AM/PM AM or PM
am/pm am or pm
LongDate long date format
LongTime long time format
ShortDate short date format
ShortTime short time format
GeneralDate general date format

CCGetCookie Function (Perl)

Description
Retrieves a value of the specified cookie.
Syntax
CCGetCookie(name)

Return value
string
Parameters
Name Type Description Required
name string Name of the cookie whose value is to be returned. Yes
See Also:
CCSetCookie
CCGetFromGet Function (Perl)
Description
Retrieves a GET input parameter value. The function first attempts to retrieve the parameter from
the GET query string and if no value is returned the function returns the default value specified in
the function call.
Syntax

288
 CCGetFromGet(ParameterName, DefaultValue)

Return value
string
Parameters
Name Type Description Required
ParameterName string Name of the parameter to retrieve. Yes
DefaultValue string The value to be assigned of the given parameter has no Yes
value. It can be an empty string.
See also:
CCGetParam function,
CCGetFromPost function
CCGetFromPost Function (Perl)
Description
Retrieves a POST input parameter value. The function first attempts to retrieve the parameter from
the POST query string and if no value is returned the function returns the default value specified in
the function call.
Syntax
CCGetFromPost(ParameterName, DefaultValue)

Return value
string
Parameters
Name Type Description Required
ParameterName string Name of the parameter to retrieve. Yes
DefaultValue string The value to be assigned if the given parameter has no value. Yes
It can be an empty string.
See also:
CCGetParam function,
CCGetFromGet function
CCGetGroupID Function (Perl)
Description
Retrieves the security group ID value of the currently logged-in user.
Syntax
CCGetGroupID()

Return value
number
Parameters
Name Type Description Required
none

289
See Also:
CCGetUserID,
CCGetUserLogin
CCGetParam Function (Perl)
Description
Retrieves a GET or POST input parameter value. The function first attempts to retrieve the
parameter from the GET query string and if no value is returned, the function checks for a POST
input parameter with the same name. If no value is returned by a GET or POST input parameter,
the function returns the default value specified in the function call.
Syntax
CCGetParam(ParameterName, DefaultValue)

Return value
string
Parameters
Name Type Description Required
ParameterName string Name of the GET or POST parameter whose value is to be Yes
returned.
DefaultValue string The value to be assigned of the given parameter has no Yes
value. It can be an empty string.
See also:
CCGetFromGet function,
CCGetFromPost function
CCGetQueryString Function (Perl)
Description
Retrieves a GET, POST or both (depending on the first parameter) input parameters value. If the
RemoveParameters array contains the names of parameters, then they will be removed from the
resulting string.
Syntax
CCGetQueryString(CollectionName, RemoveParameters)

Return value
String
Parameters
Name Type Description Required
CollectionName String Name of the parameter to retrieve. Possible values: Yes
"Form" Retrieves a POST input parameter value
"QueryString" Retrieves a GET input parameter value
"All" Retrieves a GET and POST input
parameter value
RemoveParameters Array Array of parameter names which will be removed from the Yes

290
 resulting string.

CCGetSession Function (Perl)

Description
Retrieves a value of the specified session variable.
Syntax
CCGetSession(name)

Return value
string
Parameters
Name Type Description Required
name string Name of the session variable whose value is to be returned. Yes
See Also:
CCSetSession
CCGetUserID Function (Perl)
Description
Retrieves the primary key value that uniquely identifies the currently logged-in user.
Syntax
CCGetUserID()

Return value
number
Parameters
Name Type Description Required
none
See Also:
CCGetUserLogin,
CCGetGroupID
CCGetUserLogin Function (Perl)
Description
Retrieves the login name of the currently logged-in user.
Syntax
CCGetUserLogin()

Return value
string
Parameters
Name Type Description Required
none
See Also:
291
CCGetUserID,
CCGetGroupID
CCParseDate Function (Perl)
Description
Parses the specified date string into an array according to the specified date format.
Syntax
CCParseDate(ParsingDate,FormatMask)

Specification
ParsingDate Required. Date to parse. Type: string
Optional. Format mask to parse the date with. Type: array of strings (see
FormatMask
CCFormatDate for available patterns)
Return Type: date
Value
Example
CCParseDate("2002 May 1",array("yyyy"," ","mmm"," ","d")) -> 2002-05-01

CCRemoveParam Function (Perl)

Description
Removes a parameter from the GET query string.
Syntax
CCRemoveParam(QueryString, ParameterName)

Return value
String
Parameters
Name Type Description Required
QueryString String Query string from which the parameter is removed. Yes
ParameterName String Name of the parameter to remove Yes
See also:
CCAddParam function
CCSetCookie Function (Perl)
Description
Creates a new cookie and assigns it the specified value or sets the specified value to the named
cookie if it already exists.
Syntax
CCSetCookie(Name, Value[, ExpireTime])

Return value

292
none
Parameters
Name Type Description Required
Name string Name of the cookie whose value is to be set. Yes
Value string The value to be assigned to the cookie. Yes
ExpireTime integer Number of seconds after which the cookie will be destroyed. If the Optional
parameter is not specified, then the cookie time expires after 1
year.
See Also:
CCGetCookie
CCSetSession Function (Perl)
Description
Creates a session variable and assigns it the specified value or sets the specified value to the
session variable if it already exists.
Syntax
CCSetSession(name, value)

Return value
none
Parameters
Name Type Description Required
name string Name of the session variable to be created or set. Yes
value string The value to be assigned to the session variable. Yes
See Also:
CCGetSession

ColdFusion
Variables
<control>Item Run-Time Variable (ColdFusion)
Applies to
Report
Type
structure
Access
read/write
Syntax
<cfset <expression> = <control>Item.ReportName>

Description
Structure with current report elements. Structure include key for each report control.

293
See also
<control name>Items
<control>Items Run-Time Variable (ColdFusion)
Applies to
Report
Type
array
Access
read/write
Syntax
<cfdump var="#<control>Items#">

Description
Array contains report lines. Each array item contains structure connected with current report
elements.
See also
<control name>Item
<control name>Rows Run-Time Variable (ColdFusion)
Applies to
EditableGrid
Type
structure
Access
read/write
Syntax
<cfset <expression>=<control>Rows[rPoz].Error>

Description
This variable contains an array of structures for each row in the Editable Grid. The structure is
composed of keys such as Error and Operation.
Key Description
Operation This key specifies the operation which will be performed for the current row. It's value
can be Insert, Update or Delete
Error This key contains any errors pertaining to a row within the form.

arr_<control name> Run-Time Variable (ColdFusion)

Applies to
ListBox control, CheckboxList control, RadioButton control
Access
read/write
Syntax
<cfset arr_<control>=<expression>>

294
Description
This variable contains an array of items of a list control (values and descriptions). The first element
of the array is the value of the first item, the next element is the item's description.
See also
query<control> Variable
blnDeleteAllowed<form> Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Record Form
Type
Boolean
Access
read/write
Syntax
<cfset blnDeleteAllowed<form>=<expression>>
<cfset <expression>=blnDeleteAllowed<form>>

Description
This is a Boolean variable whose value determines whether the delete operation should proceed
or not. The value of this property is set automatically based on the value of the Restricted
property of the form. If the Restricted property is set to No, the value of this property is always
True unless it is modified using event code in the Before Delete event.
See also
InsertAllowed<form> Variable
ReadAllowed<form> Variable
UpdateAllowed<form> Variable
blnEditMode<form> Run-Time Variable (ColdFusion)
Applies to
EditableGrid, Record
Type
Boolean
Access
read-only
Syntax
<cfset <expression> = blnEditMode<form>>
<cfset blnEditMode<form>=<expression>>

Description
This variable specifies the mode in which a form currently is in. A form can either be in Insert mode
or Edit mode.
See also
strError variable
strOperation variable
strPressedButton variable
blnFormSubmitted<control name> Run-Time Property (ColdFusion)
Applies to
295
EditableGrid Form, Record Form
Type
Boolean
Access
read-only
Syntax
<cfset <expression> = blnFormSubmitted&form>

Description
This variable determines how a form is processed based on whether the form is being shown for
the first time or has been submitted for postback. In the initial display, the form fields are assigned
data values before being displayed. Otherwise if the form has been submitted for postback, the
submitted data is processed based on the operation that was initiated upon submission.
See also
strError<form> Variable
blnInsertAllowed<form> Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Record Form
Type
Boolean
Access
read/write
Syntax
<cfset <expression>=blnInsertAllowed<form>>
<cfset blnInsertAllowed<form>=<expression>>

Description
This property determines whether the insert operation can proceed or not.
See also
DeleteAllowed<form> Variable
ReadAllowed<form> Variable
UpdateAllowed<form> Variable
blnReadAllowed<form> Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Record Form
Type
Boolean
Access
read/write
Syntax
<cfset <expression>=blnReadAllowed<form>>
<cfset blnReadAllowed<form>=<expression>

Description
This property determines whether data read operations can proceed or not.

296
See also
DeleteAllowed<form> Variable
InsertAllowed<form> Variable
UpdateAllowed<form> Variable
blnUpdateAllowed<form> Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Record Form
Type
Boolean
Access
read/write
Syntax
<cfset blnUpdateAllowed<form>=<expression>>
<cfset <expression>=blnUpdateAllowed<form>>

Description
This is a Boolean variable whose value determines whether the update database operation is
permitted. The value of this property is set automatically based on the value of the Restricted
property of the form. If the Restricted property is set to No, the value of this property is always
True unless it is modified using event code in the Before Update event.
See also
DeleteAllowed<form> Variable
InsertAllowed<form> Variable
ReadAllowed<form> Variable
CalendarEvents Run-Time Variable (ColdFusion)
Applies to
Calendar Form
Type
object
Access
read/write
Description
Contains the calendar events. This value can be manually modified.
Note: The value of this variable can be also modified in Before Show event.
Examples
The following example shows how to add new event.
<CFSET Evnt = StructNew()>
<CFSET CalendarEventKey=CreateDateTime(2005, 10, 31, 12, 30, 0)>
<CFSET Evnt.Time = CalendarEventKey>
<CFSET Evnt.EventTime=CalendarEventKey>
<CFSET Evnt.EventDescription = "Some text">
<CFSET StructInsert(CalendarEvents, CalendarEventKey, Evnt)>

CalendarStyles Run-Time Variable (ColdFusion)

297
Applies to
Calendar Form
Type
structure
Access
read/write
Description
Contains the calendar styles that depend on the builder settings.
Note: This variable can be modified in the Before Show event.
Examples
The following example shows how to change some styles.
<CFSET CalendarStyles.Day = "class = 'CellWithBlackText'">
<CFSET CalendarStyles.Today = "class = 'CellWithRedText'">

See also
CurrentStyle variable
CurrentDate Run-Time Variable (ColdFusion)
Applies to
Calendar Form
Type
date
Access
read/write
Syntax
<CFSET CurrentDate [= value]>

Description
Specifies the date shown in the calendar. For example, for the Monthly calendar the date can be
any date of this month.
Note: The value of this property can be modified in the Page's Before Show event.
Examples
The following example shows how to make the calendar always show January 2005.

<CFSET CurrentDate = CreateDate(2005, 1, 1)>

CurrentProcessingDate Run-Time Variable (ColdFusion)

Applies to
Calendar Form
Type
date
Access
read
Description
298
Specifies the currently processed date. The value of this variable can be modified in the Before
Show Day, Before Show Week, Before Show Month, and Before Show events.
See also
PrevProcessingDate variable,
NextProcessingDate variable
CurrentStyle Run-Time Variable (ColdFusion)
Applies to
Calendar Form
Type
string
Access
read/write
Description
Contains the calendar style of the currently processed block.
Note: This value of this variable can be modified in the Before Show Day, Before Show Week,
Before Show Month, and Before Show events.
Examples
The following example shows how to change style.
<CFSET CurrentStyle = "class = 'CellWithBlackText'">

See also
CalendarStyles property
DB_<connection name>_DS Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, Directory Form, EditableGrid Form, Grid Form, ListBox Control, Path Form,
RadioButton Control, Record Form
Type
string
Access
read/write
Syntax
<cfset Request.DB_Connection1_DS=<expression>>
<cfset <expression>=Request.DB_Connection1_DS>

Description
This variable contains the name of the data source which is used to retrieve data.
See also
DB_<connection name>_USER_PASSWORD variable
DB_<connection name>_USER_NAME variable
DB_<connection name>_DB_TYPE variable
DB_<connection name>_USER_PASSWORD; Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, Directory Form, EditableGrid Form, Grid Form, ListBox Control, Path Form,
RadioButton Control, Record Form
299
Type
string
Access
read /write
Syntax
<cfset Request.DB_Connection1_USER_PASSWORD=<expression>>
<cfset <expression>=Request.DB_Connection1_USER_PASSWORD>

Description
This variable contains the password specified for the connection
See also
DB_<connection name>_DS variable
DB_<connection name>_DB_TYPE variable
DB_<connection name>_USER_NAME variable
DB_<connection name>_DB_TYPE; Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, Directory Form, EditableGrid Form, Grid Form, ListBox Control, Path Form,
RadioButton Control, Record Form
Type
string
Access
read/write
Syntax
<cfset Request.DB_Connection1_DB_TYPE=<expression>>
<cfset <expression=Request.DB_Connection1_DB_TYPE>>

Description
This variable specifies the type of database driver used in the connection.
See also
DB_<connection name>_DS variable
DB_<connection name>_USER_PASSWORD variable
DB_<connection name>_USER_NAME variable
DB_<connection name>_USER_NAME Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, Directory Form, EditableGrid Form, Grid Form, ListBox Control, Path Form,
RadioButton Control, Record Form
Type
string
Access
read/write
Syntax
<cfset Request.DB_Connection1_USER_NAME=<expression>>
<cfset <expression>=Request.DB_Connection1_USER_NAME>

Description
300
This variable contains the username specified for the connection
See also
DB_<connection name>_USER_PASSWORD variable
DB_<connection name>_DS variable
DB_<connection name>_DB_TYPE variable
fld<control name> Run-Time Variable (ColdFusion)
Applies to
Label Control , TextBox Control, TextArea Control, Checkbox Control, Image Control, ImageLink
Control, Hidden Control, ListBox Control, CheckboxList Control, RadioButton Control, FileUpload
Control
Type
any
Access
read/write
Syntax
<cfset <expression>=fld<control>>
<cfset fld<control>=<expression>>

Description
Holds the value of the control. For list controls such as CheckBoxList and ListBox, this variable can
contain a semicolon separated list of values. For a Link, this is the value that will be displayed as
the link label (i.e. between <a> and </a> tags in the HTML code). For an Image, this value is the
image path.
See also
fld<control>Link Variable
hide<control> Variable
fld<control>Link Run-Time Variable (ColdFusion)
Applies to
ImageLink control, Link control
Type
string
Access
read/write
Syntax
<cfset fld<control>Link=<expression>>
<cfset <expression>= fld<control>Link>

Description
The Link variable stores the URL (including the query string) that is assigned to the HREF attribute
of an HTML link. This variable is used only by the Link and Image Link controls.
See also
fld<control name> variable
hide<control> Run-Time Variable (ColdFusion)
Applies to

301
Button Control, Label Control, TextBox Control, TextArea Control, Checkbox Control, Image
Control, ImageLink Control, DatePicker Control, Grid Form, ListBox Control, CheckboxList Control,
RadioButton Control, Record Form, Sorter Control, Navigator Control, EditableGrid Form, Path
Form, Directory Form, FileUpload Control, Panel
Type
Boolean
Access
read/write
Syntax
<cfset hide<control>=<expression>>
<cfset <expression>=hide<control>>

Description
This variable determines the visibility of a control. Be default, the value of this variable is False,
meaning that the control is visible. However, if the variable is set to True, the control will be hidden.
See also
fld<control> Variable
intEmptyRows Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form
Type
Access
Syntax
<CFSET intEmptyRows=<expression>>
<CFSET <expression>=intEmptyRows>

Description
This variable specifies the number of empty rows to be displayed for inserting new data.
See also
intPage Run-Time Variable (ColdFusion)
Applies to
Report
Type
number
Access
read/write
Syntax
<cfset intPageSize = 100>

Description
Specify the page number for the Web View mode.
See also
intPageSize
ViewMode

302
intPageSize Run-Time Variable (ColdFusion)
Applies to
Report
Type
number
Access
read/write
Syntax
<cfset intPageSize = 100>

Description
Specify the page size for the print mode of report.
See also
intPage
ViewMode
intShownRecords Run-Time Variable (ColdFusion)
Applies to
Grid Form
Type
string
Access
read
Syntax
<<expression>=intShownRecords>

Description
This variable contains the number of records shown on a page. This variable can be used in the
Before Show Row event.
NextProcessingDate Run-Time Variable (ColdFusion)
Applies to
Calendar Form
Type
date
Access
read
Description
Specifies the next date to the currently processing one. This variable can be modified in the Before
Show Day, Before Show Week, Before Show Month and Before Show events.
See also
CurrentPrevDate variable,
CurrentProcessingDate variable
NumberOfColumns Run-Time Variable (ColdFusion)
Applies to
303
Directory Form
Type
integer
Access
read/write
Syntax
<cfset NumberOfColumns=<expression>>

<cfset <expression>=NumberOfColumns>

Description
This variable specifies the number of columns over which a Directory form will display its
categories. This property can be used to allow the user to customize the layout of the Directory
form by specifying the number of columns they want to see in the Directory form.
See also
NumberOfSubCategories Variable
NumberOfSubCategories Run-Time Variable (ColdFusion)
Applies to
Directory Form
Type
integer
Access
read/write
Syntax
<cfset NumberOfSubCategories=<expression>>
<cfset <expression>= NumberOfSubCategories>

Description
This variable specifies the maximum number of subcategories to be displayed for each top level
category of a Directory form.
See also
NumberOfColumns Variable
par<control name>.FileFolder Run-Time Variable (ColdFusion)
Applies to
FileUpload Control
Type
string
Access
read/write
Syntax
<cfset par<control>.FileFolder=<expression>>
<cfset <expression>=par<control>.FileFolder>

Description
This variable specifies the target folder into which uploaded files will be stored.
304
See also
par<control>.TemporaryFolder Variable
par<control>.TemporaryFolder Run-Time Variable (ColdFusion)
Applies to
FileUpload Control
Type
string
Access
read/write
Syntax
<cfset par<control>.TemporaryFolder=<expression>>
<cfset <expression>=par<control>.TemporaryFolder>

Description
This variable contains the path used for storing uploaded files temporarily before they are moved
into the target folder. The property specifies the full path or the relative path from the page folder to
the temporary folder.
See also
par<control>.FileFolder Variable
PathToCurrentPage Run-Time Variable (ColdFusion)
Applies to
Page context
Type
string
Access
read/write
Syntax
<CFSET <expression>=pathToCurrentPage>
<CFSET pathToCurrentPage=<expression>>

Description
This variable contains the path of the current page relative to the root directory of the site.
See also
PathToRoot variable
PathToRoot Run-Time Variable (ColdFusion)
Applies to
Page context
Type
string
Access
read/write
Syntax

305
 <cfset <expression> = PathToRoot>
<cfset PathToRoot=<expression>>

Description
This variable contains a relative path to the root directory of the site from the location of the current
page. This property is usually used to reference custom tags and common files generated by
CodeCharge Studio in the site's root directory. This includes JavaScript file paths, etc.
See also
PathToCurrentPage variable
PrevProcessingDate Run-Time Variable (ColdFusion)
Applies to
Calendar Form
Type
date
Access
read
Description
Specifies the previous date to the currently processing one. The variable can be modified in the
Before Show Day, Before Show Week, Before Show Month and Before Show events.
See also
CurrentProcessingDate variable,
NextProcessingDate variable
query<control> Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, Directory Form, EditableGrid Form, Grid Form, ListBox Control, Path Form,
RadioButton Control, Record Form
Type
query
Access
read/write
Syntax
<cfset <expression>=query<control>.<variable>>

Description
This variable contains the query associated with a given object. The query can be used to perform
additional queries or access query results
See also
strSQL Variable
strOrder Variable
strWhere Variable
strSQL<control> Variable
strOrder<control> Variable
strWhere<control> Variable
FileName Run-Time Variable (ColdFusion)

306
Applies to
Page context
Type
string
Access
read/write
Syntax
<cfset value = strFileName> (CF)

<cfset value = Request.strFileName> (CFT)

Description
This variable contains the name of the target page for the links in the navigator and sorter
components. This filename is used to build links (column headers for sorters and next, previous,
numbers links for navigators). This variable is declared in the Request scope for ColdFusion and
Templates.
See also
strRedirect Variable
strErr<form> Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Record Form
Type
string
Access
read/write
Syntax
<cfset strError<form>=<expression>>
<cfset <expression>=strError<form>>

Description
This variable contains error messages pertaining to the form as a result of the form's execution.
See also
strEditModed<form> Variable
strRedirect Variable
blnFormSubmitted<form> Variable
strOperation Variable
strPressedButton Variable
strOperation Run-Time Variable (ColdFusion)
Applies to
Record Form
Type
string
Access
read/write

307
Syntax
<cfset <expression>=strOperation>
<cfset strOperation=<expression>>

Description
This variable specifies the operation to be performed after one of the submit buttons in a form has
been clicked to initiate postback.
See also
strEditModed<form> Variable
strError<form> Variable
strPressedButton Variable
strOrder Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Grid Form, Directory Form, Path Form
Type
string
Access
read/write
Syntax
<cfset strOrder=<expression>>
<cfset <expression>=strOrder>

Description
This variable contains the Order By clause for the SQL query to be executed. This variable can be
modified in the Before Build Select event.
See also
strSQL Variable
strWhere Variable
query<control> Variable
strOrder<control> Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, ListBox Control, RadioButton Control Record Form
Type
string
Access
read/write
Syntax
<cfset strOrder<control>=<expression>>
<cfset <expression>=strOrder<control>>

Description
This variable contains the Order By clause for the SQL query to be executed. This variable can be
modified in the Before Build Select event.
See also

308
strWhere<control> Variable,
strSQL<control> Variable
query<control> Variable
strPressedButton Run-Time Variable (ColdFusion)
Applies to
Record Form, EditableGrid Form
Type
string
Access
read
Syntax
<cfset <expression>=strPressedButton>
<cfset strPressedButton=<expression>>

Description
This variable contains the name of the form's submit button which was clicked to initiate postback.
See also
strEditModed<form> variable
strError variable
strOperation variable
strRedirect Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Record Form
Type
string
Access
read/write
Syntax
<CFSET strRedirect=<expression>>
<CFSET <expression>=strRedirect>

Description
If not empty, the browser is redirected to the URL specified by the contents of this variable.
See also
strFileName Variable
strError<form> Variable
strSQL Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Grid Form, Directory Form, Path Form
Type
string
Access
read/write
Syntax

309
 <cfset strSQL=<expression>>
<cfset <expression>=strSQL>

Description
This variable contains the SQL query string to be executed. This variable can be modified in the
Before Build Select event.
See also
strOrder Variable
strWhere Variable
query<control> Variable
strSQL<control> Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, ListBox Control, RadioButton Control Record Form
Type
string
Access
read/write
Syntax
<cfset strSQL<control>=&expression>>
<cfset &expression>=strSQL<control>>

Description
This variable contains the SQL query string to be executed to retrieve data for a control. This
variable can be modified in the Before Build Select event.
See also
strOrder<control> Variable
strWhere<control> Variable
query<control> Variable
strSQL Run-Time Variable (ColdFusion)
Applies to
Record
Type
string
Access
read/write
Syntax
<cfset <expression>=strSQL>
<cfset strSQL=<expression>>

Description
This variable contains the SQL query string to be executed in a cfquery tag in order to perform
insert, update or delete operations. This variable can be modified in events like Before Execute
Update,Before Execute Delete etc.
See also
strOrder<control> Variable
strWhere<control> Variable

310
strTemplateFileName Run-Time Variable (ColdFusion)
Applies to
Page context
Type
string
Access
Syntax
<cfset <expression> = strTemplateFileName>
<cfset strTemplateFileName=<expression>>

Description
This variable contains the name of the template file. The file is parsed to create the final page that
is sent to the browser. This applies to ColdFusion and Templates only.
See also
strFileName variable
strWhere Run-Time Variable (ColdFusion)
Applies to
EditableGrid Form, Grid Form, Directory Form, Path Form
Type
string
Access
read/write
Syntax
<cfset strWhere=<expression>>
<cfset <expression>=strWhere>

Description
This variable contains the Where clause of the SQL statement to be executed. This variable can
be modified in the Before Build Select event.
See also
strOrder Variable
strSQL Variable
query<control> Variable
strWhere<control> Run-Time Variable (ColdFusion)
Applies to
CheckboxList Control, ListBox Control, RadioButton Control Record Form
Type
string
Access
read/write
Syntax
<cfset strWhere<control>=<expression>>
<cfset <expression>=strWhere<control>>

Description
311
This variable contains the Where clause of the SQL statement to be executed. This variable can
be modified in the Before Build Select event.
See also
strOrder<control> Variable
strSQL<control> Variable
query<control> Variable
ViewMode Run-Time Variable (ColdFusion)
Applies to
Report
Type
string
Access
read/write
Syntax
<cfset ViewMode = "Print">

Description
Specify the default view mode, which will be used for report.
Type Description
Print The current report displayed in the Print View Mode.
Web The current report displayed in the Web View Mode.

Java
Methods
A-G
addError Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public void addError(java.lang.String error);
public void
addError(com.codecharge.validation.ControlErrorType,java.lang.String);

Parameters
Name Description
error The Error description
Description
This method adds error description to an error collection.

312
addError Method (Java)

Applies to
Data Source
Syntax
public void addError(java.lang.String error);

Parameters
Name Description
error The error message
Description
This method adds the error message to an error collection.
addValue Method (Java)

Applies to
CheckBoxList Control, RadioButton Control, ListBox Control
Syntax
public void addValue(java.lang.Object);
public void addValue(java.lang.String value);
public void addValue(long);
public void addValue(double);
public void addValue(boolean);

Parameters
Name Type Description
value String Value to add to selected values list
Description
This method adds a value to selected values list for Multiselect lists.
addParameter Method (Java)

Applies to
Link Control, ImageLink Control
Syntax
public void addParameter(com.codecharge.util.LinkParameter param);

Parameters
Name Description
param link parameter
Description
This method adds LinkParameter to Collection of parameters.
closeConnection Method (Java)

313
Applies to
JDBCConnection Object
Syntax
public abstract void closeConnection();

Description
This method returns a connection to the pool. It doesn't really close the connection but returns it to
the connection pool to be reused in future.
closeStatement Method (Java)

Applies to
JDBCConnection Object
Syntax
public void closeStatement(java.sql.CallableStatement cstmt);
public void closeStatement(java.sql.Statement);

Parameters
Name Type Description
cstmt CallableStatement The Callable Statement object to free.
Description
This method frees a Statement object if it is not needed.
createCallableStatement Method (Java)

Applies to
JDBCConnection Object
Syntax
public CallableStatement createCallableStatement(java.lang.String callString);

Return value
CallableStatement - callable statement object
Parameters
Name Type Description
callString String The Query that calls a stored procedure
Description
This method creates CallableStatement by preparing a procedure call provided by a callString
parameter.
createPreparedStatement Method (Java)

Applies to
JDBCConnection Object
Syntax
public PreparedStatement createPreparedStatement(java.lang.String sql);

314
Return value
PreparedStatement - prepared statement object
Parameters
Name Type Description
sql String SQL query with parameters
Description
This method creates PreparedStatement from SQL indicated by an SQL parameter.
PreparedStatement differs from an ordinary Statement by the fact that question marks can be used
in the place of query parameters.
createStatement Method (Java)

Applies to
JDBCConnection Object
Syntax
public Statement createStatement();

Return value
Statement - statement object.
Description
This method specifies the Statement object that can be used to query a database with SQL
(executeQuery).
currentRow Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public HashMap currentRow();

Return value
HashMap - a HashMap of all row controls.
Description
This method returns the current row.
execute Method (Java)

Applies to
JDBCConnection Object
Syntax
public boolean execute(java.sql.CallableStatement cstmt);

Return value
boolean - 'true' if operation was successful, 'false' otherwise
Parameters
Name Type Description

315
cstmt CallableStatement The callable statement object created by createCallableStatement
method
Description
This method executes the Stored Procedure.
executeUpdate Method (Java)

Applies to
JDBCConnection Object
Syntax
public int executeUpdate(java.lang.String sql);

Return value
int - either the row count for INSERT, UPDATE or DELETE statements, or 0 for SQL statements
that return nothing, or -1 if parameter is null
Parameters
Name Type Description
sql String The SQL query string
Description
This method executes the INSERT/UPDATE/DELETE SQL-query.
getButton Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public Button getButton(java.lang.String name);

Return value
Button - the Button with the given name or null if it does not exist.
Parameters
Name Description
name The Button name
Description
This method finds a Button in a children collection by name.
getCategoryNumberInColumn Method (Java)

Applies to
Directory Form
Syntax
public long getCategoryNumberInColumn();

Return value
long - The Number of Categories in a column.

316
Description
This method retrieves the Number of Categories in a column.
getCheckBoxList Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public CheckBoxList getCheckBoxList(java.lang.String);

Return value
CheckBoxList - the CheckBoxList with the given name or null if it does not exist.
Parameters
Name Description
name The CheckBoxList name
Description
This method finds a CheckBoxList in a children collection by name.
getChild Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public Model getChild(java.lang.String name);

Return value
Model - the Child of the given name or null if it does not exist.
Parameters
Name Description
name The Model name
Description
This method finds a Child in a children collection by name.
getChildren Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public Collection getChildren();

Return value
Collection - a collection with all children
Description
This method returns all children as a collection.

317
getControl Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public Control getControl(java.lang.String name);

Return value
Control - the Control of the given name or null if it does not exist.
Parameters
Name Description
name The Control name
Description
This method finds a Control in a children collection by name.
getComponent Method (Java)

Applies to
Panel
Syntax
public Model getComponent(java.lang.String name);

Return value
Model - the Child with the given name or null if it does not exist.
Parameters
Name Description
name The Model name
Description
This method finds a Child in a children collection by name.
getComponent Method (Java)

Applies to
Page Object
Syntax
public Component getComponent(java.lang.String name);

Return value
Component - the Component of the given name or null if no such Component exists
Parameters
Name Type Description
name String the Component name
Description
This method finds Component in a children collection by name.

318
getComponents Method (Java)

Applies to
Panel
Syntax
public Collection getComponents();

Return value
Collection - a collection with all children
Description
This method returns all children as a collection.
getComputeAt Method (Java)

Applies to
ReportLabel Control
Syntax
public String getComputeAt();

Return value
String - the name of report group, relative to percent value will be calculated.
Description
Gets the name of report group, relative to percent value will be calculated.
getComputeAtFunction Method (Java)

Applies to
ReportLabel Control
Syntax
public FunctionHandler getComputeAtFunction();

Return value
FunctionHandler - teh function to be used if the value is to be auto-calculated relative value of the
another group.
Description
Returns the function to be used if the value is to be auto-calculated relative value of the another
group.
getConnection Method (Java)

Applies to
JDBCConnection Object
Syntax
public abstract void getConnection();

Description

319
This method is used to obtain a connection from pool of connections. A new connection is created
only if there is no free connections; otherwise connections are reused. You should call
closeConnection method if there is no need to return connection to the pool.
getCurrentCategoryId Method (Java)

Applies to
Directory Form
Syntax
public long getCurrentCategoryId();

Return value
long
Description
This method retrieves the ID of the currently selected Category.
getCurrentCategoryNumber Method (Java)

Applies to
Directory Form
Syntax
public long getCurrentCategoryNumber();

Return value
long
Description
This method gets the order number of the current category.
getCurrentItem Method (Java)

Applies to
Calendar Form
Syntax
public CalendarItem getCurrentItem();

Return value
CalendarItem - the current calendar item if it is available; otherwise - null;
Description
This method returns the current calendar item if it is available.
getCurrentProcessingDate Method (Java)

Applies to
Calendar Form
Syntax
public Date getCurrentProcessingDate();

Return value
320
java.util.Date - currently processed date to be used in events.
Description
This method returns the currently processed date to be used in events.
getCurrentRow Method (Java)

Applies to
Report Form
Syntax
public ReportRow getCurrentRow();

Return value
ReportRow - the current Report detail row.
Description
Returns the current Report detail row.
getCurrentStyle Method (Java)

Applies to
Calendar Form
Syntax
public String getCurrentStyle();

Return value
String - the style (not style name) applied to the current Calendar section.
Description
This method returns the style (not style name) applied to the current Calendar section.
getCurrentSubCategoryNumber Method (Java)

Applies to
Directory Form
Syntax
public long getCurrentSubCategoryNumber();

Return value
long
Description
This method gets the order number of the current subcategory.
getDateField Method (Java)

Applies to
Calendar Form
Syntax
public String getDateField();

321
Return value
String - the field name pointing to the Event Date.
Description
This method returns field name pointing to the Event Date.
getDatePicker Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public DatePicker getDatePicker(java.lang.String name);

Return value
DatePicker - the DatePicker with the given name or null if it does not exist.
Parameters
Name Description
name The DatePicker name
Description
This method finds a DatePicker in a children collection by name.
getDirectory Method (Java)

Applies to
Page Object
Syntax
public Directory getDirectory(java.lang.String name);

Return value
Directory - the Directory of the given name or null if no such Directory exists
Parameters
Name Type Description
name String The Directory name
Description
This method finds a Directory in a children collection by name.
getEditableGrid Method (Java)

Applies to
Page Object
Syntax
public EditableGrid getEditableGrid(java.lang.String name);

Return value
EditableGrid - the EditableGrid of the given name or null if no such EditableGrid exists
Parameters
322
Name Type Description
name String The Record name
Description
This method finds an EditableGrid in a children collection by name.
getEmptyText Method (Java)

Applies to
ReportLabel Control
Syntax
public String getEmptyText();

Return value
String - the text to display when the label's value is empty.
Description
Gets the text to display when the label's value is empty.
getErrorsAsString Method (Java)

Applies to
Data Source
Syntax
public String getErrorsAsString();

Return value
String - a String that represents all errors.
Description
This method retrieves all errors as one string.
getErrorsAsString Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public String getErrorsAsString();

Return value
String - the errors description
Description
This method gets and formats all errors as String presenting each error description on a separate
line.
getErrorsAsString Method (Java)

Applies to
323
JDBCConnection Object
Syntax
public String getErrorsAsString();

Return value
String - a String that represents all the errors.
Description
This method gets all errors represented as one string.
getFile Method (Java)

Applies to
Page Object
Syntax
public UploadedFile getFile(java.lang.String name);

Return value
UploadedFile - a UploadedFile object representing the single file
Parameters
Name Type Description
name String A String specifying the name of the file.
Description
This method returns the UploadedFile object that represents an uploaded file, or null if the file has
not been uploaded.
getFileUpload Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public FileUpload getFileUpload(java.lang.String name);

Return value
FileUpload - the FileUpload with the given name or null if it does not exist.
Parameters
Name Description
name The FileUpload name
Description
This method finds a FileUpload in a children collection by name.
getFormattedOptions Method (Java)

Applies to
CheckBoxList Control, RadioButton Control, ListBox Control
Syntax
324
 public Enumeration getFormattedOptions();

Return value
Enumeration - Enumeration of String arrays in form {BOUND_COLUMN, TEXT_COLUMN,
SELECTED}
Description
This method prepares a collection list for output. It marks list values selected by request.
getFormattedValue Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public String getFormattedValue();

Return value
String - the formatted value of a control
Description
This method gets the value formatted according to the format of a control.
getFunction Method (Java)

Applies to
ReportLabel Control
Syntax
public FunctionHandler getFunction();

Return value
FunctionHandler - the function to be used if the value is to be auto-calculated.
Description
Returns the function to be used if the value is to be auto-calculated.
getGrid Method (Java)

Applies to
Page Object
Syntax
public Grid getGrid(java.lang.String name);

Return value
Grid - the Grid of the given name or null if such Grid does not exist.
Parameters
Name Type Description
name String The Grid name
Description
325
This method finds a Grid in a children collection by name.
getHeight Method (Java)

Applies to
ReportSection Control
Syntax
public double getHeight();

Return value
double - the height of section in lines.
Description
Gets the height of section in lines.
getHttpGetParameter Method (Java)

Applies to
Page Object
Syntax
public String getHttpGetParameter(java.lang.String name);

Return value
String - a String representing the single value of the parameter
Parameters
Name Type Description
name String A String specifying the name of the parameter
Description
This method returns the value of a request GET parameter as a String, or null if parameter does
not exist.
getHttpGetParameters Method (Java)

Applies to
Page Object
Syntax
public RequestParameters getHttpGetParameters();

Return value
RequestParameters
getHttpPostParameter Method (Java)

Applies to
Page Object
Syntax
public String getHttpPostParameter(java.lang.String name);

326
Return value
String - a String representing the single value of the parameter
Parameters
Name Type Description
name String A String specifying the name of the parameter
Description
This method returns the value of a request POST parameter as a String, or null if parameter does
not exist.
getHttpPostParameters Method (Java)

Applies to
Page Object
Syntax
public RequestParameters getHttpPostParameters();

Return value
RequestParameters
getJDBCConnection Method (Java)

Applies to
JDBCConnectionFactory
Syntax
public static JDBCConnection getJDBCConnection(java.lang.String
connectionName);
public static JDBCConnection getJDBCConnection(java.lang.String,boolean);

Return value
JDBCConnection - the JDBCConnection of the given name or null if it is impossible
Parameters
Name Type Description
connectionName String The Connection name
Description
This method creates a new JDBCConnection by connection name.
getLink Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public Link getLink(java.lang.String name);

Return value
Link - the Link with the given name or null if it does not exist.
Parameters
327
Name Description
name The Link name
Description
This method finds a Link in a children collection by name.
getListBox Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public ListBox getListBox(java.lang.String name);

Return value
ListBox - the ListBox with the given name or null if it does not exist.
Parameters
Name Description
name The ListBox name
Description
This method finds a ListBox in a children collection by name.
getMonth Method (Java)

Applies to
Calendar Form
Syntax
public int getMonth();

Return value
int - the month number to be shown.
Description
This method returns the month number to be shown.
getMonths Method (Java)

Applies to
Calendar Form
Syntax
public int getMonths();

Return value
int - the number of months to be shown
Description
This method returns number of months to be shown.
getMonthsInRow Method (Java)

328
Applies to
Calendar Form
Syntax
public int getMonthsInRow();

Return value
int - the number of months in the calendar row for the yearly and quarterly calendars.
Description
This method returns the number of months in the calendar row for the yearly and quarterly
calendars. If monthsInRows == 0 all months will be shown in one row.
getNavigator Method (Java)

Applies to
Grid Form, EditableGrid Form
Syntax
public Navigator getNavigator(java.lang.String name);

Return value
Navigator - the Navigator of the given name or null if such Navigator does not exist.
Parameters
Name Description
name the Navigator name
Description
This method finds a Navigator in a children collection by name.
getNumberOfCategories Method (Java)

Applies to
Directory Form
Syntax
public long getNumberOfCategories();

Return value
long
Description
This method retrieves the Number of Categories.
getNumberOfColumns Method (Java)

Applies to
Directory Form
Syntax
public long getNumberOfColumns();

Return value

329
long
Description
This method retrieves the Number of Columns used to display a directory.
getNumberOfRows Method (Java)

Applies to
Data Source
Syntax
public long getNumberOfRows();

Return value
long - the total number of rows.
Description
This method retrieves the total number of rows.
getNumberOfRows Method (Java)

Applies to
Directory Form
Syntax
public long getNumberOfRows();

Return value
long
Description
This method retrieves the Total Number of Records at the current directory level.
getNumberOfRows Method (Java)

Applies to
Grid Form, EditableGrid Form
Syntax
public long getNumberOfRows();

Return value
long - the total number of rows.
Description
This method gets the total number of rows.
getNumberOfSubCategories Method (Java)

Applies to
Directory Form
Syntax
public long getNumberOfSubCategories();

330
Return value
long
Description
This method retrieves the Number of Subcategories shown for each category.
getOptions Method (Java)

Applies to
CheckBoxList Control, RadioButton Control, ListBox Control
Syntax
public Enumeration getOptions();

Return value
Enumeration - options list in form of Enumeration of HashMaps:
{{BOUND_COLUMN,TEXT_COLUMN},...}
Description
This method gets Options list in form of Enumeration of Strings.
getOneRow Method (Java)

Applies to
JDBCConnection Object
Syntax
public DbRow getOneRow(java.lang.String sql);
public DbRow getOneRow(java.sql.ResultSet);

Return value
DbRow - DbRow containing result or null if recordset is empty.
Parameters
Name Type Description
sql String The SQL query string
Description
This method gets one row from SQL query result.
getOptionsString Method (Java)

Applies to
ListBox Control
Syntax
public String getOptionsString();

Return value
String - HTML representation of ListBox component.
Description
This method prepares the HTML output for ListBox. The output consists of a list of HTML option
elements ready for output.

331
getPage Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public Page getPage();

Return value
Page
Description
This method retrieves the page containing the control.
getPage Method (Java)

Applies to
Grid Form, EditableGrid Form
Syntax
public int getPage();

Return value
int - Page number
Description
This method retrieves the current page of a Grid.
getPageNumber Method (Java)

Applies to
Report Form
Syntax
public int getPageNumber();

Return value
int - current Report page number.
Description
Returns the current Report page number.
getPageSize Method (Java)

Applies to
Grid Form, EditableGrid Form
Syntax
public int getPageSize();

Return value
int - number of records per page.

332
Description
This method retrieves number of records per page. It is an equivalent of getFetchSize.
getPageSizeLimit Method (Java)

Applies to
Report Form
Syntax
public double getPageSizeLimit();

Return value
double - the value of page size limit if viewMode is Report.VIEW_MODE_WEB.
Description
Returns int value of page size limit if viewMode is Report.VIEW_MODE_WEB; otherwise returns
zero. Zero means that all records should be displayed. PageSizeLimit is applied to web mode only.
getPageModel Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public Page getPageModel();

Return value
Page - the page of a component
Description
This method retrieves the page where the component is placed.
getParameter Method (Java)

Applies to
Page Object
Syntax
public String getParameter(java.lang.String name);
public String getParameter(java.lang.String name,java.lang.String name);

Return value
String - a String representing the single value of the parameter
Parameters
Name Description
name A String specifying the name of the parameter
Description
This method returns the value of a request parameter as a String, or null if parameter does not
exist.
getParameter Method (Java)

333
Applies to
LinkControl, ImageLink Control
Syntax
public LinkParameter getParameter(java.lang.String name);

Return value
LinkParameter
Parameters
Name Type Description
name String The Parameter name
Description
This method finds a LinkParameter in parameters collection by its name.
getParent Method (Java)

Applies to
Button Control, DatePicker Control, Navigator Control, Sorter Control, Image Control, Label
Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox Control, Hidden
Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control, ImageLink
Control, Grid Form, EditableGrid Form, Record Form, Directory Form, Page Form, Path Form,
Panel
Syntax
public Component getParent();

Return value
Component - parent component
Description
This method gets the parent component that contains this control or component.
getPath Method (Java)

Applies to
Page Object
Syntax
public Path getPath(java.lang.String);

Return value
Path - the Path of the given name or null if no such Path exists
Parameters
Name Type Description
name String The Path name
Description
This method finds a Path in a children collection by name.
getPoolName Method (Java)

334
Applies to
JDBCConnection Object
Syntax
public String getPoolName();

Return value
String - connection name
Description
This method gets the Pool name. The name corresponds to CCS Connection name.
getPrintPageSize Method (Java)

Applies to
Report Form
Syntax
public int getPrintPageSize();

Return value
int - the height of Report page in print view mode.
Description
Returns the height of Report page in print view mode.
getRadioButton Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public RadioButton getRadioButton(java.lang.String name);

Return value
RadioButton - the RadioButton with the given name or null if it does not exist.
Parameters
Name Description
name The Radio Button name
Description
This method finds a Radio Button in a children collection by name.
getRecord Method (Java)

Applies to
Page Object
Syntax
public Record getRecord(java.lang.String name);

Return value
Record - the Record of the given name or null if such Record does not exist.

335
Parameters
Name Type Description
name String The Record name.
Description
This method finds a Record in a children collection by name.
getRedirectString Method (Java)

Applies to
Page Object
Syntax
public String getRedirectString();

Return value
String - a String containing the redirection URL.
Description
This method returns the redirection URL string.
getRequest Method (Java)

Applies to
Page Object
Syntax
public HttpServletRequest getRequest();

Return value
HttpServletRequest - the HttpServletRequest associated with this page.
Description
This method returns the current request associated with this page.
getResetAt Method (Java)

Applies to
ReportLabel Control
Syntax
public String getResetAt();

Return value
String - the name of the report group where the control value should be reset.
Description
Retrieves the name of the report group where the control value should be reset.
getResponse Method (Java)

Applies to
Page Object

336
Syntax
public HttpServletResponse getResponse();

Return value
HttpServletResponse - the HttpServletResponse associated with this page.
Description
This method returns the current response associated with this page.
getRowNumber Method (Java)

Applies to
Report Form
Syntax
public int getRowNumber();

Return value
int - the current report row number starting from one.
Description
Returns the current report row number starting from one.
getRows Method (Java)

Applies to
JDBCConnection Object
Syntax
public Enumeration getRows(java.lang.String sql,int start,int max);
public Enumeration getRows(java.sql.ResultSet,int,int);
public Enumeration getRows(java.lang.String);
public Enumeration getRows(java.sql.ResultSet);

Return value
Enumeration - the data produced by the given query in form of Enumeration object
Parameters
Name Type Description
sql String The Static SQL SELECT statement
start unt The position of first record to read
max int The maximum number of records to read
Description
This method returns Enumeration of DbRows representing records from the ResultSet
getSection Method (Java)

Applies to
Report Form
Syntax

337
 public ISection getSection(String name);

Return value
ISection - Report section with specified name.
Parameters
Name Type Description
name String The name of requested Section
Description
Returns the section with given name.
getSorter Method (Java)

Applies to
Grid Form, EditableGrid Form
Syntax
public Sorter getSorter(java.lang.String name);

Return value
Sorter - the Sorter of the given name or null if such Sorter does not exist.
Parameters
Name Description
name the Sorter name
Description
This method finds a Sorter in a children collection by name.
getTemplate Method (Java)

Applies to
Page Object
Syntax
public Template getTemplate();

Return value
• Template - the Template object
• or null
Description
This method returns the Template object for the direct usage of the template library or null for JSP.
getTimeField Method (Java)

Applies to
Calendar Form
Syntax
public String getTimeField();

338
Return value
String - the field name pointing to the Event Time.
Description
This method returns the field name pointing to the Event Time. If 'null,' the Calendar will obtain the
Event Time from the dateField field.
getTotalPages Method (Java)

Applies to
Report Form
Syntax
public int getTotalPages();

Return value
int - number of the report pages.
Description
Returns number of the report pages.
getValue Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public Object getValue();

Return value
Object - the unformatted control value.
Description
This method retrieves the value of a control before it is formatted.
getViewMode Method (Java)

Applies to
Report Form
Syntax
public int getViewMode();

Return value
int - the Report view mode
Description
Returns Report view mode. If print view mode is disabled Report.SHOW_MODE_WEB will always
be returned.
getVisualStyle Method (Java)

Applies to
339
Calendar Form
Syntax
public String getVisualStyle(String name);

Return value
String - the field name pointing to Event Style.
Parameters
Name Type Description
name String Style with specified name.
Description
This method returns the Style with the specified name.
getVisualStyles Method (Java)

Applies to
Calendar Form
Syntax
public Map getVisualStyles();

Return value
java.util.Map - the map containing styles that represent days of months, weeks, etc.
Description
This method returns the map containing styles that represent days of months, weeks, etc.
getWebPageSize Method (Java)

Applies to
Report Form
Syntax
public int getWebPageSize();

Return value
int - the height of Report page in web view mode.
Description
Returns the height of Report page in web view mode.
getYear Method (Java)

Applies to
Calendar Form
Syntax
public int getYear();

Return value
int - year to be shown.
Description
340
This method returns Year to be shown.
getYearsRange Method (Java)

Applies to
CalendarNavigator Control
Syntax
public int getYearsRange();

Return value
int - the number of years to be displayed in the Navigator.
Description
This method returns the number of years to be displayed in the Navigator.
H-Z
hasErrors Method (Java)

Applies to
Data Source
Syntax
public boolean hasErrors();

Return value
boolean - 'true' if data source has errors, 'false' otherwise.
Description
This method specifies whether the Data Source has errors.
hasErrors Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public boolean hasErrors();

Return value
boolean - if 'true' there were errors in validation of a control, 'false' otherwise
Description
This method specifies whether the control has validation errors.
hasErrors Method (Java)

Applies to
JDBCConnection Object
Syntax
public boolean hasErrors();

341
Return value
boolean - 'true' if the connection has errors, 'false' otherwise
Description
This method specifies whether a connection has errors.
hasNext Method (Java)

Applies to
Data Source
Syntax
public boolean hasNext();

Return value
boolean - 'true' if the Data Source has more data.
Description
This method specifies whether the Data Source has more data.
hasNextItem Method (Java)

Applies to
Calendar Form
Syntax
public boolean hasNextItem();

Return value
boolean - 'true' if the next Calendar item is available.
Description
This method indicates if the next Calendar item is available.
hasNextRow Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public boolean hasNextRow();

Return value
boolean - 'true' if the iteration has more elements.
Description
This method returns 'true' if the iteration has more elements.
isDetailControl Method (Java)

Applies to
Report Form
Syntax

342
 public boolean isDetailControl(String name);

Return value
boolean - true if the specified control belongs to Detail row (Detail section); otherwise - false.
Parameters
Name Type Description
name String Name of control.
Description
Returns true if the specified control belongs to Detail row (Detail section); otherwise - false.
isEnablePrintMode Method (Java)

Applies to
Report Form
Syntax
public boolean isEnablePrintMode();

Return value
boolean - true if print view mode is enabled for report component; otherwise - false.
Description
Returns true if print view mode is enabled for report component; otherwise - false.
isHideDuplicates Method (Java)

Applies to
ReportLabel Control
Syntax
public boolean isHideDuplicates();

Return value
boolean - sign if the duplicated values will be shown.
Description
Returns if the duplicated values will be shown.
isShowOtherMonthsDays Method (Java)

Applies to
Calendar Form
Syntax
public boolean isShowOtherMonthsDays();

Return value
boolean - 'true' if days of the neighbouring months should be shown, otherwise - 'false'.
Description
This method returns 'true' if days of the neighbouring months should be shown, otherwise - 'false'.

343
isAllowInsert Method (Java)

Applies to
Editable Grid, Record
Syntax
public boolean isAllowInsert();

Return value
boolean
Description
This method specifies whether Insert is allowed for the component at this moment. This value can
be modified using the setAllowInsert method.
See also:
setAllowInsert method
isAllowDelete Method (Java)

Applies to
Editable Grid, Record
Syntax
public boolean isAllowDelete();

Return value
boolean
Description
This method specifies whether Delete is allowed for the component at this moment. This value can
be modified using the setAllowDelete method.
See also:
setAllowDelete method
isAllowRead Method (Java)

Applies to
Editable Grid, Grid, Record
Syntax
public boolean isAllowRead();

Return value
boolean
Description
This method specifies whether Read is allowed for the component at this moment. This value can
modified using the setAllowRead method.
See also:
setAllowRead method
isAllowUpdate Method (Java)

344
Applies to
Editable Grid, Record
Syntax
public boolean isAllowUpdate();

Return value
boolean
Description
This method specifies whether Update is allowed for the component at this moment. This value
can modified using the setAllowUpdate method.
See also:
setAllowUpdate method
isEditMode Method (Java)

Applies to
Record Form
Syntax
public boolean isEditMode();

Return value
boolean
Description
This method is used to check whether the Record is in the Edit mode.
isEmpty Method (Java)

Applies to
Data Source
Syntax
public boolean isEmpty();

Return value
boolean - 'true' if the data source is empty, 'false' otherwise.
Description
This method indicates whether the Data Source is empty.
isEmpty Method (Java)

Applies to
Directory Form
Syntax
public boolean isEmpty();

Return value
boolean
Description
345
This method checks whether the Categories List is empty.
isProcessed Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public boolean isProcessed();

Return value
boolean
Description
This method indicates that a component is processed. The ccsForm parameter is equal to the
Component Name.
isRestricted Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public boolean isRestricted();

Return value
boolean
Description
This method specifies whether users must be logged in before accessing the form.
isShowEmptyRow Method (Java)

Applies to
EditableGrid Form
Syntax
public boolean isShowEmptyRow();

Return value
boolean
isVisible Method (Java)

Applies to
Button Control, DatePicker Control, Navigator Control, Sorter Control, Image Control, Label
Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox Control, Hidden
Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control, ImageLink
Control, Grid Form, EditableGrid Form, Record Form, Directory Form, Page Form, Path Form,
Panel
Syntax
public boolean isVisible();

Return value
346
boolean - visibility state, false means hidden
Description
This method specifies whether this control will be shown.
nextItem Method (Java)

Applies to
Calendar Form
Syntax
public CalendarItem nextItem();

Return value
CalendarItem - the next calendar item if it is available; otherwise - 'null';
Description
This method returns the next calendar item if it is available.
nextReportRow Method (Java)

Applies to
Report Form
Syntax
public ReportRow nextReportRow();

Return value
ReportRow - the next Report row.
Description
Returns the next Report row.
nextRow Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public HashMap nextRow();

Return value
HashMap - a HashMap of all row controls
Description
This method returns the next row. If a row is not available it returns an empty HashMap. It is never
null.
setAllowInsert Method (Java)

Applies to
Editable Grid, Record
Syntax
public void setAllowInsert(boolean allowInsert);

347
Parameters
Name Description
allowInsert If 'true' the Insert operation is allowed for the component.
Description
This method sets whether the Insert operation is allowed for the component. It may be used to
disallow the Insert operation from within the events.
See also:
isAllowInsert method
setAllowDelete Method (Java)

Applies to
Editable Grid, Record
Syntax
public void setAllowDelete(boolean allowDelete);

Parameters
Name Description
allowDelete If 'true' the Delete operation is allowed for this component.
Description
This method sets whether the Delete operation is allowed for the component. It may be used to
disallow the Delete operation from within the events.
See also:
isAllowDelete method
setAllowRead Method (Java)

Applies to
Editable Grid, Grid, Record
Syntax
public void setAllowRead(boolean allowRead);

Parameters
Name Description
allowRead If 'true' the Read operation is allowed for the component
Description
This method sets whether the Read operation is allowed for the component. It may be used to
disallow the Read operation from within the events.
See also:
isAllowRead method
setAllowUpdate Method (Java)

Applies to

348
Editable Grid, Record
Syntax
public void setAllowUpdate(boolean allowUpdate);

Parameters
Name Description
allowUpdate If 'true' the Update operation is allowed for the component.
Description
This method sets whether the Update operation is allowed for the component. It may be used to
disallow the Update operation from within the events.
See also:
isAllowUpdate method
setComputeAt Method (Java)

Applies to
ReportLabel Control
Syntax
public void setComputeAt(String string);

Parameters
Name Type Description
string String the name of report group, relative to percent value will be calculated.
Description
Sets the name of report group, relative to percent value will be calculated.
setComputeAtFunction Method (Java)

Applies to
ReportLabel Control
Syntax
public void setComputeAtFunction(FunctionHandler handler);

Parameters
Name Type Description
handler FunctionHandler the function to be used if the value is to be auto-calculated relative value
of the another group.
Description
Sets the function to be used if the value is to be auto-calculated relative value of the another
group.
setCurrentStyle Method (Java)

Applies to
Calendar Form

349
Syntax
public void setCurrentStyle(String style);

Parameters
Name Type Description
style String The Style (not Style Name) that is applied to the current Calendar section.
Description
This method specifies the Style (not Style Name) that is applied to the current Calendar section.
setDateField Method (Java)

Applies to
Calendar Form
Syntax
public void setDateField(String dateField);

Parameters
Name Type Description
dateField String Field name pointing to the Event Date.
Description
This method specifies the Field Name pointing to the Event Date. This field is required if the Data
Source is defined and allows to link events to the Calendar days.
setEmptyText Method (Java)

Applies to
ReportLabel Control
Syntax
public void setEmptyText(String string);

Parameters
Name Type Description
string String the text to display when the label's value is empty.
Description
Sets the text to display when the label's value is empty.
setEnablePrintMode Method (Java)

Applies to
Report Form
Syntax
public void setEnablePrintMode(boolean enablePrintMode);

Parameters

350
Name Type Description
enablePrintMode boolean true if print view mode is allowed; otherwise - false.
Description
Sets enablePrintMode value.
setFormattedValue Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public void setFormattedValue(java.lang.String value);

Parameters
Name Description
value preformatted control value
Description
This method sets the Control Value from String. The value is taken without formatting.
setFunction Method (Java)

Applies to
ReportLabel Control
Syntax
public void setFunction(FunctionHandler handler);

Parameters
Name Type Description
handler FunctionHandler the function to be used if the value is to be auto-calculated.
Description
Sets the function to be used if the value is to be auto-calculated.
setHeight Method (Java)

Applies to
ReportSection Control
Syntax
public void setHeight(double height);

Parameters
Name Type Description
height double the height of section in lines.
Description
351
Sets the height of section in lines.
setHideDuplicates Method (Java)

Applies to
ReportLabel Control
Syntax
public void setHideDuplicates(boolean b);

Parameters
Name Type Description
b boolean Specify if the duplicated values will be shown.
Description
Specify if the duplicated values will be shown.
setListOfValues Method (Java)

Applies to
CheckBoxList Control, RadioButton Control, ListBox Control
Syntax
public void setListOfValues(java.lang.String list);
public void setListOfValues(java.lang.StringBuffer);

Parameters
Name Type Description
list String Semicolon separated list of values
Description
This method sets list of values to choose from. It is used to populate list values from String.
setLocale Method (Java)

Applies to
JDBCConnection Object
Syntax
public void setLocale(java.util.Locale locale);

Parameters
Name Description
locale locale with language and country settings
Description
This method sets the Locale. The locale is used to format data before it is inserted, updated or
retrieved from datasources.
setMonths Method (Java)

352
Applies to
Calendar Form
Syntax
public void setMonths(int months);

Parameters
Name Type Description
months int Number of months to be shown.
Description
This method specifies the number of months to be shown.
setMonthsInRow Method (Java)

Applies to
Calendar Form
Syntax
public void setMonthsInRow(int monthsInRow);

Parameters
Name Type Description
monthsInRow int Number of months in the calendar row for the yearly and quarterly calendars.
Description
Specifies the number of months in the calendar row for the yearly and quarterly calendars. If
monthsInRows == 0 all months will be shown in one row.
setNumberEmptyRows Method (Java)

Applies to
EditableGrid Form
Syntax
public void setNumberEmptyRows(int numberEmptyRows);

Parameters
Name Description
numberEmptyRows The number of rows for new records.
Description
This method specifies the number of rows for adding new records.
setNumberOfColumns Method (Java)

Applies to
Directory Form
Syntax
public void setNumberOfColumns(long numberOfColumns);

353
Parameters
Name Description
numberOfColumns The number of columns
Description
This method sets the Number of Columns used to display a directory.
setNumberOfSubCategories Method (Java)

Applies to
Directory Form
Syntax
public void setNumberOfSubCategories(long count);

Parameters
Name Description
count The number of subcategories
Description
This method specifies the number of subcategories shown for each category.
setOptions Method (Java)

Applies to
CheckBoxList Control, RadioButton Control, ListBox Control
Syntax
public void setOptions(java.lang.String list);
public void setOptions(java.util.Enumeration);
public void
setOptions(java.util.Enumeration,com.codecharge.db.SqlFormatControl);

Parameters
Name Description
list Semicolon separated list of values
Description
Set list of values to choose from. Used to populate list values from String.
setPage Method (Java)

Applies to
Grid Form, EditableGrid Form
Syntax
public void setPage(java.lang.String page);
public void setPage(int);

Parameters

354
Name Type Description
page String The Integer in form of String
Description
This method sets the grid page number to be shown. It specifies the grid page number as a String
to in order to set the value from the request parameter.
setPageSize Method (Java)

Applies to
Grid Form, EditableGrid Form
Syntax
public void setPageSize(int size);
public void setPageSize(java.lang.String);

Parameters
Name Type Description
size int number of records per page.
Description
This method sets a number of records per page. It is an equivalent to setFetchSize.
setPageSizeLimit Method (Java)

Applies to
Report Form
Syntax
public void setPageSizeLimit(int pageSizeLimit);

Parameters
Name Type Description
pageSizeLimit int Maximal allowed size of the Report page in the web view mode.
Description
Sets maximal allowed size of the Report page in the web view mode.
setRedirectString Method (Java)

Applies to
Page Object
Syntax
public void setRedirectString(java.lang.String redirect);

Parameters
Name Type Description
redirect String The URL string for redirect.
Description
355
This method specifies the URL string for redirect. The redirection occurs before the On Initialize
View event is called. It is recommended to set variable values in the After Initialize event or any
submit processing event of page components.
setResetAt Method (Java)

Applies to
ReportLabel Control
Syntax
public void setResetAt(String string);

Parameters
Name Type Description
string String the name of report group where the control value should be reset.
Description
Sets the name of report group, where the control value should be reset.
setRestricted Method (Java)

Applies to
Grid Form, EditableGrid Form, Record Form, Directory Form, Page Context, Path Control
Syntax
public void setRestricted(boolean flag);

Parameters
Name Description
flag If 'true' the users must be logged in before accessing the form.
Description
This method sets whether users must be logged in before accessing the form.
setShowOtherMonthsDays Method (Java)

Applies to
Calendar Form
Syntax
public void setShowOtherMonthsDays(boolean showOtherMonthsDays);

Parameters
Name Type Description
showOtherMonthsDays boolean Whether days of the neighbouring months should be shown.
Description
This method specifies whether days of the neighbouring months should be shown.
setTimeField Method (Java)

356
Applies to
Calendar Form
Syntax
public void setTimeField(String timeField);

Parameters
Name Type Description
timeField String Field name pointing to the Event Time.
Description
This method specifies the Field Name pointing to the Event Time. If 'null,' the calendar will obtain
the Event Time from the dateField field.
setValues Method (Java)

Applies to
CheckBoxList Control, RadioButton Control, ListBox Control
Syntax
public void setValues(java.util.Enumeration records,java.lang.String
fieldName);

Parameters
Name Type Description
records enumeration The enumeration of DbRows returned from an SQl query
fieldName String Which field holds the values
Description
This method sets list selected values from Enumeration of Strings.
setValue Method (Java)

Applies to
Image Control, Label Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox
Control, Hidden Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control,
ImageLink Control
Syntax
public void setValue(java.lang.Object value);
public void setValue(java.lang.String);
public void setValue(long);
public void setValue(double);
public void setValue(boolean);

Parameters
Name Description
value The value to be assigned to the control.
Description

357
This method sets the value for the control.
setViewMode Method (Java)

Applies to
Report Form
Syntax
public void setViewMode(int mode);

Parameters
Name Type Description
mode int The requested Report view mode. It can be specified using constants
Report.VIEW_MODE_WEB and Report.VIEW_MODE_PRINT.
Description
Set Report view mode.
setVisualStyle Method (Java)

Applies to
Calendar Form
Syntax
public void setVisualStyle(String name, String value);

Parameters
Name Type Description
name String Style Name
value String Style
Description
This method specifies the Style with the specified name.
setVisualStyles Method (Java)

Applies to
Calendar Form
Syntax
public void setVisualStyles(Map visualStyles);

Parameters
Name Type Description
visualStyles java.util.Map Map containing Styles that represent days of months, weeks, etc.
Description
This method specifies the map containing Styles that represent days of months, weeks, etc.
setVisible Method (Java)

358
Applies to
Button Control, DatePicker Control, Navigator Control, Sorter Control, Image Control, Label
Control, CheckBox Control, FileUpload Control, TextArea Control, TextBox Control, Hidden
Control, CheckBoxList Control, RadioButton Control, ListBox Control, Link Control, ImageLink
Control, Grid Form, EditableGrid Form, Record Form, Directory Form, Page Form, Path Form,
Panel
Syntax
public void setVisible(boolean setVisible);

Parameters
Name Type Description
setVisible boolean The visibility boolean state, 'false' means hidden
Description
This method specifies whether this control or component should be shown.
setWebPageSize Method (Java)

Applies to
Report Form
Syntax
public void setWebPageSize(int i);

Parameters
Name Type Description
i int height of Report page in web view mode.
Description
Sets the height of Report page in web view mode.
setYearsRange Method (Java)

Applies to
CalendarNavigator Control
Syntax
public void setYearsRange(int yearsRange);

Parameters
Name Type Description
yearsRange int Number of years to be displayed in the Navigator.
Description
This method specifies the number of years to be displayed in the Navigator.
size Method (Java)

Applies to
Report Form

359
Syntax
public double size();

Return value
double - the number of the Report lines or zero if the Report is not populated with data.
Description
Returns the number of the Report lines or zero if the Report is not populated with data.
toSql Method (Java)

Applies to
JDBCConnection Object
Syntax
public String toSql(java.lang.String value,int type);
public String toSql(java.lang.String,com.codecharge.components.ControlType);
public String toSql(boolean);
public String toSql(java.lang.Boolean);
public String toSql(java.util.Date);

Return value
String - converted (SQL safe) string
Parameters
Name Type Description
value String The Element of sql expression
type int The value type indicating necessary changes
Description
This method converts a String value to an SQL expression by adding quotes and delimiters.

.NET
Common Classes
BooleanParameter Class (.NET)
Represents a CodeCharge Data Source Boolean parameter.
Constructors
Constructor Description
public BooleanParameter(Boolean Initializes a new instance of the integer parameter
intValue) class.
Properties
Property Description
public Boolean Value get or set value of parameter
Methods
Method Description

360
public virtual string Convert to string and return Value of the parameter, used
GetFormattedValue(string format) mask, specified by format parameter
public static BooleanParameter Return the instance of BooleanParameter class with value
GetParam(object param) specified by param parameter. If param is null (Nothing in
VB) value, the null reference will be returned.
public static BooleanParameter Return the instance of BooleanParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format) be parsed using mask, specified by format parameter If
param is null (Nothing in VB) value, the null reference will be
returned.
public static BooleanParameter Return the instance of BooleanParameter class with value
GetParam(object param, object specified by param parameter. If param is null (Nothing in
defaultValue) VB) value, the defaultValue parameter will be used.
public static BooleanParameter Return the instance of BooleanParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format, object defaultValue) be parsed using mask, specified by format parameter If
param is null (Nothing in VB) value, the defaultValue
parameter will be used. If param and defaultValue are null
(Nothing in VB) values, the null reference will be returned.
See also
DateParameter Class
IntegerParameter Class
FloatParameter Class
TextParameter Class
MemoParameter Class
DateParameter Class (.NET)
Represents a CodeCharge Data Source Date parameter.
Constructors
Constructor Description
public DateParameter(DateTime Initializes a new instance of the integer parameter
intValue) class.
Properties
Property Description
public DateTime Value get or set value of parameter
Methods
Method Description
public virtual string Convert to string and return Value of the parameter, used
GetFormattedValue(string format) mask, specified by format parameter
public static DateParameter Return the instance of DateParameter class with value
GetParam(object param) specified by param parameter. If param is null (Nothing in
VB) value, the null reference will be returned.
public static DateParameter Return the instance of DateParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format) be parsed using mask, specified by format parameter If

361
 param is null (Nothing in VB) value, the null reference will be
returned.
public static DateParameter Return the instance of DateParameter class with value
GetParam(object param, object specified by param parameter. If param is null (Nothing in
defaultValue) VB) value, the defaultValue parameter will be used.
public static DateParameter Return the instance of DateParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format, object defaultValue) be parsed using mask, specified by format parameter If
param is null (Nothing in VB) value, the defaultValue
parameter will be used. If param and defaultValue are null
(Nothing in VB) values, the null reference will be returned.
See also
BooleanParameter Class
IntegerParameter Class
FloatParameter Class
TextParameter Class
MemoParameter Class
FieldBase Class (.NET)
Serves as the base class that defines the properties, methods, and events common for all types of
Field classes (TextField, MemoField, BooleanField, IntegerField, FloatField and DateField).
Constructors
Property Description
public FieldBase(string format) Initializes a new instance of the Field class and sets Format
property.
public FieldBase(string format, object Initializes a new instance of the Field class and sets Format
defaultValue) property and Value property.
Properties
Property Description
public object get or set value of field
Value
public string Gets or sets a format mask, which is used in SetValue and Get Formatted
Format Value methods.
Methods
Property Description
public virtual string Convert to string and return Value of object, used mask,
GetFormattedValue() specified in Format property
public virtual string Convert to string and return Value of object, used mask,
GetFormattedValue(string format) specified by format parameter
public virtual void SetValue(object Sets Value property of a object. If value can not be
value) converted to target type, use Format property mask to
parse it.
public virtual void SetValue(object Sets Value property of a object. If value can not be
value,string format) converted to target type, use Format method mask to

362
 parse it.

FloatParameter Class (.NET)

Represents a CodeCharge Data Source Float parameter.
Constructors
Constructor Description
public FloatParameter(Double intValue) Initializes a new instance of the integer parameter class.
Properties
Property Description
public Double Value get or set value of parameter
Methods
Method Description
public virtual string Convert to string and return Value of the parameter, used
GetFormattedValue(string format) mask, specified by format parameter
public static FloatParameter Return the instance of FloatParameter class with value
GetParam(object param) specified by param parameter. If param is null (Nothing in
VB) value, the null reference will be returned.
public static FloatParameter Return the instance of FloatParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format) be parsed using mask, specified by format parameter If
param is null (Nothing in VB) value, the null reference will be
returned.
public static FloatParameter Return the instance of FloatParameter class with value
GetParam(object param, object specified by param parameter. If param is null (Nothing in
defaultValue) VB) value, the defaultValue parameter will be used.
public static FloatParameter Return the instance of FloatParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format, object defaultValue) be parsed using mask, specified by format parameter If
param is null (Nothing in VB) value, the defaultValue
parameter will be used. If param and defaultValue are null
(Nothing in VB) values, the null reference will be returned.
See also
BooleanParameter Class
DateParameter Class
IntegerParameter Class
TextParameter Class
MemoParameter Class
IntegerParameter Class (.NET)
Represents a CodeCharge Data Source integer parameter.
Constructors
Constructor Description
public IntegerParameter(Int64 intValue) Initializes a new instance of the integer parameter class.
Properties
363
Property Description
public Int64 Value get or set value of parameter
Methods
Method Description
public virtual string Convert to string and return Value of the parameter, used
GetFormattedValue(string format) mask, specified by format parameter
public static IntegerParameter Return the instance of IntegerParameter class with value
GetParam(object param) specified by param parameter. If param is null (Nothing in
VB) value, the null reference will be returned.
public static IntegerParameter Return the instance of IntegerParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format) be parsed using mask, specified by format parameter If
param is null (Nothing in VB) value, the null reference will be
returned.
public static IntegerParameter Return the instance of IntegerParameter class with value
GetParam(object param, object specified by param parameter. If param is null (Nothing in
defaultValue) VB) value, the defaultValue parameter will be used.
public static IntegerParameter Return the instance of IntegerParameter class with value
GetParam(object param, string specified by param parameter. If param is String value, it will
format, object defaultValue) be parsed using mask, specified by format parameter If
param is null (Nothing in VB) value, the defaultValue
parameter will be used. If param and defaultValue are null
(Nothing in VB) values, the null reference will be returned.
See also
BooleanParameter Class
DateParameter Class
FloatParameter Class
TextParameter Class
MemoParameter Class
public class ItemCollection:NameObjectCollectionBase, ICloneable (.NET)
A collection of item objects in a list control.
Properties
Property Description
public ItemValue Gets an Item at the specified index or value in the collection. In C#, this property
Item is the indexer for the ItemCollection class
Methods
Property Description
public void Add(string value,string text,bool selected) Appends a item to the end of the
collection.
public void Add(string value,string text) Appends a item to the end of the
collection.
public void SetSelection(object value) Set selected property to true for a
Item from the collection that

364
 represents the specified value.
public object Clone() Creates a copy of the current
collection.
public void Copies the items from the
CopyTo(System.Web.UI.WebControls.ListItemCollection col, ItemCollection to the specified
bool encode) ListItemCollection, and apply HTML
encode to a Item text.
public void Copies the items from the
CopyTo(System.Web.UI.WebControls.ListItemCollection col) ItemCollection to the specified
ListItemCollection.
public void Remove(string value) Removes the Item with the
specified value from the collection.
public void Clear() Removes all Item objects from the
collection.

public class LinkParameterCollection:NameObjectCollectionBase (.NET)

A collection of parameters for Link controls.
Properties
Property Description
public object Gets an Item at the specified index or value in the collection. In C#, this property is
Item the indexer for the LinkParameterCollection class
Methods
Property Description
public void Add(string Append an item to the end of the collection.
value,string text)
public string ToString() Return the string representation of current collection for using in Uri.
public string Return the string representation of current collection for using in Uri.
ToString(string Preserve parameter from QueryString or Form collection is will added to
preserve, string resulting string. The possible values of preserve parameters: "All","POST"
removeList) or "GET". The removeList parameter is a semicolon-separated list of
parameters, which will be removed from preserved parameters

MemoParameter Class (.NET)

Represents a CodeCharge Studio Data Source Memo parameter.
Constructors
Constructor Description
public MemoParameter(String intValue) Initializes a new instance of the integer parameter class.
Properties
Property Description
public String Value get or set value of parameter
Methods
Method Description

365
public virtual string Convert to string and return Value of the parameter, used
GetFormattedValue(string format) mask, specified by format parameter
public static MemoParameter Return the instance of MemoParameter class with value
GetParam(object param) specified by param parameter. If param is null (Nothing in
VB) value, the null reference will be returned.
public static MemoParameter Return the instance of MemoParameter class with value
GetParam(object param, string specified by param parameter. The format parameter is
format) ignored. If param is null (Nothing in VB) value, the null
reference will be returned.
public static MemoParameter Return the instance of MemoParameter class with value
GetParam(object param, object specified by param parameter. If param is null (Nothing in
defaultValue) VB) value, the defaultValue parameter will be used.
public static MemoParameter Return the instance of MemoParameter class with value
GetParam(object param, string specified by param parameter. The format parameter is
format, object defaultValue) ignored. If param is null (Nothing in VB) value, the
defaultValue parameter will be used. If param and
defaultValue are null (Nothing in VB) values, the null
reference will be returned.
See also
BooleanParameter Class
DateParameter Class
IntegerParameter Class
FloatParameter Class
TextParameter Class Represents CodeCharge Data Source parameters.
Classes
IntegerParameter
FloatParameter
TextParameter
MemoParameter
DateParameter
BooleanParameter

TextParameter Class (.NET)

Represents a CodeCharge Data Source Text parameter.
Constructors
Constructor Description
public TextParameter(String intValue) Initializes a new instance of the integer parameter class.
Properties
Property Description
public String Value get or set value of parameter
Methods
Method Description

366
public virtual string Convert to string and return Value of the parameter, used
GetFormattedValue(string format) mask, specified by format parameter
public static TextParameter Return the instance of TextParameter class with value
GetParam(object param) specified by param parameter. If param is null (Nothing in
VB) value, the null reference will be returned.
public static TextParameter Return the instance of TextParameter class with value
GetParam(object param, string specified by param parameter. The format parameter is
format) ignored. If param is null (Nothing in VB) value, the null
reference will be returned.
public static TextParameter Return the instance of TextParameter class with value
GetParam(object param, object specified by param parameter. If param is null (Nothing in
defaultValue) VB) value, the defaultValue parameter will be used.
public static TextParameter Return the instance of TextParameter class with value
GetParam(object param, string specified by param parameter. The format parameter is
format, object defaultValue) ignored. If param is null (Nothing in VB) value, the
defaultValue parameter will be used. If param and
defaultValue are null (Nothing in VB) values, the null
reference will be returned.
See also
BooleanParameter Class
DateParameter Class
IntegerParameter Class
FloatParameter Class
MemoParameter Class

Methods
CreateFromHttpRequest Method (.NET)
Applies to
Record Form
Syntax
C#.NET
public static <control name>Item CreateFromHttpRequest()

VB.NET
Public Shared Function CreateFromHttpRequest() As <control name>Item

Description
Returns the instance of item whose fields are initialized from Http request values.
DataBind Method (.NET)
Applies to
Grid Form, EditableGrid Form, Path Control, Directory Form
Syntax
C#.NET
public virtual void DataBind();

367
VB.NET
Overridable Public Sub DataBind()

Description
Binds a data source to the invoked server control and all its child controls.
Use this method to bind data from a source to a server control. This method is commonly used
after retrieving a data set through a database query.
Note: When called on a server control, this method resolves all data-binding expressions in the
server control and in any of its child controls.
DeleteFile Method (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public bool DeleteFile()

VB.NET
Public Sub DeleteFile()

Description
Deletes file from disk.
DeleteItem Method (.NET)
Applies to
Record Form
Syntax
C#.NET
public int DeleteItem(<control name>Item item)

VB.NET
Public Function DeleteItem(item As <control name>) As Int32

Description
Deletes data from item specified in item parameter from database.
InsertItem Method (.NET)
Applies to
Record Form
Syntax
C#.NET
public int InsertItem(<control name>Item item)

VB.NET
Public Function InsertItem(item As <control name>) As Int32

Description

368
Inserts the specified item into the database.
FillItem Method (.NET)
Applies to
Record Form
Syntax
C#.NET
public void FillItem(<control name>Item item, ref bool IsInsertMode)

VB.NET
Public Sub FillItem(item As <control name>, ByRef IsInsertMode As Boolean)

Description
Fills the specified item with database data. If database request returns no rows, IsInsertMode
parameter will be set to true.
GetResultSet Method (.NET)
Applies to
Path Form, Directory Form
Syntax
C#.NET
public <control name>Item[] GetResultSet()

VB.NET
Public GetResultSet() As <control name>Item()

Description
Executes SQL command and returns an array of Items.
Use this method to obtain data source for a server control.
GetResultSet Method (.NET)
Applies to
Grid Form, EditableGrid Form
Syntax
C#.NET
public <control name>Item[] GetResultSet(out int PagesCount)

VB.NET
Public GetResultSet(ByRef PagesCount As Integer) As <control name>Item()

Description
Executes SQL command and returns Items array. The PagesCount parameter contains the
number of pages.
Use this method to obtain data source for a server control.
Update Method (.NET)
Applies to

369
EditableGrid Form
Syntax
C#.NET
public void Update(ArrayList Items)

VB.NET
Public Sub Update(ByVal Items As ArrayList)

Description
Performs update operations for each item in the items array.
For each item in ArrayList the state will be checked (IsNew, IsDeleted and so on) and
corresponding DB operation will be performed.
UpdateItem Method (.NET)
Applies to
Record Form
Syntax
C#.NET
public int UpdateItem(<control name>Item item)

VB.NET
Public Function UpdateItem(item As <control name>) As Int32

Description
Updates the specified item in the database.
SaveFile Method (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public bool SaveFile()

VB.NET
Public Sub SaveFile()

Description
Saves the processed file into the FileFolder.
Validate Method (.NET)
Applies to
Record Form, EditableGrid Form
Syntax
C#.NET
public void Validate(<control name>DataProvider provider)

VB.NET

370
 Public Sub Validate(ByVal provider As <control name>DataProvider)

Description
Performs item validation and populates the item errors collection if validation fails.
Use this method to validate the item.
ValidateFile Method (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public bool ValidateFile()

VB.NET
Public Sub ValidateFile()

Description
Performs item validation and saves the file into TemporaryFolder. Returns true if the validation is
successful, otherwise returns false.

Run-Time Properties
AllowedFileMasks Run-Time Property (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public string AllowedFileMasks{get;set}

VB.NET
Public Property AllowedFileMasks() As String

Description
Gets or sets the semicolon-separated list of the allowed file masks. The default value is '*' (all
allowed).
Examples
C#.NET
FileUpload1.AllowedFileMasks="*.gif;*.jpg";

VB.NET
FileUpload1.AllowedFileMasks="*.gif;*.jpg"

See also
DisallowedFileMasks Property
FileSizeLimit Property
BoolFormat Run-Time Property (.NET)
Applies to
371
ConnectionString Object
Syntax
C#.NET
public string BoolFormat{get;set}

VB.NET
Public Property BoolFormat() As String

Description
Gets or sets the database format for work with Boolean values.
Examples
C#.NET
ConnectionString1.BoolFormat="true;false";

VB.NET
ConnectionString1.BoolFormat="true;false"

See also
DateFormat Property
ConnectionCommands Run-Time Property (.NET)
Applies to
ConnectionString Object
Syntax
C#.NET
public System.Collections.Specialized.NameValueCollection
ConnectionCommands{get;}

VB.NET
Public Readonly Property ConnectionCommands() As
System.Collections.Specialized.NameValueCollection

Description
Gets the collection of the SQL commands, which will be executed each time the connection is
opened. These commands are usually used for setting client session variables or changing
database server defaults.
Examples
C#.NET
ConnectionString1.ConnectionCommands.Add("ANSI","SET ANSI_DEFAULTS ON");

VB.NET
ConnectionString1.ConnectionCommands.Add("ANSI","SET ANSI_DEFAULTS ON")

Connection Run-Time Property (.NET)

Applies to
ConnectionString Object
Syntax

372
C#.NET
public string ConnectionString{get;set;}

VB.NET
Public Property ConnectionString() As String

Description
A connection string that includes the source database name and other parameters needed to
establish the initial connection. The default value is an empty string. The format of the string
depends on the Type property.
Examples
C#.NET
ConnectionString1.ConnectionString = @"Provider=Microsoft.Jet.OLEDB.4.0;User
ID=Admin;Data Source=c:\Program
Files\CodeChargeStudio4\Examples\Internet\Internet.mdb ;Persist Security
Info=False";

VB.NET
ConnectionString1.ConnectionString = "Provider=Microsoft.Jet.OLEDB.4.0;User
ID=Admin;Data Source=c:\Program
Files\CodeChargeStudio4\Examples\Internet\Internet.mdb ;Persist Security
Info=False"

See also
Type Property
ContentType Run-Time Property (.NET)
Applies to
ReportLabel control
Syntax
C#.NET
public ContentType ContentType{get;set;}

VB.NET
Public Property ContentType() As ContentType

Description
Retrieves or sets content type of the report label. This property defines whether the text output by
the ReportLabel will be HTML encoded. The default value is Text.
Type Description
Text The text will be encoded during rendering.
HTML The text will be rendered as is.
Examples
C#.NET
ReportLabel1.ContentType = ContentType.HTML;

VB.NET
Report1Label.ContentType = ContentType.HTML

373
See also
Text Property
CurrentDate Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET
public DateTime CurrentDate{get;set;}

VB.NET
Public Property CurrentDate() As DateTime

Description
Retrieves or specifies the current date for Calendar control. The default value is DateTime.Now.
Examples
C#.NET
Calendar1.CurrentDate = DateTime.Now;

VB.NET
Calendar1.CurrentDate = DateTime.Now

See also
Date Property
CurrentDate Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET
public string EmptyText{get;set;}

VB.NET
Public Property EmptyText() As String

Description
Retrives or specifies the text that will be rendered in case when Text property will contain null or
empty string value.
Examples
C#.NET
ReportLabel1.EmptyText = "N/A";

VB.NET
ReportLabel1.EmptyText = "N/A"

See also
Text Property

374
DataSource Run-Time Property (.NET)
Applies to
Calendar Form, Grid Form, EditableGrid Form, Report Form, Path Control, Directory Form
Syntax
C#.NET
public System.Collections.IEnumerable DataSource{get;set;}

VB.NET
Public Property DataSource() As System.Collections.IEnumerable

Description
Gets or sets the data source that provides data for populating the list.
Examples
C#.NET
Directory1.DataSource = Directory1Data.GetResultSet();
Directory1.DataBind();

VB.NET
Directory1.DataSource = Directory1Data.GetResultSet()
Directory1.DataBind()

See also
DataBind Property
DataType Run-Time Property (.NET)
Applies to
ReportLabel control
Syntax
C#.NET
public FieldType DataType{get;set;}

VB.NET
Public Property DataType() As FieldType

Description
Retrieves or sets the data type of the ReportLabel control.
Examples
C#.NET
ReportLabel1.DataType = FieldType.Integer;

VB.NET
ReportLabel1.DataType = FieldType._Integer

DateFormat Run-Time Property (.NET)

Applies to
ConnectionString Object
Syntax

375
C#.NET
public string DateFormat{get;set}

VB.NET
Public Property DateFormat() As String

Description
Gets or sets the database format of DateTime values.
Examples
C#.NET
ConnectionString1.DateFormat="yyyy-MM-dd HH:mm:ss";

VB.NET
ConnectionString1.DateFormat="yyyy-MM-dd HH:mm:ss"

See also
BoolFormat Property
Date Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET
public DateTime Date{get;set;}

VB.NET
Public Property Date() As DateTime

Description
Retrives or specifies the active date for Calendar control.
Examples
C#.NET
Calendar1.Date = new DateTime(2005,1,10);

VB.NET
Calendar1.Date = New DateTime(2005,1,10)

See also
CurrentDate Property, Year Property, Month Property, Day Property
Date Run-Time Property (.NET)
Applies to
CalendarNavigator control
Syntax
C#.NET
public DateTime Date{get}

VB.NET

376
 Public Readonly Property Date() As DateTime

Description
Retrives the selected date for CalendarNavigator control.
Examples
C#.NET
DateTime selected = CalendarNavigator1.Date;

VB.NET
Dim selected as DateTime = CalendarNavigator1.Date

See also
Year Property, Month Property, Day Property
DateLeftDelim Run-Time Property (.NET)
Applies to
ConnectionString Object
Syntax
C#.NET
public string DateLeftDelim{get;set}

VB.NET
Public Property DateLeftDelim() As String

Description
Gets or sets the left date delimiter in SQL command (for example '#' for MS Access)
Examples
C#.NET
ConnectionString1.DateLeftDelim="#";

VB.NET
ConnectionString1.DateLeftDelim="#"

See also
DateRightDelim Property
DateRightDelim Run-Time Property (.NET)
Applies to
ConnectionString Object
Syntax
C#.NET
public string DateRightDelim{get;set}

VB.NET
Public Property DateRightDelim() As String

Description
Gets or sets the right date delimiter in SQL command (for example '#' for MS Access)

377
Examples
C#.NET
ConnectionString1.DateRightDelim="#";

VB.NET
ConnectionString1.DateRightDelim="#"

See also
DateLeftDelim Property
Day Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET
public int Day{get;set;}

VB.NET
Public Property Day() As Integer

Description
Retrives or specifies the day component of Date property.
Examples
C#.NET
Calendar1.Day = 10;

VB.NET
Calendar1.Day = 10

See also
Date Property, Year Property, Month Property
Day Run-Time Property (.NET)
Applies to
CalendarNavigator control
Syntax
C#.NET
public int Day{get}

VB.NET
Public ReadOnly Property Day() As Integer

Description
Retrives the day component of Date property.
Examples
C#.NET
int selectedDay = CalendarNavigator1.Day;

378
VB.NET
Dim selectedDay As Integer = CalendarNavigator1.Day

See also
Date Property, Year Property, Month Property, Quarter Property
DisallowedFileMasks Run-Time Property (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public string DisallowedFileMasks{get;set}

VB.NET
Public Property DisallowedFileMasks() As String

Description
Gets or sets the semicolon-separated list of the disallowed file masks. The default value is an
empty string.
Examples
C#.NET
FileUpload1.DisallowedFileMasks="*.gif;*.jpg";

VB.NET
FileUpload1.DisallowedFileMasks="*.gif;*.jpg"

See also
AllowedFileMasks Property
FileSizeLimit Property
EmptyText Run-Time Property (.NET)
Applies to
ReportLabel control
Syntax
C#.NET
public string EmptyText{get;set;}

VB.NET
Public Property EmptyText() As String

Description
Retrieves or sets the text that will be output when the Text property of the report label contains null
or an empty string value.
Examples
C#.NET
ReportLabel1.EmptyText = "N/A";

VB.NET

379
 ReportLabel1.EmptyText = "N/A"

See also
Text Property
errors Run-Time Property (.NET)
Applies to
Calendar Form, EditableGrid Form, Path Control, Directory Form, Record Form, Report Form
Syntax
C#.NET
public System.Collections.Specialized.NameValueCollection errors{get;}

VB.NET
Public ReadOnly Property Errors() As
System.Collections.Specialized.NameValueCollection

Description
This property keeps the reference to the object’s errors collection. It is used to collect error
messages generated during the object’s execution.
Examples
C#.NET
item.errors.Add("TextBox1","The value in field TextBox1 is required.");

VB.NET
item.errors.Add("TextBox1","The value in field TextBox1 is required.")

Field Run-Time Property (.NET)

Applies to
Sorter Control
Syntax
C#.NET
public string Field{get;set;}

VB.NET
Public Property Field() As String

Description
The name of field which will be passed into OnItemCommand event.
Examples
C#.NET
Sorter1.Field = "user_name";

VB.NET
Sorter1.Field = "user_name"

FileFolder Run-Time Property (.NET)

Applies to

380
FileUpload Control
Syntax
C#.NET
public string FileFolder{get;set}

VB.NET
Public Property FileFolder() As String

Description
Gets or sets the destination folder for uploaded files. The default value is blank (application
working folder)
Exceptions
Exception Condition
System.IO.DirectoryNotFoundException The specified folder does not exist.
System.Security.SecurityException The working process does not have write permissions
onto the specified folder.
Examples
C#.NET
FileUpload1.FileFolder="c:\MyApp\UploadedFiles";

VB.NET
FileUpload1.FileFolder="c:\MyApp\UploadedFiles"

See also
TemporaryFolder Property
FileSizeLimit Run-Time Property (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public long FileSizeLimit{get;set}

VB.NET
Public Property FileSizeLimit() As Int64

Description
Gets or sets the limit of the file size for uploading files. the default is -1 (no limit)
Examples
C#.NET
FileUpload1.FileSizeLimit = 100000;

VB.NET
FileUpload1.FileSizeLimit = 100000

See also

381
AllowedMasks Property
DisallowedMasks Property
Format Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public string Format{get;set;}

VB.NET
Public Property Format() As String

Description
Retrieves or sets the format that will be applied to the output produced by the report label.
Examples
C#.NET
ReportLabel1.Format = "#.##0";

VB.NET
ReportLabel1.Format = "#.##0"

See also
Text Property
Function Run-Time Property (.NET)
Applies to
ReportLabel Control
Syntax
C#.NET
public TotalFunction Function{get;set;}

VB.NET
Public Property Function() As TotalFunction

Description
Retrieves or sets the function to be used if the value of the report label is to be auto-calculated.
The default value is "None".
Type Description
None No function will be used.
Sum The report label value will be calculated as the sum of previous row values.
Count If the Source is empty the value will be calculated as the count of previous data rows.
Otherwise the value will be calculated as the count of previous data rows with non-empty
values.
Min The value will be calculated as the minimum of previous row values.
Max The value will be calculated as the maximum of previous row values.

382
Avg The value will be calculated as the average of non-empty values from previous rows.
Examples
C#.NET
ReportLabel1.Function = TotalFunction.Sum;

VB.NET
ReportLabel1.Function = TotalFunction.Sum

See also
ResetAt Property,PercentOf Property
Groups Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public virtual Groups Groups{get;}

VB.NET
Public ReadOnly Property Groups() As NameValueCollection

Description
Gets the collections of report groups. The collection contains a key-value pairs, where key is a
group name and value is a grouping field name.
Examples
C#.NET
Report1.Groups.Add("Users","user_id");

VB.NET
Report1.Groups.Add("Users","user_id")

Height Run-Time Property (.NET)

Applies to
Section Control
Syntax
C#.NET
public float Height{get;set;}

VB.NET
Public Property Height() As Single

Description
Retrieves or sets the height of the current control in abstract "line" units.
Examples
C#.NET
ReportSection1.Height = 1.5;

383
VB.NET
ReportSection1.Height = 1.5

IsDeleted Run-Time Property (.NET)

Applies to
EditableGrid Form, Record Form
Syntax
C#.NET
public bool IsDeleted{get;set}

VB.NET
Public Property IsDeleted() As Boolean

Description
This property indicates if the item should be deleted.
Examples
C#.NET
item.IsDeleted = true;

VB.NET
item.IsDeleted = True

See also
IsNew Property
IsUpdated Property
IsEmptyItem Property
IsEmptyItem Run-Time Property (.NET)
Applies to
EditableGrid Form
Syntax
C#.NET
public bool IsEmptyItem{get;}

VB.NET
Public ReadOnly Property IsEmptyItem() As Boolean

Description
Indicates that the item does not contain any data.
Examples
C#.NET
if(!item.IsEmptyItem) item.Validate();

VB.NET
If Not item.IsEmptyItem Then item.Validate()

See also

384
IsNew Property
IsUpdated Property
IsDeleted Property
IsNew Run-Time Property (.NET)
Applies to
EditableGrid Form, Record Form
Syntax
C#.NET
public bool IsNew{get;}

VB.NET
Public ReadOnly Property IsNew() As Boolean

Description
Indicates that the item is new and Update method has not been called.
Examples
C#.NET
if(!item.IsNew) Record1Data.Update(item);

VB.NET
If Not item.IsNew Then Record1Data.Update(item)

See also
IsEmptyItem Property
IsUpdated Property
IsDeleted Property
IsUpdated Run-Time Property (.NET)
Applies to
EditableGrid Form
Syntax
C#.NET
public bool IsUpdated{get;}

VB.NET
Public ReadOnly Property IsUpdated() As Boolean

Description
This property indicates that the Update method of the Data Provider successfully performed
database operation (insert, update or delete) for the item.
Examples
C#.NET
if(!item.IsUpdated) EditableGrid1Data.Update();

VB.NET
If Not item.IsUpdated Then EditableGrid1Data.Update()

385
See also
IsEmptyItem Property
IsNew Property
IsDeleted Property
MaxPage Run-Time Property (.NET)
Applies to
Navigator Control
Syntax
C#.NET
public int MaxPage{get;set;}

VB.NET
Public Property MaxPage() As Integer

Description
The maximum number of pages. Use this property to set the number of pages that the navigator
can display.
Examples
C#.NET
Navigator.MaxPage = 10;

VB.NET
Navigator.MaxPage = 10

See also
PageMumber Property
PagerSize Property
Style Property
Mode Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET
public CalendarMode Mode{get;set;}

VB.NET
Public Property Mode() As CalendarMode

Description
Retrives or specifies the calendar type.
Type Description
Full The calendar will display 12 months of the given year.
Quarter The calendar will display 3 months of the quarter to which the selected date belongs.
ThreeMonth The calendar will display 3 months of a quarter: the selected, next and previous
months.

386
OneMonth The calendar will display 1 selected month.
Examples
C#.NET
Calendar1.Mode = CalendarMode.Quarter;

VB.NET
Calendar1.Mode = CalendarMode.Quarter

See also
Text Property
Month Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET
public int Month{get;set;}

VB.NET
Public Property Month() As Integer

Description
Retrives or specifies the month component of Date property.
Examples
C#.NET
Calendar1.Month = 10;

VB.NET
Calendar1.Month = 10

See also
Date Property, Year Property, Day Property
MonthsInRow Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET
public int MonthsInRow{get;set;}

VB.NET
Public Property MonthsInRow() As Integer

Description
Retrives or specifies the number of calendar columns. An annual calendar can have between 1
and 12 columns, while quarterly and 3-months calendars can have between 1 and 3 columns.
Examples

387
C#.NET
Calendar1.MonthsInRow = 2;

VB.NET
Calendar1.MonthsInRow = 2

Name Run-Time Property (.NET)

Applies to
Section Control
Syntax
C#.NET
public string name{get;set;}

VB.NET
Public Property Name() As String

Description
Gets or sets the name of the Section control.
Examples
C#.NET
ReportSection1.Name = "Detail";

VB.NET
ReportSection1.Name = "Detail"

NumberOfColumns Run-Time Property (.NET)

Applies to
Directory Form
Syntax
C#.NET
public int NumberOfColumns{get;set}

VB.NET
Public Property NumberOfColumns() As Integer

Description
The number of columns the categories in the directory form are displayed in.
Examples
C#.NET
Directory1.NumberOfColumns = 2;

VB.NET
Directory1.NumberOfColumns = 2

NumberOfSubCategories Run-Time Property (.NET)

Applies to

388
Directory Form
Syntax
C#.NET
public int NumberOfSubCategories{get;set}

VB.NET
Public Property NumberOfSubCategories() As Integer

Description
The maximum number of subcategories to be displayed per category.
Examples
C#.NET
Directory1.NumberOfSubCategories = 3;

VB.NET
Directory1.NumberOfSubCategories = 3

Order Run-Time Property (.NET)

Applies to
CalendarNavigator control
Syntax
C#.NET
public CalendarNavigatorOrder Order{get;set;}

VB.NET
Public Property Order() As CalendarNavigatorOrder

Description
Retrives or specifies the order of showing calendar navigator navigation parts.
Type Description
YearsQuartersMonths The calendar navigator will show year, then quarter, then month navigation
parts.
YearsMonthsQuarters The calendar navigator will show year, then month, then quarter navigation
parts.
MonthsQuartersYears The calendar navigator will show month, then quarter, then year navigation
parts.
MonthsYearsQuarters The calendar navigator will show month, then year, then quarter navigation
parts.
QuartersYearsMonths The calendar navigator will show quarter, then year, then month navigation
parts.
QuartersMonthsYears The calendar navigator will show quarter, then month, then year navigation
parts.
Examples
C#.NET

389
 CalendarNavigator1.Order = CalendarNavigatorOrder.MonthsQuartersYears;

VB.NET
CalendarNavigator1.Order = CalendarNavigatorOrder.MonthsQuartersYears

PageNumber Run-Time Property (.NET)

Applies to
Navigator Control
Syntax
C#.NET
public int PageNumber{get;set;}

VB.NET
Public Property PageNumber() As Integer

Description
The number of the currently displayed page. Use this property to retrieve the number of the page
the navigator is currently displaying.
Examples
C#.NET
Navigator.PageNumber = 6;

VB.NET
Navigator.PageNumber = 6

See also
MaxPage Property
PagerSize Property
Style Property
PagerSize Run-Time Property (.NET)
Applies to
Navigator Control
Syntax
C#.NET
public int PagerSize{get;set;}

VB.NET
Public Property PagerSize() As Integer

Description
The number of pages that are displayed simultaneously by the pager.
Examples
C#.NET
Navigator.PagerSize = 10;

VB.NET

390
 Navigator.PagerSize = 10

See also
MaxPage Property
PageNumber Property
Style Property
PageSize Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public virtual float PageSize{get;set;}

VB.NET
Public Overridable Property PageSize() As Single

Description
Retrieves or sets the number of lines per page to be output in Print view mode.
Examples
C#.NET
Report1.PageSize = 100;

VB.NET
Report1.PageSize = 100

See also
PageSizeLimit Property,WebPageSize Property,ViewMode Property
PageSizeLimit Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public virtual float PageSizeLimit{get;set;}

VB.NET
Public Overridable Property PageSizeLimit() As Single

Description
Retrieves or sets the maximum number of lines per page to be output in Web view mode.
Examples
C#.NET
Report1.PageSizeLimit = 100;

VB.NET
Report1.PageSizeLimit = 100

391
See also
PageSize Property,WebPageSize Property,ViewMode Property
PageNumber Run-Time Property (.NET)
Applies to
Grid Form, EditableGrid Form
Syntax
C#.NET
public int PageNumber{get;set;}

VB.NET
Public Property PageNumber() As Integer

Description
Retrieves or sets the number of displayed page.
Examples
C#.NET
Grid1Data.PageNumber = 6;

VB.NET
Grid1Data.PageNumber = 6

See also
RecordPerPage Property
PercentOf Run-Time Property (.NET)
Applies to
ReportLabel control
Syntax
C#.NET
public string PercentOf{get;set;}

VB.NET
Public Property PercentOf() As String

Description
Retrieves or sets the name of the report group of which the percent value will be calculated. The
possible values are "Report" or the name of any defined report group.
Examples
C#.NET
ReportLabel1.PercentOf = "Report";

VB.NET
ReportLabel1.PercentOf = "Report"

See also
Function Property

392
PreviewPageNumber Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public virtual uint PreviewPageNumber{get;set;}

VB.NET
Public Overridable Property PreviewPageNumber() As Integer

Description
Retrieves or sets the page number in the Web view mode.
Examples
C#.NET
Report1.PreviewPageNumber = 100;

VB.NET
Report1.PreviewPageNumber = 100

See also
WebPageSize Property,ViewMode Property
Quarter Run-Time Property (.NET)
Applies to
CalendarNavigator control
Syntax
C#.NET
public int Quarter{get}

VB.NET
Public ReadOnly Property Quarter() As Integer

Description
Retrives the quarter of Date property.
Examples
C#.NET
int selectedQuarter = CalendarNavigator1.Quarter;

VB.NET
Dim selectedQuarter As Integer = CalendarNavigator1.Quarter

See also
Date Property, Month Property, Day Property, Year Property
RecordPerPage Run-Time Property (.NET)
Applies to
Grid Form, EditableGrid Form

393
Syntax
C#.NET
public int RecordPerPage{get;set;}

VB.NET
Public Property RecordPerPage() As Integer

Description
Retrieves or sets the number of records displayed on a page.
Examples
C#.NET
Grid1Data.RecordPerPage = 10;

VB.NET
Grid1Data.RecordPerPage = 10

Required Run-Time Property (.NET)

Applies to
FileUpload Control
Syntax
C#.NET
public bool Required{get;set}

VB.NET
Public Property Required() As Boolean

Description
If this property is set to true, the user will not be able to delete an already uploaded file.
Examples
C#.NET
FileUpload1.Required = true;

VB.NET
FileUpload1.Required = True

ResetAt Run-Time Property (.NET)

Applies to
ReportLabel Control
Syntax
C#.NET
public string ResetAt{get;set;}

VB.NET
Public Property ResetAt() As String

Description

394
Retrieves or sets the name of the section where the corresponding control's value should be reset.
Possible values are "Report", "Page" or name of any defined report group.
Examples
C#.NET
ReportLabel1.ResetAt = "Page";

VB.NET
ReportLabel1.ResetAt = "Page"

See also
Function Property,PercentOf Property
RowNumber Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public virtual uint RowNumber{get;}

VB.NET
Public Overridable ReadOnly Property RowNumber() As Integer

Description
Retrieves the number of the currently processed report row.
Examples
C#.NET
int currentRow = Report1.RowNumber;

VB.NET
Dim CurrentRow As Integer = Report1.RowNumber

ShowOtherMonthsDays Run-Time Property (.NET)

Applies to
Calendar control
Syntax
C#.NET
public bool ShowOtherMonthsDays{get;set;}

VB.NET
Public Property ShowOtherMonthsDays() As Boolean

Description
Retrives or specifies whether to show days of the surrounding months if the 1st or last week of the
month includes days of other months.
Examples
C#.NET

395
 Calendar1.ShowOtherMonthsDays = true;

VB.NET
Calendar1.ShowOtherMonthsDays = True

Applies to
Grid Form, EditableGrid Form
Syntax
C#.NET
public <control name>DataProvider.SortFields SortField{get;set;}

VB.NET
Public Property SortField() As <control name>DataProvider.SortFields

Description
Gets or sets the sort column for the Select command. The default value is <control
name>DataProvider.SortFields.Default
Examples
C#.NET
Grid1Data.SortField = Grid1DataProvider.SortFields.UserId;

VB.NET
Grid1Data.SortField = Grid1DataProvider.SortFields.UserId

Source Run-Time Property (.NET)

Applies to
ReportLabel Control
Syntax
C#.NET
public string Source{get;set;}

VB.NET
Public Overridable Property Source() As Single

Description
Retrieves or sets the data source for the control. The value may be different depending on the
SourceType property. If SourceType is set to DBColumn then the value should be the name of a
database column. If SourceType is set to SpecialValue then the value should be one of the
following: RowNumber, PageNumber, CurrentDate, CurrentDateTime, CurrentTime.
Examples
C#.NET
ReportLabel1.Source = "user_name";

VB.NET
ReportLabel1.Source = "user_name"

See also
SourceType Property

396
SourceType Run-Time Property (.NET)
Applies to
ReportLabel Control
Syntax
C#.NET
public ReportLabelSourceType SourceType{get;set;}

VB.NET
Public Property SourceType() As ReportLabelSourceType

Description
Retrieves or sets the source type of the report label.
Type Description
DBColumn The source of report label is a database column.
SpecialValue The source of report label is a special value.
Examples
C#.NET
ReportLabel1.SourceType = ReportLabelSourceType.DBColumn;

VB.NET
ReportLabel1.SourceType = ReportLabelSourceType.DBColumn

See also
Source Property

State Run-Time Property (.NET)

Applies to
Sorter Control
Syntax
C#.NET
public SorterState State{get;set;}

VB.NET
Public Property State() As SorterState

Description
The state of the sorter control.
Type Description
Ascending The sorter in Ascending state.
Descending The sorter in Descending state.
None The sorter is inactive.
Examples
C#.NET

397
 Sorter1.State = SorterState.Ascending;

VB.NET
Sorter1.State = SorterState.Ascending

Style Run-Time Property (.NET)

Applies to
Navigator Control
Syntax
C#.NET
public PagerStyle Style{get;set;}

VB.NET
Public Property Style() As PagerStyle

Description
The display style of the navigator.
Type Description
Centered The current page displayed in the center of the pager.
Moving The current page moving in the pager.
Examples
C#.NET
Navigator.Style = PageStyle.Centered;

VB.NET
Navigator.Style = PageStyle.Centered;

See also
MaxPage Property
PageNumber Property
PagerSize Property
TemporaryFolder Run-Time Property (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public string TemporaryFolder{get;set}

VB.NET
Public Property TemporaryFolder() As String

Description
Retrieves or sets the temporary folder for uploaded files. This folder is used for storing files during
form validation. Values starting with the "%" character will be interpreted as system environment
variable name.
Exceptions
398
Exception Condition
System.IO.DirectoryNotFoundException The specified folder does not exist.
System.Security.SecurityException The working process does not have write permissions for
the specified folder.
Examples
C#.NET
FileUpload1.TemporaryFolder="%TEMP";

VB.NET
FileUpload1.TemporaryFolder="%TEMP"

See also
FileFolder Property
Text Run-Time Property (.NET)
Applies to
FileUpload Control
Syntax
C#.NET
public string Text{get;set}

VB.NET
Public Property Text() As String

Description
This property contains the name of the uploaded file.
Exceptions
Exception Condition
System.IO.FileNotFoundException The specified file does not exist.
Examples
C#.NET
FileUpload1.Text = @"c:\MyApp\UploadedFiles\image1.jpg";

VB.NET
FileUpload1.Text = @"c:\MyApp\UploadedFiles\image1.jpg"

Text Run-Time Property (.NET)

Applies to
ReportLabel Control
Syntax
C#.NET
public virtual string Text{get;set;}

VB.NET

399
 Public Overridable Property Text() As String

Description
Retrieves or sets the text to be output by the report label control.
Examples
C#.NET
Report1.Text = "Hello world";

VB.NET
Report1.Text = "Hello world"

See also
ContentType Property
TotalPages Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public virtual uint TotalPages{get;}

VB.NET
Public ReadOnly Property TotalPages() As Integer

Description
Retrieves total number of pages of the current report.
Examples
C#.NET
int totalPages = Report1.TotalPages;

VB.NET
Dim TotalPages As Integer = Report1.TotalPages

See also
PageSizeLimit Property, PageSize Property,WebPageSize Property,ViewMode Property
Type Run-Time Property (.NET)
Applies to
ConnectionString Object
Syntax
C#.NET
public ConnectionStringType Type{get;set;}

VB.NET
Public Property Type() As ConnectionStringType

Description

400
The type of .NET Managed Provider, which will be used for the connection. The following table
lists the different types.
Type Description
OleDb OLE DB .NET Data Provider.
Sql SQL Server .NET Data Provider.
Odbc ODBC .NET Data Provider.
Oracle Oracle .NET Data Provider.
Examples
C#.NET
ConnectionString1.Type = ConnectionStringType.OleDb;

VB.NET
ConnectionString1.Type = ConnectionStringType._OleDb

See also
ConnectionString Property
ViewMode Run-Time Property (.NET)
Applies to
Report Form
Syntax
C#.NET
public virtual ReportViewMode ViewMode{get;set;}

VB.NET
Public Overridable Property ViewMode() As ReportViewMode

Description
Retrieves or sets the current view mode of the report.

Type Description
Print The report will be displayed in Print mode.
Web The report will be displayed in Web view mode.
Examples
C#.NET
Report1.ViewMode = ReportViewMode.Print;

VB.NET
Report1.ViewMode = ReportViewMode.Print

See also
PageSizeLimit Property,PageSize Property,WebPageSize Property
Visible Run-Time Property (.NET)
Applies to

401
Button Control, Label Control, TextBox Control, TextArea Control, Checkbox Control, Image
Control, ImageLink Control, DatePicker Control, Hidden Control, Grid Form, ListBox Control,
CheckboxList Control, RadioButton Control, Record Form, Sorter Control, EditableGrid Form, Path
Control, Directory Form, FileUpload Control, Panel, Calendar
Syntax
C#.NET
public bool Visible{get;set;}

VB.NET
Public Property Visible() As Boolean

Description
If this property is false, the server control is not rendered.
Examples
C#.NET
Grid1Repeater.Visible = false;

VB.NET
Grid1Repeater.Visible = False

WebPageSize Run-Time Property (.NET)

Applies to
Report Form
Syntax
C#.NET
public virtual float WebPageSize{get;set;}

VB.NET
Public Overridable Property WebPageSize() As Single

Description
Retrieves or sets the number of lines per page to be output in Web view mode.
Examples
C#.NET
Report1.WebPageSize = 100;

VB.NET
Report1.WebPageSize = 100

See also
PageSizeLimit Property,PageSize Property,ViewMode Property
Year Run-Time Property (.NET)
Applies to
Calendar control
Syntax
C#.NET

402
 public int Year{get;set;}

VB.NET
Public Property Year() As Integer

Description
Retrives or specifies the year component of Date property.
Examples
C#.NET
Calendar1.Year = 10;

VB.NET
Calendar1.Year = 10

See also
Date Property, Month Property, Day Property
Year Run-Time Property (.NET)
Applies to
CalendarNavigator control
Syntax
C#.NET
public int Year{get}

VB.NET
Public ReadOnly Property Year() As Integer

Description
Retrives the year component of Date property.
Examples
C#.NET
int selectedYear = CalendarNavigator1.Year;

VB.NET
Dim selectedYear As Integer = CalendarNavigator1.Year

See also
Date Property, Month Property, Day Property, Quarter Property
YearsRange Run-Time Property (.NET)
Applies to
CalendarNavigator control
Syntax
C#.NET
public int YearsRange{get;set;}

VB.NET
Public Property YearsRange() As Integer

403
Description
Retrives or specifies the number of years to display in the navigator..
Examples
C#.NET
CalendarNavigator1.YearsRange = 10;

VB.NET
CalendarNavigator1.YearsRange = 10

404