ThachNguyen/ibsheet7-dataset huggingface dataset:
 Info 
Return  String, current aggregate color value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check background color of aggregate row.  
mySheet.GetCumulate BackColor();
 Syntax  
Syntax  Set ObjId. SetCumulateBackColor (Color)  
 Info 
Return  String, current aggregate color value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
Color String  Required  WebColor value
 Example  
//Set background color of aggregate row as green.  
mySheet.SetCumulate BackColor ("#00FF00 "); 
Data2Clipboard  Method  
 Purpose  
Copy all the data on IBSheet  to ClipBoard. Calling this function will copy all data including the 
header, data area and sums. Columns will be separated with a tab and rows with new line in 
ClipBoard.
This function can be used only on Inter net Explorer because of ClipBoard security 
restrictions.  
 Syntax  
Syntax  ObjId. Data2Clipboard ()
 Info 
Return  String, string copied in ClibBoard  
Parameter  Type Required 
Y/N Description  
N/A 
 Example  
//Copy to ClibBoard.  
mySheet.Data2Clipboard();
DataAlternateBackColor  Method  
 Purpose  
Check or configure  default background color of even -number data rows.  
Use this to set different colors for even and odd -number data rows. Background color of data 
rows will be determined by this and DataBackColor funct ion. 
Select the color using WebColor.  
 Syntax  
Syntax  Get ObjId. GetDataAlternateBackColor ()
 Info 
Return  String, current even number row color value (in case of Get 
Method)  
Parameter  Type Required 
Y/N Description  
 Example  
// Check the current color value. 
var color = mySheet.GetDataAlternateBackColor(1,1);  
alert("Color value of the even number rows is " + color + ".");
 Syntax  
Syntax  Set ObjId. SetDataAlternateBackColor (Color)  
 Info 
Return  None 
Parameter  Type Required Description  
Y/N 
Color String  Required  Color value to set
 Example  
//Change the background color of the even number rows to red  
mySheet.SetDataAlternateBackColor("#FF0000");       // WebColor  
DataAutoTrim  Method  
 Purpose  
Check or configure whether to trim space in data for search or save.  
In default, spaces leading or trailing the data will be trimmed in search or save; if this attribute is 
set as 0, the empty spaces in data will be returned in search and saved. This setting will apply 
not just for search or save but to all attribu te such as CellValue. In default, data space trimming 
is set.
 Syntax  
Syntax  Get ObjId. GetDataAutoTrim () 
 Info 
Return  Boolean, data space trim setting value (in case of Get 
Method)   
Parameter  Type Required 
Y/N Description
 Example  
//Check automatic trim setting  
mySheet.GetDataAutoTrim();  
 Syntax  
Syntax  Set ObjId. SetDataAutoTrim (Trim)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Trim Boolean  Required  Data space trim value to set  
 Example  
//Search using automatic trimming  
mySheet.SetDataAutoTrim(1);  
mySheet.DoSearch("list.jsp");  
//Save data without trimming  
mySheet.SetDataAutoTrim(0);  
mySheet.DoSave("save.jsp");
DataBackColor Method  
 Purpose  
Check or configure  default background color of odd -number data rows.  
Use this to set different colors for even and odd -number data rows. Background color of data 
rows will be determined by this and DataAlternateBackColor function.  
Select the color using WebColor.  
 Syntax  
Syntax  Get ObjId. GetDataBackColor ()
 Info 
