ThachNguyen/ibsheet7-dataset huggingface dataset:
HideProcessDlg  Method  
 Purpose  
Close waiting  image from sheet  
 Syntax  
Syntax  ObjId. HideProcessDlg ()
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A 
 Example  
// Close waiting image  
mySheet. HideProcessDlg ();
HideSubSum  Method  
 Purpose  
Calling ShowSubSum method will insert sub sum  rows to search data from the next search. Using 
this method will stop addition of subsum started by ShowSubSumto the next search.  
This method will not operate immediately upon call, but work in the next search.  
 Syntax  
Syntax  ObjId. HideSubSum ([StdCol])
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
StdCol  Long/String  
 Optional  Column index or SaveName of the 
reference  column marking sub sums 
Default=""(All columns)  
 Example  
//Display sub sums for Column 1  
var info = [{StdCol:1, SumCols:"3|4|5"} ]; 
mySheet.ShowSubSum(info);
//Hide showing sub sums  
mySheet.HideSubSum();  
HighlightAfterSort  Method  
 Purpose  
Check or configure highlighting after sorting.  
If this property value is 0, focus will be reset after sorting. If it is 1, focus will move to the row 
originally highlighted after sorting.
 Syntax  
Syntax  Get ObjId. GetHighlightAfterSort () 
 Info 
