text stringlengths 1 8.76k | target stringlengths 0 2.93k |
|---|---|
IBSheet7 Method, Event API Document | |
Table of Contents
Chapter 1. IBSheet Events 11
1. IBSheet Events 13
1.1 Using even ts 13
2.2 Event List 14
OnAfterColumnMove Event 14
OnAfterEdit Event 14
OnAfterExpand Event 15
OnBeforeCheck Event 16
OnBeforeColumnMove Event 17
OnBeforeEdit Event 18
OnBeforeExpand Event 18
OnBeforePaste Event ... | Chapter 1. IBSheet Events |
1. IBSheet Events
1.1 Using events
IBSheet offers a wide range of events to support users to customize or configure a function as they
want.
function Object ID _Event name (Parameter , …) { } | For example, if you need to use OnChange event for a new function, you may create the following
statement, assuming the IBSheet ObjectID is "mySheet":
function mySheet_OnChange(Row, Col, Value) {
alert(Row + "," + Col + " values have been updated.");
} |
The followings are the list of events offered by IBSheet: | 2.2 Event List
OnAfterColumnMove Event
Purpose
Event fires when a user has successfully moved a column using mouse drag or MoveColumnPos
function. |
Syntax
Syntax function Object ID_OnAfterColumnMove(Col, NewPos) { } | Parameters
Parameter Type Description
Col Long Index of the original column
NewPos Long Index of the new column location |
Example
//Event fires after a column is moved.
function mySheet_OnAfterColumnMove(Col, NewPos) {
alert(Col + " location has been moved to " + NewPos + " location ..”);
} | See Also
OnBeforeColumnMove , MoveColumnPos , MoveColumnFail |
OnAfterEdit Event
Purpose
Event fires promptly after a cell value is edited. | Syntax
Syntax function Object ID _OnAfterEdit (Row, Col) { } |
Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell | Example
//Event fires promptly after a cell value is edited.
function mySheet_OnAfterEdit(Row, Col) {
alert(" Exit editing .");
} |
See Also
OnBeforeEdit | OnAfterExpand Event
Purpose
Event fires when you collapse or expand a tree -type sheet by clicking + or - buttons. |
Syntax
Syntax function ObjectID_OnAfterExpand(Row, Expand) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Expand Long 0 : Expand
2 : Collapse |
Example
function mySheet_OnAfterExpand(Row, Expand) {
alert( Row + "Row, "+ Expand +"'s status");
} | See Also
OnBeforeExpand , RowExpand , RowLevel , ShowTreeLevel |
OnBeforeCheck Event
Purpose
Event fires promptly before user starts editing a checkbox value (by mouse -clicking or pushing
the space button) .
As the e vent timing is immediately before checkbox is updated, conditional processing is
available upon checking. | The following data types are supported :
- DelCheck
- CheckBox
- Radio
- DummyCheck |
Syntax
Syntax function Object ID_OnBeforeCheck(Row, Col) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell |
Example
//Event fires when a box is about to be checked.
//Display a warning window if a row to check is an Insert row.
function mySheet_OnBeforeCheck(Row, Col) {
if(mySheet.GetCellValue(Row,"status") == "I") {
alert("Check : " + Row + " is an Insert row.");
}
} | OnBeforeColumnMove Event
Purpose
Event fires when the user starts moving a column using mouse or MoveColumnPos method . You
can block column movements by using MoveColumnFail(1) method . |
Syntax
Syntax function Object ID_OnBeforeColumnMove(Col, NewPos) { } | Parameters
Parameter Type Description
Col Long Index of the source column
NewPos Long Index of the target column location |
Example
//Cancel column movement if column 0 is mo ved to a location past column
3
function mySheet_OnBeforeColumnMove(Col, NewPos) {
if(Col==0 && NewPos > 3) {
mySheet.MoveColumnFail(1);
}
} | OnBeforeEdit Event
Purpose
Event fires immediately before a cell value is edited . |
Syntax
Syntax function Object ID _OnBeforeEdit (Row, Col) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell |
Example
//Event fires after a column is moved.
function mySheet_OnBeforeEdit(Row, Col) {
alert("Start editing .");
} | OnBeforeExpand Event
Purpose
In a tree structure , event fires when a tree expands or collapses upon clicking. |
Syntax
Syntax function Object ID _OnBeforeExpand (Row, Expand) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Expand Long 0 : Expand
2 : Collapse |
Example
function mySheet_OnBeforeExpand(Row, Expand) {
if(Row == 1 && Expand == 2) {
mySheet.SetAllowExpand(0);
alert("You can expand Row 1 but cannot collapse it.");
}
} | OnBefore Paste Event
Purpose
Event fires promptly before data are pasted into IBSheet. |
Syntax
Syntax function Object ID _OnBefore Paste(text) { } | Parameters
Parameter Type Description
text String Text to paste into IBSheet |
Remarks
This event will fire before data are pasted : you can cancel past ing or edit the text before pasting
as necessary. Past ing will be calceled in the event of a false return . When a string is returned, it
will replace the paste target text. | Example
function mySheet_OnBefore Paste(text) {
if(text == “not allow text ”) {
alert("Past ing is cancelled.");
return false;
}
} |
function mySheet_OnBefore Paste(text) {
if(text == “not allow text ”) {
return “allow text ”;
}
} | OnBefore Save Event
Purpose
Event fires promptly before Ajax communication when a saving method is called. |
Syntax
Syntax function Object ID _OnBefore Save() { } | Parameters
Parameter Type Description
N/A |
Remarks
Event fires before Ajax communication when DoSave or DoAllSave method is called.
Use this event when you want to customize the saving waiting image . | Example
function mySheet_OnBefore Save() {
alert("Saving.");
} |
OnBefore Search Event
Purpose
Event fires promptly before Ajax communication when a search method is called. | Syntax
Syntax function Object ID _OnBefore Search () { } |
Parameters
Parameter Type Description
N/A | Remarks
Event fires before Ajax communication when DoSearch, DoSearchChild, DoSearchPaging or
DoRowSearch method is called.
Use this event when you want to customize the search waiting image. |
Example
function mySheet_OnBefore Search () {
alert("Search is in progress.");
} | OnCellDropEnd Event
Purpose
Event fires upon drop after the user starts dragging cells |
Syntax
Syntax function Object ID _OnCellDropEnd (FromSheet, FromRow,
FromCol, ToSheet, ToRow, ToCol, X, Y ) { } | Parameters
Parameter Type Description
FromSheet Object Drag location sheet object
FromRow Long Row index of the drag location sheet object
FromCol Long Column index of the drag location sheet object
ToSheet Object Drop location sheet object
ToRow Long Row index of the drop location sheet object
T... |
Example
Set the drag cell value into the cell at the drop target location .
function mySheet_On CellDropEnd (FromSheet, FromRow, FromCol, ToSheet, ToRow,
ToCol) {
var bValue = ToObj.GetCellValue(ToRow, ToCol);
var aValue = Obj.GetCellValue(Row, Col);
if (ToRow < 0) {
ToRow = ToObj.DataInsert(ToRow);
T... | OnChange Event
Purpose
Event fires when the cell editing is complete d and the p revious value has been updated.
In addition to value update by the user, other methods may also fire this event for each of the
updated Checkbox in each data row, such as when CellValue method is used, when the Check All
checkbo... |
Syntax
Syntax function Object ID _OnChange (Row, Col, Value , OldValue,
RaiseFlag ) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell
Value String Updated value ;
Value used for saving without formatting
OldValue String Value before update
RaiseFlag Integer Event fire option
(0: manual editing, 1: method, 2: paste) |
Example
function mySheet_OnChange(Row, Col, Value) {
if(Col == 3 && mySheet.GetCellValue(Row, 2) == 'Korean won' && Value
== '9') {
alert("You should select code 10 for Korean won.");
}
} | OnChange Filter Event
Purpose
Event fires when a cell value in the filter row or an option has been updated.
In addition to value editing by the user, use of SetFilterOption function also fires this event. |
Syntax
Syntax function Object ID _OnChange Filter() { } | Parameters
Parameter Type Description
None |
Example
//When SearchMode is set as 3, search if filtering condition is changed
function mySheet_OnChange Filter() {
// Filter row QueryString update
var fp = mySheet.GetFilterParam(0,1);
var info = { PageParam: " page", Param: "id=ibleaders&seq=1& " + fp};
mySheet .DoSearch Paging ("list.jsp", info);
... | OnChangeSum Event
Purpose
Event fires when t he value in the sum row changes . |
Syntax
Syntax function Object ID _OnChangeSum (Row,Col) { } | Parameters
Parameter Type Description
Row Long Index of the row above the sum row
Col Long Col index of the updated cell |
Example
function mySheet_OnChangeSum(Row , Col ) {
//When the value in the sum row changes, display calculation result in
another cell of the same row :
mySheet.SetSumText(2, mySheet.GetSumValue( Col) / 100 + " %");
} | OnCheckAllEnd Event
Purpose
Event fires when CheckAll action is completed for a checkbox type column . |
Syntax
Syntax function Object ID _OnCheckAllEnd (Col, Value ) { } | Parameters
Parameter Type Description
Col Integer Index of the column
Value Boolean Checked or not |
Example
function mySheet_On CheckAllEnd (Col, Value ) {
alert(CheckAll action for Col + "th column has been completed.");
} | OnClick Event
Purpose
Event fires when user clicks a cell in data area. |
Syntax
Syntax function Object ID_OnClick (Row, Col, Value, CellX, CellY, CellW,
CellH) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell
Value String Cell value where the event fired
CellX Long X coordinate of the cell
CellY Long Y coordinate of the cell
CellW Long Width of the cell
CellH Long Height of the cell |
Example
function mySheet_OnClick(Row, Col, Value, CellX, CellY, CellW, CellH) {
//Set to move to another page when a row is clicked
location.href = "link.jsp?key=" + Value;
} | OnDblClick Event
Purpose
Event fires when the user double clicks a cell in the data area. |
Syntax
Syntax function Object ID _OnDblClick (Row, Col, Value, CellX, CellY,
CellW, CellH) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell
Value String Value of the cell
CellX Long X coordinate of the cell
CellY Long Y coordinate of the cell
CellW Long Width of the cell
CellH Long Height of the cell |
Example
function mySheet_OnDblClick(Row, Col, CellX, CellY, CellW, CellH) {
//Set to move to another page when a row is double -clicked
location.href = "link.jsp?key=" + mySheet.GetCellValue(Row, Col + 1) ;
} | OnDebugMsg Event
Purpose
Event fires when a debugging message occurs during any processing.
If ShowDebugMsg property is set as 0, debugging message will be called through this event. If
the property is set as 1, the message will appear in an pop -up window for the user to see. |
Syntax
Syntax function Object ID _OnDebugMsg (Msg) { } | Parameters
Parameter Type Description
Msg String Debug message |
Example
function mySheet_OnDebugMsg(Msg) {
txtErr.value = txtErr.value + " \n>>>>" + Msg;
} | //Create a text area to display debug message
<textarea name="txtErr" rows=10 cols=70></textarea> |
OnDecr yption Event
Purpose
Event fires for each cell or EtcData element when you run a search and need to edit data before
they populate cells , or interface the data with encryption module.
.
Syntax
Syntax function Object ID _OnDecr yption(Row,Col, SaveName ,Value ){} | Parameters
Parameter Type Description
Row Long Row index of the cell ( -1 for EtcData)
Col Long Col index of the cell ( -1 for EtcData)
SaveName String SaveName of the column or KEY of EtcData
Value String Data to populate cell s or EtcData Value |
Remarks
If you need to display B instead of the actual value A you retrieved through search,
or if data are encrypted and need decryption to display, you can use this event.
See the source below for detailed instructions. | Example
function mySheet_ OnDecr yption(Row, Col, SaveName, Value){
/* Call and return the Dec user method which performs decryption using
value as a parameter.
return Dec(Value);
} |
OnDownFinish Event
Purpose
Event fires when excel or text file download is complete.
.
Syntax
Syntax function Object ID _OnDownFinish (downloadType, result ){} | Parameters
Parameter Type Description
downloadType String File format between excel and text : “EXCEL ” or
“TEXT”
result Boolean Download error flag . Success: true, Failure: false |
Remarks | Example
function mySheet_OnDownFinish(downloadType, result) {
alert(downloadType + 'Downlo ad is complete. Download result : ' +
result);
} |
OnDragStart Event
Purpose
Event fires when the user starts dragging one or more rows or cells. | Syntax
Syntax function Object ID _OnDragStart (Row, Col ) { } |
Parameters
Parameter Type Description
Row Long Row index of the drag location
Col Long Column index of the drag location | Example
var dragValue = "";
function mySheet_On DragStart (Row, Col ) {
// Save the CellValue of the position where drag started
dragValue = mySheet.GetCellValue(Row, Col) ;
} |
OnDropEnd Event
Purpose
Event fires upon drop after the user starts dragging one or more rows. | Among event parameters, the Type parameter will deliver detailed drop location value in a tree
structure.
Type parameter may have the following values:
Type Description
1 Upper part of the Drop location row
2 Middle part of the Drop location row
3 Lower part of the drop location row |
Syntax
Syntax function Object ID _OnDropEnd (FromSheet, FromRow, ToSheet,
ToRow, X, Y, Type ) { } | Parameters
Parameter Type Description
FromSheet Object Drag location sheet object
Row Long Row index of the drag location sheet object
ToSheet Object Drop location sheet object
ToRow Long Row index of the drop location sheet object
X Integer X coordinate of the drop location
Y Integer Y coordina... |
Example
// Add the drag row to the drop location and delete from the drag sheet.
function mySheet_On DropEnd (FromSheet, FromRow, ToSheet, ToRow, X, Y, Type) {
var NewRow = ToObj.DataInsert(ToRow);
for (var c = 0; c <= Obj.LastCol(); c++) {
ToObj.SetCellValue(NewRow, c, Obj.GetCellValue(Row, c));
}
Obj.R... | OnEditValidation Event
Purpose
Event fires when cell editing completes so that validation check may run for the updated value. |
If validation fails, set as ValidateFail(1) and revert to the original values. | Syntax
Syntax function Object ID _OnEditValidation (Row, Col, Value) { } |
Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell
Value Variant This value is used for saving without a designated
format. | Example
function mySheet_OnEditValidation(Row, Col, Value) {
switch(Col) {
case 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);
} else if(Value=="Foreign c... |
OnEncr yption Event
Purpose
When IBSheet saves data , any change will be adjoined into a QueryString. This event may be
used when the data requires encryption or the user needs to change a value before saving. | Syntax
Syntax function Object ID _OnEncr yption(Row, Col, Value) { } |
Parameters
Parameter Type Remark
Row Long Row Index of the cell
Col Long Col Index of the cell
SaveName String SaveName of the column
Value String Current data in the cell | Remarks
If you need validation check before saving data, you may use OnValidation event to determine
whether to save the data or not if validation fails . However, if you must save the data regardless
of the validation result by changing any invalid values found during validation , you may use this
event. See... |
Example
function mySheet_OnEncr yption(Row, Col, SaveName, Value){
/* Call and return the Enc user function which performs encryption using the
values to save as a parameter.
return Enc(Value);
} | OnFilterEnd Event
Purpose
Event fires after filtering is completed. |
Syntax
Syntax function Object ID _ OnFilter End(RowCnt, FirstRow) { } | Parameters
Parameter Type Description
RowCnt Long Number of rows after filtering
FirstRow Long Index of the first row post filtering |
Example
function mySheet_ OnFilter End(RowCnt, FirstRow ) {
} | OnHScroll Event
Purpose
Event fires upon horizontal scroll. |
Syntax
Syntax function Object ID _OnHScroll (hpos, oldhpos, isLeft, isRight,
section ) { } | Parameters
Parameter Type Description
hpos Long Horizontal scroll position
oldhpos Long Previous horizontal scroll position
isLeft Boolean Whether the horizontal scroll bar is located at the
far left
isRight Boolean Whether the horizontal scroll bar is located at the
far right
section Int Scroll ... |
Example
function mySheet_ OnHScroll (hpos, oldhpos, isLeft, isRight, section ) {
} | OnKeyDown Event
Purpose
Event fires when a cell value is being edited or a key is pressed on a selected cell.
As KeyCode is an ASCII value, transcode before use. |
Syntax
Syntax function Object ID _OnKeyDown (Row, Col, KeyCode, Shift) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell
KeyCode Integer ASCII value of the keyboard
Shift Integer 1 : When a Shift key is pressed
2 : When a Ctrl key is pressed
0 : Others |
Example
function mySheet_ OnKeyDown (Row, Col, KeyCode, Shift) {
//If the Enter key is pressed in the last column, put focus on the first
part of the next row.
if(KeyCode == 13 && Col == mySheet.LastCol()) {
mySheet.SelectCell(Row + 1, 2);
}
} | OnKeyUp Event
Purpose
Event fires when a cell value is being edited or a pushed key is unpressed on a selected cell. This
event immediately follows OnKeyDown event.
As KeyCode is an ASCII value, transcode before use. |
Syntax
Syntax function Object ID _OnKeyUp (Row, Col, KeyCode, Shift) { } | Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell
KeyCode Integer ASCII value of the keyboard
Shift Integer 1 : When a Shift key is pressed
2 : When a Ctrl key is pressed
0 : Others |
Example
function mySheet_OnKeyUp(Row,Col,KeyCode,Shift) {
//If the Enter key is pressed in the last column, put focus on the first
part of the next row.
if(KeyCode ==13 && Col == mySheet.LastCol()
&& Row < mySheet.RowCount()) {
mySheet.SelectCell( Row + 1, 2);
}
} | OnLoadData Event
Purpose
Event f ires when the data received from the server are loaded to IBSheet after a data search
method or a data save method is called.
This event can be used when the data received from the server requires editing or interface with
encryption module. |
Syntax
Syntax function Object ID _OnLoadData (Data) { } | Parameters
Parameter Type Description
Data String Search XML or JSON charcter string/object |
Example
function mySheet_On LoadData (data) {
// Decryption
var decrypt_data = fnDecryption(data); | // Return decrypted data
return decrypt_data;
} |
OnLoadExcel Event
Purpose
Event fires after LoadExcel has been completed . | Syntax
Syntax function Object ID _OnLoadExcel (result) { } |
Parameters
Parameter Type Description
result Boolean Loading result. Success : true, Failure : false | Example
function mySheet_On LoadExcel (result) {
if(result) {
alert(‘Excel file loading is completed.');
} else {
alert(‘An error occured while loading an excel file.');
}
} |
OnLoadText Event
Purpose
Event fires after LoadText has been completed . | Syntax
Syntax function Object ID _OnLoadText (result) { } |
Parameters
Parameter Type Description
result Boolean Loading result. Success : true, Failure : false | Example
function mySheet_On LoadText(result) {
if(result) {
alert(‘Text file loading is completed.');
} else {
alert(‘An error occured while loading a text file.');
}
} |
OnMessage Event
Purpose
In case SetShowMsgMode is set as 0, a confirmation or warning message will fire this event
instead of displaying a system pop -up. In case the trigger was a confirmation message, IsConfirm
= 1. Always use ConfirmOK function to return a response to the sheet for such cases. | Syntax
Syntax function Object ID _OnMessage (Msg, Level, IsConfirm) { } |
Parameters
Parameter Type Description
Msg String Message
Level String Message level code
"U" – message is for end users
"E" – message is for developers
"D" – message is concerned with server
connection function page
"X" – MXL parser message of inquiry or save XML
IsConfirm Boolean Confirmation m... | Example
//Configure the message mode.
mySheet.ShowMsgMode=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;');
... | OnMouseDown Event
Purpose
Event fires when mouse is clicked.
To find out cell location on which the mouse is clicked, use MouseRow and MouseCol function s. |
Syntax
Syntax function Object ID _OnMouseDown (Button, Shift, X, Y) { } | Parameters
Parameter Type Description
Button Integer 0 : Left, 2 : Right (Mouse button)
Shift Integer 1 : When a Shift key is pressed
2 : When a Ctrl key is pressed
0 : Others
X Long X coordinate
Y Long Y coordinate |
Example
function mySheet_OnMouseDown(Button, Shift, X, Y) {
//Check the column of the clicked cell
alert(mySheet.MouseRow() + "Row" + mySheet.MouseCol() +
"Column is clicked");
} | OnMouseMove Event
Purpose
Event fires when mouse pointer is moving on the sheet.
To find out the cell location on which mouse pointer is moving, use MouseRow and MouseCol
functions . |
Syntax
Syntax function Object ID _OnMouseMove (Button, Shift, X, Y) { } | Parameters
Parameter Type Description
Button Integer 0 : Left, 2 : Right (Mouse button)
Shift Integer 1 : When a Shift key is pressed
2 : When a Ctrl key is pressed
0 : Others
X Long X coordinate
Y Long Y coordinate |
Example
function mySheet_OnMouseMove(Button, Shift, X, Y) {
//Fetch the row and column values of the mouse pointer location.
var Row = mySheet.MouseRow();
var Col = mySheet.MouseCol();
var sText = mySheet.GetCellText(Row, Col); | //Set the mouse pointer style
//Set a hand mouse pointer only for Column 2 with cell text 2011-07-14
if(Col == 2 && sText == "2011 -07-14") {
mySheet.SetMousePointer("Hand");
} else {
mySheet.SetMousePointer("Default"); // Default
}
} |
OnMouseUp Event
Purpose
Event fires when a clicked mouse button is unclicked .
To find out the cell location on which the mouse is uncli cked, use MouseRow and MouseCol
methods . | Syntax
Syntax function Object ID _OnMouseUp (Button, Shift, X, Y) { } |
Parameters
Parameter Type Description
Button Integer 0 : Left, 2 : Right (Mouse button)
Shift Integer 1 : When a Shift key is pressed
2 : When a Ctrl key is pressed
0 : Others
X Long X coordinate
Y Long Y coordinate | Example
function mySheet_OnMouseUp(Button, Shift, X, Y) {
//Check the column where the mouse is unclicked
alert(mySheet.MouseRow() + "Row" + mySheet.MouseCol() + "Column is
clicked");
} |
OnPageRequest Event
Purpose
Event fires for server paging searches when a request for further loading is sent to the server in
order to reload result page as the scroll r eaches the end. | Syntax
Syntax function Object ID _OnPageRequest (page) { } |
Parameters
Parameter Type Description
page Integer Page number to request | Example
function mySheet_ OnPageRequest (page) {
//Display a warning before page request is sent to the server.
alert(page + “ page will be requested to the server .”);
} |
OnPopupClick Event
Purpose
Event fires when user clicks the pop-up button in the cell that appear s when focus is put on the
cell, or tries to edit the cell , given that a cell type is either Popup or PopupEdit.
User should add a popup invoking logic to this event to enable it. | Syntax
Syntax function Object ID _OnPopupClick (Row, Col) { } |
Parameters
Parameter Type Description
Row Long Row index of the cell
Col Long Column index of the cell | Example
function mySheet_OnPopupClick(Row,Col) {
//Open pop -up.
window.open("Sheet_Popup.jsp?row="+Row+"&col="+Col, "list",
"scrollbars=no,fullscreen=no,width=250,height=350");
} |
OnReadyExcelDown Event
Purpose
After calling Down2Excel to download data into excel format and downloaded data are fetched,
event fires before the form is submitted. Excel download can be successfully completed only
when the form is submitted within this event. | Syntax
Syntax function Object ID _OnReadyExcelDown (frm) { } |
Parameters
Parameter Type Description
frm Object Html Form object | Example
function mySheet_ OnReadyExcelDown (frm) {
//Submit the excel download form.
frm.submit ();
} |
OnResize Event
Purpose
Event fires when the IBSheet width or height has been changed when the width is set as a
relative value to height in percentage . | Syntax
Syntax function Object ID _OnResize (Width, Height) { } |
Parameters
Parameter Type Description
Width Integer Overall width
Height Integer Overall height | Example
function mySheet_OnResize(Width, Height) {
//Readjust the width of columns according to updated information.
mySheet.FitColWidth();
} |
OnRowSearchEnd Event
Purpose
Event fires for each row while data is being searched using DoSearch or LoadSearchData
methods.
This event comes in handy when you want to color font or background of certain cells based on
the data contained in the row. | This event will fire for every row during search. If it is used for com plicated event logic or loop
statement, it may result in slowness of performance . |
Syntax
Syntax function Object ID _OnRowSearchEnd (row) { } | Parameters
Parameter Type Description
row Integer Index of the row |
Example
function mySheet_On RowSearchEnd (row) {
//Change the font color of column 6 to red if column 3 is checked and
column 4 value is bigger than 100.
if( mySheet.GetCellValue( row,3) == 1 && mySheet.GetCellValue(row,4) >
100){
mySheet.SetCellFontColor(row ,6 ,"#FF000 0");
}
} | OnSaveEnd Event
Purpose
Event fires when saving is completed using saving function and other internal processing has
been also completed.
If an error message occurs during saving, it will be set as code, a event parameter. Program an
error processing logic for any code value smaller than 0.
If no result is... |
This event can fire when DoSave or DoAllSave function is called. | Syntax
Syntax function Object ID _OnSaveEnd (Code, Msg, StCode, StMsg ) { } |
Parameters
Parameter Type Description
Code Long Processing result code (0 or higher is success,
others should be processed as error)
Msg String Processing result message
StCode Integer HTTP response code
StMsg String HTTP response message | Example
function mySheet_OnSaveEnd(code, msg) {
if(code >= 0) {
alert(msg); // saving success message
mySheet.DoSearch("list1.jsp");
} else {
alert(msg); // saving failure message
}
}
<?xml version='1.0' ?>
<SHEET><Result Code=" -1" Message= "The slip has been pos... |
OnSearchEnd Event
Purpose
Event fires when search is completed using a search function and other internal data processing
are also completed.
If an error message occurs during searching, it will be set as code, a n event parameter. Program
an error processi ng logic for any code value smaller than 0.
If no... | Syntax
Syntax function Object ID _OnSearchEnd (Code, Msg, StCode, StMsg ) { } |
Parameters
Parameter Type Description
Code Long Processing result code (0 is success, others should
be processed as error)
Msg String Processing result message
StCode Integer HTTP response code
StMsg String HTTP response message | Example
function mySheet_OnSearchEnd(code , message ) {
if(code == 0) {
alert(message );
//Perform post -search tasks
} else {
alert("An error occured during search..");
}
} |
OnSelectMenu Event
Purpose
Given the menu displayed is not a column popup menu but the one set in ActionMenu, event
fires when the user selects a certain menu item.
Texts returned by this event are the same as the characters displayed in the menu list, and they
perform the corresponding functions. | Syntax
Syntax function Object ID _OnSelectMenu (Text, Code ) { } |
Parameters
Parameter Type Description
Text String Selected menu string
Code String Selected menu code string | Example
// Menu setting
mySheet.SetActionMenu("Insert|Copy row| -|Delete row|Clear|Download to
excel"); |
function mySheet_ OnSelectMenu (Text, Code ) {
// Perform action using the text or code value
switch( text) {
case "Insert data to the first row" :
mySheet.DataInsert(0);
break; | case "Insert data to the last row" :
mySheet.DataInsert( -1);
break; |
case "I nsert" :
mySheet.DataInsert();
break; | case "Copy row":
mySheet.DataCopy();
break; |
End of preview. Expand in Data Studio
README.md exists but content is empty.
- Downloads last month
- 1