Return  String, current odd number row color value (in case of Get 
Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check the current background color of odd -number data rows.  
mySheet.GetDataBackColor();
 Syntax  
Syntax  Set ObjId. SetDataBackColor (Color)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Color String  Required  Color value to set
 Example  
//Set the background color of odd -number data rows to white.  
mySheet.SetDataBackColor("#FFFFFF");  
DataCopy  Method  
 Purpose  
Copy the data row content that is last selected to create a new row, and return the row index of 
the new row. In case of a tree structure and the copy target row includes child levels, copy all 
child level rows if IncludeChild parameter is 1.  
Transaction status of new row will be "Insert".
 Syntax  
Syntax  ObjId. DataCopy ([IncludeChild])  
 Info 
Return  Long, Row Index of the row copied  
Parameter  Type Required 
Y/N Description  
IncludeChild  Boolean  Optional  Whether to copy child level rows  
Default=0
 Example  
//Copy the  row and change the transaction status of copied row to "Search".  
//'Status' is the status column SaveName  
var Row = mySheet.DataCopy();  
mySheet.SetCellValue(Row, "Status", "R");  
//Copy child level rows  
mySheet.DataCopy(1);  
DataFontColor  Method  
 Purpose  
Check or configure  font color of all data rows.  
Select the color using WebColor.
 Syntax  
Syntax  Get ObjId. GetDataFontColor () 
 Info 
Return  String, set font color value (in case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
// Check font color of a data row.  
mySheet.GetDataFontColor();  
 Syntax  
Syntax  Set ObjId. SetDataFontColor (Color)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Color String  Required  Color value to set  
 Example  
//Set the data row font color as red.  
mySheet.SetDataFontColor("#FF0000");
DataInsert  Method  
 Purpose  
Create a new data row, and return the row index of the new row.  
Row parameter and Level parameter will be set as follows:  
Row setting  New row location  Level 
Row < 0  Create as the last Level 0  
row 
Row >= All rows  Create as the last 
row Level 0  
Row < First data row  Create as the first 
row Level 0  
Others  Create in the row  Set level  
Default  Create below the 
selected row  If there is no setting, child level 
of the selected row  
In case of a  tree structure, the defaul is to create a row as child of selected row if Level 
parameter is not set. If the selected row is deleted, an error message is returned and creation will 
be aborted.
 Syntax  
Syntax  ObjId. DataInsert ([Row], [Level])  
 Info 
Return  Long, Row index of the new row  
Parameter  Type Required 
Y/N Description  
Row Long Optional  Location of the new row, 
Default="immediately below the last row 
selected"  
Level Long Optional  Tree level of the new row, 
Default="immediately above one level 
than the last row selected, create as a 
child"
 Example  
//Create as the first row  
mySheet.DataInsert(0);  
//Create as the last row  
mySheet.DataInsert( -1);
//Create immediately below the currently selected row  
mySheet.DataInsert();  
//Create as Row 7  
mySheet.DataInsert(7);
DataLinkMouse  Method  
 Purpose  
Check or configure whether a data row links a page.  
If a page is linked to a data row which opens upon click or DbleClick, use this method to change 
mouse pointer to finger sty le to indicate a link.  
If Link parameter is set as 1, mouse pointer will change to finger s tyle for the column.   
 Syntax  
Syntax  Get ObjId. GetDataLinkMouse (Col)
 Info 
Return  Boolean, set link value (In case of Get Method)   
Parameter  Type Required 
Y/N Description  
Col Long Required  Column index of a particular column  
/String  or SaveName  
 Example  
// Check a data row for page link.  
mySheet.GetDataLinkMouse(1);
 Syntax  
Syntax  Set ObjId. SetDataLinkMouse (Col, Link)  
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Col Long 
/String  Required  Column index of a particular column  
or SaveName  
Link Boolean  Required  Set whether link exists
 Example  
//Set to allow link for column 1 and 2 only.  
mySheet.SetDataLinkMouse(1, 1);  
mySheet.SetDataLinkMouse(2, 1);  
DataMove Method  
 Purpose  
Move data row to a desired location. In case of a tree type, any child level rows of the selected 
row will be moved as well.
This function does not create new rows like DetaInsert or DataCopy but simply relocate existing 
rows. However, internally there will be copy and delete.  
Therefore, attention should be paid to the pasting location if ToRow is bigger than FromRow.  
For example, if ToRow is bigger than FromRow, it will work like below:
 Syntax  
Syntax  ObjId. DataMove (ToRow, [FromRow], [RowLevel])  
 Info 
Return  Long, Top Row index of the relocated rows  
Parameter  Type Required 
Y/N Description  
ToRow  Long Required  Row Index of the new location  
FromRow  Long Optional  Row Index of the selected data  
Default =-1 
RowLevel  Integer  Optional  Tree level of the relocated data  
Default="Original level"
 Example  
//Move row 12 to row 10.  
mySheet.DataMove(10, 12);  
DataRowHeight  Method  
 Purpose  
Check or configure  row height of all data rows.  
This property  can be set at pixels. Default value is 21 pixels.  
Data
Move(
4,1);  
Copy data  
 Delete row
 Syntax  
Syntax  Get ObjId. GetDataRowHeight () 
 Info 
Return  Integer, set height value (In case of Get Method)   
Parameter  Type Required 
Y/N Description
 Example  
//Check the height of all data rows . 
mySheet.GetDataRowHeight();  
 Syntax  
Syntax  Set ObjId. SetDataRowHeight (Height)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Height  Integer  Required  Data row height to set   
 Example  
//Set the height of all data rows at 22 pixels.  
mySheet.Set DataRowHeight( 22);
DataRow Merge  Method  
 Purpose  
Check or configure  whether to horizontally merge all data rows . 
The default is that horizontal merging is not allowed unless the value is set as 0. 
 Syntax  
Syntax  Get ObjId. GetDataRow Merge ()
 Info 
Return  Boolean, set value (In case of Get Method)   
Parameter  Type Required 
Y/N Description  
 Example  
//Whether to allow horizontal merge for all data rows  
mySheet. GetDataRow Merge ();
 Syntax  
Syntax  Set ObjId. SetDataRow Merge (Merge ) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Merge  Boolean  Required  Whether to allow merge
 Example  
//Allow horizontal merge for all data rows  
mySheet.Set DataRow Merge (1); 
DirectDown2 Excel Method  
 Purpose  
This download data into excel the same way as Down2Excel. The different is that the data to 
download into excel is not data displayed in IBSheet  but the data created in the server. This 
method will quickly create an excel file using the data.  
Therefore, the only data received from the IBSheet  on the screen are header titles. The actual 
data will be transferred to DirectDown2Excel. jsp file by putting the data into request object 
named “SHEETDATA ” in java.util.List(java.util.Map) structure, which is then downloaded into an 
excel file.
The process is as follows:  
// Screen page   
var cols = [  
  {Type:"Text",Width:85,SaveName:"POSTNO",Format:"PostNo",Align:"center"},  
 {Type:"Text",Width:70,SaveName:"SIDO"},  
 {Type:"Text",Width:80,SaveName:"SIGUNGU"},  
 {Type:"Text",Width:80,SaveName:"LEE"},  
 {Type:"Text",Width:300,SaveName:"ADDRESS"}
]; 
mySheet.InitColumns(cols);  
var param = {  
    URL:"/bus/bussinessList.jsp "  //Business logic page  
    ,ExtendParam:"sa_nm= 양진열 &sa_no=980123"  
    ,FileName:"PersonList.xls"  
};  
sheet.DirectDown2Excel(param);
// bussinessList.jsp page  
// 1. Receive search parameters from the screen . 
String sa_name = request.getParameter("sa_nm");  
String sa_no = request.getParameter("sa_no');  
// 2. Inquire the data to download into excel from DB   
String query  
= “SELECT POSTNO,  SIDO, SIGUNGU,   LEE, ADDRESS FROM POSTNO” ; 
Class.forName(driver);  
conn = DriverManager.getConnection(url,id,pwd);  
pstmt = conn.prepareStatement(query);  
rs = pstmt.execut eQuery();  
// 3. Convert data to List(Map) . 
java.util.List li = new java.util.List();  
java.util.Map mp = null;  
while(rs.next()){  
mp = new Java.util.Map();  
mp.put("POSTNO",rs.getString("POSTNO"));  
mp.put("SIDO",rs.getString("SIDO"));  
.. 
.. 
li.add(mp);  
} 
// Put data into object. Must use SHEETDATA as object name . 
request.setAttribute(" SHEETDATA ", li);  
// 4. Forward data to DirectDown2Excel.jsp page 
System.out.println(" All counts :"+li.size());    
String forwardPath = "./DirectDown2Excel.jsp ";  
if(!"".equals(forwardPath)){  
RequestDispatcher rd = request.getRequestDispatcher(forwardPath);  
rd.forward(request,response);  
}
The parameters to send are JSON type. Put c onfiguration information into JSON format and 
send it to the server.  
Ex)  
var params = { FileName : "myFile.xls", SheetName : "Sheet"} ;  
URL parameter  is used to  mark the page path where excel display data is populated . (Required ) 
ex) URL:"/bus/displayList.do"
FileName  parameter is used to set the downloaded excel file name. If file extension is set as xls, 
excel 2003 format file is downloaded. If xlsx, excel 2007 format file is downloaded. If no value is 
set, an xls file is downloaded.  
ex ) FileName:"NameCard.xls"  
SheetName  parameter sets Worksheet names within an excel  file. If the data is large enough to 
exceed the max number of rows allowed for a single Worksheet, which is 65536, () and index will 
be added to the name. For example, if the set name is “January ”, any data exceeding the limit 
will be put into a new spreadsheet i n names “January  (1)” and “January  (2)”.
ex) SheetName:"SupportTeam"  
DownCols  parameter is a string connecting all downloading columns using "|". You can use 
either SaveName  or column index. If null, all columns are downloaded.
DownHeader  parameter sets  whether to include header when downloading. Default is 1(include 
header).  
Merge  parameter determines whether to merge columns if adjacent header data cells contain 
same letters. The default is 0.
SheetDesign  parameter determines whether to download head er color.  The default is 0.  
ExcelFontSize  parameter can determine particular font size within the excel file, independently of  
SheetFontSize .
ExtendParam  parameter is used to create a get method QueryString of search conditions to 
send to the server, which can be retrieved using request.getParameter() method from the page 
set in URL parameter.   
 ex)  ExtendParam:"name=shkim&sa_no=980123&enter_date=19980222 "; 
 Syntax  
