Namespace: scriptlist

otris. scriptlist

Classes

Column
List
Row
RowUpdate
Subrow

Methods

staticotris.scriptlist.getScriptListEvent(){Object|undefined}

Returns the ScriptList event. See addListener for details.
Notice: Returns undefined if the script was not triggered by an event.

  • Since:
    • Documents 5.0d
Returns:
Type Description
Object | undefined ScriptList event object

staticotris.scriptlist.MoveRowResult(result)

Result to be returned after move row with moveRowsRemote enabled. This will cause the scriptlist to approve/deny rendering the row at the new position without rerendering the whole scriplist.
If no message will be displayed the script may also just return "MOVE_ROW_SUCCESS" or "MOVE_ROW_DENIED".

Name Type Description
result Object

Move row result options

Name Type Description
success Boolean

Move row was successfull.

message String optional

Detailed message why moving the row failed/succeded.

  • Since:
    • Documents 5.0e
Examples

Move row was denied with message being displayed:

var event = otris.scriplist.getScriptListEvent();
if (event.name === "moveRow" && moveDenied) {
	return new otris.scriptlist.MoveRowResult({ success: false, message: "The row can't be moved to this position." })
}
// ...

Simple success and deny move row:

if (event.name === "moveRow") {
	if(moveDenied) {
		return "MOVE_ROW_DENIED";
	}
	else {
		return "MOVE_ROW_SUCCESS";
	}
}
// ...