ThachNguyen/ibsheet7-dataset huggingface dataset:
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
cfg json Optional  The parameters to send are in JSON 
type. Put configuration information 
into JSON format and send it to the 
server.  
  Details  
Parameter  Type Required 
Y/N Description  
FileName  String Optional  File name to save  
Default=”Excel.xls”  
SheetName  String Optional  Excel worksheet name, 
Default="Sheet"  
DownRows  String Optional  Connect rows to download 
using | Default=""(Download 
all) 
DownCols  String Optional  Connect columns to download 
using | Default=""(Download 
all) 
DownHeader  bool Optional  Whether to download header  
Default=1  
DownSum  bool Optional  Whether to download sums  
Default=1  
Merge  bool Optional  Whether to apply merge to 
download  
Default=0  
SheetDesign  bool Optional  Whether to apply IBSheet  
design concept to download 
file 
Default=0  
TitleText  String Optional  Default=""(Not use)  
UserMerge  String Optional  Default=""(Not use)  
OnlyHeaderMerge  bool Optional  Whether to merge the header 
only 
Default=0
 Example  
// Default setting  
cfg= { FileName: ”DownExcel.xls ”, Merge :1}; 
mySheet.Set Down2Excel Config(cfg);  
mySheet.Down2Excel();
SetEndEdit  Method  
 Purpose  
End cell editing. If you want to save edited contents before exiting edit mode, set Save  
parameter as 1 (true). If you want to cancel editing before saving, set the parameter as 0 (false).  
 Syntax  
Syntax  ObjId. SetEndEdit (Save)
 Info 
Return  Boolean, whether ending has been successfully done  
Parameter  Type Required 
Y/N Description  
Save Boolean  Required  Whether to save edited contents  
 Example  
// Method to process saving related logics  
var result = mySheet.SetEndEdit(1);
if (!result) {  
    return;  
} 
// Proceed with saving processing logics
SetFilterOption  Method  
 Purpose  
Use this method to configure column filtering options when filter rows are used  
 Syntax  
Syntax  ObjId. SetFilterOption (Col, Option)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Col Long Required  Column index or SaveName  
Option  Integer  Required  Option value to set  
 Option Value  
0 Do not use  
1 Equal 2 Not equal  
3 Smaller  4 equal or smaller  
5 Bigger  6 equal or bigger  
7 Start with word  8 Not start with word  
9 End with word  10 Not end with word  
11 Include  12 Not include
 Example  
// When filter row is Row 1, configure filtering value for column 2  
mySheet.SetCellValue(1, 2, “Include ”); 
// Configure filter option for filter row column 2  – Filter any words that are 
the same as string 'Include'  
mySheet.SetFilterOption (2, 1);
SetFilterValue Method  
 Purpose  
Use this method when setting filter value when filter row is used,  
 Syntax  
Syntax  ObjId. SetFilterValue (Col, Value, Option)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Col Long Required  Column index or SaveName  
Value String  Required  Value to set in filter  
Option  Integer  Optional  Option value to set  
 Option Value  
0 Do not use  
1 Equal 2 Not equal  
3 Smaller  4 equal or smaller  
5 Bigger  6 equal or bigger  
7 Start with word  8 Not start with word  
9 End with word  10 Not end with word  
11 Include  12 Not include
 Example  
// Filter strings that include "Seoul" in column 5  
mySheet.SetFilterValue(5, “Seoul”, 11); 
SetFindDialog  Method  
 Purpose  
Configure default setting for search dialogue using Ctrl+Shift+F  keys.
In FullMatch parameter, you can configure what types of items you may search. FindTextMethod 
is the same as FullMatch configuration. The available values are as follows:  
FullMatch value  Purpose  
-1 Find rows that are identical to SearchText  
0 Find rows that have matching opening with SearchText  
1 Find rows that have matching ending with SearchText  
2 Find rows that have matching center with SearchText  
 Syntax  
Syntax  ObjId. SetFindDialog (Show,[Col],[FullMatch],[FirstStart],[CaseSensitive], 
[KeepDialog])
 Info 
Return  None.  
Parameter  Type Required 
Y/N Description  
Show Boolean  Required  Whether to use Search dialogue  
Col Long/String  Optional  Index or SaveName of the search 
target columns  
If empty, all columns, Default=""  
FullMatch  Integer  Optional  Configure text match option, 
Default= -1 
FirstStart  Boolean  Optional  Configure start location, Default=1  
CaseSensitive  Boolean  Optional  Configure case sensitivity, Default=0  
KeepDialog  Boolean  Optional  Configure whether to close dialog 
after search,  
Default=0  
 Example  
//Use search dialog, target column: 5, start location: next row after the focus 
row, match option: center match)  
mySheet.SetFindDialog( 1, 5, 2, 0 );
SetFocus  Method  
 Purpose  
Configure focus on sheet  
 Syntax  
Syntax  ObjId. SetFocus ()
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
 N/A 
 Example  
// Configure focus on sheet.  
mySheet.SetFocus();
SetMergeCell  Method  
 Purpose  
Force merge on a particular cell with adjacent cells  
This method must be used for search screen.  
In general, cells can be automatically merged only when the value of the adjacent cell is identical 
to the merging cell. However, if you call this method, merge will be forced to a particular cell 
with all the cells within the set size ind iscriminately (even though cell values are different).
 Syntax  
