TSService.getSetSortSettings

Syntax

getSetSortSettings (wbk, sortingEnabled, reverseHeader, direction, column);

Parameters

wbk. Sets workbook, an instance of the Workbook class.

sortingEnabled. Indicates that sorting is enabled.

reverseHeader. Sets order of calendar items.

direction. Sets sorting direction.

column. Sets sorting column.

Description

The getSetSortSettings method returns body of a sorting request.

Comments

The reverseHeader parameter may take the following values:

False - direct date order (ascending).
True - reverse date order (descending).

Example

To execute the example, the page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component), and also add the following code in the handler, that processes document opening event:

	var wbk = args.Workbook;
	//Set parameter that enables sorting
	var sortingEnabled = True;
	//Set order of calendar elements
	var reverseHeader = False;
	//Set sorting direction
	var direction = 'west';
	//Set sorting column
	var column=0;
	//Return body of sorting request
	var sortSettings=tsService.getSetSortSettings(wbk,sortingEnabled,reverseHeader,direction,column);
	//Execute request
	tsService._invokeRemoteProc(wbk, sortSettings, PP.Delegate(onResponse, this));
	//Response get handler
	function onResponse(sender, args){
		alert(args.ResponseText);
	}

After executing the example the WorkbookBox component is placed on the HTML page and the sorting request body is shown as a message.