Return  Integer, currently set value (In case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
//Check the configuration post sorting  
mySheet. GetHighlightAfterSort (); 
 Syntax  
Syntax  Set ObjId. SetHighlightAfterSort (Sort)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Sort Integer  Required  Sort setting (Default=1)  
 Example  
//After sorting,  go to the data previously selected.  
mySheet. SetHighlightAfterSort (1);
IBCloseCalendar  Method   
 Purpose  
Set to close calendar pop -up used by external control.  
 Syntax  
Syntax  ObjId. IBCloseCalendar ()
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A 
// Open calendar pop -up. 
mySheet.IBShowCalendar("20121116", { Format:" yyyy/MM/dd ", X:300,  Y:600});
// Close calendar pop -up dialog.  
mySheet.IBCloseCalendar();  
IBShowCalendar  Method   
 Purpose  
Set to allow use of calendar pop -up by external control.  
When a CallBack method is configured, the first parameter is usually the selected date string. If 
there are other parameters to send by CallBack method, set it as CallBackParam. Object set in 
CallBackParam will be sent as the second param eter of CallBack method.
 Syntax  
Syntax  ObjId. IBShowCalendar (val, [obj] ); 
 Info 
Return  String,  (Date value set in calendar pop -up dialog)  
Parameter  Type Required 
Y/N Description  
val String  Required  Date data value (Defaul=today's date)  
obj   Object  Optional  Configure function into JSON format.
Details  
Properties configurable by column are as follows:  
Property  Type Description  
Format  String  Date format (Default="Ymd")  
Target  String, 
Object  “Mouse” (When last mouse location is used, 
Default)    
or calendar button Object (when calendar 
button location is used)  
Result  Object  Object where to include selected values (Input 
object)  
X Integer  (When coordinate values are used), X 
coordinate  
Y Integer  (When coordinate values are used), Y 
coordinate  
CallBack  String  Function Name  
Method name to use upon return  
CallBackParam  Object  Parameter object to receive from CallBack 
method  
CalButtons  String  Configure the button to use for calendar 
popup  
Adjoin buttons to use with "|".  
Value Details  
Close Cancel button  
Today  Enter today's date button  
Yesterday  Enter yesterday's date button  
CalButtonAlign  String  Configure how to align buttons to use in 
calendar pop -up 
Value Details  
Left Align left  
Center  Align center (Default)  
Right Align right
 Example  
// Enter date data value  
var val = document.getElementById("DateText").value ; 
// Calendar pop -up dialog location: When X and Y coordinates are used  
1.var obj = {  Format: " Ymd", X:300,  Y:600,  CallBack: " Test" };
// Calendar pop -up dialog location: When last mouse location is used  
2.var obj = {  Format: " Ymd", Target:"Mouse" , CallBack: " Test" }; 
// Calendar pop -up dialog location: When calendar button location is used  
3.var obj = { Format:" Ymd", Target:document.getElementById("DateBtn") , 
CallBack: " Test" };
// CalButtons property: when closing calendar button option setting is used  
3.var obj = { Format:" Ymd", Target:document.getElementById("DateBtn") , 
CallBack: " Test" , CalButtons : "Close"};  
// Alignment setting when closing calendar button option setting is used: 
Align left  
4.var obj = { Format:" Ymd", Target:document.getElementById("DateBtn") , 
CallBack: " Test", CalButtons : "Close", CalButtonAlign : "Left"  };
// fnName: create a function using the method name  
function Test (date){  
// Return value when a date is selected from calendar pop -up dialogue  
document.getElementById("DateText").value = date;  
} 
ImageList  Method   
 Purpose  
Check or configure web server path of Nth image file  
This property is used to remember image file by configuring image path displayed in a cell with 
Image type so that it can be downloaded and reused later once . 
Can be used for search and new row entry.  
Image file path may be a relative path to the current page, or an absolute path below web server 
root. 
If you set index, start with 0 and set as many index as you want.  
[Instructions]  
mySheet. SetImageList(0 , "../image/btn_search.gif”) ; 
mySheet. SetImageList(1 ,"/common/image/btn_cal.gif") ;
[List of methods used to change image -related values]  
Image setting  Purpose  Image  
ImageList  Change 
image  SetCellValue,SetCellImage  
SetSearchingImage,SetSavingImage,  
SetWaitImage,SetKeyFieldImage  
Change 
value N/A 
 Syntax  
Syntax  Get ObjId. GetImageList (Index)
 Info 
Return  String, image path configured in the index  
(in case of Get Method)  
Parameter  Type Required 
Y/N Description  
Index Integer  Required  Image index  
 Example  
Check for image path configured in the index  
mySheet. GetImageList( 0);
 Syntax  
Syntax  Set ObjId. SetImageList (Index, Url) 
 Info 
Return  None 
(in case of Get Method)  
Parameter  Type Required 
Y/N Description  
Index Integer  Required  Image index  
Url  String  Required  Image path to set
 Example  
// Set image path in 0 index  
mySheet. SetImageList( 0, "../image/btn_search.gif” ); 
// Use the image saved in 0  index (Type:Image)  
mySheet.SetCellValue(3, 5, 0);  
mySheet.SetCellImage(3, 5, 0);  
mySheet.SetSearchingImage(0);  
mySheet.SetSavingImage(0);  
mySheet.SetWaitImage(0);  
mySheet.SetKeyFieldImage(0);
InitCellProperty  Method  
 Purpose  
After search or addition  of a new row, use this method to define properties of a particular cell 
from default column property sets.  
(Date formats available are Ymd, Ym, Md, YmdHms and YmdHm.)  
If the column type defined in InitColumns method is Seq, Status, DelCheck, AutoSum or AutoAvg, 
you cannot use this method.Available types are as follows:  
Type Description  
Text Basic string data  
CheckBox  Checkbox type data  
Combo  Uneditable  combo data  
ComboEdit  Auto complete combo data  
Image  Uneditable  simple image representation data  
Int Integer type  
Float Float type  
Date Date type  
Popup  Data using popup  
PopupEdit  Editable data which uses pop -up 
Properties configurable in this method are as follows:  
Property  Type Description  
Type String Column data type (Required)  
AcceptKeys  String Accepted key configuraiton  
Align String Data alignment  
ApproximateType  Integer  Approximation type (1: Rounding, 2: 
Rounding down, 3: Rounding up)  
ComboCode  String Combo list code group  
ComboText  String Combo list text string group  
Cursor  String Mouse pointer style setting  
CustomDate  Integer  Custom date availability  
Edit Boolean  Editability  
EditLen  Integer  Editable data legnth  
Format  String Data mask application format  
FormatFix  Boolean  Whether to return GetCellText values during 
GetCellValue (Default=0); if true, the cell 
value will be saved with format.  
HoverUnderline  Boolean  Whether to underline when mouse is 
hovering over  
Image  String Image path  
ImgAlign  String Image display location  
ImgHeight  Integer  Image height  
ImgWidth  Integer  Image width  
InputCaseSensitive  Number  Whether to use particular case 
automatically for alphabet inputs  
0: No configuration (Default)  
1: Replace with upper case  
2: Replace with lower case  
MultiLineText  Boolean  Whether to use multilines  
PointCount  Integer  When column type is float, number of 
decimal places.  
For detailed description of each property, see InitColumns Method desription.
 Syntax  
Syntax  ObjId. InitCellProperty (Row, Col, info ); 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Index of relevant rows  
Col Long / Required  Index of the target column   
String  or SaveName  
info Object  Required  Cell property definition object
 Example  
// Change to text column type  
var info = {Type:  "Text", Align:  "Center ", Edit: 0};  
mySheet.InitCellProperty(2, "sCombo ", info);  
InitColumns  Method  
 Purpose  
Configure data type, format and functionality of each column.
 Syntax  
Syntax  ObjId. InitColumns (cols); 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
cols json Required  Configure functionality of each column 
into JSON format.
Align is Left, Center or Right alignment setting of cell data.  
DataAlign  Description  
Left Left alignment (Default)  
Center  Center alignment  
Right Right alignment  
AcceptKeys is where you configure key operations allowed for a column.  
Set as "N" for numbers and "E" for english  alphabet; if both numbers and English alphabets are 
allowed, connect the two values with "|".
BackColor is the background color of a column.  
ButtonUrl property may be used when you wish to change the pop -up button image for 
column types Popup or PopupEdit. If this property is not configured, "popup.gif" in Theme will 
display in default. If date format is set, "calendar.gif" image will display. If you want to use an 
image other than those two, use this property to set the wanted image. To use a sel ected image, 
image path string or image list index should be configured as property value. Use the default 
theme path as reference when you configure a new image. Image size should be 12*12 to 
display correctly. For other than dynamic change, it is recomme nded to replace the theme 
image at the same location.
CalcLogic can be used to configure calculation formula for  the data. If part of column data is 
referenced in a formula, surround the value with "|" within the formula.  The default is "".  
For example,  if you need to multiply column 5 value by 2 and add column 3 value, the formula 
will be "|5| * 2 + |3|". Once a formula is configured, the value will be automatically updated upon 
search or when a column value is changed.
In addition to column name, you can also use SaveName of other columns in your formula. If 
SaveName of Column 5 is "pay" in the example above, the formula may be "|pay|*2+|3|" and still 
it will produce the same effect.  
CaseSensitive is where you may configure whether to make filtering c ase-sensitive.
ColMerge configures whether to allow vertical merge for data columns. The default value is 1.  
In ColSpan, you can set the scope of ColSpan to apply as fixed within a unit data rows for unit -
data row structure. When this property is set, cell will display as merged regardless of whether 
the data are the same. This property is effective only for unit data row structure. To use this 
property, MergeSheet value must be 3 or 8. (Related property: RowSpan)
ComboCode is composed of code items ad joined by  "|" for columns of Type "Combo" or 
"ComboEdit". The item count must be the same as the item count for ComboText above.  
ComboText is composed of string items to display on the screen, adjoined by  "|" for columns 
of Type "Combo" or "ComboEdit".
Cursor can be used to set the cursor image to display when mouse is over the column.   
You may set this as "Default" or "Pointer". "Default" will be the default value.  
DefaultValue  can be used to configure the default value for any new entries. The default value 
is "". 
Edit can be used to configure data editability. The default value is 1.
EditLen can be used to configure the maximum number of characters to allow for a piece of 
data. 
Ellipsis  can be use d to set whether to display ellipsis when full  column text cannot be displayed. 
The default value is 0.
ExcludeEmpty  can be used to configure whether to include empty values to averaging for 
AutoAvg column type. If not configured, the default value of 0 will apply (include empty value). 
As this prope rty involves identification of empty values, the format should be set as NullInteger 
or NullFloat to use this.  
FontColor can be used to configure a column's font color.
Format  can be used to configure whether to apply Mask to data. Available values are as in the 
table below. In addition to formats provided in OOTB solution, you may also create a custom 
format  ((ex) Format="#,###,#0"). Formats will apply depending on the column Type.  
Format  Description  Available types  
Ymd "Year, month, day" format.  
Follow SYS_d format of ibmsg.  Date,Text,Popup,PopupEdit  
Ym "Year Month" format.  
Follow SYS_m format of ibmsg.  Date,Text,Popup,PopupEdit  
Md "Month, day" format.  
Follow SYS_M format of ibmsg.  Date,Text,Popup,PopupEdit  
Hms "Hour, minute, second" format.  
Follow SYS_T format of ibmsg.  Date,Text,Popup,PopupEdit  
Hm "Hour, minute" format.  
Follow SYS_t format of ibmsg.  Date,Text,Popup,PopupEdit  
YmdHms "Year, month, day, hour, minute, 
second" format.  
Follow SYS_G format of ibmsg.  Date,Text,Popup,PopupEdit  
YmdHm "Year, month, day, hour, minute" 
format.  
Follow SYS_g format of ibmsg.  Date,Text,Popup,PopupEdit  
Integer  Integer format, default is 0  Int,AutoSum,AutoAvg  
NullInteger  Null integer type, Default is null  Int,AutoSum,AutoAvg  
Float Float format, default is 0  Float,AutoSum,AutoAvg  
NullFloat  Null float type, Default is null  Float,AutoSum,AutoAvg  
IdNo Korean  resident ID number format  Text 
SaupNo  Korean  business registration number 
format  Text 
PostNo  Korean  zip code format  Text 
CardNo  Credit card number format  Text 
PhoneNo  Phone number format  Text 
Number  Number format (No particular format; 
accepts number key entries)  Text
※ Number format guide for users  
In addition to OOTB formats, you can define a custom format by combining "#", "0", "," ".". 
Types that may use a custom format are Int, Float, AutoSum and AutoAvg.  
Detailed instuctions are as in the table below:  
Cell format  sym
bol Description  
Number  # If a number format is set using #, display numbers for 
those digits and leave an empty digit if there is no 
number for the corresponding digit. When  # is used 
after decimal point, numbers in decimal places will be 
rounded up if the number  exceeds the decimal place 
count set by #.  
Sample)  
Input= 12345.678, Format=#,###.##,Output=12,345.68  
Input= 0.789  Format=#,###.##,Output=.79  
0 Display value as set. If there is no value to display, 
display 0 instead. This works the same way as # above 
in decimal places.  
Sample)  
Input=123456.7  Format=#,##0.00  Result=123,456.70  
Input= 0.7  Format=#,##0.00  Result=0.70  
Decimal 
separator  . When there is a decimal separator, the number format 
may be a float. The symbol for decimal separator will 
be represented with the value configured in 
SYS_DecimalSeparator of ibmsg.  
Thousands 
separator  , When thousands separator is configured, groups of 
thousands will be separated using the separator 
configured in SYS_GroupSeparator of ibmsg.  
Also, when t housands separator is used immediately 
before the decimal separator, the display value will be 
the number divided by 1000 as many times as the 
number of commas.  
Sample)  
Input= 123456.789  Format=0,.00  Result=123.46  
Input= 123456.789  Format=0,,.00  Resul t=0.12  
Percentage  \\
% When percentage symbol is used at the end, the input 
value will be automatically marked with the percentage 
symbol.  
Sample)  
Input=123 .456 Format=#,##0.00 \\%  Result=123 .46%
※ Character format guide for users  
In addition to OOTB formats, you can define a custom format by combining "#", "*", or others. 
Types that may use a custom format are Text and PopupEdit.  
Detailed instuctions are as in the table below:  
Cell format  sym
bol Description
Character  
 # If a number format is set using #, display numbers for 