Syntax  ObjId. SetMergeCell (Row, Col, Rows, Cols ) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Row Index of the cell to force merge  
Col Long Required  Column Index of the cell to force 
merge  
Rows Long Required  Row count of the cells to force merge  
Cols Long Required  Column count of the cells to force 
merge
 Example  
// Merge and display 2X2 window cells from (1, 10) to (2, 11).  
mySheet.SetMergeCell(1,  10, 2, 2);  
SetRowHaveChildValue  Method  
 Purpose  
In this method, you can change HaveChild property setting for a stree structure.
When HaveChild property is configured, lower node expansion icon is set depending on the 
configuration. Using this method,  you may change the HaveChild property value.  
 Syntax  
Syntax  ObjId. SetRowHaveChildValue (Row, HaveChild )
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Index of relevant rows  
HaveChild  Boolean  Required  Property setting  
 Example  
// Change HaveChild configuration of Row 3 to 0.  
mySheet.SetRowHaveChildValue(3, 0);
SheetWidth  Method  
 Purpose  
Check or configure the overall width. Set the value in pixel count.  
 Syntax  
Syntax  Get ObjId. GetSheetWidth ()
 Info 
Return  Integer,  width pixel counts (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
// Currently configured width value.  
alert(mySheet.GetSheetWidth());
 Syntax  
Syntax  Set ObjId. SetSheetWidth (Width)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Width  Integer  Required  Sheet width pixel count to set
 Example  
// Set the total width at 800 pixels  
mySheet.SetSheetWidth(800);  
Sheet Height  Method  
 Purpose  
Check or configure the total height. Set the value in pixel count.
 Syntax  
Syntax  Get ObjId. GetSheet Height () 
 Info 
Return  Integer, height pixel counts (in case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
// Check currently configured height value.  
alert(mySheet.GetSheet Height ()); 
 Syntax  
Syntax  Set ObjId. SetSheet Height (Height )
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Height  Integer  Required  Sheet height pixel count to set  
 Example  
// Set the total height at 800 pixels.  
mySheet.SetSheet Height (800);
ShowButtonImage  Method  
 Purpose  
Check or configure the button image styles of popup and combo.  
Upon initial loading, button image display style should be configured.  
Style setting to configure are as follows:  
Type Description  
0 Display combo, calendar and pop -up image only when is focused.  
1 Display calendar and popup image when the cell is editable.  
2 Always display calendar and pop -up image.  
3 Display combo, calendar and popup image when the cell is 
editable (Default)  
4 Always display combo, calendar and pop -up image
 Syntax  
Syntax  Get ObjId. GetShowButtonImage () 
 Info 
Return  Integer,current set value (in case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
// Check the displayed button image style of popup and combo.  
mySheet. GetShowButtonImage();  
 Syntax  
Syntax  Set ObjId. SetShowButtonImage (type)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
type Integer  Required  Set value (Default=3)  
 Example  
// Combo and popup image will display only when focus is placed.  
mySheet.SetShowButtonImage(0);
// Popup image displays when cells are editable.  
mySheet.SetShowButtonImage(1);  
// Popup images are always displayed.  
mySheet.SetShowButtonImage(2);
// Combo and popup images are displayed when cells are editable.  
mySheet.SetShowButtonImage(3);
// Combo and popup images are always displayed.  
mySheet.SetShowButtonImage(4);  
ShowCalendar  Method  
 Purpose  
When date format is set in Text type column, calendar popup will display upon clicking on the 
column if you run ShowCalendar() in OnClick event.
If you want to enter data of  '0000 -00-00' or '2013 -00-00' format in date data type, you may use 
OnClick or OnPopupClick when CustomDate parameter is set as 1 for Text, Popup or PopupEdit 
columns.   
When you use CustomDate, you need to define user custom format. You may choose from Year -
month-date(#### -##-##, ####/##/## etc.), Year -month (#### -##, ####/## etc.), or Month -date 
(##-##, ##/## etc.) types.  
The format will be determined by the number ouf #: Year -month -date (8), Year -month(6) or 
Month -date (4).  
Only 4 digit format is supported for  year format, and the display order should be year -month -
date. 
If there is a date data value, the date value displays as selected, If there is no data or if the data 
is not in date format, today's date displays as selected.
 Syntax  
Syntax  ObjId.  ShowCalen dar() 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A
 Example  
// Display calendar pop -up when text -type column is clicked  
function mySheet_OnClick(Row, Col) {  
 mySheet.ShowCalendar();  
} 
// Display calendar popup when OnPopup button is clicked in Popup or 
PopupEdit column  
function mySheet_OnPopupClick(Row,Col) {  
 mySheet.ShowCalendar();  
}
ShowDebugMsg Method  
 Purpose  
Check or configure whether to display debugging message  
If you set to display debugging message, debugging message will  display as a system popup 
message. If you set not to display the message, OnDebugMsg event fires so that the user can 
check the message as an event parameter.  
Setting options are as follows:  
Type Description  
-1 Start system popup debugging  
0 End all debugging  
 Syntax  
Syntax  ObjId. ShowDebugMsg (Msg)
 Info 
Return  Boolean, 디버깅용  메시지  표시 여부  
Parameter  Type Required 
Y/N Description  
Msg Integer  Required  Whether to display debugging message  
Default=0.  
 Example  
//Show debugging message for saving process as a pop -up 
mySheet.ShowDebugMsg( -1);
//Search  
mySheet.DoSearch( “list.xml ”); 
ShowColumnPopup Method  
 Purpose  
This method is used to force open a pop -up in a column when column pop -up function is 
configured using InitColumns method.  
When MousePos is set as 1, the popup will display at (X, Y) coordinates where the mouse was 
clicked for the last time. If MousePos is set as 0, popup will display below the (Row, Col) cell 
location.
 Syntax  
Syntax  ObjId. ShowColumnPopup (Row, Col, [MousePos ]) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Row Index of the cell to select  
Col Long / 
String  Required  Column Index of the selected cell  
or SaveName  
MousePos  Boolean  Optional  Whether to use the last mouse location  
Default=1 (Use the last location)
 Example  
//Open a popup at the current cell location  
mySheet.ShowColumnPopup(1, 4, 0)  
//Open a popup at the last mouse click location  
mySheet.ShowColumnPopup(1, 4,1)
ShowFilterRow  Method  
 Purpose  
Add filter row as a frozen row at the top of IBSheet  
Using this method will allow you to use filtering for column data.  
You need to call this method after initialization before search processing.  
 Syntax  
Syntax  ObjId. ShowFilterRow ()
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A 
 Example  
//Add a filter row  
mySheet.Show FilterRow();
ShowFindDialog  Method  
 Purpose  
Display search dialog when the user presses Ctrl + Shift + F on IBSheet.  
 Syntax  
Syntax  ObjId. ShowFindDialog ()
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A 
 Example  
//Display search dialog.  
mySheet.ShowFindDialog();
ShowGroupRow  Method  
 Purpose  
Add a group row at the top of IBSheet  header.  
This method will create a group row at the top of header where columns can be dragged and 
dropped. By dragging and dropping columns to group, you can group data based on the column.  
You need to call this method after initialization before search processing.
 Syntax  
Syntax  ObjId. ShowGroupRow ([Cols]) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Cols Long/  
String  Optional  String of column index or SaveName to 
group, adjoined by “|”
 Example  
//Add a group row  
mySheet.Show GroupRow();  
//Add a group row for column index 1 and 3  
mySheet.ShowGroupRow( “1|3”);
//Add a group row for column SaveName sName and sDept  
mySheet.ShowGroupRow( “sName|sDept ”); 
ShowMsgMode  Method  
 Purpose  
Configure whether to use system pop -up or event for various IBSheet messages.
If this property value is  1, all messages will be system popup. If 0, OnMessage event will fire. If 
you need to apply a design concept to message dialog or adjust buttons, set this property as 0, 
and use OnMessage event and ConfirmOK method together.  
 Syntax  
Syntax  Get ObjId. GetShowMsgMode ()
 Info 
Return  Boolean,current set value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check the message mode.  
mySheet. GetShowMsgMode();
 Syntax  
Syntax  Set ObjId. SetShowMsgMode (Mode)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Mode  Boolean  Required  Whether to display message
 Example  
//Configure the message mode.  
mySheet.SetShowMsgMode(0);  
//Process OnMessage event.  
function mySheet_OnMessage(Msg, Level, IsConfirm) {  
//Display message  
    var win_result = window.showModalDialog(  
 “sheet_message.jsp?Msg=” + Msg + “&IsConfirm=” + IsConfirm,  
        ‘modalResult’,  
        ‘dialogWidth:200px;dialogHeight:200px;center:yes;help:no;status:no;’);  
    //Return the message result to the sheet.  
    if(IsConfirm) mySheet.ConfirmOK( win_result);  
}
ShowProcessDlg  Method  
 Purpose  
Display waiting image at the center of IBSheet.  
Depending on the parameters, you may display waiting image for search, saving , download or 
upload. Each waiting image will be the image configured in methods.  
To close display image, use HideProcessDlg method.  
Available images based on parameters are as follows:  
Type Image type  Method (Configuration/check)  
Search  Search waiting image  SearchingImage  
Save Saving waiting image  SavingImage  
Download  Download waiting image  DownloadingImage  
Upload  Upload waiting image  UploadingImage
 Syntax  
Syntax  ObjId. ShowProcessDlg (Type) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Type String  Optional  Type of waiting image 
(Default:"Search")
 Example  
// Display waiting image for saving.  
mySheet.ShowProcessDlg( "Search "); 
ShowSortArrow  Method  
 Purpose  
Check or configure whether to display sorting direction using an arrow when sorting by clicking 
is allowed on the header.
 Syntax  
Syntax  Get ObjId. GetShowSortArrow () 
 Info 
Return  Boolean, whether to display arrow image (in case of Get 
Method)  
Parameter  Type Required 
Y/N Description
 Example  
// Check the setting whether sorting direction is displayed.  
alert(mySheet.GetShowSortArrow());  
 Syntax  
Syntax  Set ObjId. SetShowSortArrow (Arrow)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Arrow  Boolean  Required  Whether arrow is displayed  
 Example  
// Display sorting  direction.  
mySheet.SetShowSortArrow(1);
ShowSubSum  Method  
 Purpose  
Calculate sub sums and total sum for a column.  
This method should be called before data search method is called. When configuration is 
changed, you need to rerun a data search to apply it. 
SumCols is a string of column indexes where sub sum and total sum should be calculated, 
adjoined by“|”.
If ShowCumulate is set as 1, sub sums are displayed and aggregate total of all sub sums are 
displayed in the row below. If set as 0, only sub sums  are calculated and displayed.   
Total sum is calculated as follows: The first aggregate total  is the same as the first sub sum. The 
second aggregate total  is the sum of the first and second sub sums. The last aggregate total  is 
sum of all previous sub sums.  Aggregate total  is displayed only when sub sums are calculated.  
AvgCols parameter is a string of column indexes that average should be calculated, adjoined by 
“|”.
CaptionText parameter can be used when you want to cha nge different format for sub sum 
caption text.  
If this parameter is not set, it is set as “Sub sum : “ + reference value.  
When sub sum ( aggregate total ) is displayed, “%s” is used. You can use “%col” to set the format 
for reference value.  
For example, if you set the format as “%s = %col ”, sub sum row will display sub sum = reference 
value, and the aggregate total  row will display aggregate total  = reference value. For example  
Sub sum rows will display “Sub sum : “ + reference value in the first column, and aggregate total  
rows will display “ Aggregate total  : “ + reference value.
Set the parameter values in JSON format.  
Sample) var info = {StdCol:2, SumCols:”2|3|4”, ShowCumulate:1, AvgCols:”5|6”};  
 Syntax  
Syntax  ObjId. ShowSubSum (info)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
StdCol  Long/String  Required  Reference column index or 
SaveName  
SumCols  String  Required  String of column indexes where 
sub sum should be calculated, 
adjoined by“|”.  
Sort Boolean  Optional  Whether the reference column is 
sorted. To display sub sum, 
values in reference column must 
have been sorted.  
Default= 1 
ShowCumulate  Boolean  Optional  Whether to display aggregate 
total of sub sums  
Default=0  
CaptionCol  Long Optional  Column to set sub sum caption 
text as “Sub sum : “ + reference 
value 
Default=The first unhidden 
column  
CaptionText  String  Optional  Set sub sum caption text format  
Default=sub sum (aggregate 
total): + reference value  
AvgCols  String  Optional  String of column indexes where 
average should be calculated, 
adjoined by“|”. Default=””  
 Example  
//Calculate and display sub sums for Column 1 (volume)  
var info = [ 
{StdCol:1, SumCols:”2|3|4|5|6|7”,  Sort:1}  
]; 
mySheet.ShowSubSum(info);
// Display aggregate total as well  
var info =  [ 
 {StdCol:1, SumCols:”2|3|4|5|6|7”, ShowCumulate:1,  Sort:1}  
]; 
mySheet.ShowSubSum(info);  
ShowToolTip  Method  
 Purpose  
Configure to show tooltip  for all data cell.  
You may set the same effect using ToolTip parameter of initialization method SetConfig.  
You need to call this method after initialization before search processing.
 Syntax  
Syntax  ObjId. ShowToolTip (ToolTip ) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
ToolTip  Boolean  Required  Whether to display tooltips
 Example  
//Configure  to show tooltip  
mySheet.ShowToolTip(1);  
ShowTreeSubSum  Method  
 Purpose  
In stree structure, calculate and display sub sum in a particular column  
This method should be called before data search method is called. When configuration is 
changed, you need to  rerun a data search to apply it.
SumCols is a string of column indexes or SaveNames where sub sum should be calculated, 
adjoined by“|”.  
AvgCols is a string of column indexes or SaveNames where average should be calculated, 
adjoined by“|”.
CountCols is a string of column indexes or SaveNames where counting should be done, adjoined 
by“|”. 
Set the parameter values in JSON format.  
Sample) var info = {SumCols:”2|3|4”, AvgCols:”5|6”, SumEx:1};
 Syntax  
Syntax  ObjId. ShowTreeSubSum (Info) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
SumCols  String  Optional  String of column indexes or 
SaveNames where aggregate total 
should be calculated, adjoined by “|”. 
Default= ”” 
AvgCols  String  Optional  String of column indexes or 
SaveNames where average should 
be calculated, adjoined by“|”. 
Default=””  
CountCols  String  Optional  String of column indexes or 
SaveNames where counting should 
be done, adjoined by “|”. Default= ”” 
SumEx  Boolean  Optional  Whether to include rows with status 
Deleted in calculation. Default=0  
ExceptNull  Boolean  Optional  Whether to includ Null values to 
averaging Default=0
 Example  
//Display tree sub sums for the 2nd column  
var info = SumCols:”2} ; 
mySheet.Show TreeSubSum(info);  
// Exclude deleted rows from calculation  
var info = {SumCols:”2 , SumEx:1 }; 
mySheet. Show TreeSubSum (info);
SubSumBackColor Method  
 Purpose  
Check or configure background color of sub sum row.  
 Syntax  
Syntax  Get ObjId. GetSubSumBackColor ()
 Info 
Return  String, currently set value (In case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check background color of sub sum row.  
mySheet. GetSubSumBackColor ();
 Syntax  
Syntax  Set ObjId. SetSubSumBackColor (Color)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Color String  Required  WebColor value to set
 Example  
//Set background color of sub sum row as green.  
mySheet.SetSubSumBackColor(“#00FF00”);  
ShowSum Method  
 Purpose  
When aggregate total  is not calculated due to performance issue, this method can be used to 
calculate sum of AutoSum columns to display once, or perform recalculation.  
It may be faster to call ShowSum() after search without calculating the sum, rather than 
calculating sum fro m the start.  
You can call ShowSum multiple times to recalculate the sum.  
Sums will be calculated (recalculated) only when SetRedrawSum is 1. If it is 0, sums will not be 
calculated (recalculated) even though this method is called.
 Syntax  
Syntax  ObjId. ShowSum () 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A
 Example  
mySheet.ShowSum();  
ShowTreeLevel  Method  
 Purpose  
Configure the tree levels to display when data is tree type.  
Available options are as follows:  
Level  Description  
0 Collapse all tree  
-1 Expand all, Default  
Others  Expand to that level
In ChildStatus, you can configure child status below the tree level to expand.  
In ChildStatus, you can configure the following values:  
ChildStatus   Description  
0 Maintain the previous state, Default  
1 Collapse all  
2 Expand all  
 Syntax  
Syntax  ObjId. ShowTreeLevel ([Level], [ChildStatus])
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Level Integer  Optional  Tree level to show Default= -1 
ChildStatus  Integer  Optional  Configure expansion status of the levels 
below the tree level to expand. 
Default=0  
 Example  
//Collapse all  
mySheet.ShowTreeLevel(0, 1);
//Expand all  
mySheet.ShowTreeLevel( -1); 
SumBackColor  Method  
 Purpose  
Check or configure background color of sum row.  
Select the color using WebColor.
 Syntax  
Syntax  Get ObjId. GetSumBackColor () 
 Info 
Return  String, WebColor value (In case of Get Method)  
Parameter  Type Required Y/N  Description
 Example  
//Check background color of sum row  
mySheet.GetSumBackColor();  
 Syntax  
Syntax  Set ObjId. SetSumBackColor (Color)
 Info 
Return  None 
Parameter  Type Required Y/N  Description  
Color String  Required  WebColor value  
 Example  
//Set background color of sum row as green.  
mySheet.Set SumBackColor(“#00FF00”);
SumFontBold  Method  
 Purpose  
Check or configure whether to bolden font in sum row.  
If this property is set as 1, sum row font is boldened. If 0, they will remain as general font. If sum 
row font is boldened, the downside is that they do not align well with other data. The default 
setting is 0.  
 Syntax  
Syntax  Get ObjId. GetSumFontBold ()
 Info 
Return  Boolean, bold status of the current font (In case of Get Method)  
Parameter  Type Required Y/N  Description  
 Example  
//Check font bold status of sum row.  
mySheet.GetSumFontBold();
 Syntax  
Syntax  Set ObjId. SetSumFontBold (Bold)  
 Info 
Return  None 
Parameter  Type Required Y/N  Description  
Bold Boolean  Required  Font bold status
 Example  
//Bolden the font in sum row.  
mySheet.Set SumFontBold(1);  
SumFontColor  Method  
 Purpose  
Check or configure font color of sum row.  
Select the color using WebColor.
 Syntax  
Syntax  Get ObjId. GetSumFontColor () 
 Info 
Return  String, current font color of sum row (in case of Get Method)  
Parameter  Type Required Y/N  Description
 Example  
//Check for font color of sum row  
mySheet.GetSumFontColor();  
 Syntax  
Syntax  Set ObjId. SetSumFontColor (Color)
 Info 
Return  None 
Parameter  Type Required Y/N  Description  
Color String  Required  WebColor value  
 Example  
//Set the font color of sum row as green.  
mySheet.Set SumFontColor(“ #00FF00”);
SumRowHidden Method  
 Purpose  
Check or configure hiding status of sum row.  
 Syntax  
Syntax  Get ObjId. GetSumRowHidden ()
 Info 
Return  Boolean, hiding setting value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check hiding status of sum row and unhide if hidden.  
if(mySheet.Get SumRowHidden () == 1) { 
mySheet. SetSumRowHidden (0); 
}
 Syntax  
Syntax  Set ObjId. SetSumRowHidden (Hidden)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Hidden  Boolean  Required  Hidden or not
 Example  
//Check hiding status of sum row and unhide if hidden.  
if(mySheet.Get SumRowHidden () == 1) { 
mySheet. SetSumRowHidden (0); 
} 
SumValue  Method  
 Purpose  
Check  or configure sum cell values without formatting.
 Syntax  
Syntax  Get ObjId. GetSumValue (Col) 
 Info 
Return  String, value of the sum cell (in case of Get Method)  
Parameter  Type Required Description  
Y/N 
Col Long / String  Required  Column index of sum cell  
or SaveName
 Example  
//Read value of column 2 in the first sum row. If the value is 1,234.56,  
//1234.56 will be returned.  
alert(“The sum is “ + mySheet.GetSumValue(2) + “.”);  
 Syntax  
Syntax  Set ObjId. SetSumValue (Col,Value)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Col Long / String  Required  Column index of sum cell  
or SaveName  
Value Long Required  CellValue without formatting  
 Example  
//Change the value of column 2 in the sum row to 5432.12  
mySheet.SetSumValue(2,5432.12);
Theme  Method  
 Purpose  
Check or configure theme design of IBSheet.  
To set a theme, you need a defined theme design. (See Appendix 3. Creating a Theme at the end 
of this document for more details)  
 Syntax  
Syntax  Get ObjId. GetTheme ()
 Info 
Return  String, prefix of  the current theme (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check the currently set theme  
var Prefix = mySheet.GetTheme();
 Syntax  
Syntax  Set ObjId. SetTheme (Prefix, Folder ) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Prefix String  Required  Prefix of the theme  
Folder  String  Required  Theme folder name
 Example  
//Apply Gray theme.  
mySheet.SetTheme( “GG”, “Gray”); 
ToolTipText  Method  
 Purpose  
Check or configure cell tooltip . 
You can check or configure tooltips for each cell in header or data row. Hover help appears when 
mouse hovers over the cell.
 Syntax  
Syntax  Get ObjId. GetToolTipText (Row, Col)  
 Info 
Return  String, currently set 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 of the cell  
or SaveName
 Example  
//Check tooltip configuration  
alert(mySheet.GetToolTipText(1, 1));  
 Syntax  
Syntax  Set ObjId. SetToolTipText (Row, Col, ToolTip)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Row index of the cell  
Col Long / 
String  Required  Column index of the cell  
or SaveName  
ToolTip  String  Required  Tooltip configuration  
 Example  
//Set to display tooltip for a cell  
mySheet.SetToolTipText(1,1, “The cell amount is “ + mySheet.GetCellText(1,1) 
+ “. “);
TopRow  Method  
 Purpose  
Check or configure the topmost row index.  
The row set in this method is the topmost row of the data area, except for the header area. The 
row set in this method does not become selected.  
Even though a wrong row index is used, the closest row will be used as the topmost row without 
an error messag e. This only works when there are enough number of rows to display below the 
topmost row.  
For example, let's assume that the total row count is 103 and 20 rows display in one page. Even 
though you set the TopRow property as 100, at least 18 rows should dis play, so TopRow will be 
changed to 85. The number of rows to display in the display area is deducted first, and then the 
TopRow is determined.  
 Syntax  
Syntax  Get ObjId. GetTopRow ()
 Info 
Return  Long, the topmost row index (In case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check for the topmost row index  
mySheet.GetTopRow();
 Syntax  
Syntax  Set ObjId. SetTopRow (Row) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Row Index
 Example  
//Configure the  topmost row index  
mySheet.SetTopRow(100);  
TotalRows  Method  
 Purpose  
Check or configure the DB record count to search depending on the search parameters.
 Syntax  
Syntax  Get ObjId. GetTotalRows () 
 Info 
Return  String, currently set value (In case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
Check the total data count.  
alert(“Total data count is “ + mySheet.GetTotalRows() + “. “);  
 Syntax  
Syntax  Set ObjId. SetTotalRows (Count)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Count  Long Required  Total count configuration  
 Example  
//Set the total data count as 1000.  
mySheet.SetTotalRows(1000);
TreeActionMode  Method  
 Purpose  
Check or configure various properties related to functional processes in tree structure.  
Property options are as follows:  
Value Purpose  
0 Do not allow deletion if there is child level.  
If the parent is deleted, deletion cannot be reversed. (Default)  
1 If deletion is checked for a parent, child will be also deleted.
 Syntax  
Syntax  Get ObjId. GetTreeActionMode () 
 Info 
Return  Integer, set value (In case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
//Check the currently set TreeActionMode value.  
alert(mySheet.GetTreeActionMode());  
 Syntax  
Syntax  Set ObjId. SetTreeActionMode (Value)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Value Integer  Required  TreeActionMode value  
 Example  
//Delete child levels when delete is checked for a parent row.  
mySheet.SetTreeActionMode(1);
UnicodeByte Method  
 Purpose  
Check or configure bytes of Asian charaters.  
In Java script, all characters are recognized as 1 byte.  
However, depending on the DB language configurations, Korean, Japanese or Chinese letter may  
need to be recognized as 2 byte or larger.  
In this case, you may adjust byte count using this method.  
 Syntax  
Syntax  Get ObjId. GetUnicodeByte ()
 Info 
Return  Integer,current set value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
// Check for the currently set byte  
mySheet.  GetUnicodeByte ();
 Syntax  
Syntax  Set ObjId. SetUnicodeByte (byte) 
 Info 
Return  None 
Parameter  Type Required Description  
Y/N 
byte Integer  Required  Byte to set (Default=1)
 Example  
//Change the byte count for one Asian character to 3.  
mySheet.  SetUnicodeByte (3); 
UseDefaultTime  Method  
 Purpose  
When a cell format is "Hms" or "Hm", the current system time will display when the cell value is 
null and editing starts. When this property is set as 0, the cell will display nothing instead of 
current system time. The default value of this property is 1.
 Syntax  
Syntax  Get ObjId. GetUseDefaultTime () 
 Info 
Return  Boolean,current set value (in case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
//Check the current time display setting  
myShe et.GetUseDefaultTime( ); 
 Syntax  
Syntax  Set ObjId. SetUseDefaultTime (Value)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Value Boolean  Required  Whether to display current time 
(Default=1)  
 Example  
//Set not to display the current time  
mySheet.SetUseDefaultTime(0);
UserAgent  Method  
 Purpose  
Check or configure the IBUserAgent value which is sent to the server as part of header 
information during search or saving.  
 Syntax  
Syntax  Get ObjId. GetUserAgent ()
 Info 
Return  String, currently set value (In case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
// Check the IBUserAgent value.  
mySheet. GetUserAgent( );
 Syntax  
Syntax  Set ObjId. SetUserAgent (Value)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Value String  Required  User-Agent configuration
 Example  
// Send the IBUserAgent value in HTTP header information as My Agent 
Name  
mySheet.SetUserAgent( “My Agent Name ”); 
UploadingImage  Method  
 Purpose  
Check or configure the waiting image file path for file upload.  
This method can be used to customize waiting image as the user want which displays during file 
upload.
 Syntax  
Syntax  Get ObjId. GetUploadingImage () 
 Info 
Return  String, currently set value (In case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
//Check the currently set image path of the upload waiting image.  
alert(mySheet.GetUploadingImage());  
 Syntax  
Syntax  Set ObjId. SetUploadingImage (Url)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Image URL  
 Example  
//Change the upload waiting image.  
mySheet.SetUploadingImage( “/sheet/img Upload .gif”);
ValidateFail  Method  
 Purpose  
If you want to stop saving as an invalid data piece is found during pre -saving data validation 
using OnValidation event, use this method to abort saving.  
 Syntax  
Syntax  ObjId. ValidateFail (Flag)
 Info 
Return  None 
Parameter  Type Required Description  
Y/N 
Flag Boolean  Required  Whether to abort saving  
 Example  
function mySheet_OnValidation(Row, Col, Value) {  
if(Col == 2)    {  
if(Value=="Korean won" && mySheet.GetCellValue(Row,Col+1) >= 
10000000) {  
alert("When the currency is Korean won, the amount cannot exceed 
ten million Korean won."); “);  
mySheet.ValidateFail(1);  
mySheet.SetSelectCell(Row, Col+1);  
} else if(Value=="Foreign currency" && mySheet.GetCellValue(Row,Col+1) 
< 10000000) {  
alert("When the currency is a foreign one, the amount must be ten 
million or greater."); “);  
mySheet.ValidateFail(1);  
mySheet.SetSelectCell(Row, Col+1);  
} 
} 
}
Visible Method  
 Purpose  
Check or configure whether to display IBSheet.  
When this property is set as 0, everything including count information will be hidden. When set 
as 1, all information will become visible.  
 Syntax  
Syntax  Get ObjId. GetVisible ()
 Info 
Return  Boolean,current set value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
// Check whether to display IBSheet  
if(mySheet.GetVisible()){  
    alert(“Display IBSheet”);  
}else{ 
alert(“IBSheet is hidden”);  
}
 Syntax  
Syntax  Set ObjId. SetVisible (Visible)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Visible  Boolean  Required  Whether to display sheet on the 
screen
 Example  
// Hide IBSheet  
mySheet.SetVisible(0);  
WaitImage Method  
 Purpose  
Check or configure waiting image file path.  
This method can be used to customize waiting image as the user want which displays during 
processing. Waiting image for processing includes both the search waiting image and save 
waiting image.
 Syntax  
Syntax  Get ObjId. GetWaitImage () 
 Info 
Return  String, currently set URL (In case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
//Check the processing waiting image path.  
mySheet. GetWaitImage( ); 
 Syntax  
Syntax  Set ObjId. SetWaitImage (Url)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Image URL  
 Example  
//Change waiting image for processing.  
mySheet.SetWaitImage(“/sheet/imgWait.gif”);
WaitImageVisible Method  
 Purpose  
Check or configure whether to display waiting image during processing.  
When a search or saving method is called where the end user waiting time is required, waiting 
image displays as default.  
If you do not want to use the waiting image for any reason, set this property as 0 to remove 
waiting image.  
Dependin g on the property setting, waiting images may or may not display for different 
processing.  
 Syntax  
Syntax  Get ObjId. GetWaitImageVisible ()
 Info 
Return  Boolean,current set value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check whether to display waiting image for processing.  
alert(mySheet.GetWaitImageVisible());
 Syntax  
Syntax  Set ObjId. SetWaitImageVisible (Visible)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Visible  Boolean  Required  Whether to display various waiting 
images
 Example  
//Set not to display waiting image for processing.  
mySheet.SetWaitImageVisible(0);  
WaitTimeOut  Method  
 Purpose  
Check or configure timeout for server response. (Unit: second)
 Syntax  
Syntax  Get ObjId. GetWaitTimeOut () 
 Info 
Return  Integer,current set value (in case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
// Check for the current timeout for server response  
alert(mySheet. GetWaitTimeOut ()); 
 Syntax  
Syntax  Set ObjId. SetWaitTimeOut (time)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
time Integer  Required  Timeout to set in seconds 
(Default=60)  
 Example  
// Check or configure timeout for server response  
mySheet. SetWaitTimeOut(120 );
Chapter 10. IBSheet  Global Function  
10.  IBSheet Global Function  
10.1 Use Global Function  
To use Global functions supported by IBSheet, you must include ibsheet.js file within the corresonding 
page.
IBSheet offers the following global functions:  
10.2 Function  List
IBCalendarSetTheme  Method  
 Purpose  
Set a theme design for calendar pop -up to use for external control.  
To set a theme, you need a defined theme design.  
(See Appendix  3. Creating a Theme at the end of this document for more details)  
 Syntax  
Syntax  IBCalendarSetTheme (Prefix, Folder );
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Prefix String  Required  Prefix of the theme  
Folder  String  Required  Theme folder name  
 Example  
//Apply Gray theme.  
IBCalendarSetTheme (“GG”, “Gray”);
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 Cal lBackParam. Object set in 
CallBackParam will be sent as the second parameter of CallBack method.  
 Syntax  
Syntax  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  
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
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  
CallBack  String  Function Name  
Method name to use upon return  
CallBackParam  Object  Parameter object to receive from CallBack 
method  
Format  String  Date format pattern (Default= “yyyy/MM/dd ”) 
Holiday  String  Set custom holidays to show on calendar  
You can set custom holidays using a string of 
values connected with a pipe operator. The 
date format should be yyyyMMdd format.  
Use asterisk (*) for recurring holidays on a 
monthly or yearly basis.  
Sample)   
Holiday : "20120725|*0703|2012*27|**17"  
*0703 : July 3th, every year 매년 7월 3일 
2012*27 : 27th of each month for the year 
2012 
**17 : 17th of every month, every year  
Result  Object  Object where to include selected values (Input 
object)  
Target  String, 
Object  “Mouse” (When last mouse location is used, 
Default)    
or calendar button Object (when calendar 
button location is used)  
X Integer  (When coordinate values are used), X 
coordinate  
Y Integer  (When coordinate values are used), Y 
coordinate
 Example  
// Enter date data value  
var val = document.getElementById(“DateText”).value ; 
// Calendar pop -up dialog location: When X and Y coordinates are used  
var obj = {  Format:” yyyy/MM/dd ”, X:300,  Y:600,  CallBack:” Test” };
// Calendar pop -up dialog location: When last mouse location is used  
var obj = {  Format:” yyyy/MM/dd ”, Target:”Mouse” , CallBack:  “Test” }; 
// Calendar pop -up dialog location: When calendar button location is used  
var obj = {  Target:document.getElementById(“DateBtn” ), CallBack:  “Test” };
// CalButtons property: when closing calendar button option setting is used  
var obj = { Format:” Ymd”, Target:document.getElementById(“DateBtn”) , 
CallBack: “ Test” , CalButtons : “Close”}; 
// Alignment setting when closing calendar button option setting is use d: 
Align left  
var obj = { Format:” Ymd”, Target:document.getElementById(“DateBtn”) , 
CallBack: “ Test”, CalButtons : “Close”, CalButtonAlign : “Left” };
// Custom holiday setting   
var obj = { Format:” Ymd”, Target:document.getElementById(“DateBtn”) , 
CallBack:  “Test”, Holiday:  " 20101215|*1203 "}; 
// 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;  
}
IBCloseCalendar Method   
 Purpose  
Set to close calendar pop -up used by external control.  
 Syntax  
Syntax  IBCloseCalendar ();
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A 
// Open calendar pop -up. 
IBShowCalendar( “20121116 ”, {Format:” yyyy/MM/dd ”, X:300,  Y:600});
// Close calendar pop -up dialog.  
IBCloseCalendar();  
Appendix   
1. Configurable properties by column type  
In InitColumns method, you can configure the following properties for each type as in the table 
below:  
1.1. Text format type
3.  Creating a theme  
In IBSheet, a design theme is composed of image files and ibsheet.css file within the "Main" folder where 
ibsheet.js file is located.  
To create a new design theme or update an existing theme, go through the following steps:
1. Copy the Main folder and save it in another name. (Let's assume that we copied the folder and 
saved in "DeepBlue" folder.)  
2. Change the various butto n images within the folder to suit the theme of the current development 
project.  
3. See ibsheet.css file for sheet color. When you open the file, you can see that all css class names 
start with .GM. You must replace this name with another to use. (Let's assum e that we 
replaced .GM with .DB.)  
4. As the last step, you can apply the new theme as follows in IBSheet initialization statement.  
mySheet.SetTheme("DB","DeepBlue");  
4. Apply Merge setting to excel download  
  DownCols  
Same column setting as in 
the screen  Different column setting 
from the screen  
Use DownRows  X X 
Not use DownRows  ○ △ 
X  : Do not apply merge setting to excel file  
△ : Merge is applied, but not necessarily the same way as the merging on the screen  
○ : Merge is applied the same way as it displays  on the screen
1. When merge is not applied  
  - When you use DownRows, merge will not apply to excel file even when Merge is set as 1.  
2. When the excel file cells are merged the same way as the screen  
  - Download columns as they appear on the screen
3. When merge is applied, but not necessarily the same way as the merging on the screen  
  - Columns that appear on the screen may be different from the columns downloaded.