exceljs#951: Force formula re-calculation on file open from Excel

README.md

@@ -220,6 +220,13 @@ workbook.lastPrinted = new Date(2016, 9, 27);
 workbook.properties.date1904 = true;
 ```
 
+## Set Calculation Properties
+
+```javascript
+// Force workbook calculation on load
+workbook.calcProperties.fullCalcOnLoad = true;
+```
+
 ## Workbook Views
 
 The Workbook views controls how many separate windows Excel will open when viewing the workbook.

index.d.ts

@@ -972,6 +972,11 @@ export interface Worksheet {
 	 */
 	properties: WorksheetProperties;
 
+	/**
+	 * Workbook calculation Properties
+	 */
+	calcProperties: CalculationProperties;
+
 	/**
 	 * Open panes representing the sheet
 	 */
@@ -1169,6 +1174,13 @@ export interface Worksheet {
 	getTable(name: string): Table;
 }
 
+export interface CalculationProperties {
+	/**
+	 * Whether the application shall perform a full recalculation when the workbook is opened
+	 */
+	fullCalcOnLoad: boolean
+}
+
 export interface WorksheetProperties {
 	/**
 	 * Color of the tab

lib/doc/workbook.js

@@ -16,6 +16,7 @@ class Workbook {
     this.created = new Date();
     this.modified = this.created;
     this.properties = {};
+    this.calcProperties = {};
     this._worksheets = [];
     this.views = [];
     this.media = [];
@@ -170,6 +171,7 @@ class Workbook {
       contentStatus: this.contentStatus,
       themes: this._themes,
       media: this.media,
+      calcProperties: this.calcProperties,
     };
   }
 
@@ -191,6 +193,7 @@ class Workbook {
     this.contentStatus = value.contentStatus;
 
     this.properties = value.properties;
+    this.calcProperties = value.calcProperties;
     this._worksheets = [];
     value.worksheets.forEach(worksheetModel => {
       const {id, name, state} = worksheetModel;

lib/stream/xlsx/workbook-writer.js

@@ -265,6 +265,7 @@ WorkbookWriter.prototype = {
       definedNames: this._definedNames.model,
       views: this.views,
       properties: {},
+      calcProperties: {},
     };
 
     return new Promise(resolve => {

lib/xlsx/xform/book/workbook-calc-properties-xform.js

@@ -0,0 +1,26 @@
+const BaseXform = require('../base-xform');
+
+class WorkbookCalcPropertiesXform extends BaseXform {
+    render(xmlStream, model) {
+        xmlStream.leafNode('calcPr', {
+            calcId: 171027,
+            fullCalcOnLoad: model.fullCalcOnLoad ? 1 : undefined,
+        });
+    }
+
+    parseOpen(node) {
+        if (node.name === 'calcPr') {
+            this.model = {};
+            return true;
+        }
+        return false;
+    }
+
+    parseText() {}
+
+    parseClose() {
+        return false;
+    }
+}
+
+module.exports = WorkbookCalcPropertiesXform;

lib/xlsx/xform/book/workbook-xform.js

@@ -10,6 +10,7 @@ const DefinedNameXform = require('./defined-name-xform');
 const SheetXform = require('./sheet-xform');
 const WorkbookViewXform = require('./workbook-view-xform');
 const WorkbookPropertiesXform = require('./workbook-properties-xform');
+const WorkbookCalcPropertiesXform = require('./workbook-calc-properties-xform');
 
 class WorkbookXform extends BaseXform {
   constructor() {
@@ -21,7 +22,7 @@ class WorkbookXform extends BaseXform {
       bookViews: new ListXform({tag: 'bookViews', count: false, childXform: new WorkbookViewXform()}),
       sheets: new ListXform({tag: 'sheets', count: false, childXform: new SheetXform()}),
       definedNames: new ListXform({tag: 'definedNames', count: false, childXform: new DefinedNameXform()}),
-      calcPr: WorkbookXform.STATIC_XFORMS.calcPr,
+      calcPr: new WorkbookCalcPropertiesXform(),
     };
   }
 
@@ -84,7 +85,7 @@ class WorkbookXform extends BaseXform {
     this.map.bookViews.render(xmlStream, model.views);
     this.map.sheets.render(xmlStream, model.sheets);
     this.map.definedNames.render(xmlStream, model.definedNames);
-    this.map.calcPr.render(xmlStream);
+    this.map.calcPr.render(xmlStream, model.calcProperties);
 
     xmlStream.closeNode();
   }
@@ -125,6 +126,7 @@ class WorkbookXform extends BaseXform {
           sheets: this.map.sheets.model,
           properties: this.map.workbookPr.model || {},
           views: this.map.bookViews.model,
+          calcProperties: {},
         };
         if (this.map.definedNames.model) {
           this.model.definedNames = this.map.definedNames.model;
@@ -231,7 +233,6 @@ WorkbookXform.STATIC_XFORMS = {
     tag: 'fileVersion',
     $: {appName: 'xl', lastEdited: 5, lowestEdited: 5, rupBuild: 9303},
   }),
-  calcPr: new StaticXform({tag: 'calcPr', $: {calcId: 171027}}),
 };
 
 module.exports = WorkbookXform;

lib/xlsx/xlsx.js

@@ -252,6 +252,7 @@ class XLSX {
                 model.definedNames = workbook.definedNames;
                 model.views = workbook.views;
                 model.properties = workbook.properties;
+                model.calcProperties = workbook.calcProperties;
                 break;
               }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "exceljs",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Excel Workbook Manager - Read and Write xlsx and csv Files.",
   "private": false,
   "license": "MIT",

spec/unit/xlsx/xform/book/data/book.1.1.json

@@ -9,5 +9,8 @@
   ],
   "properties": {
   	"date1904": true
+  },
+  "calcProperties": {
+    "fullCalcOnLoad": true
   }
 }

spec/unit/xlsx/xform/book/data/book.1.2.xml

@@ -10,5 +10,5 @@
         <sheet name="Hidden" sheetId="2" r:id="rId2" state="hidden"/>
         <sheet name="VeryHidden" sheetId="3" r:id="rId3" state="veryHidden"/>
     </sheets>
-    <calcPr calcId="171027"/>
+    <calcPr calcId="171027" fullCalcOnLoad="1"/>
 </workbook>

spec/unit/xlsx/xform/book/data/book.1.3.json

@@ -9,5 +9,6 @@
   ],
   "properties": {
   	"date1904": true
-  }
+  },
+  "calcProperties": {}
 }

spec/unit/xlsx/xform/book/data/book.2.3.json

@@ -5,5 +5,6 @@
   "sheets": [
     {"name": "Values", "id": 1, "rId": "rId1"}
   ],
-  "properties": {}
-}
+  "properties": {},
+  "calcProperties": {}
+}

spec/unit/xlsx/xform/book/workbook-calc-properties-xform.spec.js

@@ -0,0 +1,32 @@
+const testXformHelper = require('./../test-xform-helper');
+
+const WorkbookCalcPropertiesXform = verquire('xlsx/xform/book/workbook-calc-properties-xform');
+
+const expectations = [
+    {
+        title: 'default',
+        create() {
+            return new WorkbookCalcPropertiesXform();
+        },
+        preparedModel: {},
+        xml:
+            '<calcPr calcId="171027"></calcPr>',
+        parsedModel: {},
+        tests: ['render', 'renderIn'],
+    },
+    {
+        title: 'fullCalcOnLoad',
+        create() {
+            return new WorkbookCalcPropertiesXform();
+        },
+        preparedModel: {fullCalcOnLoad: true},
+        xml:
+            '<calcPr calcId="171027" fullCalcOnLoad="1"></calcPr>',
+        parsedModel: {},
+        tests: ['render', 'renderIn', 'parse'],
+    },
+];
+
+describe('WorkbookCalcPropertiesXform', () => {
+    testXformHelper(expectations);
+});