those digits and leave an empty digit if there is no 
number for the corresponding digit.  
Sample)  
Input=7907211022553,  
Format=###### -****, Result=790721 -****553  * 
Others  Characters or numbers other than # and * will be 
displayed as they are.
FormatFix  can be used to  configure whether to return GetCellText value upon GetCellValue. If 
set as true, the format will be also saved upon saving.  
The default value is 0.  
FullInput can be used when  you need to use the full legnth of EditLen for columns with single 
row string as the type. The default value is 0.
HeaderCheck  can be used to  configure whether to check the CheckAll box in the header.  
The default value is 1.  
Hidden  can be used to  configure whether to hide a certain data column.
HoverUnderline  can be used to configure whether to underline cell value when the mouse 
point is over the cell. The default value is 0.  
Image can be used when an image should be displayed in the column. This may be used for the 
following column types:  "Text", "Int", "Float", "AutoSum", "AutoAvg" The image configured here 
is the default image for the column. In Search Data Structure, you may set different images for 
individual cells.
ImgAlign  can be used  to configure the image location when you are using the Image property. 
If you set this as "Left", image will display left to text. "Right" will display image on the right side 
of text. If you choose not to configure, the default value is "Left".  
ImgHeigh t can be used to  configure the height of image if the column type is "Image" or you 
are using the "Image" property. The default is 0, which displays the image at its original size.
ImgWidth  can be used to configure the width of image if the column type is  "Image" or you 
are using the "Image" property. The default is 0, which displays the image at its original size.  
InsertEdit  can be used to configure editability of data the transaction status of which is Insert. 
The default value is 1.
KeyField  can be used to configure whether to make a data cell a required field. If the value is 
set as 1 and the data cell is empty, a warning message appears when the saving method is 
called so as to encourage the user to fill the cell. The default value is 0.  
LevelSaveName allows you to configure the tree -level parameter name to use when you save 
data for a tree -type search. If the name is not set, tree levels of the row will not be transferred 
to the server.
MaximumValue  can be used to set the max value allow ed during editing for number cell 
formats like Integer, Float, NullInteger or NullFloat.  
MinimumValue  can be used to set the min value allowed during editing for number cell formats 
like Integer, Float, NullInteger or NullFloat.
MultiLineText  can be used  to configure whether to allow multiple lines for columns with Type 
"Text". The default value is 0.  
PointCount  can be used to configure the number of demimal places to display for column type 
Float. 
If a value is not set, the number of decimal places will  be determined by Format value. If 
PointCount is set, it will prevail over Format value.
PopupCheckEdit can be used to check  editability of selected rows when column pop -up is set. 
Set the value as 1 if you need to change only editable data. The default value is 0.  
PopupCode is composed of code values m apped to PopupText, adjoined by  "|". The value count 
must be the same as the value count in PopupText. Once this property is configured, when a 
pop-up menu option is selected, mapping code values display i n the adjacent column.
PopupText is composed of popup menu options to display upon right click of mouse, adjoined 
by "|". 
RadioIcon  can be used to s elect the button or box image to display in data cells for CheckBox, 
DummyCheck, DelCheck and Radio column  types. If set 1, the cells will display a radio button. If 
set 0, a checkbox. The default value is 1 for Radio column type and 0 for other column types.
RowSpan can be used to set the scope of RowSpan to apply as fixed within a unit data rows for 
unit-data row structure. When this property is set, cell will display as merged regardless of 
whether the data are the same. This property is effective only for unit data row structure. To use 
this property, MergeSheet value mu st be 3 or 8. (Related proper ty: ColSpan)  
SaveName  can be used to  configure the parameter names to use when saving data. If not 
configured, names will be given sequentially as in C1, C2 and so on.
Sort can be used to  configure whether to allow sorting by clicking on the header cell. The 
default value is 1.  
ToolTipText  can be used to  configure the text to display in tooltip  at the header row. The 
default is empty value.
TreeCol  can be used to  configure whether to set  a reference column for a tree -type search.  
TrueValue and FalseValue allows user to use custom values in CheckBox columns rather than 0 
and 1, which are default in OOTB. For example, if you set as TrueValue:"T" and FalseValue:"F", 
you can use "T" instead of 1 and "F" instead of 0 to represent values.
UpdateEdit  can be used to  configure editability of data the transaction status of which is Search. 
The default value is 1.  
Width should be set as pixel count. Otherwise, the column width will be automatically adjusted 
to fit the header text.
Wrap can be used to  configure whether to break lines of text automatically to display the text 
within the set column width. The default value is 0.  
VAVlign  can be used to  configure vertical alignment optio n for columns. If set as "Top", text and 
images will be aligned to the top. If set as "Bottom", they will be aligned to the bottom. If this 
property is not configured, they will be aligned as "Middle".
 Example  