Syntax  ObjId. DirectDown2 Excel([parameters])
 Example  
// Prepare and download data directly from the server . 
var param = {URL:"/sub/ex/bussDeptList.jsp"  
,ExtendParam:"DECNO=3422&PartMngNO=982211"  
,FileName:"OrgList.xls"};  
mySheet. DirectDown2 Excel(param );          
Direct LoadExcel  Method  
 Purpose  
This method reads excel document like LoadExcel, but it does not put the excel contents into 
IBSheet but transfers them to a page designated by the server.  
A page where excel data should be transfer red should be developed separately, and designate 
forwarding page path  (FP=/jsp/excelsave.jsp ) in ExtendParam.  
Forwarding page receives excel content  using “SHEETDATA ” as a name of a request object. 
SHEETDATA contents are composed of List(Map). Map keys are the SaveName of each IBSheet 
column.  
ex) //forwarding page..  
 List sheet = (List)request.getAttribute( “SHEETDATA ”); 
 for(int i=0;i<sheet.size();i++){  
  Map mp =(Map)sheet.get(i);  
} 
Also all the data transferred to ExtendParam can be loaded to the screen using getAttribute to 
the forwarding page.
p.s : You need to set DirectLoadExcel path within  ibsheet.cfg  to use this method . 
 Syntax  
Syntax  ObjId. DirectL oadExcel ([parameters])
 Info 
Parameter  Type Required 
Y/N Description  
ColumnMapping  String Optional  Excel column number  
Default=""  
EndRow  String Optional  Last row number after excel 
loading is completed  
Default="0"  
ExtendParam  String Required  Put parameters to send to 
server in QueryString  
FP to perform saving is 
required  
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 spreadsheet number, 
Default="1"  
WorkSheetName  String Optional  Excel Worksheet name  
Default=""  
 Example  
