SerieRevisionsPanel.NeedRefresh

Syntax

NeedRefresh: Boolean;

Description

The NeedRefresh property determines whether it is necessary to get requests of new revisions list and panel update from server.

Comments

If this property is set to True, on saving workbook data to the server the revision panel sends a request to get new revisions on changing selection in the spreadsheet. If this property is False -the panel does not send a request.

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:

//Get workbook properties panel
var propertyBar = workbookBox.getPropertyBarView(); 
//Get the Revisions panel of the Series tab
var serieRevisionsPanel =  propertyBar.getSerieRevisionsPanel();
var updateSerieListSelectionButt = new PP.Ui.Button({
	ParentNode: document.body, //DOM parent node
	Content: "Refresh selection in the list of revisions", //Text
	Click: PP.Delegate(onClickUpdateSerieListSelection)
});
function onClickUpdateSerieListSelection(){
	serieRevisionsPanel.updateSerieListSelection();
	alert(serieRevisionsPanel.getNeedRefresh());
}

After executing the example the button named Refresh Selection in Revisions List is placed in the HTML page. On clicking this button selection in revisions list is refreshed, and value of the NeedRefresh property is shown. By default the properties are set to False. On changing workbook data, such as changing value in a table cell, if the user clicks the Save Changes button in the Data ribbon tab, this property is set to True.

See also:

SerieRevisionsPanel