//Configure functions of each column.  
var cols = [  
{Type:"Status",Width:60,SaveName:"sStatus",Align:"Center"},  
{Type:"DelCheck",Width:60,SaveName:"sDelete",Align:"Center"},  
{Type:"Text",Width:100,SaveName:"JOB",Align:"Center"},  
{Type:"Combo",Width:100,SaveName:"DEPTNO",Align:"Center"  
,ComboText:c omboDataArr[0],ComboCode:comboDataArr[1]},  
{Type:"Text",Width:60,SaveName:"EMPNO",Align:"Center"},  
{Type:"Text",Width:150,SaveName:"ENAME",Align:""},  
{Type:"Date",Width:120,SaveName:"HIREDATE",Format:"Ymd"  
,Align:"Center",EditLen:8},  
{Type:"Text",Width:120 ,SaveName:"MGR",Align:"Center"},  
{Type:"Int",Width:120,SaveName:"SAL",Align:"Right",Format:"NullInteger"},  
{Type:"Int",Width:60,SaveName:"COMM",Align:"Right",Format:"Integer"}  
]; 
 mySheet.InitColumns(cols);  
InitComboNoMatchText Method  
 Purpose  
Using this method, you can configure the characters to display when you configure or search for 
items that do not exist in Combo items.  
Assuming the Show parameter value is set as 1 (true), when the search data include values that 
do not exist in ComboCode, the value set at ShowText parameter will display.  
Assuming the InsertItem parameter is set as 1 (true), if a value that has never been set at 
InitDataCombo is searched, that value will be added as a new item. However, if there is a set 
value in ShowText, ShowT ext value will be added as an item.
 Syntax  
Syntax  ObjId. InitComboNoMatchText (Show, [ShowText],  [InsertItem])  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Show Boolean  Required  Whether to show characters other 
than combo items.  
ShowText  String  Optional  Characters to display when combo 
items are not found, Default=""  
InsertItem  Boolean  Optional  If  
Default=0
 Example  
//When there is no Combo item, display "No Item Found"  
mySheet.InitComboNoMatchText(1, "No Item Found");  
InitHeaders Method  
 Purpose  
You can define the header title and function using this method.
 Syntax  