// Reference function  
function makeExParam(key,data){  
return   "&"+encodeURIComponent(key)+"="+encodeURIComponent(data);  
}
// Forwarding page  to transfer excel contents  (except for ContextRoot  name .) 
var param =makeExParam( “FP" ,"/bu/MassSave.jsp" ); 
param += makeExParam("sname","chris");  
param += makeExParam("date","20091221 ”); 
var parameters = {  Mode : mch,  StartRow: "1",  ExtendParam:param}  
// Load from excel for immediate processing by the server  
mySheet. Direct LoadExcel( parameters ); 
-----------------------------------------------------------------------------------------------------  
// MassSave.jsp page content  
// 1. Check excel contents.  (Check data)  
String PRINT_STR = "";  
ArrayList keys = new ArrayList();  
List li = (List)request.getAttribute("SHEETDATA");  
for(int i=0;i<li.size();i++){  
 Map mp = (Map)li.get(i);  
 // Send header row only . 
 if(i==0){  
  Iterator it = mp.keySet().iterator();  
  while(it.hasNext()){  
   String key = (String)it.next();  
   PRINT_STR += key+" \t"; 
   keys.add(key);  
  } 
  PRINT_STR += " \\n"; 
 } 
 // Send data  
 for(int c=0;c<keys.size();c++){  
  PRINT_STR += mp.get(keys.get(c))+" \t"; 
 } 
 PRINT_STR += " \\n"; 
} 
// Check from  server console  
System.out.println(PRINT_STR);  
// 2. Check for the content sent to ExtendParam . 
System.out.println(  request.getAttribute( “sname ”)); 
System.out.println(  request.getAttribute( “date”));
// 3. Return the result to the screen . 
out.println( “<script>alert( ‘Total data count : ”+li.size()+ ” has been \nsaved.');</script> ”); 
DoAllSave  Method  
 Purpose  
This method calls pages to save all data regardless of data transaction status .
If there is no data, a warning message will appear and process will be aborted . 
OnValidation event will fire in the processing collecting data to save. Depending on the custom 
logic, failure of OnValidation may result in abortion of saving.  
Call the save page using URL and complete saving to read saving XML. Then OnSaveEn d event 
fires and the whole process completes.
You can set how to combine Query String using Mode parameter.  
Query String  options based on  parameter  values are as follows:  
Mode  Description   Ex) 
1 Combine by cell  
(Array by SaveName)  sSeq=1&sStatus=R..  
2 Combine by column  
(Combine using separator by 
SaveName)  sSeq=1|2&sStatus=R|U..
You can set property values for "Selection " parameter in JSON format . (See the sample)  
 Syntax  
Syntax  ObjId. DoAllSave (PageUrl, [Param], [UrlEncode] , [Mode], [Delim] )
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
PageUrl  String  Required  Page file name to save  
Param  String  Optional  Parameter  for saving , Default=""  
UrlEncode  Boolean  Optional  Whether  to encode data on IBSheet , 
Default=1  
Mode  Integer  Optional  How to combine string in QueryString, 
Mode=1, Mode=2 (Default=1)  
Delim String  Optional  Decide separator for Mode=2  
(Default ="|")  
 Example  
// Save all  
var Result = mySheet.DoAllSave("save.jsp", "id=khlee&seq=1");
//If saving fails, return an error message. If succeed, do search.  
if(!Result){  
    alert(" Saving failed. Try again "); 
} else {  
    mySheet.DoSearch("list.jsp");  
} 
//Set values for “Selection ” parameter in JSON format  
mySheet.DoAllSave( PageUrl , { UrlEncode:0, Mode:2, Delim:"$"});
DoPrint Method  
 Purpose  
Print all the data that are displayed . 
Browser printing configuration is used to process printing. In order to print the background color 
or image, you need to change print configuration of the browser.  
 Syntax  
Syntax  ObjId. DoPrint()
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
N/A 
 Example  
// Print 
mySheet.DoPrint();
DoRowSearch  Method  
 Purpose  
Search cell data of a particular row . 
 Syntax  
Syntax  ObjId. DoRowSearch (Row, PageUrl, [Param],  [Opt])
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Index of the row  
PageUrl  String  Required  URL of the page  
Param  String  Optional  Search parameter  Query String , Default 
"" 
Opt.Wait  Boolean  Optional  Whether to display waiting image , 
Default = 1 
Opt.Sync Boolean  Optional  Whether to sync search  
Default=0  
(SearchSync  value if SearchSync  is set) 
 Example  
//Read column 3 data from DB if the data in column 3 has been updated  
function mySheet_OnChange(Row, Col, Value) {  
if (Col == 3) {  
    var opt = { Wait : 1, Sync : 1  }; 
mySheet. DoRowSearch( Row, "grid_rowdata.html",   "" , opt); 
} 
} 
// 1. Do not display image, async search  
var opt = { Wait : 0, Sync : 0 }; 
mySheet. DoRowSearch( Row, "grid_rowdata.html",   "" , opt);
// 2. Display image, sync search  
var opt = { Wait : 1, Sync : 1 };  
mySheet. DoRowSearch( Row, "grid_rowdata.html",   "" , opt); 
DoSave Method  
 Purpose  
Save data based on data transaction status or column . 
If Col parameter is not set, data rows whose transaction status is not “Search ” is saved. If there is 
a particular parameter set in Col, data with values in the designated column will be saved.  
If the column is in CheckBox format, only checked boxes will be saved.
If there is no data to save, a warning message will appear and  the process is dropped.  
OnValidation event will fire in the processing collecting data to save. Depending on the custom 
logic, failure of OnValidation may result in abortion of saving.  
Call the save page using URL and complete saving to read saving XML. Then OnSaveEnd event 
fires and the whole process completes.
You can set how to combine Query String using Mode parameter.  
Query String options based on parameter values are as follows:  
Mode  Description   Ex) 
1 Combine by cell  
(Array by SaveName)  sSeq=1& sStatus=R..  
2 Combine by column  
(Combine using separator by 
SaveName)  sSeq=1|2&sStatus=R|U..
"Selection" parameter can be set in JSON format. (See the example)  
 Syntax  
Syntax  ObjId. DoSave (PageUrl, [Param], [Col] , [Quest],  [UrlEncode] , 
[Mode], [Delim] )
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
PageUrl  String  Required  Page file name to save  
Param  String  Optional  Parameter for saving, Default ="" 
Col Long / 
String  Optional  Column to save ,  
or SaveName  
Default= Status column (-1) 
Quest  Boolean  Optional  Whether to display confirmation 
message before saving , Default=1  
UrlEncode  Boolean  Optional  Whether to encode data on IBSheet , 
Default=1  
Mode  Integer  Optional  How to combine strings for Query 
String, Mode=1, Mode=2 (Default=1)  
Delim String  Optional  Set the separator for Mode=2  
(Default="|")  
 Example  
//Save only the data with transaction happening  
mySheet.DoSave("Save.jsp" ,"id=khlee&seq=1");
//Save checked checkboxes in Column 2 
mySheet.DoSave("Save.jsp" ,"id=khlee&seq=1", 2);  
//Set “Selection ” parameter value in json format  
mySheet.DoSave( PageUrl , {UrlEncode:0, Mode:2, Delim:"$"});
DoSearch  Method  
 Purpose  
Connect to search page to read search XML, and then load XML data internally in IBSheet  
Param parameter can be set by connecting conditions using "=" and "&", as in “Condition 
name=value 1&condition name 2=value 2 ”. 
In Opt parameter, an object -type parameter, you can set whether to do Sync search (Sync) and 
Append search (Append).  
Sync parame ter is sync /async search mode.  Async search means when there are multiple calls 
sent, following calls for search will be ignored if the first search is not complete. If you need to 
run multiple calls and all searches must be complete, use sync mode.  
If you  set Append parameter as 1, you can append the existing data to the current search data 
to run search.  
Call the search page using URL and complete data representation by reading search data. Then 
OnSearchEnd event fires and the whole process completes.  
 Syntax  
Syntax  ObjId. DoSearch (PageUrl, [Param ], [Opt] )
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
PageUrl  String  Required  Search XML page file name  
Param  String  Optional  Search condition  Query String, 
Default=””  
Opt.Sync  Boolean  Optional  Sync search or not  
Default=0  
(SearchSync value when SearchSync is 
set) 
Opt.Append  Boolean  Optional  Append search result or not, Default=0  
 Example  
// 1. General search  
mySheet.DoSearch("list.jsp", "p1=aa&p2=bb");
// 2. Sync search  
var opt = { Sync : 1 }; 
mySheet.DoSearch("list.jsp", "p1=aa&p2=bb", opt);  
// 3. Append search  
var opt = { Append : 1 };  
mySheet.DoSearch("list.jsp", "p1=aa&p2=bb", opt);
// 4. Sync && Append search  
var opt = { Sync : 1, Append : 1 };  
mySheet.DoSearch("list.jsp", "p1=aa&p2= bb", opt);  
DoSearch Child Method  
 Purpose  
In a tree data structure, this method connects to child data search page within OnTreeChild event 
to read search XML and JSON, and append XML and JSON data as child.  
Row parameter transfers parent parameter to append child data through OnTreeChild event.
Call the page to run child data search using  URL and read search XML and JSON to complete 
data representation. OnSearchEnd event fires and the whole process is complete d. 
Param parameter can be configured by connecting search conditions using "=" and "&" as in the 
following format: "Condition name 1=Value 1&Condition Name 2= Value 2".
Wait parameter  can be used to set  whether to display waiting image during search.  
 Syntax  
Syntax ObjId. DoSearch Child(Row, PageUrl, [Param ], [Opt] )
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Row Long Required  Index of the row received from 
OnTreeChild event  
PageUrl String  Required  File name of search XML and JSON 
pages  
Param  String  Optional  Search parameter Query String, 
Default=""  
Opt.Wait  Boolean  Optional  Whether to display waiting image 
Default=1  
Opt.Sync Boolean  Optional  Sync search or not  
Default=0  
(SearchSync value when SearchSync is 
set)
 Example  
// Search the child data  
<script type="text/Javascript">  
 function mySheet_OnTreeChild(Row){  
   var url = "";  
   // Column 4 : Tree column  
   switch(mySheet.GetCellValue(Row, 4)){  
    case "Seoul" :  
      url = " type15_dat(1).xml";  
      break;  
    case "Incheon":  
      url = "type15_data(2).xml";  
      break;  
   } 
   var opt = { Wait : 1, Sync : 0 }; 
   mySheet.DoSearchChild(Row, url, "", opt);  
 } 
</script>  
// 1. Do not display image, async search  
var opt = { Wait : 0, Sync : 0 }; 
mySheet.DoSearchChild(Row, url, "",  opt);
// 2. Display image, sync search  
var opt = { Wait : 1, Sync : 1 };  
mySheet.DoSearchChild(Row, url, "", opt);  
DoSearch Paging  Method  
 Purpose  
When searching a large amount of data, search only partial data corresponding to the IBSheet 
scroll location to display on the screen.  
As the page scrolls, the Url configured as a parameter is called to display further search result 
data corresponding to the new scroll location.  
When this function is used, SearchMode should be set as 3 in the initializat ion method SetConfig, 
and Page property must be configured.  
The total scroll size will be determined by Total property value of the search data. Total property 
value must be set.  
When this function is used for search, there may be some restrictions to Ro w and Cell properties 
or use of multi -transaction function.
 Syntax  
Syntax  ObjId. DoSearch Paging (Url, [Info]) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Search page Url  
Info.PageParam  String  Optional  Parameter name to receive page 
index, Default="ibpage"  
Info.Param  String  Optional  Search parameter Query String, 
Default=""  
Info. 
OrderbyParam  String  Optional  Parameter name to receive header 
sorting information, 
Default="iborderby"  
As in “SIDO|SIGUNGU 
^ASC|DESC ”, 
the SaveName and sorting 
direction are separated by “^” and 
each name with “|”.  
Info. 
UseWaitImage  Boolean  Optional  When WaitImageVisible setting is 
true,  
whether to display waiting image 
for search of 2 pages or more.  
Default=0  
Info.Sync  Boolean  Optional  Sync search or not  
Default=0  
(SearchSync value when 
SearchSync is set)
 Example  
//Default setting  (Set page size at 100 ) 
var cfg = {SearchMode:3, Page:100};  
mySheet.SetConfig(cfg);  
// Real-time search  
var info = { PageParam: " page", OrderbyParam :”orderbyParam ”, Param:  
"id=ibleaders&seq=1 "}; 
mySheet.DoSearch Paging ("list.jsp", info);
// Sync search  
var info = { PageParam: " page", OrderbyParam :”orderbyParam ”, Param:  
"id=ibleaders&seq=1 ", Sync : 1 }; 
mySheet.DoSearch Paging ("list.jsp", info); 
Down2Excel  Method  
 Purpose  
IF there are any search result data returned, download the data displayed in IBSheet into an excel 
file.
The parameters to send are JSON type. Put c onfiguration information into JSON format and 
send it to the server.  
Sample )  
var params = { FileName : "myFile.xls",  SheetName : "Sheet"} ;  
mySheet.Down2Excel(params);
FileName  parameter is used to set the downloaded excel file name. If file extension is set as xls, 
excel 2003 format file is downloaded. If xlsx, excel 2007 format file is downloaded. If no value is 
set, an xls file is downloaded.  
SheetName  parameter sets Worksheet names within an excel  file. If the data is large enough to 
exceed the max number of rows allowed for a single Worksheet, which is 65536, () and index wil l 
be added to the name. For example, if the set name is “January ”, any data exceeding the limit 
will be put into a new spreadsheet in names “January(1) ” and “January(2) ”.
Down Rows parameter is a string connecting all downloading rows using "|". If this parameter is 
null, all rows are downloaded. If the value is “Visible ”, all rows that are currently visible will be 
downloaded, excluding hidden rows. If this parameter is not null, DownTreeHide parameter will 
be set as false.  
DownCols  parameter is  a string connecting all downloading columns using "|". You can use 
either SaveName  or column index. If this is null, all columns are downloaded.
HiddenColumn  parameter downloads hidden columns as hidden. The columns will not be visible 
initially but you can unhide them by using excel “unhide ” menu option.  
DownHeader  parameter sets whether to include header when downloading. Default is 1(include 
header).
DownS um parameter sets whether to include sum rows to download. Default is 1(include sum).  
Merge parameter determines whether to apply IBSheet merge status to excel document. Using 
this parameter may result in further delay of performance. Default is 0 (not use merg ing). 
※ For use of merge settings, see Appendix# 4. Applying Merge Setting for Excel Download.
SheetDesign parameter reflects IBSheet design. Font name, font size and background color are 
available. Using this parameter may result in further delay of performance. Default is 0 (Not apply 
design). Font color will always display in black. Multiple font coloring is not supported. For cell 
background color, up to 48 colors may be used concurrent ly for a single excel file.  If one 
IBSheet includes a larger number of colors, some of the colors will display to the closest color 
among the 48 available colors. If this parameter is set as 2, design will be still reflected as in 1, 
but cell borders will  not be lined.  
CheckBoxOnValue parameter is used to define other values than 1 i f you have checked checkbox 
and radio box. Default is 1.
CheckBoxOffValue  parameter can be used  to define values other than 0  if you have unchecked a 
checkbox or radio box . Default is 0.  
DownCombo parameter allows you to download optional attributes of combo and combo edit in 
TEXT or CODE format. The default is "TEXT". If you change the value to "CODE", download format 
will be CODE instead of TEXT.
TitleText parameter allows the user to customize title at the top of grid or other texts. If you 
enter A|B|C \r\nD|E|F for this parameter, three cells in the first row will be populated with A, B 
and C respectively, and those in the second row with D, E and F. To inc lude 'enter' within value, 
insert \r or \n. If the total \r\n count is 10, it will take up 11 rows. IBSheet data will continue 
from the 12th row.  
If cell data put into this parameter have more columns than the columns displayed in excel, 
those values will be ignored. If the # of columns displayed in an excel file is 10 in total, you can 
only configure 10 titles or other texts. (No such restrictions to the title row)  
UserMerge parameter is configured to apply merge to cells entered using TitleText or cells from 
IBSheet . One merge statement is composed of four numbers and commas. Multiple merges can 
be combined using space character as separator. If the parameter value is set as “0,0,2,2 0,2,1,8 ”, 
2X2 merge is applied to the first row, first column of the exc el (0, 0). Then another, a 1x8 merge, 
will apply to (0,2), a cell in the first row and Column 2(=third column) .
OnlyHeaderMerge parameter restricts merge in the data area to improve performance.  
ExcelFontSize parameter can designate font size in excel document separately from 
SheetFontSize.
ExcelRowHeight parameter is uesd to fix all the rows to a particular pixel size only in excel 
document. If this is set as "auto", excel row height is automatically adjusted.  
The page configured in  URL parameter is called before Down2Excel.jsp page when you put a URL 
to process a logic when there are any server side jobs that should be processed by the server 
along with Down2Excel (logging, for example). Therefore, configuration page must send a 
request to Down2Excel .jsp page after the jobs are completed.  
Sample)  
var param = { URL:"/ibsheet7_down2excel_extendparam/fp.jsp"};  
mySheet.Down2Excel(param);
Server side page)  
RequestDispatcherrd= 
request.getRequestDispatcher( "/ibsheet7_down2excel_extendparam/IBSheet/Down2Excel.jsp");  
rd.forward(request,response);  
ExtendParam parameter is used when you have instructions to send to the server. Connect them 
into a QueryString of GetMethod and set it in this parameter to deliver it to the same page as 
set in URL.  
Sample)  
param = { ExtendParam :"sawon_name=shkim&sawon_no=12345 ", 
URL:"/ibsheet7_down2excel_extendparam/fp.jsp };
ExtendParamMethod determines whether to send ExtendParam contents using GET or POST 
method.  
TextToGeneral parameter is used when IBSheet Text type columns are downloaded in an excel 
file and you need to change them into general or text type.
DownTreeHide parameter is used to download the rows collapsed in a tree structure.  
If this parameter is set true, hidde n rows are all downloaded using SetRowHidden.  
KeyFieldMark  parameter is used to download KeyFIeld mark (*) in KeyField column.
TreeLevel  parameter is used to download tree levels in a tree -structure column.  
WordWrap  parameter is used to configure whether to allow multilines for a text cell.
AutoSizeColumn  parameter is used to adjust column width to fit the column text. Still, automatic 
adjustment may not be precise.  
ExcludeSubSum  parameter can be used if you want to exclude sub sum or aggregate t otal rows 
from downloaded rows.
ComboValidation  parameter is used to set whether to create combo type columns in the data 
area (excluding the header, sub sum, aggregate total or sum rows) as a drop -down list (data 
validation). The default value is 0, whic h means data validation will not be done.  
When this parameter is set as 1, the dropdown list items will use either the ComboCode as set in 
the column if DownCombo value is “Code”, and ComboText if “Text”. 
Combo list updated using InitCellProperty will not be updated individually to excel ’s dropdown 
list, but the values will display intact when downloaded in excel.  
 Syntax  
Syntax  ObjId. Down2Excel ([parameters])
 Info 
Parameter  Type Required 
Y/N Description  
AutoSizeColumn  bool Optional  Default=0(do not auto  adjust 
column width)  
CheckBoxOffValue  String Optional  Value when checkbox is 
unchecked   
Default=” 0” 
CheckBoxOnValue  String Optional  Value when checkbox is 
checked   
Default=” 1” 
ComboValidation  bool Optional  Whether to download combo 
dropdown format  
Default=0 
DownCols  String Optional  Connect columns to download 
using | Default=""(Download 
all) 
DownCombo  String Optional  Whether to download combo 
in TEXT/CODE format  
Default=”TEXT”  
DownHeader  bool Optional  Whether to download header  
Default=1  
DownRows  String Optional  Connect rows to download 
using | Default=""(Download 
all) 
DownSum  bool Optional  Whether to download sums  
Default=1  
DownTreeHide  bool Optional  Whether to download 
collapsed rows in a tree  
Default=0(Not download)  
ExcelFontSize  Integer  Optional  Font size setting  
Default=0  
ExcelRowHeight  String Optional  Default=""(Not use)  
ExcludeSubSum  Integer  Optional  Whether to exclude partial 
sum/aggregate rows  
1: exclude partial sums only  
2: exclude aggregate only  
3: exclude both partial 
sum/aggregates  
Default=0 (Include both partial 
sum and aggregates)  
ExtendParam  String Optional  Default=""(Not use)  
ExtendParamMeth
od String Optional  Default="GET"  
FileName  String Optional  File name to save  
Default= "Excel.xls " 
HiddenColumn  bool Optional  Whether to apply hiding status 
to download file  
Default=0  
KeyFieldMark  bool Optional  Whether to download Keyfield 
mark(*)  
Default=1(Download)  
Merge  bool Optional  Whether to apply merge to 
download  
Default=0  
OnlyHeaderMerge  bool Optional  Whether to merge the header 
only 
Default=0  
SheetDesign  Integer  Optional  Whether to apply IBSheet  
design concept to download 
file 
Default=0  
SheetName  String Optional  Excel worksheet name, 
Default="Sheet"  
TextToGeneral  bool Optional  Text type excel format  
Default=1(General)  
TitleText  String Optional  Default=""(Not use)  
TreeLevel  bool Optional  Default=0(Not download)  
URL String Optional  Default=""(Not use)  
UserMerge  String Optional  Default=""(Not use)  
WordWrap  bool Optional  Default=1(allow multi -line) 
 Example  
// Download in excel 
mySheet.Down2Excel();
// Set the download file name as excel2, and worksheet name as sheet -test. 
mySheet.Down2Excel({FileName:'excel2',SheetName:' sheet -test'});  
//Apply sheet color and merge to download file and use code for combo 
and Y/N for check. Exclude Header and sum, and download three columns 
starting from the left.  
mySheet.Down2Excel({SheetDesign:1, Merge:1, DownCombo:'CODE', 
CheckBoxOnValue:'Y', CheckBoxOffValue:'N',  DownRows:'', DownCols:'0|1|2', 
DownHeader:0, D ownSum:0});
Down2Excel Url Method  
 Purpose  
Check and configure server page path to process excel download.  
 Syntax  
Syntax  Get ObjId. GetDown2ExcelUrl ()
 Info 
Return  String, set path value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check the excel download path.  
var url = mySheet.GetDown2ExcelUrl();
 Syntax  
Syntax  Set ObjId. SetDown2ExcelUrl (Url) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Server page URL to set
 Example  
// Configure excel download path.  
mySheet.SetDown2ExcelUrl( "/jsp/Down2Excel.jsp "); 
Down2ExcelBuffer  Method  
 Purpose  
Download multiple sheets into a single excel document.
If buffer parameter in Down2ExcelBuffer is set as true, all Down2Excel executed afterwards will 
not actually run and buffered to internal memory.  
Afterwards, when the buffer parameter of Down2ExcelBuffer is changed to false, all the sheets 
buffered will b e downloaded as separate spreadsheet within a single excel file.  
Among the excel file names you set during buffering, the first name and excel file format will be 
effective. If worksheet name is redundant, name will change automatically adding brackets a nd 
serial numbers.
 Syntax  
Syntax  ObjId. Down2ExcelBuffer (IsBuffer) 
 Info 
Parameter  Type Required 
Y/N Description  
IsBuffer  bool Required  Buffering or not
 Example  
//Buffer afterwards. Do nothing.  
firstSheet.Down2ExcelBuffer(true);   
//Reserve downloading into the first worksheet.  
firstSheet.Down2Excel({FileName:'excel2',SheetName:'sheet1'});
//Reserve downloading into the second worksheet.  
secondSheet .Down2Excel({FileName:'excel2',SheetName:' sheet2'});  
// Download all buffered sh eet data into a single excel document 
immediately.  
firstSheet.Down2ExcelBuffer(false);
Down2 Pdf Method  
 Purpose  
If there are any returned data, convert IBSheet  contents into a PDF file to download.  
The parameters to send are in JSON type. Put configuration information into JSON format and 
send it to the server.
Sample)  
var params = { FileName:"myPDF .pdf"}; 
mySheet.Down2 Pdf(params);  
FileName parameter sets the file name for downloaded PDF file. File extension must be pdf. You 
can skip adding extension and then .pdf will be added automatically when file is downloaded.
DownCols parameter is a string of all download columns separated with "|" You can use either 
SaveName or Column Index. If this par ameter is null, all column data will be downloaded.   
Sample)  
var params = { DownCols :"4|5|6|7|8|9|10 "}; 
mySheet.Down2 Pdf(params);
Paper parameter sets the print orientation for PDF file. Vertical: landscape, horizontal: portrait  
Sample)  
var params = { Paper:" landscape "}; 
mySheet.Down2 Pdf(params);
Dpi parameter sets the enlargement scale for PDF file. Value may be set between 50 and 32800. 
Bigger the value is, smaller the print size gets.  
Sample)  
var params = { Dpi:1800};  
mySheet.Down2 Pdf(params);
Title parameter sets the title to print in PDF file.   
TitleStyle parameter sets css style to apply to title to print in PDF file.   
Sample)  
var params = {Title:" IBSheet  PDF file", TitleStyle:"color:red;size:12pt;" };  
mySheet.Down2 Pdf(params);
The page configured in  URL parameter is called before Down2Pdf.jsp page when you put a URL 
to process a logic when there are any server side jobs that should be processed by the server 
along with Down2Pdf (logging, for example). Therefore, configuration page must send a request 
to Down2Pdf.jsp page after the jobs are completed.  
Sample)  
var param = { URL:"/ibsheet7_down2 pdf/fp.jsp"};  
mySheet. Down2 Pdf(param);
Server side page)  
RequestDispatcher  rd= request.getRequestDispatcher("/ibsheet7_down2 pdf/ Down2 Pdf.jsp"); 
rd.forward(request,response);  
ExtendParam parameter is used when you have instructions to send to the server. Connect them 
into a QueryString of GetMethod and set it in this parameter to deliver it to the same page as 
set in URL.
Sample)  
param  = { ExtendParam :"sawon_name=shkim&sawon_no=12345 ", 
URL: "/ibsheet7_down2 pdf/fp.jsp"};   
mySheet. Down2 Pdf(param);  
ExtendParamMethod determines whether to send ExtendParam contents using GET or POST 
method.
FontTo parameter sets the Korean font to use in PDF. When the sheet includes Korean characters, 
set either Gulim or Gothic for font, as they are supported by PDF conversion module. (Gulim or 
Gothic)  
Sample)  
var params = { FontTo :" Gulim "}; 
mySheet.Down2 Pdf(params);
 Syntax  