Syntax  ObjId. InitHeaders(Headers, [info])  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Headers  json Required  Define header title and alignment in 
JSON format.  
info json Optional  Define header functions such as 
sorting and column movement 
permissions.
Detailed configurations  
Parameters  Type Description  
headers  Text String String of texts to display in header, 
adjoined by  "|"  
Align String How to align header text  
(Default = "Center")  
info Sort Boolean  Whether to allow sorting by clicking on 
the header (Default=1)  
ColMove  Boolean  Whether to allow column movement in 
header (Default=1)  
ColResize  Boolean  Whether to allow resizing of column 
width (Default=1)  
HeaderCheck  Boolean  Whether the CheckAll in the header is 
checked (Default=1)  
 Example  
// Configure double line header title.  
var headers = [  
{Text:"Status|Delete|Employee Profile|Employee Profile|Employee Profile", 
Align:" Center"} ,  
{Text:"Status|Delete|Employee Name|Employee Number|Date of Joining", 
Align:" Center"}  
]; 
var info = {Sort:1, ColMove:1, ColResize:0, HeaderCheck:0};  
mySheet.InitHeaders(headers,info);
IsDataModified  Method  
 Purpose  
Check transaction status of data rows. 
If any data is in transaction status other than "Search", 1 is returned; otherwise, 0 is returned.  
 Syntax  
Syntax  ObjId. IsDataModified ()
 Info 
Return  Boolean, whether transaction occurred in a data row  
Parameter  Type Required 
Y/N Description  
N/A 
 Example  
// If there is no transaction occurred, cancel saving after displaying a 
message.  
if(!mySheet.IsDataModified()) {  
    alert("Nothing to save. Saving is cancelled.");  
// Save any transactions occurred  
} else {  
    mySheet.DoSave("sheet_save.jsp");  
}
IsHaveChild Method  
 Purpose  
In tree type data, check whether there are Child level rows to a particular row.  
If there are any child levels, 1 is returned; otherwise, 0 is returned.  
IncludeDelRow parameter determines whether to include "deleted" child level rows for the row 
defined in Row parameter. If the value is set as 1, "Deleted" child rows will be included. If 0, they 
are excluded. Default=0.  
 Syntax  
Syntax  ObjId. IsHaveChild (Row, [IncludeDelRow])
 Info 
Return  Boolean, whether child rows exist.  
Parameter  Type Required 
Y/N Description  
Row Long Required  Row index of a particular row  
IncludeDelRow  Boolean  Optional  Whether to include rows of 
"Deleted" status among the child 
level rows, Default=0  
 Example  
//Check for child level rows of Row 4.  
if(mySheet.IsHaveChild(4)) {  
   alert("Row 4 has child level.");  
}else{ 
  alert("Row 4 does not have child level.");  
} 
//Check child rows of Row 4, including deleted child rows.  
var bResult = mySheet.IsHaveChild(4, 1);
KeyFieldImage Method  
 Purpose  
Check or configure image file location for required field image.  
This method can be used when the user wants to customize the required field image.  
 Syntax  
Syntax  Get ObjId. GetKeyFieldImage ()
 Info 