Syntax  ObjId. Down2 Pdf([parameters])  
 Info 
Parameter  Type Required 
Y/N Description  
DownCols  String Optional  Connect columns to 
download using |  
Default=""(Download all)  
Dpi Integer  Optional  Enlargement scale. Bigger the 
print image is the smaller the 
value is. Value may be set 
between 50  and32840.  
Default = 2000  
ExtendParam  String Optional  If there are any instructions to 
send to the server, connect 
them into a Get Method 
QueryString. Default=""  
ExtendParam  String Optional  Default=""(Not use)  
ExtendParamMethod  String Optional  Default="GET"  
FileName  String Optional  File name to save  
Default= "IBSheet .pdf" 
FontTo  String Optional  Default = " Gothic " 
Paper String Optional  Print orientation  
Landscape or portrait  
Default = " landscape " 
Title String Optional  Default =  "" 
TitleStyle  String Optional  Default = ""  
URL String Optional  Default=""(Not use)
 Example  
// Download to PDF.  
mySheet.Down2 Pdf();          
// Set the download file name as text and download the file.  
mySheet.Down2 Pdf({FileName:' text' });
// Set the download columns and download them into myPDF.pdf.  
mySheet.Down2Pdf({FileName:"myPDF", DownCols:"7|8|9|4|5|6|10"});  
Down 2PdfUrl Method  
 Purpose  