Return  String, set value (In case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
// Check the required field item image.  
mySheet. GetKeyField Image ();
 Syntax  
Syntax  Set ObjId. SetKeyFieldImage (imgUrl ) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
imgUrl  String  Required  Url to set
 Example  
// Change the required field item image.  
mySheet.SetKeyField Image (“/sheet/imgKeyField.gif ”); 
LastCol Method  
 Purpose  
Return the column index of the last column.
 Syntax  
Syntax  ObjId. LastCol () 
 Info 
Return  Long, last column index  
Parameter  Type Required 
Y/N Description  
N/A
 Example  
//Check the column index of the last column.  
alert("Index of the last column is " + mySheet.LastCol() + ".");  
LastRow Method  
 Purpose  
Return the row index of the last row.  
Using this method will return the index of the very last row, not just last data row or the last row 
as displayed in the screen.  
Note that the last row may be a sum row, data row or even a header row.
 Syntax  
Syntax  ObjId. LastRow () 
 Info 
Return  Long, last row index  
Parameter  Type Description  
N/A
 Example  
//Check the row index of the last row.  
alert("Index of the last row is " + mySheet.LastRow() + ".");  
LeftCol Method  
 Purpose  
Check or configure the leftmost column to display. If there are any frozen columns, the column 
you set using this method will display right to the frozen columns. Setting this property will not 
move focus, but as the column at the leftmost side is changed,  horizontal scroll bar will be 
moved accordingly. LeftCol is set by counting distance from column 0 including hidden columns.
 Syntax  
Syntax  Get ObjId. GetLeftCol () 
 Info 
Return  Long, leftmost column index (in case of Get Method)  
Parameter  Type Required  
Y/N Description
 Example  
//Check for left column setting  
mySheet.GetLeftCol();  
 Syntax  
Syntax  Set ObjId. SetLeftCol (Col)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Col Long/  
String  Required  Column index of a particular column  
or SaveName  
 Example  
//If there are frozen columns   
//Configure that column 4 should display at the leftmost side of horizontal 
scroll  
mySheet.SetLeftCol(4);
//When there are no frozne columns  
//Configure that column 6 should display at the leftmost side of horizontal 
scroll  
mySheet.SetLeftCol(6);  
LoadSaveData Method  
 Purpose  
Fetch saved data as method parameter and process the result within IBSheet . 
This method can be used to read encrypted  save data when security module is used. Saved data 
are retrieved using GetSaveData method. The data retrieved are set as a method parameter. The 
results are displayed and OnSaveEnd event fires.
 Syntax  
Syntax  ObjId. LoadSaveData (Content)  
 Info 
Return  None.  
Parameter  Type Required 
Y/N Description  
Content  String  Required  Save XML or Save JSON string
 Example  
//Apply ajax to saving  
var rtnData  = mySheet. GetSaveData ("Action.do",param ); 
//Represent saving results  
mySheet.LoadSaveData( rtnData );
LoadSearch ChildData Method  
 Purpose  
This method performs the same function as DoSearchChild method but as object or string, not 
url; In tree structure, child node data (xml or json) are received as method parameter and loaded 
in IBSheet . This method can be used to read encrypted search data when security module is 
used. Search data are retrieved using GetSearchData method from the server. The data string 
fetched is set as a method parameter. The search data are loaded to IBSheet  and OnSe archEnd 
event fires.  
 Syntax  
Syntax  ObjId. LoadSearchChildData (Row, Data, [Opt])
 Info 
Return  None.   
Parameter  Type Required 
Y/N Description  
Row Long Required  Target parent row index  
Data String  
/ 
Object  Required  Data string or JSON object to search  
Opt  
Object  Optional  Option parameter  
Configure function into JSON format.  
    The followings are the Opt option parameters:  
WaitDlg  Boolean  Whether to display waiting image (Default=1)  
Append  Boolean  Whether to append to the existing child data 
(Default=0)
 Example  
//Read search data  
var Row = mySheet.GetSelectRow();  
var Data;  
Data= mySheet.GetSearchData('list2_Child_Json.jsp', 
'ChildLevel='+(parseInt(mySheet.GetRowLevel(Row))+1));  
var Opt = {Append: 1, WaitDlg: 1} ; 
//Load search data  
mySheet.LoadSearchChildData( Row, Data, Opt );
LoadSearchData Method  
 Purpose  
Get search data (xml or json) as a method parameter and load to IBSheet . 
This method can be used to read encrypted search data when security module is used.  
Search data are retrieved using GetSearchData method from the server. The data string fetched is 
set as a method parameter. The search data are loaded to IBSheet  and OnSearchEnd event fires.  
 Syntax  
Syntax  ObjId. LoadSearchData (Content , [Opt] )
 Info 
Return  None.   
Parameter  Type Required 
Y/N Description  
Content  String  Required  Search XML or Search JSON string  
Opt.Append  Boolean  Optional  Append search result or not, 
Default=0  
 Example  
/* The below two rows represent each step of two -step processes of using 
DoSearch() method. */  
//Read search data  
var sXml = mySheet.GetSearchData(" list.jsp");
//Load search data  
mySheet.LoadSearchData(sXml);  
// Represent search result by appending to t he exisisting data  
var opt = { Append : 1 };  
mySheet.LoadSearchData(sXml, opt);
LoadExcel Method  
 Purpose  
Read data from excel to display in the data area.  
The parameters to send are in JSON type. Put configuration information into JSON format and 
send it to the server.
Sample)  
var params = { Mode : "NoHeader ",  StartRow: "1"} ;  
mySheet.LoadExcel(params);  
If Append parameter is set as  1, you may append the current excel data to the existing data to 
load.
ColumnMapping parameter is used when you wan t to load a selected range of excel columns to 
IBSheet  from the first column onward. The default value is null. If not null, this parameter will 
prevail over Mode even though its value is HeaderMatch.   
FileExt parameter  can be used to  configure file extensions that can be uploaded. Extensions 
should be put without “.”, such as “xls”. The default value is “” and it has the same effect as 
“xls|xlsx ”. Multiple extensions should be separated with “|”.
Mode parameter determines whether to match grid heade r title and excel header title when 
loading, and whether header is included in any excel file to load.  
Mode value  Description  
HeaderMatch  Match excel header titles with the grid header titles 
to load excel columns in the matching order, even 
though columns are mixed in the excel document.  
NoHeader  Excel document does not have a header row above 
data rows, so keep the excel column order when 
loading.  
HeaderSkip  Starting from the first row, the excel document has as 
many header rows as the grid header rows, but 
ignore those and instead load the rest data rows 
sequentially. When IBSheet  has two header rows, load 
excel document from the third row, which is 
presumabl y the start of data rows.
StartRow and EndRow parameters define the starting and ending rows of the areas to fetch; if 
these are not set, all excel areas will be fetched.   
Excel row number starts from 1.  
WorkSheetName parameter  can be used to set the na mes of excel worksheets to load.  
Selection of excel worksheet will be based on WorkSheetName parameter first.  
If reading the parameter fails, then WorkSheetNo parameter value will be considered.
(Sample)  
ColumnMapping:'1|2|3' // Load the first, second and third columns of the excel file to the first, 
second and third columns of IBSheet.  
ColumnMapping:'7||7' // Load the seventh excel column to the first and third columns of IBSheet.  
 Syntax  
Syntax  ObjId. LoadExcel ([parameters])
 Info 
Parameter  Type Required 
Y/N Description  
Append  Boolean  Optional  Whether to append to the 
existing data  
Default=0  
ColumnMapping  String Optional  Excel column number  
Default=""  
EndRow  String Optional  Last row number after excel 
loading is completed  
Default="0"  
ExtendParam  String Optional  Define extra parameters to 
send to the server in a=1&b=2 
format. Default="" Default=""  
FileExt  String Optional  File extensions that can be 
uploaded  
Default=""  
Mode  String Optional  Loading options (header 
matching, etc.)  
Default=“HeaderMatch”  
StartRow  String Optional  Excel loading row number  
Default="1"  
WorkSheetNo  String Optional  Excel worksheet number  
Default="1"  
WorkSheetName  String Optional  Excel Worksheet name  
Default=""  
 Example  
// Load excel file  
mySheet.LoadExcel();
// Compare the header titles to load the matching columns, but read only 
from row 7 to 9.  
mySheet.LoadExcel({Mode:'HeaderMatch',StartRow:'7',EndRow:'9'});  
// Load the fifth excel column values to the IBSheet  first column, and load 
the first excel column values to the 5th IBSheet  column.  
mySheet.LoadExcel({ColumnMapping:'5|4|3|2|1'});
LoadExcelBuffer  Method  
 Purpose  
Load one excel document to multiple sheets.  
When you set IsBuffer parameter of LoadExcelBuffer as true, all LoadExcel execution thereafter 
will not run but be buffered in memory.   
File upload window will appear once you change the IsBuffer value to false.
All the FileExt property settings made during buffering will be ignored excep t for the last one.  
 Syntax  
Syntax  ObjId. LoadExcelBuffer (IsBuffer)
 Info 
Parameter  Type Required 
Y/N Description  
IsBuffer  bool Required  Buffering or not  
 Example  
// Immediately load an excel file  
mySheet.LoadExcel();
//Buffer  afterwards. Do nothing.  
mySheet. LoadExcelBuffer(true);   
// Schedule an excel loading. Compare the header titles of my Sheet and the 
first spreadsheet of an excel file to load the same columns, but load only 
rows 7 -9. 
mySheet.LoadExcel({Mode:'HeaderMatch ',StartRow:'7',EndRow:'9' , 
WorkSheetNo: 1});
// Schedule an excel loading. Load the second spreadsheet of excel file to 
mySheet2. Load the fifth excel column values to the first IBSheet column, 
and load the first excel column values to the fifth IBSheet column.  
mySheet 2.LoadExcel({ColumnMapping:'5|4|3|2|1' , WorkSheetNo: 2}); 
// Bring up a file upload window to send all buffered excel and file loading 
to the server.  
mySheet. LoadExcelBuffer(false);
LoadExcelUrl Method  
 Purpose  
Check or configure the server page path to process excel upload.  
 Syntax  
Syntax  Get ObjId. GetLoadExcelUrl ()
 Info 
Return  String, set path value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check the excel upload path.  
var url = mySheet.GetLoadExcelUrl();
 Syntax  
Syntax  Set ObjId. SetLoadExcelUrl (Url) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Server page URL to set
 Example  
// Configure excel upload path.  
mySheet.SetLoadExcelUrl( "/jsp/LoadExcel.jsp "); 
LoadText Method  
 Purpose  
Read data from a text file and display them in the data area.
The parameters to send are in JSON type. Put configuration information into JSON format and 
send it to the server.  
Sample)  
var params = { Mode : "NoHeader ", Deli: "\t"} ; 
mySheet.Load Text(params);
If Append parameter is set as 1, you may append the current search result data to the existing 
data to run a search.  
Deli parameter sets a column separator for the data. The default value is " \t".
FileExt can be used to configure file extensions that can be uploaded. Extensions should be put 
without “.”, such as “txt”. The default value is “” and it has the same effect as “txt”. Multiple 
extensions should be separated with “|”. 
Mode parameter determines whether to match grid header title and excel header title when 
loading, and whether header is included in any excel file to load.
Mode value  Description  
HeaderMatch  Match text header titles with the grid header titles to 
load text columns in the matching order, even though 
columns are mixed in the text document.  
NoHeader  Text document does not have a header row above 
data rows, so keep the text column order when 
loading.  
HeaderSkip  Starting from the first row, the text document is 
presumed to have  as many header rows as the grid 
header row  count.  However,  those will be ignored  and 
instead the rest data rows will load sequentially. 
When IBSheet  has two header rows, load text 
document from the third row, which is presumably 
the start of data rows.  
 Syntax  
Syntax  ObjId. LoadText([parameters])
 Info 
Parameter  Type Required 
Y/N Description  
Mode  String Optional  Loading options (header 
matching, etc.)  
Default=“HeaderMatch”  
Deli String Optional  Data column separator.  
Default=" \t" 
Append  Boolean  Optional  Whether to append to the 
existing data  
Default=0  
FileExt  String Optional  File extensions that can be 
uploaded  
Default=""  
 Example  
// Load as text file  
mySheet. Load Text();
// Compare  the header titles to load the matching columns; column 
separator is' \t'. 
mySheet.Load Text({Mode:'HeaderMatch',  Deli:'\t'}); 
LoadTextUrl  Method  
 Purpose  
Check and configure server page path to process text file upload.
 Syntax  
Syntax  Get ObjId. GetLoadTextUrl () 
 Info 