Check and configure server page path to process PDF download.
 Syntax  
Syntax  Get ObjId. GetDown2 PdfUrl() 
 Info 
Return  String, set path value (in case of Get Method)  
Parameter  Type Required 
Y/N Description
 Example  
//Check the PDF download path.  
var url = mySheet.GetDown2 PdfUrl(); 
 Syntax  
Syntax  Set ObjId. SetDown2 PdfUrl(Url)
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Server page URL to set  
 Example  
// Configure PDF download path.  
mySheet.SetDown2Pdf Url("/jsp/Down2 Pdf.jsp");
Down2 Text Method  
 Purpose  
If there are any returned data, convert IBSheet  contents into a text file to download.  
The parameters to send are in JSON type. Put configuration information into JSON format and 
send it to the server.
Sample)  
var params = { FileName : "myFile. txt "}; 
mySheet.Down2 Text(params);  
FileName parameter sets the file name for downloaded text file. File extension must be txt. You 
can skip adding extension and then .txt will be added automatically when file is downloaded.
DownRows parameter is a string of all download rows separated with "|" If this parame ter is null, 
all row data will be downloaded.  
DownCols parameter is a string of all download columns separated with "|" You can use either 
SaveName or Column Index. If this parameter is null, all column data will be downloaded.
DownHeader parameter configures whether to include header for download. Default is 1 
(Include header).  
DownSum parameter configures whether to include sums for download. Default is 1 (Include 
Sums).
DownCombo parameter allows you to download optional attributes of combo and combo edit in 
TEXT or CODE format. The default is "TEXT". If you change the value to "CODE", download format 
will be CODE instead of TEXT.  
ExtendParam parameter is used when you have instructions to send to the server. Connect them 
into a QueryString of G etMethod and set it in this parameter to deliver it to the same page as 
set in URL.  
Sample)  
param  = { ExtendParam :"sawon_name=shkim&sawon_no=12345 ", 
URL:"/ibsheet7_down2 text_extendparam/fp.jsp };
DownTreeHide parameter is used to download the rows collapsed in a tree structure.  
 Syntax  
Syntax  ObjId. Down2 Text([parameters])
 Info 
Parameter  Type Required 
Y/N Description  
FileName  String Optional  File name to save  
Default= "Test.txt"  
RowDelim String Optional  Record separator to display in 
row data 
Default= ”\n” (Enter format)  
ColDelim 
 String Optional  Column separator to display in 
row data  
Default= ” ” (Space format)  
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  
DownCombo  String Optional  Whether to download combo 
in TEXT/CODE format  
Default=”TEXT”  
ExtendParam  String Optional  If there are any instructions to 
send to the server, connect 
them into a Get Method 
QueryString. Default=""  
DownTreeHide  bool Optional  Whether to download 
collapsed rows in a tree  
Default=0(Not download)  
 Example  
// Download to text.  
mySheet.Down2 Text();
// Set the download file name as text and download the file.  
mySheet.Down2 Text({FileName:' text' }); 
//Use code for combo and exclude header and sum. Download three 
columns starting from the left.  
mySheet.Down2 Text({DownCombo:'CODE', DownRows:'', DownCols:'0|1|2', 
DownHeader:0, DownSum:0});
Down2TextUrl Method  
 Purpose  
Check and configure server page path to process text file download.  
 Syntax  
Syntax  Get ObjId. GetDown2TextUrl ()
 Info 
Return  String, set path value (in case of Get Method)  
Parameter  Type Required 
Y/N Description  
 Example  
//Check the text download path.  
var url = mySheet.GetDown2TextUrl();
 Syntax  
Syntax  Set ObjId. SetDown2TextUrl (Url) 
 Info 
Return  None 
Parameter  Type Required 
Y/N Description  
Url String  Required  Server page URL to set