Return  String, set path value (in case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
//Check the text upload path.  
var url = mySheet.GetLoadTextUrl();  
 Syntax  
Syntax  Set ObjId. SetLoadTextUrl (Url)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Server page URL to set  
 Example  
// Configure text upload path.  
mySheet.SetLoadTextUrl( "/jsp/LoadText.jsp ");
MergeSheet Method  
 Purpose  
Check or configure the overall merge types permitted.  
If 'Both' merge option is turned off, you cannot merge any cells. When 'Both' merge optioni is 
allowed, you can set to allow or disallow vertical or horizontal merge.  
※ Merged data will be divided by page size set in SetConfig. However, if merge a ction follows 
msPrevColumnMerge setting, you can display merged data based on previous column 
merge status by setting PrevColumnMergeMode:0 in SetConfig. This action may result in 
delay in performance if there are many merged rows, as it will display all m erged rows on 
the screen.  
This method performs the same function as MergeSheet in SetConfig method.  
Constant 
value Type Description  
0 msNone  No merge  
1 msAll Allow merge for all  
2 msPrevColumnMerge  Merge is allowed for rows where they 
are merged in the previous column.  
3 msFixedMerge  Merge fixed cells in unit data row 
structure  
5 msHeaderOnly  Allow merge in the header rows only  
7 msPrevColumnMerge + 
msHeaderOnly  Merge is allowed for rows where they 
are merged in the previous column as 
well as header rows. 
8 msFixedMerge + 
msHeaderOnlyl  Merge is allowed for fixed cells in unit 
data row structure and in header rows  
 Syntax  
Syntax  Get ObjId. GetMergeSheet ()
 Info 
Return  Integer, currently configured merge type (in case of Get 
Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check merge type  
mySheet. GetMergeSheet();
 Syntax  
Syntax  Set ObjId. SetMergeSheet (Merge)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Merge  Integer  Required  Merge types
 Example  
//Configure all merge types upon loading  
mySheet.SetMergeSheet( msHeaderOnly);  
MaximumValue Method  
 Purpose  
Check or configure the max value to allow during editing when the cell format is Integer, Float, 
NullInteger, NullFloat or other number related format.
When a cell with max value setting is edited with a value bigger than the set max value, a 
warning message will appear. (ibmsg file's SYS_MaximumBigValue)  
Min and max value configured as default are as follows:  
Format  Min value  Max value  
Integer  
NullInteger  -999999999999999  999999999999999  
Float 
NullFloat  -999999999999999 .00 999999999999999 .00
 Syntax  
Syntax  Get ObjId. GetMaximumValue (Row, Col)  
 Info 
Return  Long, set max value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
Row Long Required  Row index of the cell  
Col Long/  
String  Required  Column index or  
SaveName
 Example  
//Check the configured max value of number format.  
mySheet.GetMaximumValue(1, 12);  
 Syntax  
Syntax  Set ObjId. SetMaximumValue (Row, Col , Value )
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Row index of the cell  
Col Long/  
String  Required  Column index or  
SaveName  
Value Long Required  Max value to configure  
 Example  
//Set the max value of number format.  
mySheet.SetMaximumValue(1, 12, 5000);
MinimumValue  Method  
 Purpose  
Check or configure the min value to allow during editing when the cell format is Integer, Float, 
NullInteger, NullFloat or other number related format.  
When a cell with min value limit is edited with a value smaller than the set min value, a warning 
message will appear. (ibmsg file's SYS_MinimumBigValue)
Min and max value configured as default are as follows:  
Format  Min value  Max value  
Integer  
NullInteger  -999999999999999  999999999999999  
Float 
NullFloat  -999999999999999 .00 999999999999999 .00 
 Syntax  
Syntax  Get ObjId. GetMinimumValue (Row, Col)
 Info 
Return  Long, set min value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
Row Long Required  Row Index of the selected data  
Col Long/  
String  Required  Column Index of the selected data or  
SaveName  
 Example  
//Check the configured min value of number format.  
mySheet.GetMinimumValue(1, 12);
 Syntax  
Syntax  Set ObjId. SetMinimumValue (Row, Col, Value)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Row Index of the selected data  
Col Long/  
String  Required  Column Index of the selected data or  
SaveName  
Value Long Required  Min value to set
 Example  
//Set the min value of number format.  
mySheet.SetMinimumValue(1, 12, 1000);  
MouseCol  Method  
 Purpose  
Return the selected column index when mouse button is clicked. If the mouse is clicked on non 
data area, return -1.
 Syntax  
Syntax  ObjId. MouseCol () 
 Info 
Return  Long, column index of the mouse location  
Parameter  Type Required 
Y/N Description  
 N/A
 Example  
// Fetch the column index where mouse button is clicked.  
function mySheet_OnMouseDown(Button, Shift, X, Y) {  
    //Check the column of the clicked cell  
    alert(mySheet.MouseRow() + "Row" + mySheet.MouseCol() + "Column is 
clicked");  
} 
MousePointer  Method  
 Purpose  
Check or configure the mouse pointer style. Values available are as follows:  
Value Mouse pointer style  
Default  Basic arrow style  
Hand Finger style  
This property is different from DataLinkMouse property.
 Syntax  
Syntax  Get ObjId. GetMousePointer () 
 Info 
Return  String, mouse style configuration (In case of Get Method)  
Parameter  Type Required Description  
Y/N
 Example  
//Check the mouse pointer style.  
mySheet. GetMousePointer("Default");  
 Syntax  
Syntax  Set ObjId. SetMousePointer (Pointer)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Pointer  String  Required  Mouse pointer style to set  
 Example  
function mySheet_OnMouseMove(Button, Shift, X, Y) {  
//Change the mouse pointer style to finter only when the mouse location 
is Column 2.  
  if(mySheet.MouseCol() == 2) {  
    mySheet.SetMousePointer("Hand");  
  } else {  
    mySheet.SetMousePointer("Default");  
  } 
}
MouseRow  Method  
 Purpose  
Return the selected row index when mouse button is clicked. If the mouse is clicked on non data 
area, return -1. 
 Syntax  
Syntax  ObjId. MouseRow ()
 Info 
Return  Long, row index of the mouse location  
Parameter  Type Description  
N/A 
 Example  
// Fetch the row index where mouse button is clicked.  
function mySheet_OnMouseDown(Button, Shift, X, Y){  
 //Check the row of the clicked cell  
    alert(mySheet.MouseRow() + "row is clicked");  
}
MoveColumnFail  Method  
 Purpose  
This method is used within OnBeforeColumnMove event, and it commands whether column 
movement will fail. If you set this property as 1 within OnBeforeColumnMove event, column 
movement will fail and OnAfterColumnMove will not f ire. 
 Syntax  
Syntax  ObjId. MoveColumnFail (Flag)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Flag Boolean  Required  Whether column movement fails  
 Example  
Cancel column movement if column 0 is moved to a location past column 3.  
function mySheet_ OnBeforeColumnMove (Col, NewPos) {  
if(Col==0 && NewPos > 3) {  
mySheet.MoveColumnFail(1);  
}else{ 
mySheet.MoveColumnFail( 0); 
} 
}
MoveColumnPos  Method  
 Purpose  
Move a particular column to a new column location. If Event parameter value is set as 1,  
OnBeforeColumnMove event and OnAfterColumnMove event will fire, so you can use the column 
movement cancellation function within OnBeforeColumnMove event. If set 0, columns will be 
moved without events.  
 Syntax  
Syntax  ObjId. MoveColumnPos (Col, NewPos, [Even t])