/* Version: 16.0.7524.3000 */ /* Copyright (c) Microsoft Corporation. All rights reserved. */ /* Your use of this file is governed by the Microsoft Services Agreement http://go.microsoft.com/fwlink/?LinkId=266419. */ /// Office._ExcelMask = 0x1; Office._WordMask = 0x2; Office._ProjectMask = 0x4; Office._OutlookMask = 0x8; Office._PowerPointMask = 0x10; Office._OutlookComposeMask = 0x20; Office._AccessWebAppMask = 0x40; { Office._extractedCallback = function (originalArgs, totalArgsCount, optionalArgsCount) { var optionalArgs = Array.prototype.slice.call(originalArgs, totalArgsCount - optionalArgsCount); var callback = function(){}; for (var i = Math.min(optionalArgs.length, optionalArgsCount) - 1; i >= 0; i--) { if (typeof optionalArgs[i] == "function") { callback = optionalArgs[i]; break; } } return callback; } Office._BindingDataChangedEvents = function (eventType) { this.binding = new Office._Binding(bindingType); this.type = eventType; this.startColumn = {}; this.startRow = {}; } Office._DocumentEventArgs = function (eventType) { Office._processContents(this, { type: { annotate: { /// type: undefined }, value: eventType } }); if (eventType == "activeViewChanged") { Office._processItem( this, { annotate: { /// activeView: undefined } }, "activeView" ); } } Office._DialogEventArgs = function (eventType) { Office._processContents(this, { type: { annotate: { /// type: undefined }, value: eventType } }); if (eventType == "dialogMessageReceived") { Office._processItem( this, { annotate: { /// message: undefined } }, "message" ); } else if (eventType == "dialogEventReceived") { Office._processItem( this, { annotate: { /// error: undefined } }, "error" ); } } Office._CustomXmlNodeEvents = function (eventType) { this.type = eventType; this.inUndoRedo = {}; if (eventType == 'nodeDeleted') { this.oldNode = new Office._CustomXmlNode(); this.oldNextSibling = new Office._CustomXmlNode(); } if (eventType == 'nodeInserted') { this.newNode = new Office._CustomXmlNode(); } if (eventType == 'nodeReplaced') { this.oldNode = new Office._CustomXmlNode(); this.newNode = new Office._CustomXmlNode(); } } Office._Error = function () { this.id = {}; this.message = {}; this.name = {}; } Office._CustomXmlNode = function () { this.baseName = {}; this.namespaceUri = {}; this.nodeType = {}; this.getNodesAsync = function (xPath, callback) { /// Gets the nodes associated with the xPath expression. ///The xPath expression ///The optional callback method var result = new Office._AsyncResult("getNodesAsync"); callback(result); }; this.getNodeValueAsync = function (callback) { /// Gets the node value. ///The optional callback method var result = new Office._AsyncResult("getNodeValueAsync"); callback(result); }; this.getXmlAsync = function (callback) { /// Gets the node's XML. ///The optional callback method var result = new Office._AsyncResult("getXmlAsync"); callback(result); }; this.setNodeValueAsync = function (value, callback) { /// Sets the node value. ///The value to be set on the node ///The optional callback method var result = new Office._AsyncResult("setNodeValueAsync"); callback(result); }; this.setXmlAsync = function (xml, callback) { /// Sets the node XML. ///The XML to be set on the node ///The optional callback method var result = new Office._AsyncResult("setXmlAsync"); callback(result); }; } Office._context_document_customXmlParts_customXmlPrefixMappings = function () { this.addNamespaceAsync = function (prefix, nsUri, callback) { ///Adds a namespace. //////The namespace prefix //////The namespace URI ///The optional callback method var result = new Office._AsyncResult("addNamespaceAsync"); callback(result); }; this.getNamespaceAsync = function (prefix, callback) { /// Gets a namespace with the specified prefix ///The namespace prefix ///The optional callback method var result = new Office._AsyncResult("getNamespaceAsync"); callback(result); }; this.getPrefixAsync = function (nsUri, callback) { /// Gets a prefix for the specified URI ///The namespace URI ///The optional callback method var result = new Office._AsyncResult("getPrefixAsync"); callback(result); }; } Office._CustomXmlPart = function () { this.builtIn = {}; this.id = {}; this.namespaceManager = new Office._context_document_customXmlParts_customXmlPrefixMappings(); this.deleteAsync = function (callback) { /// Deletes the Custom XML Part. ///The optional callback method var result = new Office._AsyncResult("deleteAsync"); callback(result); }; this.getNodesAsync = function (xPath, callback) { /// Gets the nodes associated with the xPath expression. ///The xPath expression ///The optional callback method var result = new Office._AsyncResult("getNodesAsync"); callback(result); }; this.getXmlAsync = function (callback) { /// Gets the XML for the Custom XML Part. ///The optional callback method var result = new Office._AsyncResult("getXmlAsync"); callback(result); }; this.addHandlerAsync = function (eventType, handler, callback) { /// Adds an event handler to the object using the specified event type. ///The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced' ///The name of the handler ///The optional callback method var events = new Office._CustomXmlNodeEvents(eventType); handler(events); var result = new Office._AsyncResult("addHandlerAsync"); callback(result); }; this.removeHandlerAsync = function (eventType, options, callback) { /// Removes an event handler from the object using the specified event type. ///The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced' /// /// Syntax example: {handler:eventHandler} /// handler: Indicates a specific handler to be removed, if not specified all handlers are removed /// asyncContext: Object keeping state for the callback /// ///The optional callback method /// Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("removeHandlerAsync")); } } Office._Binding = function (bindingType) { ///Id of the Binding}; this.id = {}; this.type = {}; this.document = {}; this.setDataAsync = function (data, options, callback) { /// Writes the specified data into the current selection. ///The data to be set. Either a string or value, 2d array or TableData object /// /// Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'} /// coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type. /// startRow: Used in partial set for table/matrix. Indicates the start row. /// startColumn: Used in partial set for table/matrix. Indicates the start column. /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("setDataAsync")); }; this.getDataAsync = function (options, callback) { /// Returns the current selection. /// /// Syntax example: {coercionType: 'matrix,'valueFormat: 'formatted', filterType:'all'} /// coercionType: The expected shape of the selection. If not specified returns the bindingType shape. Use Office.CoercionType or text value. /// valueFormat: Get data with or without format. Use Office.ValueFormat or text value. /// startRow: Used in partial get for table/matrix. Indicates the start row. /// startColumn: Used in partial get for table/matrix. Indicates the start column. /// rowCount: Used in partial get for table/matrix. Indicates the number of rows from the start row. /// columnCount: Used in partial get for table/matrix. Indicates the number of columns from the start column. /// filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value. /// asyncContext: Object keeping state for the callback /// ///The optional callback method if (arguments.length == 1) { callback = options; } var result = new Office._AsyncResult("getDataAsync", options.coercionType); callback(result); }; this.addHandlerAsync = function (eventType, handler, callback) { /// Adds an event handler to the object using the specified event type. ///The event type. For binding it can be 'bindingDataChanged' and 'bindingSelectionChanged' ///The name of the handler ///The optional callback method var events = new Office._BindingDataChangedEvents(eventType); handler(events); var result = new Office._AsyncResult("addHandlerAsync"); callback(result); }; this.removeHandlerAsync = function (eventType, options, callback) { /// Removes an event handler from the object using the specified event type. ///The event type. For binding can be 'bindingDataChanged' and 'bindingSelectionChanged' /// /// Syntax example: {handler:eventHandler} /// handler: Indicates a specific handler to be removed, if not specified all handlers are removed /// asyncContext: Object keeping state for the callback /// ///The optional callback method var events = new Office._BindingDataChangedEvents(eventType); handler(events); Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("removeHandlerAsync")); }; if ((bindingType == undefined) || (bindingType == Office.BindingType.Matrix) || (bindingType == Office.BindingType.Table)) { this.columnCount = {}; this.rowCount = {}; } if ((bindingType == undefined) || (bindingType == Office.BindingType.Table)) { Office._processContents(this, { hasHeaders: { value: {} }, addRowsAsync: { value: function (data, callback) { /// Adds the specified rows to the table /// A 2D array with the rows to add ///The optional callback method } }, addColumnsAsync: { value: function (tableData, callback) { /// Adds the specified columns to the table /// A TableData object with the headers and rows ///The optional callback method}; } }, deleteAllDataValuesAsync: { value: function (callback) { /// Clears the table ///The optional callback method}; } }, formattingSpecific: { metaOnly: true, conditions: { hosts: ["excel"], }, contents: { clearFormatsAsync: { conditions: { reqs: ["method TableBinding.clearFormatsAsync"] }, value: function (options, callback) { /// Clears formatting on the bound table. /// /// Syntax example: {asyncContext:context} /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("clearFormatsAsync")); } }, getFormatsAsync: { conditions: { reqs: ["method TableBinding.getFormatsAsync"] }, value: function (cellReference, formats, options, callback) { /// Gets the formatting on specified items in the table. ///An object literal containing name-value pairs that specify the range of cells to get formatting from. ///An array specifying the format properties to get. /// /// Syntax example: {asyncContext:context} /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 4, 4)(new Office._AsyncResult("getFormatsAsync")); } }, setFormatsAsync: { conditions: { reqs: ["method TableBinding.setFormatsAsync"] }, value: function (formatsInfo, options, callback) { /// Sets formatting on specified items and data in the table. /// /// Array elements are themselves three-element arrays: /// [target, type, formats] /// target: The identifier of the item to format. String. /// type: The kind of item to format. String. /// formats: An object literal containing a list of property name-value pairs that define the formatting to apply. /// /// /// Syntax example: {asyncContext:context} /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 3, 3)(new Office._AsyncResult("setFormatsAsync")); } }, setTableOptionsAsync: { conditions: { reqs: ["method TableBinding.setTableOptionsAsync"] }, value: function (tableOptions, options, callback) { /// Updates table formatting options on the bound table. ///An object literal containing a list of property name-value pairs that define the table options to apply. /// /// Syntax example: {asyncContext:context} /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("setTableOptionsAsync")); } } } } }); } } Office._TableData = function () { this.headers = new Array(new Array()); this.rows = new Array(new Array()); } Office._File = function () { this.size = {}; this.sliceCount = {}; this.getSliceAsync = function (sliceIndex, callback) { /// Gets the specified slice. ///The index of the slice to be retrieved ///The optional callback method var result = new Office._AsyncResult("getSliceAsync"); callback(result); }; this.closeAsync = function (callback) { /// Closes the File. ///The optional callback method }; } Office._Slice = function () { this.data = {}; this.index = {}; this.size = {}; } Office._Dialog = function () { this.data = {}; this.close = function () { /// Allows the add-in to close its dialog box. }; this.addEventHandler = function (eventType, handler) { /// Registers an event handler. /// The two supported events are: DialogMessageReceived or DialogEventReceived /// The name of the handler handler(new Office._DialogEventArgs(eventType)); }; } Office._AsyncResult = function (method, bindingType) { this.asyncContext = {}; this.error = new Office._Error(); this.status = {}; if ((method == "addfromSelectionAsync") || (method == "addFromNamedItemAsync") || (method == "getByIdAsync") || (method == "addFromPromptAsync")) { this.value = new Office._Binding(bindingType); } else if ((method == "getDataAsync") || (method == "getSelectedDataAsync")) { if (bindingType == "table") this.value = new Office._TableData(); else if (bindingType == "matrix") this.value = new Array(new Array); else this.value = {}; } else if (method == "getAllAsync") { this.value = new Array(new Office._Binding(bindingType)); } else if (method == "getByNamespaceAsync") { this.value = new Array(new Office._CustomXmlPart()); } else if (method == "getNodesAsync") { this.value = new Array(new Office._CustomXmlNode()); } else if ((method == "XMLgetByIdAsync") || (method == "addAsync")) { this.value = new Office._CustomXmlPart(); } else if (method == "refreshAsync") { this.value = new Office._context_document_settings(); } else if (method == "getFileAsync") { this.value = new Office._File(); } else if (method == "getSliceAsync") { this.value = new Office._Slice(); } else if (method == "getActiveViewAsync") { Office._processItem(this, { annotate: { ///The presentation's current view. value: undefined } }, "value" ); } else if (method == "getFilePropertiesAsync") { this.value = new Office._FileProperties(); } else if (method == "displayDialogAsync") { this.value = new Office._Dialog(); }else { this.value = {}; } } Office._FileProperties = function () { ///File's URL this.url = ""; } Office._context_document_settings = function () { this.get = function (settingName) { ///Retrieves the setting with the specified name. ///The name of the setting }; this.remove = function (settingName) { ///Removes the setting with the specified name. ///The name of the setting /// }; this.saveAsync = function (options, callback) { ///Saves all settings. /// /// Syntax example: {overwriteIfStale:false} /// overwriteIfStale: Indicates whether the setting will be replaced if stale. /// asyncContext: Object keeping state for the callback /// ///The optional callback method /// Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("saveAsync", coercionType)); }; this.set = function (settingName, value) { ///Sets a value for the setting with the specified name. ///The name of the setting ///The value for the setting }; }; Office._context_document_bindings = function () { this.document = {}; if (Office._AccessWebAppMask & Office._appContext) { this.addFromSelectionAsync = function (bindingType, options, callback) { ///Create a binding based on what the user's current selection. ///The Office BindingType for the data /// /// addFromSelectionAsyncOptions- e.g. {id: "BindingID"} /// id: Identifier. /// asyncContext: Object keeping state for the callback /// columns: The string[] of the columns involved in the binding /// sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string. /// ///The optional callback method if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("addfromSelectionAsync", bindingType); callback(result); } } else { this.addFromSelectionAsync = function (bindingType, options, callback) { ///Create a binding based on what the user's current selection. ///The Office BindingType for the data /// /// addFromSelectionAsyncOptions- e.g. {id: "BindingID"} /// id: Identifier. /// asyncContext: Object keeping state for the callback /// ///The optional callback method if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("addfromSelectionAsync", bindingType); callback(result); } } if (Office._AccessWebAppMask & Office._appContext) { this.addFromNamedItemAsync = function (itemName, bindingType, options, callback) { ///Creates a binding against a named object in the document ///Name of the bindable object in the document. For Example 'MyExpenses' table in Excel." ///The Office BindingType for the data /// /// Syntax example: {id: "BindingID"} /// id: Name of the binding, autogenerated if not supplied. /// asyncContext: Object keeping state for the callback /// columns: The string[] of the columns involved in the binding /// ///The optional callback method if (arguments.length == 3) { callback = options; }; var result = new Office._AsyncResult("addFromNamedItemAsync", bindingType); callback(result); } } else { this.addFromNamedItemAsync = function (itemName, bindingType, options, callback) { ///Creates a binding against a named object in the document ///Name of the bindable object in the document. For Example 'MyExpenses' table in Excel." ///The Office BindingType for the data /// /// Syntax example: {id: "BindingID"} /// id: Name of the binding, autogenerated if not supplied. /// asyncContext: Object keeping state for the callback /// ///The optional callback method if (arguments.length == 3) { callback = options; }; var result = new Office._AsyncResult("addFromNamedItemAsync", bindingType); callback(result); } } this.getByIdAsync = function (id, callback) { ///Retrieves a binding based on its Name ///The binding id ///The optional callback method var result = new Office._AsyncResult("getByIdAsync") callback(result); } this.getAllAsync = function (callback) { ///Gets an array with all the binding objects in the document. ///The optional callback method var result = new Office._AsyncResult("getAllAsync") callback(result); }; this.releaseByIdAsync = function (id, callback) { ///Removes the binding from the document ///The binding id ///The optional callback method var result = new Office._AsyncResult("releaseByIdAsync") callback(result); }; if (Office._AccessWebAppMask & Office._appContext) { this.addFromPromptAsync = function (bindingType, options, callback) { ///(Access only with sample data) Create a binding by prompting the user to make a selection on the document. ///The Office BindingType for the data /// /// addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"} /// promptText: Greet your users with a friendly word. /// asyncContext: Object keeping state for the callback /// id: Identifier. /// sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string. /// ///The optional callback method if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("addFromPromptAsync", bindingType) callback(result); } } else if (Office._ExcelMask & Office._appContext) { this.addFromPromptAsync = function (bindingType, options, callback) { ///(Excel only) Create a binding by prompting the user to make a selection on the document. ///The Office BindingType for the data /// /// addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"} /// promptText: Greet your users with a friendly word. /// asyncContext: Object keeping state for the callback /// id: Identifier. /// ///The optional callback method if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("addFromPromptAsync", bindingType) callback(result); } } }; Office._context_ui = { displayDialogAsync: { value: function (startAddress, options, callback) { /// Displays a dialog box in an Office host. /// Accepts the initial HTTPS(TLS) URL that opens in the dialog box. /// /// Syntax example: {width:80} /// width: Defines the width of the dialog box as a percentage of the current display. /// height: Defines the height of the dialog box as a percentage of the current display. /// displayInIFrame: false (defult): The dialog will be displayed as a new browser window /// true: The dialog will be displayed as a floating overlay with an IFrame. /// ///The optional callback method /// if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("displayDialogAsync"); callback(result); } }, messageParent: { value: function (messageObject) { /// Delivers a message from the dialog box to its parent/opener page. The page calling this API must be on the same domain as the parent. /// Accepts a message from the dialog box to deliver to the add-in. } } } Office._context_document = { mode: { annotate: { //Gets the document mode mode: undefined } }, url: { annotate: { //Gets the document URL url: undefined } }, addHandlerAsync: { value: function (eventType, handler, callback) { /// Adds an event handler for the specified event type. ///The event type. For document can be 'DocumentSelectionChanged' ///The name of the handler ///The optional callback method var result = new Office._AsyncResult("addHandlerAsync"); callback(result); handler(new Office._DocumentEventArgs(eventType)); } }, removeHandlerAsync: { value: function (eventType, handler, callback) { /// Removes an event handler for the specified event type. ///The event type. For document can be 'DocumentSelectionChanged' ///The name of the handler. If not specified all handlers are removed ///The optional callback method /// var result = new Office._AsyncResult("removeHandlerAsync", coercionType); callback(result); } }, settings: { conditions: { hosts: ["word", "excel", "ppt", "accesswebapp"], reqs: [ "set Settings GE 1.1", "method Settings.get", "method Settings.remove", "method Settings.saveAsync", "method Settings.set" ] }, value: new Office._context_document_settings() }, refreshableSettings: { name: "settings", conditions: { hosts: ["excel", "ppt", "accesswebapp"], reqs: [] }, partialConditions: true, contents: { addHandlerAsync: { conditions: { reqs: ["method Settings.addHandlerAsync"] }, value: function (eventType, handler, callback) { /// Adds an event handler for the object using the specified event type. ///The event type. For settings can be 'settingsChanged' ///The name of the handler ///The optional callback method var result = new Office._AsyncResult("addHandlerAsync", coercionType); callback(result); } }, refreshAsync: { conditions: { reqs: ["method Settings.refreshAsync"] }, value: function (callback) { ///Gets the latest version of the settings object. ///The optional callback method var result = new Office._AsyncResult("refreshAsync", coercionType); callback(result); } }, removeHandlerAsync: { conditions: { reqs: ["method Settings.removeHandlerAsync"] }, value: function (eventType, handler, callback) { /// Removes an event handler for the specified event type. ///The event type. For settings can be 'settingsChanged' /// /// Syntax example: {handler:eventHandler} /// handler: Indicates a specific handler to be removed, if not specified all handlers are removed /// asyncContext: Object keeping state for the callback /// ///The optional callback method var result = new Office._AsyncResult("removeHandlerAsync", coercionType); callback(result); } } } }, setSelectedDataAsync: { conditions: { hosts: ["word", "excel", "ppt"], reqs: ["set Selection GE 1.1", "method Document.setSelectedDataAsync"] }, value: function (data, options, callback) { /// Writes the specified data into the current selection. ///The data to be set. Either a string or value, 2d array or TableData object /// /// Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'} /// coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type. /// imageLeft: Used for image. Sets the left position of the image. /// imageTop: Used for image. Sets the top position of the image. /// imageWidth: Used for image. Sets the width of the image. /// imageHeight: Used for image. Sets the height of the image. /// asyncContext: Object keeping state for the callback /// ///The optional callback method /// if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("setSelectedDataAsync"); callback(result); } }, bindings: { conditions: { hosts: ["word", "excel", "accesswebapp"], reqs: [ "set TextBindings GE 1.1", "set TableBindings GE 1.1", "set MatrixBindings GE 1.1", "method Bindings.addFromPromptAsync", "method Bindings.addFromNamedItemAsync", "method Bindings.addFromSelectionAsync", "method Bindings.getAllAsync", "method Bindings.getByIdAsync", "method Bindings.releaseByIdAsync", "method MatrixBinding.getDataAsync", "method MatrixBinding.setDataAsync", "method TableBinding.clearFormatsAsync", "method TableBinding.setFormatsAsync", "method TableBinding.setTableOptionsAsync", "method TableBinding.addColumnsAsync", "method TableBinding.addRowsAsync", "method TableBinding.deleteAllDataValuesAsync", "method TableBinding.getDataAsync", "method TableBinding.setDataAsync", "method TextBinding.getDataAsync", "method TextBinding.setDataAsync" ] }, value: new Office._context_document_bindings() }, getFileAsync: { conditions: { hosts: ["word", "ppt","excel"], reqs: ["set File GE 1.1", "method Document.getFileAsync", "method File.closeAsync", "method File.getSliceAsync"] }, value: function (fileType, options, callback) { ///(Word and PowerPoint only) Gets the entire file in slices of up to 4MB. ///The format in which the file will be returned /// /// Syntax example: {sliceSize:1024} /// sliceSize: Specifies the desired slice size (in bytes) up to 4MB. If not specified a default slice size of 4MB will be used. /// ///The optional callback method if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("getFileAsync"); callback(result); } }, getSelectedDataAsync: { conditions: { hosts: ["excel", "word", "project", "ppt"], reqs: ["set Selection GE 1.1", "method Document.getSelectedDataAsync"] }, value: function (coercionType, options, callback) { /// Returns the current selection. ///The expected shape of the selection. /// /// Syntax example: {valueFormat: 'formatted', filterType:'all'} /// valueFormat: Get data with or without format. Use Office.ValueFormat or text value. /// filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value. /// asyncContext: Object keeping state for the callback /// ///The optional callback method /// if (arguments.length == 2) { callback = options; }; var result = new Office._AsyncResult("getSelectedDataAsync", coercionType); callback(result); } }, customXmlParts: { conditions: { hosts: ["word"], reqs: [ "set CustomXmlParts GE 1.1", "method CustomXmlNode.getNodesAsync", "method CustomXmlNode.getNodeValueAsync", "method CustomXmlNode.getXmlAsync", "method CustomXmlNode.setNodeValueAsync", "method CustomXmlNode.setXmlAsync", "method CustomXmlPart.addHandlerAsync", "method CustomXmlPart.deleteAsync", "method CustomXmlPart.getNodesAsync", "method CustomXmlPart.getXmlAsync", "method CustomXmlPart.removeHandlerAsync", "method CustomXmlPrefixMappings.addNamespaceAsync", "method CustomXmlPrefixMappings.getNamespaceAsync", "method CustomXmlPrefixMappings.getPrefixAsync" ] }, partialConditions: true, contents: { addAsync: { conditions: { reqs: ["method CustomXmlParts.addAsync"] }, value: function (xml, callback) { ///(Word Only) Asynchronously adds a new custom XML part to a file. ///The XML to add to the newly created custom XML part. ///A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. var result = new Office._AsyncResult("addAsync"); callback(result); } }, getByIdAsync: { conditions: { reqs: ["method CustomXmlParts.getByIdAsync"] }, value: function (id, callback) { ///(Word Only) Asynchronously gets the specified custom XML part by its id. ///The id of the custom XML part. ///A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. var result = new Office._AsyncResult("XMLgetByIdAsync"); callback(result); } }, getByNamespaceAsync: { conditions: { reqs: ["method CustomXmlParts.getByNamespaceAsync"] }, value: function (ns, callback) { ///(Word Only) Asynchronously gets the specified custom XML part(s) by its namespace. /// The namespace to search. ///A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. var result = new Office._AsyncResult("getByNamespaceAsync"); callback(result); } } } }, getActiveViewAsync: { conditions: { hosts: ["ppt"], reqs: ["set ActiveView GE 1.1", "method Document.getActiveViewAsync"] }, value: function(options, callback) { ///(PowerPoint only) Returns the current view of the presentation. /// /// Syntax example: {asyncContext:context} /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("getActiveViewAsync")); } }, getFilePropertiesAsync: { conditions: { hosts: ["word", "ppt", "excel"], reqs: ["method Document.getFilePropertiesAsync"] }, value: function(options, callback) { ///Gets file properties of the current document. /// /// Syntax example: {asyncContext:context} /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("getFilePropertiesAsync")); } }, goToByIdAsync: { conditions: { hosts: ["excel", "ppt", "word"], reqs: ["method Document.goToByIdAsync"] }, value: function(id, goToType, options, callback) { ///Goes to the specified object or location in the document. ///The identifier of the object or location to go to. ///The type of the location to go to. /// /// Syntax example: {asyncContext:context} /// selectionMode: (Word only) Use Office.SelectionMode or text value. /// asyncContext: Object keeping state for the callback /// ///The optional callback method Office._extractedCallback(arguments, 4, 2)(new Office._AsyncResult("goToByIdAsync")); } } } } Office._items = { context: { contents: { contentLanguage: {}, displayLanguage: {}, license: { contents: { value: { annotate: { //License summary. value: undefined } } } }, document: { conditions: { hosts: ["not outlook; not outlookcompose"] }, annotate: { // Office Document document: undefined }, contents: Office._context_document }, officeTheme: { conditions: { hosts: ["excel", "outlook", "powerpoint", "project", "word"] }, annotate: { officeTheme: undefined }, contents: { "bodyBackgroundColor": {}, "bodyForegroundColor": {}, "controlBackgroundColor": {}, "controlForegroundColor": {} } }, touchEnabled: {}, commerceAllowed : {}, requirements: { annotate: { // Checks whether a given requirement set is supported by the current host. requirements: undefined }, contents: { isSetSupported: { value: function (name, minVersion) { /// Check if the specified requirement set is supported by the host Office application /// Set name. e.g.: "MatrixBindings" /// The minimum required version } }, } }, ui: { conditions: { reqs: ["set DialogAPI GE 1.1"] }, annotate: { // Office UI ui: undefined }, contents: Office._context_ui } } }, initialize: { value: function (reason) { /// This method is called after the Office API was loaded. /// Indicates how the app was initialized } }, useShortNamespace: { value: function (useShortNamespace) { /// Indicates if the large namespace for objects will be used or not. /// Indicates if 'true' that the short namespace will be used } }, select: { conditions: { hosts: ["not outlook; not outlookcompose"] }, value: function (expression, callback) { /// Returns a promise of an object described in the expression. Callback is invoked only if method fails. ///The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName' ///The optional callback method /// var result = new Office._AsyncResult("select"); callback(result); return (new Office._Binding()); } }, TableData: { conditions: { hosts: ["word", "excel", "accesswebapp"], reqs: ["set TableBindings GE 1.1"] }, value: new Office._TableData() } }; /*Infrastructure***************************************************************/ Office._processItem = function (target, item, key, suppressConditionCheck) { var conditionsFulfilled = suppressConditionCheck || Office._filterManager._checkCondition(item.conditions); if (!(conditionsFulfilled || item.partialConditions)) { return false; } suppressConditionCheck = suppressConditionCheck || conditionsFulfilled && item.partialConditions; if (item.setup) { item.setup(); } if (item.metaOnly) { return Office._processContents(target, item.contents, suppressConditionCheck); } key = item.name || key; var areItemsAdded = false; if (item.hasOwnProperty("value")) { target[key] = item.value; areItemsAdded = true; } else if (typeof item.contents == "function") { target[key] = item.contents(); areItemsAdded = true; } else { target[key] = target[key] || {}; if (Office._processContents(target[key], item.contents, suppressConditionCheck) || conditionsFulfilled) { areItemsAdded = true; } else { delete target[key]; } } if (item.annotate) { intellisense.annotate(target, item.annotate); areItemsAdded = true; } return areItemsAdded; } Office._processContents = function (target, contents, suppressConditionCheck) { if (typeof contents !== "object") { return false; } var areItemsAdded = false; for (var item in contents) { areItemsAdded = Office._processItem(target, contents[item], item, suppressConditionCheck) || areItemsAdded; } return areItemsAdded; } Office._filterManager = (function () { var filters = []; return { _checkCondition: function (condition) { if (!condition) return true; var answer = true; for (var i = 0; i < filters.length; i++) { var filter = filters[i]; var conditionForThisFilter = condition[filter.identifier]; if (conditionForThisFilter && filter.isEnabled()) { var thisFiltersAnswer = false; for (var j = 0; j < conditionForThisFilter.length; j++) { var productTerm = conditionForThisFilter[j].split(';'); var thisTermsAnswer = true; for (var k = 0; k < productTerm.length; k++) { var singleCondition = productTerm[k].toUpperCase().trim(); var invert = false; if (singleCondition.indexOf("NOT") != -1) { invert = true; singleCondition = singleCondition.slice(singleCondition.indexOf(" ")).trim(); } var result = filter.isConditionTrue(singleCondition, invert); thisTermsAnswer = thisTermsAnswer && result; } thisFiltersAnswer = thisFiltersAnswer || thisTermsAnswer; } answer = answer && thisFiltersAnswer; } if (!answer) break; } return answer; }, _pushFilter: function (identifier, filteringDelegate, isEnabledDelegate) { filters.push({ identifier: identifier, isConditionTrue: filteringDelegate, isEnabled: isEnabledDelegate }); } } })(); Office._filterManager._pushFilter( "hosts", (function () { var nameToMaskMapping = { EXCEL: Office._ExcelMask, WORD: Office._WordMask, PROJECT: Office._ProjectMask, OUTLOOK: Office._OutlookMask, PPT: Office._PowerPointMask, OUTLOOKCOMPOSE: Office._OutlookComposeMask, ACCESSWEBAPP: Office._AccessWebAppMask } return function (condition, invert) { var result = false; if (nameToMaskMapping[condition] & Office._appContext) { result = true; } return invert ? !result : result; } })(), function () { return typeof Office._appContext === "number"; } ); Office._filterManager._pushFilter( "reqs", (function () { function checkForMethod(methodName) { return Office._methodContext && Office._methodContext[methodName]; } function checkForSet(setDescriptor) { setDescriptor = setDescriptor.split(" "); var setName = setDescriptor[0].trim(), setEntry = Office._setContext && setName in Office._setContext && (Office._setContext[setName] || "1.1"); if (!setEntry) { return false; } if (setDescriptor.length === 1) { return true; } else { var comparisonOperator = setDescriptor[1].trim(), setVersion = setDescriptor[2].split("."), setEntryVersion = setEntry.split("."), difference = 0, maxComponentCount = Math.max(setEntryVersion.length, setVersion.length); for (var i = 0; i < maxComponentCount; i++) { var leftInt = parseInt(setEntryVersion[i], 10) || 0, rightInt = parseInt(setVersion[i], 10) || 0; if (leftInt === rightInt) { continue; } difference = leftInt - rightInt; break; } switch (comparisonOperator) { case "EQ": return difference === 0; case "GT": return difference > 0; case "LT": return difference < 0; case "GE": return difference >= 0; case "LE": return difference <= 0; default: return false; } } return false; } return function (condition, invert) { var result = true; var typeAgnosticCond = condition.slice(condition.indexOf(" ")).trim(); if (condition.indexOf("SET") === 0) { result = checkForSet(typeAgnosticCond); } else if (condition.indexOf("METHOD") === 0) { result = checkForMethod(typeAgnosticCond); } return invert ? !result : result; } })(), function () { if (Office._showAll === false) { return true; } return false; } ) Office._addEnumOnObject = function (enumName, enumObj, targetObj, conditions) { Office._processItem( targetObj, { conditions: conditions, value: enumObj }, enumName ); } /******************************************************************************/ // Setup Project Office._processItem(Office, { metaOnly: true, conditions: { hosts: ["project"] }, contents: { ProjectProjectFields: { value: { ///CurrencySymbol CurrencySymbol: 1, ///CurrencySymbolPosition CurrencySymbolPosition: 2, ///DurationUnits DurationUnits: 3, ///GUID GUID: 4, ///Finish Finish: 5, ///Start Start: 6, ///ReadOnly ReadOnly: 7, ///VERSION VERSION: 8, ///WorkUnits WorkUnits: 9, ///ProjectServerUrl ProjectServerUrl: 10, ///WSSUrl WSSUrl: 11, ///WSSList WSSList: 12 } }, ProjectViewTypes: { value: { ///Gantt Gantt: 1, ///NetworkDiagram NetworkDiagram: 2, ///TaskDiagram TaskDiagram: 3, ///TaskForm TaskForm: 4, ///TaskSheet TaskSheet: 5, ///ResourceForm ResourceForm: 6, ///ResourceSheet ResourceSheet: 7, ///ResourceGraph ResourceGraph: 8, ///TeamPlanner TeamPlanner: 9, ///TaskDetails TaskDetails: 10, ///TaskNameForm TaskNameForm: 11, ///ResourceNames ResourceNames: 12, ///Calendar Calendar: 13, ///TaskUsage TaskUsage: 14, ///ResourceUsage ResourceUsage: 15, ///Timeline Timeline: 16, ///Drawing Drawing: 18, ///Resource Plan ResourcePlan: 19 } }, ProjectTaskFields: { value: { ///ActualCost ActualCost: 0, ///ActualDuration ActualDuration: 1, ///ActualFinish ActualFinish: 2, ///ActualOvertimeCost ActualOvertimeCost: 3, ///ActualOvertimeWork ActualOvertimeWork: 4, ///ActualStart ActualStart: 5, ///ActualWork ActualWork: 6, ///Text1 Text1: 7, ///Text10 Text10: 8, ///Finish10 Finish10: 9, ///Start10 Start10: 10, ///Text11 Text11: 11, ///Text12 Text12: 12, ///Text13 Text13: 13, ///Text14 Text14: 14, ///Text15 Text15: 15, ///Text16 Text16: 16, ///Text17 Text17: 17, ///Text18 Text18: 18, ///Text19 Text19: 19, ///Finish1 Finish1: 20, ///Start1 Start1: 21, ///Text2 Text2: 22, ///Text20 Text20: 23, ///Text21 Text21: 24, ///Text22 Text22: 25, ///Text23 Text23: 26, ///Text24 Text24: 27, ///Text25 Text25: 28, ///Text26 Text26: 29, ///Text27 Text27: 30, ///Text28 Text28: 31, ///Text29 Text29: 32, ///Finish2 Finish2: 33, ///Start2 Start2: 34, ///Text3 Text3: 35, ///Text30 Text30: 36, ///Finish3 Finish3: 37, ///Start3 Start3: 38, ///Text4 Text4: 39, ///Finish4 Finish4: 40, ///Start4 Start4: 41, ///Text5 Text5: 42, ///Finish5 Finish5: 43, ///Start5 Start5: 44, ///Text6 Text6: 45, ///Finish6 Finish6: 46, ///Start6 Start6: 47, ///Text7 Text7: 48, ///Finish7 Finish7: 49, ///Start7 Start7: 50, ///Text8 Text8: 51, ///Finish8 Finish8: 52, ///Start8 Start8: 53, ///Text9 Text9: 54, ///Finish9 Finish9: 55, ///Start9 Start9: 56, ///Baseline10BudgetCost Baseline10BudgetCost: 57, ///Baseline10BudgetWork Baseline10BudgetWork: 58, ///Baseline10Cost Baseline10Cost: 59, ///Baseline10Duration Baseline10Duration: 60, ///Baseline10Finish Baseline10Finish: 61, ///Baseline10FixedCost Baseline10FixedCost: 62, ///Baseline10FixedCostAccrual Baseline10FixedCostAccrual: 63, ///Baseline10Start Baseline10Start: 64, ///Baseline10Work Baseline10Work: 65, ///Baseline1BudgetCost Baseline1BudgetCost: 66, ///Baseline1BudgetWork Baseline1BudgetWork: 67, ///Baseline1Cost Baseline1Cost: 68, ///Baseline1Duration Baseline1Duration: 69, ///Baseline1Finish Baseline1Finish: 70, ///Baseline1FixedCost Baseline1FixedCost: 71, ///Baseline1FixedCostAccrual Baseline1FixedCostAccrual: 72, ///Baseline1Start Baseline1Start: 73, ///Baseline1Work Baseline1Work: 74, ///Baseline2BudgetCost Baseline2BudgetCost: 75, ///Baseline2BudgetWork Baseline2BudgetWork: 76, ///Baseline2Cost Baseline2Cost: 77, ///Baseline2Duration Baseline2Duration: 78, ///Baseline2Finish Baseline2Finish: 79, ///Baseline2FixedCost Baseline2FixedCost: 80, ///Baseline2FixedCostAccrual Baseline2FixedCostAccrual: 81, ///Baseline2Start Baseline2Start: 82, ///Baseline2Work Baseline2Work: 83, ///Baseline3BudgetCost Baseline3BudgetCost: 84, ///Baseline3BudgetWork Baseline3BudgetWork: 85, ///Baseline3Cost Baseline3Cost: 86, ///Baseline3Duration Baseline3Duration: 87, ///Baseline3Finish Baseline3Finish: 88, ///Baseline3FixedCost Baseline3FixedCost: 89, ///Baseline3FixedCostAccrual Baseline3FixedCostAccrual: 90, ///Basline3Start Basline3Start: 91, ///Baseline3Work Baseline3Work: 92, ///Baseline4BudgetCost Baseline4BudgetCost: 93, ///Baseline4BudgetWork Baseline4BudgetWork: 94, ///Baseline4Cost Baseline4Cost: 95, ///Baseline4Duration Baseline4Duration: 96, ///Baseline4Finish Baseline4Finish: 97, ///Baseline4FixedCost Baseline4FixedCost: 98, ///Baseline4FixedCostAccrual Baseline4FixedCostAccrual: 99, ///Baseline4Start Baseline4Start: 100, ///Baseline4Work Baseline4Work: 101, ///Baseline5BudgetCost Baseline5BudgetCost: 102, ///Baseline5BudgetWork Baseline5BudgetWork: 103, ///Baseline5Cost Baseline5Cost: 104, ///Baseline5Duration Baseline5Duration: 105, ///Baseline5Finish Baseline5Finish: 106, ///Baseline5FixedCost Baseline5FixedCost: 107, ///Baseline5FixedCostAccrual Baseline5FixedCostAccrual: 108, ///Baseline5Start Baseline5Start: 109, ///Baseline5Work Baseline5Work: 110, ///Baseline6BudgetCost Baseline6BudgetCost: 111, ///Baseline6BudgetWork Baseline6BudgetWork: 112, ///Baseline6Cost Baseline6Cost: 113, ///Baseline6Duration Baseline6Duration: 114, ///Baseline6Finish Baseline6Finish: 115, ///Baseline6FixedCost Baseline6FixedCost: 116, ///Baseline6FixedCostAccrual Baseline6FixedCostAccrual: 117, ///Baseline6Start Baseline6Start: 118, ///Baseline6Work Baseline6Work: 119, ///Baseline7BudgetCost Baseline7BudgetCost: 120, ///Baseline7BudgetWork Baseline7BudgetWork: 121, ///Baseline7Cost Baseline7Cost: 122, ///Baseline7Duration Baseline7Duration: 123, ///Baseline7Finish Baseline7Finish: 124, ///Baseline7FixedCost Baseline7FixedCost: 125, ///Baseline7FixedCostAccrual Baseline7FixedCostAccrual: 126, ///Baseline7Start Baseline7Start: 127, ///Baseline7Work Baseline7Work: 128, ///Baseline8BudgetCost Baseline8BudgetCost: 129, ///Baseline8BudgetWork Baseline8BudgetWork: 130, ///Baseline8Cost Baseline8Cost: 131, ///Baseline8Duration Baseline8Duration: 132, ///Baseline8Finish Baseline8Finish: 133, ///Baseline8FixedCost Baseline8FixedCost: 134, ///Baseline8FixedCostAccrual Baseline8FixedCostAccrual: 135, ///Baseline8Start Baseline8Start: 136, ///Baseline8Work Baseline8Work: 137, ///Baseline9BudgetCost Baseline9BudgetCost: 138, ///Baseline9BudgetWork Baseline9BudgetWork: 139, ///Baseline9Cost Baseline9Cost: 140, ///Baseline9Duration Baseline9Duration: 141, ///Baseline9Finish Baseline9Finish: 142, ///Baseline9FixedCost Baseline9FixedCost: 143, ///Baseline9FixedCostAccrual Baseline9FixedCostAccrual: 144, ///Baseline9Start Baseline9Start: 145, ///Baseline9Work Baseline9Work: 146, ///BaselineBudgetCost BaselineBudgetCost: 147, ///BaselineBudgetWork BaselineBudgetWork: 148, ///BaselineCost BaselineCost: 149, ///BaselineDuration BaselineDuration: 150, ///BaselineFinish BaselineFinish: 151, ///BaselineFixedCost BaselineFixedCost: 152, ///BaselineFixedCostAccrual BaselineFixedCostAccrual: 153, ///BaselineStart BaselineStart: 154, ///BaselineWork BaselineWork: 155, ///BudgetCost BudgetCost: 156, ///BudgetFixedCost BudgetFixedCost: 157, ///BudgetFixedWork BudgetFixedWork: 158, ///BudgetWork BudgetWork: 159, ///TaskCalendarGUID TaskCalendarGUID: 160, ///ConstraintDate ConstraintDate: 161, ///ConstraintType ConstraintType: 162, ///Cost1 Cost1: 163, ///Cost10 Cost10: 164, ///Cost2 Cost2: 165, ///Cost3 Cost3: 166, ///Cost4 Cost4: 167, ///Cost5 Cost5: 168, ///Cost6 Cost6: 169, ///Cost7 Cost7: 170, ///Cost8 Cost8: 171, ///Cost9 Cost9: 172, ///Date1 Date1: 173, ///Date10 Date10: 174, ///Date2 Date2: 175, ///Date3 Date3: 176, ///Date4 Date4: 177, ///Date5 Date5: 178, ///Date6 Date6: 179, ///Date7 Date7: 180, ///Date8 Date8: 181, ///Date9 Date9: 182, ///Deadline Deadline: 183, ///Duration1 Duration1: 184, ///Duration10 Duration10: 185, ///Duration2 Duration2: 186, ///Duration3 Duration3: 187, ///Duration4 Duration4: 188, ///Duration5 Duration5: 189, ///Duration6 Duration6: 190, ///Duration7 Duration7: 191, ///Duration8 Duration8: 192, ///Duration9 Duration9: 193, ///Duration Duration: 194, ///EarnedValueMethod EarnedValueMethod: 195, ///FinishSlack FinishSlack: 196, ///FixedCost FixedCost: 197, ///FixedCostAccrual FixedCostAccrual: 198, ///Flag10 Flag10: 199, ///Flag1 Flag1: 200, ///Flag11 Flag11: 201, ///Flag12 Flag12: 202, ///Flag13 Flag13: 203, ///Flag14 Flag14: 204, ///Flag15 Flag15: 205, ///Flag16 Flag16: 206, ///Flag17 Flag17: 207, ///Flag18 Flag18: 208, ///Flag19 Flag19: 209, ///Flag2 Flag2: 210, ///Flag20 Flag20: 211, ///Flag3 Flag3: 212, ///Flag4 Flag4: 213, ///Flag5 Flag5: 214, ///Flag6 Flag6: 215, ///Flag7 Flag7: 216, ///Flag8 Flag8: 217, ///Flag9 Flag9: 218, ///FreeSlack FreeSlack: 219, ///HasRollupSubTasks HasRollupSubTasks: 220, ///ID ID: 221, ///Name Name: 222, ///Notes Notes: 223, ///Number1 Number1: 224, ///Number10 Number10: 225, ///Number11 Number11: 226, ///Number12 Number12: 227, ///Number13 Number13: 228, ///Number14 Number14: 229, ///Number15 Number15: 230, ///Number16 Number16: 231, ///Number17 Number17: 232, ///Number18 Number18: 233, ///Number19 Number19: 234, ///Number2 Number2: 235, ///Number20 Number20: 236, ///Number3 Number3: 237, ///Number4 Number4: 238, ///Number5 Number5: 239, ///Number6 Number6: 240, ///Number7 Number7: 241, ///Number8 Number8: 242, ///Number9 Number9: 243, ///ScheduledDuration ScheduledDuration: 244, ///ScheduledFinish ScheduledFinish: 245, ///ScheduledStart ScheduledStart: 246, ///OutlineLevel OutlineLevel: 247, ///OvertimeCost OvertimeCost: 248, ///OvertimeWork OvertimeWork: 249, ///PercentComplete PercentComplete: 250, ///PercentWorkComplete PercentWorkComplete: 251, ///Predecessors Predecessors: 252, ///PreleveledFinish PreleveledFinish: 253, ///PreleveledStart PreleveledStart: 254, ///Priority Priority: 255, ///Active Active: 256, ///Critical Critical: 257, ///Milestone Milestone: 258, ///Overallocated Overallocated: 259, ///IsRollup IsRollup: 260, ///Summary Summary: 261, ///RegularWork RegularWork: 262, ///RemainingCost RemainingCost: 263, ///RemainingDuration RemainingDuration: 264, ///RemainingOvertimeCost RemainingOvertimeCost: 265, ///RemainingWork RemainingWork: 266, ///ResourceNames ResourceNames: 267, ///ResourceNames ResourceNames: 268, ///Cost Cost: 269, ///Finish Finish: 270, ///Start Start: 271, ///Work Work: 272, ///StartSlack StartSlack: 273, ///Status Status: 274, ///Successors Successors: 275, ///StatusManager StatusManager: 276, ///TotalSlack TotalSlack: 277, ///TaskGUID TaskGUID: 278, ///Type Type: 279, ///WBS WBS: 280, ///WBSPREDECESSORS WBSPREDECESSORS: 281, ///WBSSUCCESSORS WBSSUCCESSORS: 282, ///WSSID WSSID: 283 } }, ProjectResourceFields: { value: { ///Accrual Accrual: 0, ///ActualCost ActualCost: 1, ///ActualOvertimeCost ActualOvertimeCost: 2, ///ActualOvertimeWork ActualOvertimeWork: 3, ///ActualOvertimeWorkProtected ActualOvertimeWorkProtected: 4, ///ActualWork ActualWork: 5, ///ActualWorkProtected ActualWorkProtected: 6, ///BaseCalendar BaseCalendar: 7, ///Baseline10BudgetCost Baseline10BudgetCost: 8, ///Baseline10BudgetWork Baseline10BudgetWork: 9, ///Baseline10Cost Baseline10Cost: 10, ///Baseline10Work Baseline10Work: 11, ///Baseline1BudgetCost Baseline1BudgetCost: 12, ///Baseline1BudgetWork Baseline1BudgetWork: 13, ///Baseline1Cost Baseline1Cost: 14, ///Baseline1Work Baseline1Work: 15, ///Baseline2BudgetCost Baseline2BudgetCost: 16, ///Baseline2BudgetWork Baseline2BudgetWork: 17, ///Baseline2Cost Baseline2Cost: 18, ///Baseline2Work Baseline2Work: 19, ///Baseline3BudgetCost Baseline3BudgetCost: 20, ///Baseline3BudgetWork Baseline3BudgetWork: 21, ///Baseline3Cost Baseline3Cost: 22, ///Baseline3Work Baseline3Work: 23, ///Baseline4BudgetCost Baseline4BudgetCost: 24, ///Baseline4BudgetWork Baseline4BudgetWork: 25, ///Baseline4Cost Baseline4Cost: 26, ///Baseline4Work Baseline4Work: 27, ///Baseline5BudgetCost Baseline5BudgetCost: 28, ///Baseline5BudgetWork Baseline5BudgetWork: 29, ///Baseline5Cost Baseline5Cost: 30, ///Baseline5Work Baseline5Work: 31, ///Baseline6BudgetCost Baseline6BudgetCost: 32, ///Baseline6BudgetWork Baseline6BudgetWork: 33, ///Baseline6Cost Baseline6Cost: 34, ///Baseline6Work Baseline6Work: 35, ///Baseline7BudgetCost Baseline7BudgetCost: 36, ///Baseline7BudgetWork Baseline7BudgetWork: 37, ///Baseline7Cost Baseline7Cost: 38, ///Baseline7Work Baseline7Work: 39, ///Baseline8BudgetCost Baseline8BudgetCost: 40, ///Baseline8BudgetWork Baseline8BudgetWork: 41, ///Baseline8Cost Baseline8Cost: 42, ///Baseline8Work Baseline8Work: 43, ///Baseline9BudgetCost Baseline9BudgetCost: 44, ///Baseline9BudgetWork Baseline9BudgetWork: 45, ///Baseline9Cost Baseline9Cost: 46, ///Baseline9Work Baseline9Work: 47, ///BaselineBudgetCost BaselineBudgetCost: 48, ///BaselineBudgetWork BaselineBudgetWork: 49, ///BaselineCost BaselineCost: 50, ///BaselineWork BaselineWork: 51, ///BudgetCost BudgetCost: 52, ///BudgetWork BudgetWork: 53, ///ResourceCalendarGUID ResourceCalendarGUID: 54, ///Code Code: 55, ///Cost1 Cost1: 56, ///Cost10 Cost10: 57, ///Cost2 Cost2: 58, ///Cost3 Cost3: 59, ///Cost4 Cost4: 60, ///Cost5 Cost5: 61, ///Cost6 Cost6: 62, ///Cost7 Cost7: 63, ///Cost8 Cost8: 64, ///Cost9 Cost9: 65, ///ResourceCreationDate ResourceCreationDate: 66, ///Date1 Date1: 67, ///Date10 Date10: 68, ///Date2 Date2: 69, ///Date3 Date3: 70, ///Date4 Date4: 71, ///Date5 Date5: 72, ///Date6 Date6: 73, ///Date7 Date7: 74, ///Date8 Date8: 75, ///Date9 Date9: 76, ///Duration1 Duration1: 77, ///Duration10 Duration10: 78, ///Duration2 Duration2: 79, ///Duration3 Duration3: 80, ///Duration4 Duration4: 81, ///Duration5 Duration5: 82, ///Duration6 Duration6: 83, ///Duration7 Duration7: 84, ///Duration8 Duration8: 85, ///Duration9 Duration9: 86, ///Email Email: 87, ///End End: 88, ///Finish1 Finish1: 89, ///Finish10 Finish10: 90, ///Finish2 Finish2: 91, ///Finish3 Finish3: 92, ///Finish4 Finish4: 93, ///Finish5 Finish5: 94, ///Finish6 Finish6: 95, ///Finish7 Finish7: 96, ///Finish8 Finish8: 97, ///Finish9 Finish9: 98, ///Flag10 Flag10: 99, ///Flag1 Flag1: 100, ///Flag11 Flag11: 101, ///Flag12 Flag12: 102, ///Flag13 Flag13: 103, ///Flag14 Flag14: 104, ///Flag15 Flag15: 105, ///Flag16 Flag16: 106, ///Flag17 Flag17: 107, ///Flag18 Flag18: 108, ///Flag19 Flag19: 109, ///Flag2 Flag2: 110, ///Flag20 Flag20: 111, ///Flag3 Flag3: 112, ///Flag4 Flag4: 113, ///Flag5 Flag5: 114, ///Flag6 Flag6: 115, ///Flag7 Flag7: 116, ///Flag8 Flag8: 117, ///Flag9 Flag9: 118, ///Group Group: 119, ///Units Units: 120, ///Name Name: 121, ///Notes Notes: 122, ///Number1 Number1: 123, ///Number10 Number10: 124, ///Number11 Number11: 125, ///Number12 Number12: 126, ///Number13 Number13: 127, ///Number14 Number14: 128, ///Number15 Number15: 129, ///Number16 Number16: 130, ///Number17 Number17: 131, ///Number18 Number18: 132, ///Number19 Number19: 133, ///Number2 Number2: 134, ///Number20 Number20: 135, ///Number3 Number3: 136, ///Number4 Number4: 137, ///Number5 Number5: 138, ///Number6 Number6: 139, ///Number7 Number7: 140, ///Number8 Number8: 141, ///Number9 Number9: 142, ///OvertimeCost OvertimeCost: 143, ///OvertimeRate OvertimeRate: 144, ///OvertimeWork OvertimeWork: 145, ///PercentWorkComplete PercentWorkComplete: 146, ///CostPerUse CostPerUse: 147, ///Generic Generic: 148, ///OverAllocated OverAllocated: 149, ///RegularWork RegularWork: 150, ///RemainingCost RemainingCost: 151, ///RemainingOvertimeCost RemainingOvertimeCost: 152, ///RemainingOvertimeWork RemainingOvertimeWork: 153, ///RemainingWork RemainingWork: 154, ///ResourceGUID ResourceGUID: 155, ///Cost Cost: 156, ///Work Work: 157, ///Start Start: 158, ///Start1 Start1: 159, ///Start10 Start10: 160, ///Start2 Start2: 161, ///Start3 Start3: 162, ///Start4 Start4: 163, ///Start5 Start5: 164, ///Start6 Start6: 165, ///Start7 Start7: 166, ///Start8 Start8: 167, ///Start9 Start9: 168, ///StandardRate StandardRate: 169, ///Text1 Text1: 170, ///Text10 Text10: 171, ///Text11 Text11: 172, ///Text12 Text12: 173, ///Text13 Text13: 174, ///Text14 Text14: 175, ///Text15 Text15: 176, ///Text16 Text16: 177, ///Text17 Text17: 178, ///Text18 Text18: 179, ///Text19 Text19: 180, ///Text2 Text2: 181, ///Text20 Text20: 182, ///Text21 Text21: 183, ///Text22 Text22: 184, ///Text23 Text23: 185, ///Text24 Text24: 186, ///Text25 Text25: 187, ///Text26 Text26: 188, ///Text27 Text27: 189, ///Text28 Text28: 190, ///Text29 Text29: 191, ///Text3 Text3: 192, ///Text30 Text30: 193, ///Text4 Text4: 194, ///Text5 Text5: 195, ///Text6 Text6: 196, ///Text7 Text7: 197, ///Text8 Text8: 198, ///Text9 Text9: 199 } }, context: { contents: { document: { contents: { getSelectedTaskAsync: { conditions: { reqs: ["method Document.getSelectedTaskAsync"] }, value: function (callback) { /// (Project only) Get the current selected Task's Id. ///The optional callback method } }, getTaskByIndexAsync: { conditions: { reqs: ["method Document.getTaskByIndexAsync"] }, value: function (taskIndex, callback) { /// (Project only) Get the Task's Id for provided task index. ///Task index in task container ///The optional callback method } }, getTaskAsync: { conditions: { reqs: ["method Document.getTaskAsync"] }, value: function (taskId, callback) { /// (Project only) Get the Task Name, WSS Task Id, and ResourceNames for given taskId . ///Either a string or value of the Task Id. ///The optional callback method } }, getTaskFieldAsync: { conditions: { reqs: ["method Document.getTaskFieldAsync"] }, value: function (taskId, taskField, callback) { /// (Project only) Get task field for provided task Id. (Ex. StartDate). ///Either a string or value of the Task Id. ///Task Fields. ///The optional callback method } }, getSelectedResourceAsync: { conditions: { reqs: ["method Document.getSelectedResourceAsync"] }, value: function (callback) { /// (Project only) Get the current selected Resource's Id. ///The optional callback method } }, getResourceByIndexAsync: { conditions: { reqs: ["method Document.getResourceByIndexAsync"] }, value: function (resourceIndex, callback) { /// (Project only) Get the Resource's Id for provided resource index. ///Resource index in resource container ///The optional callback method } }, getResourceFieldAsync: { conditions: { reqs: ["method Document.getResourceFieldAsync"] }, value: function (resourceId, resourceField, callback) { /// (Project only) Get resource field for provided resource Id. (Ex.ResourceName) ///Either a string or value of the Resource Id. ///Resource Fields. ///The optional callback method } }, getProjectFieldAsync: { conditions: { reqs: ["method Document.getProjectFieldAsync"] }, value: function (projectField, callback) { /// (Project only) Get Project field (Ex. ProjectWebAccessURL). ///Project level fields. ///The optional callback method } }, getSelectedViewAsync: { conditions: { reqs: ["method Document.getSelectedViewAsync"] }, value: function (callback) { /// (Project only) Get the current selected View Type (Ex. Gantt) and View Name. ///The optional callback method } }, getWSSURLAsync: { conditions: { reqs: ["method Document.getWSSURLAsync"] }, value: function (callback) { /// (Project only) Get the WSS Url and list name for the Tasks List, the MPP is synced too. ///The optional callback method } }, setTaskFieldAsync: { conditions: { reqs: ["method Document.setTaskFieldAsync"] }, value: function (taskId, fieldId, fieldValue, callback) { /// (Project only) Set Taskfield (Ex. TaskName). ///Either a string or value of the Task Id. ///Task Field. ///Either a string, number boolean or object for the data that you want to set. ///The optional callback method } }, setResourceFieldAsync: { conditions: { reqs: ["method Document.setResourceFieldAsync"] }, value: function (resourceId, fieldId, fieldValue, callback) { /// (Project only) Set Resource field (Ex. ResourceName). ///Either a string or value of the Resource Id. ///Resource Field. ///Either a string, number boolean or object for the data that you want to set. ///The optional callback method } } } } } } } }); // Setup outlook Office._processItem(Office, { metaOnly: true, conditions: { hosts: ["outlook", "outlookcompose"], reqs: ["set Mailbox GE 1.1"] }, contents: { MailboxEnums: { value: new Office._MailboxEnums() }, context: { contents: { mailbox: { value: new Office._context_mailbox() }, roamingSettings: { value: new Office._settings() } } }, cast: { value: { item: new Office._cast_item() } } } }) // Setup CustomXMLParts Office._addEnumOnObject("CustomXmlNodeType", { ///Element Element: "element", ///Attribute Attribute: "attribute", ///String/field> Text: "text", ///CData Cdata: "cdata", ///ProcessingInstruction ProcessingInstruction: "processingInstruction", ///NodeComment NodeComment: "nodeComment", ///NodeDocument NodeDocument: "nodeDocument" }, Office, { hosts: ["word"] } ); // Other enumerations on Office Office._addEnumOnObject("AsyncResultStatus", { ///Operation failed, check error object Failed: "failed", ///Operation succeeded Succeeded: "succeeded" }, Office, { hosts: ["not outlook; not outlookcompose"] } ); Office._processItem(Office, { contents: { Text: { conditions: { hosts: ["excel", "word"], reqs: ["set TextBindings GE 1.1"] }, annotate: { ///Text based Binding Text: undefined }, value: "text" }, Matrix: { conditions: { hosts: ["excel", "word"], reqs: ["set MatrixBindings GE 1.1"] }, annotate: { ///Matrix based Binding Matrix: undefined }, value: "matrix" }, Table: { conditions: { hosts: ["excel", "word", "accesswebapp"], reqs: ["set TableBindings GE 1.1"] }, annotate: { ///Table based Binding Table: undefined }, value: "table" } } }, "BindingType" ); Office._processItem(Office, { contents: { Table: { conditions: { hosts: ["word", "excel", "accesswebapp"], reqs: ["set TableCoercion GE 1.1"] }, annotate: { ///Coerce as Table Table: undefined }, value: "table" }, Text: { conditions: { hosts: ["excel", "ppt", "project", "word"], reqs: ["set TextCoercion GE 1.1"] }, annotate: { ///Coerce as Text Text: undefined }, value: "text" }, Matrix: { conditions: { hosts: ["excel", "word"], reqs: ["set MatrixCoercion GE 1.1"] }, annotate: { ///Coerce as Matrix Matrix: undefined }, value: "matrix" }, Html: { conditions: { hosts: ["word"], reqs: ["set HtmlCoercion GE 1.1"] }, annotate: { ///Coerce as HTML Html: undefined }, value: "html" }, Ooxml: { conditions: { hosts: ["word"], reqs: ["set OoxmlCoercion GE 1.1"] }, annotate: { ///Coerce as Office Open XML Ooxml: undefined }, value: "ooxml" }, SlideRange: { conditions: { hosts: ["ppt"] }, annotate: { ///Coerce as JSON object containing an array of the ids, titles, and indexes of the selected slides. SlideRange: undefined }, value: "slideRange" } } }, "CoercionType" ); Office._addEnumOnObject("DocumentMode", { ///Document in Read Only Mode ReadOnly: "readOnly", ///Document in Read/Write Mode ReadWrite: "readWrite" }, Office, { hosts: ["word", "excel", "accesswebapp"] } ); Office._addEnumOnObject("EventType", { ///Triggers when a document level selection happens DocumentSelectionChanged: "documentSelectionChanged", /// Triggers when a binding level selection happens BindingSelectionChanged: "bindingSelectionChanged", ///Triggers when a binding level data change happens BindingDataChanged: "bindingDataChanged", ///Triggers when settings change in a co-Auth session. SettingsChanged: "settingsChanged", ///Triggers when a customXmlPart node was deleted DataNodeDeleted: "nodeDeleted", ///Triggers when a customXmlPart node was inserted DataNodeInserted: "nodeInserted", ///Triggers when a customXmlPart node was replaced DataNodeReplaced: "nodeReplaced", ///Triggers when a Task selection happens in Project. TaskSelectionChanged: "taskSelectionChanged", /// Triggers when a Resource selection happens in Project. ResourceSelectionChanged: "resourceSelectionChanged", ///Triggers when a View selection happens in Project. ViewSelectionChanged: "viewSelectionChanged" }, Office, { hosts: ["not outlook; not outlookcompose"] } ); // EventType augmentations Office._processContents(Office.EventType, { ActiveViewChanged: { conditions: { hosts: ["ppt"] }, annotate: { ///Occurs when the user changes the current view of the document. ActiveViewChanged: undefined }, value: "activeViewChanged" } }); Office._processItem(Office, { conditions: { hosts: ["not outlook; not outlookcompose; not accesswebapp"] }, contents: { Compressed: { conditions: { hosts: ["ppt", "word"], reqs: ["set CompressedFile GE 1.1"] }, annotate: { ///Returns the file as a byte array Compressed: undefined }, value: "compressed" }, Pdf: { conditions: { hosts: ["ppt", "word"], reqs: ["set PdfFile GE 1.1"] }, annotate: { ///Returns the file in PDF format as a byte array Pdf: undefined }, value: "pdf" }, Text: { conditions: { hosts: ["word"], reqs: ["set TextFile GE 1.1"] }, annotate: { ///Returns the file as plain text Text: undefined }, value: "text" } } }, "FileType" ); Office._addEnumOnObject("FilterType", { ///Returns all items All: "all", ///Returns only visible items OnlyVisible: "onlyVisible" }, Office, { hosts: ["not outlook; not outlookcompose; not accesswebapp"] } ); Office._addEnumOnObject("InitializationReason", { ///Indicates the app was just inserted in the document /field> Inserted: "inserted", ///Indicated if the extension already existed in the document DocumentOpened: "documentOpened" }, Office, { hosts: ["not outlook; not outlookcompose"] } ); Office._addEnumOnObject("ValueFormat", { ///Returns items with format Formatted: "formatted", ///Returns items without format Unformatted: "unformatted" }, Office, { hosts: ["not outlook; not outlookcompose"] } ); Office._processContents(Office, { GoToType: { contents: { Binding: { conditions: { hosts: ["excel", "word"] }, annotate: { ///Goes to a binding object using the specified binding id. Binding: undefined }, value: "binding" }, NamedItem: { conditions: { hosts: ["excel"] }, annotate: { /// /// Goes to a named item using that item's name. /// In Excel, you can use any structured reference for a named range or table: "Worksheet2!Table1" /// NamedItem: undefined }, value: "namedItem" }, Slide: { conditions: { hosts: ["ppt"] }, annotate: { ///Goes to a slide using the specified id. Slide: undefined }, value: "slide" }, Index: { conditions: { hosts: ["ppt"] }, annotate: { ///Goes to the specified index by slide number or enum Office.Index Index: undefined }, value: "index" } } } }); Office._addEnumOnObject("Index", { First: "first", Last: "last", Next: "next", Previous: "previous" }, Office, { hosts: ["ppt"] } ); Office._addEnumOnObject("SelectionMode", { Default: "default", Selected: "selected", None: "none" }, Office, { hosts: ["word"] } ); if (!!intellisense) { intellisense.addEventListener('statementcompletion', function (event) { if (event.targetName === "this" || event.target === undefined || event.target === window) return; event.items = event.items.filter(function (item) { return !(item.name && item.name.charAt(0) === "_"); }); }); } Office._processContents(Office, Office._items); document.addEventListener("DOMContentLoaded", function () { Office.initialize(); }); var __extends = this.__extends || function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; function __() { this.constructor = d; } __.prototype = b.prototype; d.prototype = new __(); }; var OfficeExtension; (function (OfficeExtension) { var ClientObject = (function () { function ClientObject() { /// Returns a boolean value for whether the corresponding object is a null object. You must call "context.sync()" before reading the isNullObject property. } return ClientObject; })(); OfficeExtension.ClientObject = ClientObject; })(OfficeExtension || (OfficeExtension = {__proto__: null})); var OfficeExtension; (function (OfficeExtension) { var ClientRequestContext = (function () { function ClientRequestContext(url) { /// /// An abstract RequestContext object that facilitates requests to the host Office application. The "Excel.run" and "Word.run" methods provide a request context. /// /// Collection of objects that are tracked for automatic adjustments based on surrounding changes in the document. /// Request headers. this.requestHeaders = { __proto__: null, }; } ClientRequestContext.prototype.load = function (object, option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// }; ClientRequestContext.prototype.trace = function (message) { /// /// Adds a trace message to the queue. If the promise returned by "context.sync()" is rejected due to an error, this adds a ".traceMessages" array to the OfficeExtension.Error object, containing all trace messages that were executed. These messages can help you monitor the program execution sequence and detect the cause of the error. /// /// }; ClientRequestContext.prototype.sync = function (passThroughValue) { /// /// Synchronizes the state between JavaScript proxy objects and the Office document, by executing instructions queued on the request context and retrieving properties of loaded Office objects for use in your code.ÿThis method returns a promise, which is resolved when the synchronization is complete. /// /// return new OfficeExtension.Promise(); }; ClientRequestContext.prototype.__proto__ = null; return ClientRequestContext; })(); OfficeExtension.ClientRequestContext = ClientRequestContext; })(OfficeExtension || (OfficeExtension = {__proto__: null})); var OfficeExtension; (function (OfficeExtension) { var ClientResult = (function () { function ClientResult() { /// /// Contains the result for methods that return primitive types. The object's value property is retrieved from the document after "context.sync()" is invoked. /// /// /// The value of the result that is retrieved from the document after "context.sync()" is invoked. /// } ClientResult.prototype.__proto__ = null; return ClientResult; })(); OfficeExtension.ClientResult = ClientResult; })(OfficeExtension || (OfficeExtension = {__proto__: null})); var OfficeExtension; (function (OfficeExtension) { var Error = (function () { function Error() { /// /// The error object returned by "context.sync()", if a promise is rejected due to an error while processing the request. /// /// /// Error name: "OfficeExtension.Error" /// /// /// The error message passed through from the host Office application. /// /// /// Stack trace, if applicable. /// /// /// Error code string, such as "InvalidArgument". /// /// /// Trace messages (if any) that were added via a "context.trace()" invocation before calling "context.sync()". If there was an error, this contains all trace messages that were executed before the error occurred. These messages can help you monitor the program execution sequence and detect the case of the error. /// /// /// Debug info, if applicable. The ".errorLocation" property can describe the object and method or property that caused the error. /// this.debugInfo = { __proto__: null, /// /// If applicable, will return the object type and the name of the method or property that caused the error. /// errorLocation: "" }; } Error.prototype.__proto__ = null; return Error; })(); OfficeExtension.Error = Error; })(OfficeExtension || (OfficeExtension = {__proto__: null})); var OfficeExtension; (function (OfficeExtension) { var ErrorCodes = (function () { function ErrorCodes() { } ErrorCodes.__proto__ = null; ErrorCodes.accessDenied = ""; ErrorCodes.generalException = ""; ErrorCodes.activityLimitReached = ""; return ErrorCodes; })(); })(OfficeExtension || (OfficeExtension = {__proto__: null})); var OfficeExtension; (function (OfficeExtension) { var Promise = (function () { /// /// Creates a promise that resolves when all of the child promises resolve. /// Promise.all = function (promises) { return [new OfficeExtension.Promise()]; }; /// /// Creates a promise that is resolved. /// Promise.resolve = function (value) { return new OfficeExtension.Promise(); }; /// /// Creates a promise that is rejected. /// Promise.reject = function (error) { return new OfficeExtension.Promise(); }; /// /// A Promise object that represents a deferred interaction with the host Office application. The publically-consumable OfficeExtension.Promise is available starting in ExcelApi 1.2 and WordApi 1.2. Promises can be chained via ".then", and errors can be caught via ".catch". Remember to always use a ".catch" on the outer promise, and to return intermediary promises so as not to break the promise chain. When a "native" Promise implementation is available, OfficeExtension.Promise will switch to use the native Promise instead. /// Promise.prototype.then = function (onFulfilled, onRejected) { /// /// This method will be called once the previous promise has been resolved. /// Both the onFulfilled on onRejected callbacks are optional. /// If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called. /// Returns a new promise for the value or error that was returned from onFulfilled/onRejected. /// /// /// /// onRejected(new Error()); } Promise.prototype.catch = function (onRejected) { /// /// Catches failures or exceptions from actions within the promise, or from an unhandled exception earlier in the call stack. /// /// function to be called if or when the promise rejects. /// onRejected(new Error()); } Promise.prototype.__proto__ = null; }) OfficeExtension.Promise = Promise; })(OfficeExtension || (OfficeExtension = {__proto__: null})); var OfficeExtension; (function (OfficeExtension) { var TrackedObjects = (function () { function TrackedObjects() { /// /// Collection of tracked objects, contained within a request context. See "context.trackedObjects" for more information. /// } TrackedObjects.prototype.add = function (object) { /// /// Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. /// /// }; TrackedObjects.prototype.remove = function (object) { /// /// Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. /// /// }; TrackedObjects.prototype.__proto__ = null; return TrackedObjects; })(); OfficeExtension.TrackedObjects = TrackedObjects; })(OfficeExtension || (OfficeExtension = {__proto__: null})); (function (OfficeExtension) { var EventHandlers = (function () { function EventHandlers() { } EventHandlers.prototype.add = function (handler) { return new EventHandlerResult(null, null, handler); }; EventHandlers.prototype.remove = function (handler) { }; EventHandlers.prototype.removeAll = function () { }; EventHandlers.prototype.__proto__ = null; return EventHandlers; }()); OfficeExtension.EventHandlers = EventHandlers; var EventHandlerResult = (function () { function EventHandlerResult() { } EventHandlerResult.prototype.remove = function () { }; EventHandlerResult.prototype.__proto__ = null; return EventHandlerResult; }()); OfficeExtension.EventHandlerResult = EventHandlerResult; })(OfficeExtension || (OfficeExtension = {__proto__: null})); OfficeExtension.__proto__ = null; var Excel; (function (Excel) { var _V1Api = (function(_super) { __extends(_V1Api, _super); function _V1Api() { /// [Api set: ExcelApi 1.3] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. } _V1Api.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } _V1Api.prototype.bindingAddColumns = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingAddFromNamedItem = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingAddFromPrompt = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingAddFromSelection = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingAddRows = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingClearFormats = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingDeleteAllDataValues = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingGetAll = function() { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingGetById = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingGetData = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingReleaseById = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingSetData = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingSetFormats = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.bindingSetTableOptions = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.getSelectedData = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.gotoById = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } _V1Api.prototype.setSelectedData = function(input) { /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = {}; return result; } return _V1Api; })(OfficeExtension.ClientObject); Excel._V1Api = _V1Api; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Application = (function(_super) { __extends(Application, _super); function Application() { /// Represents the Excel application that manages the workbook. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the calculation mode used in the workbook. See Excel.CalculationMode for details. Read-only. [Api set: ExcelApi 1.1] } Application.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Application.prototype.calculate = function(calculationType) { /// /// Recalculate all currently opened workbooks in Excel. [Api set: ExcelApi 1.1] /// /// Specifies the calculation type to use. See Excel.CalculationType for details. /// } return Application; })(OfficeExtension.ClientObject); Excel.Application = Application; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Binding = (function(_super) { __extends(Binding, _super); function Binding() { /// Represents an Office.js binding that is defined in the workbook. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents binding identifier. Read-only. [Api set: ExcelApi 1.1] /// Returns the type of the binding. See Excel.BindingType for details. Read-only. [Api set: ExcelApi 1.1] /// Occurs when data or formatting within the binding is changed. [Api set: ExcelApi 1.2] /// Occurs when the selection is changed within the binding. [Api set: ExcelApi 1.2] } Binding.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Binding.prototype.delete = function() { /// /// Deletes the binding. [Api set: ExcelApi 1.3] /// /// } Binding.prototype.getRange = function() { /// /// Returns the range represented by the binding. Will throw an error if binding is not of the correct type. [Api set: ExcelApi 1.1] /// /// } Binding.prototype.getTable = function() { /// /// Returns the table represented by the binding. Will throw an error if binding is not of the correct type. [Api set: ExcelApi 1.1] /// /// } Binding.prototype.getText = function() { /// /// Returns the text represented by the binding. Will throw an error if binding is not of the correct type. [Api set: ExcelApi 1.1] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Binding.prototype.onDataChanged = { __proto__: null, add: function (handler) { /// Handler for the event. EventArgs: Provides information about the binding that raised the DataChanged event. /// var eventInfo = new Excel.Interfaces.BindingDataChangedEventArgs(); eventInfo.__proto__ = null; handler(eventInfo); }, remove: function (handler) { /// Handler for the event. return; }, removeAll: function () { return; } }; Binding.prototype.onSelectionChanged = { __proto__: null, add: function (handler) { /// Handler for the event. EventArgs: Provides information about the binding that raised the SelectionChanged event. /// var eventInfo = new Excel.Interfaces.BindingSelectionChangedEventArgs(); eventInfo.__proto__ = null; handler(eventInfo); }, remove: function (handler) { /// Handler for the event. return; }, removeAll: function () { return; } }; return Binding; })(OfficeExtension.ClientObject); Excel.Binding = Binding; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var BindingCollection = (function(_super) { __extends(BindingCollection, _super); function BindingCollection() { /// Represents the collection of all the binding objects that are part of the workbook. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the number of bindings in the collection. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } BindingCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } BindingCollection.prototype.add = function(range, bindingType, id) { /// /// Add a new binding to a particular Range. [Api set: ExcelApi 1.3] /// /// Range to bind the binding to. May be an Excel Range object, or a string. If string, must contain the full address, including the sheet name /// Type of binding. See Excel.BindingType. /// Name of binding. /// } BindingCollection.prototype.addFromNamedItem = function(name, bindingType, id) { /// /// Add a new binding based on a named item in the workbook. [Api set: ExcelApi 1.3] /// /// Name from which to create binding. /// Type of binding. See Excel.BindingType. /// Name of binding. /// } BindingCollection.prototype.addFromSelection = function(bindingType, id) { /// /// Add a new binding based on the current selection. [Api set: ExcelApi 1.3] /// /// Type of binding. See Excel.BindingType. /// Name of binding. /// } BindingCollection.prototype.getItem = function(id) { /// /// Gets a binding object by ID. [Api set: ExcelApi 1.1] /// /// Id of the binding object to be retrieved. /// } BindingCollection.prototype.getItemAt = function(index) { /// /// Gets a binding object based on its position in the items array. [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return BindingCollection; })(OfficeExtension.ClientObject); Excel.BindingCollection = BindingCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var BindingDataChangedEventArgs = (function() { function BindingDataChangedEventArgs() { /// Provides information about the binding that raised the DataChanged event. [Api set: ExcelApi 1.2] /// Gets the Binding object that represents the binding that raised the DataChanged event. [Api set: ExcelApi 1.2] } return BindingDataChangedEventArgs; })(); Interfaces.BindingDataChangedEventArgs.__proto__ = null; Interfaces.BindingDataChangedEventArgs = BindingDataChangedEventArgs; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var BindingSelectionChangedEventArgs = (function() { function BindingSelectionChangedEventArgs() { /// Provides information about the binding that raised the SelectionChanged event. [Api set: ExcelApi 1.2] /// Gets the Binding object that represents the binding that raised the SelectionChanged event. [Api set: ExcelApi 1.2] /// Gets the number of columns selected. [Api set: ExcelApi 1.2] /// Gets the number of rows selected. [Api set: ExcelApi 1.2] /// Gets the index of the first column of the selection (zero-based). [Api set: ExcelApi 1.2] /// Gets the index of the first row of the selection (zero-based). [Api set: ExcelApi 1.2] } return BindingSelectionChangedEventArgs; })(); Interfaces.BindingSelectionChangedEventArgs.__proto__ = null; Interfaces.BindingSelectionChangedEventArgs = BindingSelectionChangedEventArgs; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var BindingType = { __proto__: null, "range": "range", "table": "table", "text": "text", } Excel.BindingType = BindingType; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var BorderIndex = { __proto__: null, "edgeTop": "edgeTop", "edgeBottom": "edgeBottom", "edgeLeft": "edgeLeft", "edgeRight": "edgeRight", "insideVertical": "insideVertical", "insideHorizontal": "insideHorizontal", "diagonalDown": "diagonalDown", "diagonalUp": "diagonalUp", } Excel.BorderIndex = BorderIndex; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var BorderLineStyle = { __proto__: null, "none": "none", "continuous": "continuous", "dash": "dash", "dashDot": "dashDot", "dashDotDot": "dashDotDot", "dot": "dot", "double": "double", "slantDashDot": "slantDashDot", } Excel.BorderLineStyle = BorderLineStyle; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var BorderWeight = { __proto__: null, "hairline": "hairline", "thin": "thin", "medium": "medium", "thick": "thick", } Excel.BorderWeight = BorderWeight; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var CalculationMode = { __proto__: null, "automatic": "automatic", "automaticExceptTables": "automaticExceptTables", "manual": "manual", } Excel.CalculationMode = CalculationMode; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var CalculationType = { __proto__: null, "recalculate": "recalculate", "full": "full", "fullRebuild": "fullRebuild", } Excel.CalculationType = CalculationType; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Chart = (function(_super) { __extends(Chart, _super); function Chart() { /// Represents a chart object in a workbook. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents chart axes. Read-only. [Api set: ExcelApi 1.1] /// Represents the datalabels on the chart. Read-only. [Api set: ExcelApi 1.1] /// Encapsulates the format properties for the chart area. Read-only. [Api set: ExcelApi 1.1] /// Represents the height, in points, of the chart object. [Api set: ExcelApi 1.1] /// The distance, in points, from the left side of the chart to the worksheet origin. [Api set: ExcelApi 1.1] /// Represents the legend for the chart. Read-only. [Api set: ExcelApi 1.1] /// Represents the name of a chart object. [Api set: ExcelApi 1.1] /// Represents either a single series or collection of series in the chart. Read-only. [Api set: ExcelApi 1.1] /// Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only. [Api set: ExcelApi 1.1] /// Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). [Api set: ExcelApi 1.1] /// Represents the width, in points, of the chart object. [Api set: ExcelApi 1.1] /// The worksheet containing the current chart. Read-only. [Api set: ExcelApi 1.2] } Chart.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Chart.prototype.delete = function() { /// /// Deletes the chart object. [Api set: ExcelApi 1.1] /// /// } Chart.prototype.getImage = function(width, height, fittingMode) { /// /// Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. The aspect ratio is preserved as part of the resizing. [Api set: ExcelApi 1.2] /// /// (Optional) The desired height of the resulting image. /// (Optional) The desired width of the resulting image. /// (Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set)." /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Chart.prototype.setData = function(sourceData, seriesBy) { /// /// Resets the source data for the chart. [Api set: ExcelApi 1.1] /// /// The Range object corresponding to the source data. /// Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns. See Excel.ChartSeriesBy for details. /// } Chart.prototype.setPosition = function(startCell, endCell) { /// /// Positions the chart relative to cells on the worksheet. [Api set: ExcelApi 1.1] /// /// The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings. /// (Optional) The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range. /// } return Chart; })(OfficeExtension.ClientObject); Excel.Chart = Chart; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartAreaFormat = (function(_super) { __extends(ChartAreaFormat, _super); function ChartAreaFormat() { /// Encapsulates the format properties for the overall chart area. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the fill format of an object, which includes background formatting information. Read-only. [Api set: ExcelApi 1.1] /// Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only. [Api set: ExcelApi 1.1] } ChartAreaFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartAreaFormat; })(OfficeExtension.ClientObject); Excel.ChartAreaFormat = ChartAreaFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartAxes = (function(_super) { __extends(ChartAxes, _super); function ChartAxes() { /// Represents the chart axes. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the category axis in a chart. Read-only. [Api set: ExcelApi 1.1] /// Represents the series axis of a 3-dimensional chart. Read-only. [Api set: ExcelApi 1.1] /// Represents the value axis in an axis. Read-only. [Api set: ExcelApi 1.1] } ChartAxes.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartAxes; })(OfficeExtension.ClientObject); Excel.ChartAxes = ChartAxes; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartAxis = (function(_super) { __extends(ChartAxis, _super); function ChartAxis() { /// Represents a single axis in a chart. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the formatting of a chart object, which includes line and font formatting. Read-only. [Api set: ExcelApi 1.1] /// Returns a gridlines object that represents the major gridlines for the specified axis. Read-only. [Api set: ExcelApi 1.1] /// Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. [Api set: ExcelApi 1.1] /// Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1] /// Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1] /// Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only. [Api set: ExcelApi 1.1] /// Represents the interval between two minor tick marks. "Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1] /// Represents the axis title. Read-only. [Api set: ExcelApi 1.1] } ChartAxis.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartAxis; })(OfficeExtension.ClientObject); Excel.ChartAxis = ChartAxis; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartAxisFormat = (function(_super) { __extends(ChartAxisFormat, _super); function ChartAxisFormat() { /// Encapsulates the format properties for the chart axis. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only. [Api set: ExcelApi 1.1] /// Represents chart line formatting. Read-only. [Api set: ExcelApi 1.1] } ChartAxisFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartAxisFormat; })(OfficeExtension.ClientObject); Excel.ChartAxisFormat = ChartAxisFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartAxisTitle = (function(_super) { __extends(ChartAxisTitle, _super); function ChartAxisTitle() { /// Represents the title of a chart axis. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the formatting of chart axis title. Read-only. [Api set: ExcelApi 1.1] /// Represents the axis title. [Api set: ExcelApi 1.1] /// A boolean that specifies the visibility of an axis title. [Api set: ExcelApi 1.1] } ChartAxisTitle.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartAxisTitle; })(OfficeExtension.ClientObject); Excel.ChartAxisTitle = ChartAxisTitle; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartAxisTitleFormat = (function(_super) { __extends(ChartAxisTitleFormat, _super); function ChartAxisTitleFormat() { /// Represents the chart axis title formatting. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only. [Api set: ExcelApi 1.1] } ChartAxisTitleFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartAxisTitleFormat; })(OfficeExtension.ClientObject); Excel.ChartAxisTitleFormat = ChartAxisTitleFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartCollection = (function(_super) { __extends(ChartCollection, _super); function ChartCollection() { /// A collection of all the chart objects on a worksheet. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the number of charts in the worksheet. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } ChartCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } ChartCollection.prototype.add = function(type, sourceData, seriesBy) { /// /// Creates a new chart. [Api set: ExcelApi 1.1] /// /// Represents the type of a chart. See Excel.ChartType for details. /// The Range object corresponding to the source data. /// Specifies the way columns or rows are used as data series on the chart. See Excel.ChartSeriesBy for details. /// } ChartCollection.prototype.getItem = function(name) { /// /// Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. [Api set: ExcelApi 1.1] /// /// Name of the chart to be retrieved. /// } ChartCollection.prototype.getItemAt = function(index) { /// /// Gets a chart based on its position in the collection. [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return ChartCollection; })(OfficeExtension.ClientObject); Excel.ChartCollection = ChartCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartDataLabelFormat = (function(_super) { __extends(ChartDataLabelFormat, _super); function ChartDataLabelFormat() { /// Encapsulates the format properties for the chart data labels. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the fill format of the current chart data label. Read-only. [Api set: ExcelApi 1.1] /// Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only. [Api set: ExcelApi 1.1] } ChartDataLabelFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartDataLabelFormat; })(OfficeExtension.ClientObject); Excel.ChartDataLabelFormat = ChartDataLabelFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var ChartDataLabelPosition = { __proto__: null, "invalid": "invalid", "none": "none", "center": "center", "insideEnd": "insideEnd", "insideBase": "insideBase", "outsideEnd": "outsideEnd", "left": "left", "right": "right", "top": "top", "bottom": "bottom", "bestFit": "bestFit", "callout": "callout", } Excel.ChartDataLabelPosition = ChartDataLabelPosition; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartDataLabels = (function(_super) { __extends(ChartDataLabels, _super); function ChartDataLabels() { /// Represents a collection of all the data labels on a chart point. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the format of chart data labels, which includes fill and font formatting. Read-only. [Api set: ExcelApi 1.1] /// DataLabelPosition value that represents the position of the data label. See Excel.ChartDataLabelPosition for details. [Api set: ExcelApi 1.1] /// String representing the separator used for the data labels on a chart. [Api set: ExcelApi 1.1] /// Boolean value representing if the data label bubble size is visible or not. [Api set: ExcelApi 1.1] /// Boolean value representing if the data label category name is visible or not. [Api set: ExcelApi 1.1] /// Boolean value representing if the data label legend key is visible or not. [Api set: ExcelApi 1.1] /// Boolean value representing if the data label percentage is visible or not. [Api set: ExcelApi 1.1] /// Boolean value representing if the data label series name is visible or not. [Api set: ExcelApi 1.1] /// Boolean value representing if the data label value is visible or not. [Api set: ExcelApi 1.1] } ChartDataLabels.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartDataLabels; })(OfficeExtension.ClientObject); Excel.ChartDataLabels = ChartDataLabels; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartFill = (function(_super) { __extends(ChartFill, _super); function ChartFill() { /// Represents the fill formatting for a chart element. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. } ChartFill.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } ChartFill.prototype.clear = function() { /// /// Clear the fill color of a chart element. [Api set: ExcelApi 1.1] /// /// } ChartFill.prototype.setSolidColor = function(color) { /// /// Sets the fill formatting of a chart element to a uniform color. [Api set: ExcelApi 1.1] /// /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). /// } return ChartFill; })(OfficeExtension.ClientObject); Excel.ChartFill = ChartFill; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartFont = (function(_super) { __extends(ChartFont, _super); function ChartFont() { /// This object represents the font attributes (font name, font size, color, etc.) for a chart object. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the bold status of font. [Api set: ExcelApi 1.1] /// HTML color code representation of the text color. E.g. #FF0000 represents Red. [Api set: ExcelApi 1.1] /// Represents the italic status of the font. [Api set: ExcelApi 1.1] /// Font name (e.g. "Calibri") [Api set: ExcelApi 1.1] /// Size of the font (e.g. 11) [Api set: ExcelApi 1.1] /// Type of underline applied to the font. See Excel.ChartUnderlineStyle for details. [Api set: ExcelApi 1.1] } ChartFont.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartFont; })(OfficeExtension.ClientObject); Excel.ChartFont = ChartFont; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartGridlines = (function(_super) { __extends(ChartGridlines, _super); function ChartGridlines() { /// Represents major or minor gridlines on a chart axis. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the formatting of chart gridlines. Read-only. [Api set: ExcelApi 1.1] /// Boolean value representing if the axis gridlines are visible or not. [Api set: ExcelApi 1.1] } ChartGridlines.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartGridlines; })(OfficeExtension.ClientObject); Excel.ChartGridlines = ChartGridlines; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartGridlinesFormat = (function(_super) { __extends(ChartGridlinesFormat, _super); function ChartGridlinesFormat() { /// Encapsulates the format properties for chart gridlines. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents chart line formatting. Read-only. [Api set: ExcelApi 1.1] } ChartGridlinesFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartGridlinesFormat; })(OfficeExtension.ClientObject); Excel.ChartGridlinesFormat = ChartGridlinesFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartLegend = (function(_super) { __extends(ChartLegend, _super); function ChartLegend() { /// Represents the legend in a chart. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the formatting of a chart legend, which includes fill and font formatting. Read-only. [Api set: ExcelApi 1.1] /// Boolean value for whether the chart legend should overlap with the main body of the chart. [Api set: ExcelApi 1.1] /// Represents the position of the legend on the chart. See Excel.ChartLegendPosition for details. [Api set: ExcelApi 1.1] /// A boolean value the represents the visibility of a ChartLegend object. [Api set: ExcelApi 1.1] } ChartLegend.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartLegend; })(OfficeExtension.ClientObject); Excel.ChartLegend = ChartLegend; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartLegendFormat = (function(_super) { __extends(ChartLegendFormat, _super); function ChartLegendFormat() { /// Encapsulates the format properties of a chart legend. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the fill format of an object, which includes background formating information. Read-only. [Api set: ExcelApi 1.1] /// Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only. [Api set: ExcelApi 1.1] } ChartLegendFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartLegendFormat; })(OfficeExtension.ClientObject); Excel.ChartLegendFormat = ChartLegendFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var ChartLegendPosition = { __proto__: null, "invalid": "invalid", "top": "top", "bottom": "bottom", "left": "left", "right": "right", "corner": "corner", "custom": "custom", } Excel.ChartLegendPosition = ChartLegendPosition; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartLineFormat = (function(_super) { __extends(ChartLineFormat, _super); function ChartLineFormat() { /// Enapsulates the formatting options for line elements. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// HTML color code representing the color of lines in the chart. [Api set: ExcelApi 1.1] } ChartLineFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } ChartLineFormat.prototype.clear = function() { /// /// Clear the line format of a chart element. [Api set: ExcelApi 1.1] /// /// } return ChartLineFormat; })(OfficeExtension.ClientObject); Excel.ChartLineFormat = ChartLineFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartPoint = (function(_super) { __extends(ChartPoint, _super); function ChartPoint() { /// Represents a point of a series in a chart. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Encapsulates the format properties chart point. Read-only. [Api set: ExcelApi 1.1] /// Returns the value of a chart point. Read-only. [Api set: ExcelApi 1.1] } ChartPoint.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartPoint; })(OfficeExtension.ClientObject); Excel.ChartPoint = ChartPoint; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartPointFormat = (function(_super) { __extends(ChartPointFormat, _super); function ChartPointFormat() { /// Represents formatting object for chart points. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the fill format of a chart, which includes background formating information. Read-only. [Api set: ExcelApi 1.1] } ChartPointFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartPointFormat; })(OfficeExtension.ClientObject); Excel.ChartPointFormat = ChartPointFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartPointsCollection = (function(_super) { __extends(ChartPointsCollection, _super); function ChartPointsCollection() { /// A collection of all the chart points within a series inside a chart. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the number of chart points in the collection. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } ChartPointsCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } ChartPointsCollection.prototype.getItemAt = function(index) { /// /// Retrieve a point based on its position within the series. [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return ChartPointsCollection; })(OfficeExtension.ClientObject); Excel.ChartPointsCollection = ChartPointsCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartSeries = (function(_super) { __extends(ChartSeries, _super); function ChartSeries() { /// Represents a series in a chart. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the formatting of a chart series, which includes fill and line formatting. Read-only. [Api set: ExcelApi 1.1] /// Represents the name of a series in a chart. [Api set: ExcelApi 1.1] /// Represents a collection of all points in the series. Read-only. [Api set: ExcelApi 1.1] } ChartSeries.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartSeries; })(OfficeExtension.ClientObject); Excel.ChartSeries = ChartSeries; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// Specifies whether the series are by rows or by columns. On Desktop, the "auto" option will inspect the source data shape to automatically guess whether the data is by rows or columns; on Excel Online, "auto" will simply default to "columns". [Api set: ExcelApi 1.1] var ChartSeriesBy = { __proto__: null, "auto": "auto", "columns": "columns", "rows": "rows", } Excel.ChartSeriesBy = ChartSeriesBy; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartSeriesCollection = (function(_super) { __extends(ChartSeriesCollection, _super); function ChartSeriesCollection() { /// Represents a collection of chart series. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the number of series in the collection. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } ChartSeriesCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } ChartSeriesCollection.prototype.getItemAt = function(index) { /// /// Retrieves a series based on its position in the collection [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return ChartSeriesCollection; })(OfficeExtension.ClientObject); Excel.ChartSeriesCollection = ChartSeriesCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartSeriesFormat = (function(_super) { __extends(ChartSeriesFormat, _super); function ChartSeriesFormat() { /// encapsulates the format properties for the chart series [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the fill format of a chart series, which includes background formating information. Read-only. [Api set: ExcelApi 1.1] /// Represents line formatting. Read-only. [Api set: ExcelApi 1.1] } ChartSeriesFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartSeriesFormat; })(OfficeExtension.ClientObject); Excel.ChartSeriesFormat = ChartSeriesFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartTitle = (function(_super) { __extends(ChartTitle, _super); function ChartTitle() { /// Represents a chart title object of a chart. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the formatting of a chart title, which includes fill and font formatting. Read-only. [Api set: ExcelApi 1.1] /// Boolean value representing if the chart title will overlay the chart or not. [Api set: ExcelApi 1.1] /// Represents the title text of a chart. [Api set: ExcelApi 1.1] /// A boolean value the represents the visibility of a chart title object. [Api set: ExcelApi 1.1] } ChartTitle.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartTitle; })(OfficeExtension.ClientObject); Excel.ChartTitle = ChartTitle; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var ChartTitleFormat = (function(_super) { __extends(ChartTitleFormat, _super); function ChartTitleFormat() { /// Provides access to the office art formatting for chart title. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the fill format of an object, which includes background formating information. Read-only. [Api set: ExcelApi 1.1] /// Represents the font attributes (font name, font size, color, etc.) for an object. Read-only. [Api set: ExcelApi 1.1] } ChartTitleFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ChartTitleFormat; })(OfficeExtension.ClientObject); Excel.ChartTitleFormat = ChartTitleFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var ChartType = { __proto__: null, "invalid": "invalid", "columnClustered": "columnClustered", "columnStacked": "columnStacked", "columnStacked100": "columnStacked100", "_3DColumnClustered": "_3DColumnClustered", "_3DColumnStacked": "_3DColumnStacked", "_3DColumnStacked100": "_3DColumnStacked100", "barClustered": "barClustered", "barStacked": "barStacked", "barStacked100": "barStacked100", "_3DBarClustered": "_3DBarClustered", "_3DBarStacked": "_3DBarStacked", "_3DBarStacked100": "_3DBarStacked100", "lineStacked": "lineStacked", "lineStacked100": "lineStacked100", "lineMarkers": "lineMarkers", "lineMarkersStacked": "lineMarkersStacked", "lineMarkersStacked100": "lineMarkersStacked100", "pieOfPie": "pieOfPie", "pieExploded": "pieExploded", "_3DPieExploded": "_3DPieExploded", "barOfPie": "barOfPie", "xyscatterSmooth": "xyscatterSmooth", "xyscatterSmoothNoMarkers": "xyscatterSmoothNoMarkers", "xyscatterLines": "xyscatterLines", "xyscatterLinesNoMarkers": "xyscatterLinesNoMarkers", "areaStacked": "areaStacked", "areaStacked100": "areaStacked100", "_3DAreaStacked": "_3DAreaStacked", "_3DAreaStacked100": "_3DAreaStacked100", "doughnutExploded": "doughnutExploded", "radarMarkers": "radarMarkers", "radarFilled": "radarFilled", "surface": "surface", "surfaceWireframe": "surfaceWireframe", "surfaceTopView": "surfaceTopView", "surfaceTopViewWireframe": "surfaceTopViewWireframe", "bubble": "bubble", "bubble3DEffect": "bubble3DEffect", "stockHLC": "stockHLC", "stockOHLC": "stockOHLC", "stockVHLC": "stockVHLC", "stockVOHLC": "stockVOHLC", "cylinderColClustered": "cylinderColClustered", "cylinderColStacked": "cylinderColStacked", "cylinderColStacked100": "cylinderColStacked100", "cylinderBarClustered": "cylinderBarClustered", "cylinderBarStacked": "cylinderBarStacked", "cylinderBarStacked100": "cylinderBarStacked100", "cylinderCol": "cylinderCol", "coneColClustered": "coneColClustered", "coneColStacked": "coneColStacked", "coneColStacked100": "coneColStacked100", "coneBarClustered": "coneBarClustered", "coneBarStacked": "coneBarStacked", "coneBarStacked100": "coneBarStacked100", "coneCol": "coneCol", "pyramidColClustered": "pyramidColClustered", "pyramidColStacked": "pyramidColStacked", "pyramidColStacked100": "pyramidColStacked100", "pyramidBarClustered": "pyramidBarClustered", "pyramidBarStacked": "pyramidBarStacked", "pyramidBarStacked100": "pyramidBarStacked100", "pyramidCol": "pyramidCol", "_3DColumn": "_3DColumn", "line": "line", "_3DLine": "_3DLine", "_3DPie": "_3DPie", "pie": "pie", "xyscatter": "xyscatter", "_3DArea": "_3DArea", "area": "area", "doughnut": "doughnut", "radar": "radar", } Excel.ChartType = ChartType; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var ChartUnderlineStyle = { __proto__: null, "none": "none", "single": "single", } Excel.ChartUnderlineStyle = ChartUnderlineStyle; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var ClearApplyTo = { __proto__: null, "all": "all", "formats": "formats", "contents": "contents", } Excel.ClearApplyTo = ClearApplyTo; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var DeleteShiftDirection = { __proto__: null, "up": "up", "left": "left", } Excel.DeleteShiftDirection = DeleteShiftDirection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var DynamicFilterCriteria = { __proto__: null, "unknown": "unknown", "aboveAverage": "aboveAverage", "allDatesInPeriodApril": "allDatesInPeriodApril", "allDatesInPeriodAugust": "allDatesInPeriodAugust", "allDatesInPeriodDecember": "allDatesInPeriodDecember", "allDatesInPeriodFebruray": "allDatesInPeriodFebruray", "allDatesInPeriodJanuary": "allDatesInPeriodJanuary", "allDatesInPeriodJuly": "allDatesInPeriodJuly", "allDatesInPeriodJune": "allDatesInPeriodJune", "allDatesInPeriodMarch": "allDatesInPeriodMarch", "allDatesInPeriodMay": "allDatesInPeriodMay", "allDatesInPeriodNovember": "allDatesInPeriodNovember", "allDatesInPeriodOctober": "allDatesInPeriodOctober", "allDatesInPeriodQuarter1": "allDatesInPeriodQuarter1", "allDatesInPeriodQuarter2": "allDatesInPeriodQuarter2", "allDatesInPeriodQuarter3": "allDatesInPeriodQuarter3", "allDatesInPeriodQuarter4": "allDatesInPeriodQuarter4", "allDatesInPeriodSeptember": "allDatesInPeriodSeptember", "belowAverage": "belowAverage", "lastMonth": "lastMonth", "lastQuarter": "lastQuarter", "lastWeek": "lastWeek", "lastYear": "lastYear", "nextMonth": "nextMonth", "nextQuarter": "nextQuarter", "nextWeek": "nextWeek", "nextYear": "nextYear", "thisMonth": "thisMonth", "thisQuarter": "thisQuarter", "thisWeek": "thisWeek", "thisYear": "thisYear", "today": "today", "tomorrow": "tomorrow", "yearToDate": "yearToDate", "yesterday": "yesterday", } Excel.DynamicFilterCriteria = DynamicFilterCriteria; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Filter = (function(_super) { __extends(Filter, _super); function Filter() { /// Manages the filtering of a table's column. [Api set: ExcelApi 1.2] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// The currently applied filter on the given column. [Api set: ExcelApi 1.2] } Filter.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Filter.prototype.apply = function(criteria) { /// /// Apply the given filter criteria on the given column. [Api set: ExcelApi 1.2] /// /// The criteria to apply. /// } Filter.prototype.applyBottomItemsFilter = function(count) { /// /// Apply a "Bottom Item" filter to the column for the given number of elements. [Api set: ExcelApi 1.2] /// /// The number of elements from the bottom to show. /// } Filter.prototype.applyBottomPercentFilter = function(percent) { /// /// Apply a "Bottom Percent" filter to the column for the given percentage of elements. [Api set: ExcelApi 1.2] /// /// The percentage of elements from the bottom to show. /// } Filter.prototype.applyCellColorFilter = function(color) { /// /// Apply a "Cell Color" filter to the column for the given color. [Api set: ExcelApi 1.2] /// /// The background color of the cells to show. /// } Filter.prototype.applyCustomFilter = function(criteria1, criteria2, oper) { /// /// Apply a "Icon" filter to the column for the given criteria strings. [Api set: ExcelApi 1.2] /// /// The first criteria string. /// The second criteria string. /// The operator that describes how the two criteria are joined. /// } Filter.prototype.applyDynamicFilter = function(criteria) { /// /// Apply a "Dynamic" filter to the column. [Api set: ExcelApi 1.2] /// /// The dynamic criteria to apply. /// } Filter.prototype.applyFontColorFilter = function(color) { /// /// Apply a "Font Color" filter to the column for the given color. [Api set: ExcelApi 1.2] /// /// The font color of the cells to show. /// } Filter.prototype.applyIconFilter = function(icon) { /// /// Apply a "Icon" filter to the column for the given icon. [Api set: ExcelApi 1.2] /// /// The icons of the cells to show. /// } Filter.prototype.applyTopItemsFilter = function(count) { /// /// Apply a "Top Item" filter to the column for the given number of elements. [Api set: ExcelApi 1.2] /// /// The number of elements from the top to show. /// } Filter.prototype.applyTopPercentFilter = function(percent) { /// /// Apply a "Top Percent" filter to the column for the given percentage of elements. [Api set: ExcelApi 1.2] /// /// The percentage of elements from the top to show. /// } Filter.prototype.applyValuesFilter = function(values) { /// /// Apply a "Values" filter to the column for the given values. [Api set: ExcelApi 1.2] /// /// The list of values to show. /// } Filter.prototype.clear = function() { /// /// Clear the filter on the given column. [Api set: ExcelApi 1.2] /// /// } return Filter; })(OfficeExtension.ClientObject); Excel.Filter = Filter; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var FilterCriteria = (function() { function FilterCriteria() { /// Represents the filtering criteria applied to a column. [Api set: ExcelApi 1.2] /// The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering. [Api set: ExcelApi 1.2] /// The first criterion used to filter data. Used as an operator in the case of "custom" filtering. For example ">50" for number greater than 50 or "=*s" for values ending in "s". Used as a number in the case of top/bottom items/percents. E.g. "5" for the top 5 items if filterOn is set to "topItems" [Api set: ExcelApi 1.2] /// The second criterion used to filter data. Only used as an operator in the case of "custom" filtering. [Api set: ExcelApi 1.2] /// The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering. [Api set: ExcelApi 1.2] /// The property used by the filter to determine whether the values should stay visible. [Api set: ExcelApi 1.2] /// The icon used to filter cells. Used with "icon" filtering. [Api set: ExcelApi 1.2] /// The operator used to combine criterion 1 and 2 when using "custom" filtering. [Api set: ExcelApi 1.2] /// The set of values to be used as part of "values" filtering. [Api set: ExcelApi 1.2] } return FilterCriteria; })(); Interfaces.FilterCriteria.__proto__ = null; Interfaces.FilterCriteria = FilterCriteria; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var FilterDatetime = (function() { function FilterDatetime() { /// Represents how to filter a date when filtering on values. [Api set: ExcelApi 1.2] /// The date in ISO8601 format used to filter data. [Api set: ExcelApi 1.2] /// How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specifity is set to "month", the filter operation will keep all rows with a date in the month of april 2009. [Api set: ExcelApi 1.2] } return FilterDatetime; })(); Interfaces.FilterDatetime.__proto__ = null; Interfaces.FilterDatetime = FilterDatetime; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var FilterDatetimeSpecificity = { __proto__: null, "year": "year", "month": "month", "day": "day", "hour": "hour", "minute": "minute", "second": "second", } Excel.FilterDatetimeSpecificity = FilterDatetimeSpecificity; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var FilterOn = { __proto__: null, "bottomItems": "bottomItems", "bottomPercent": "bottomPercent", "cellColor": "cellColor", "dynamic": "dynamic", "fontColor": "fontColor", "values": "values", "topItems": "topItems", "topPercent": "topPercent", "icon": "icon", "custom": "custom", } Excel.FilterOn = FilterOn; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var FilterOperator = { __proto__: null, "and": "and", "or": "or", } Excel.FilterOperator = FilterOperator; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var FormatProtection = (function(_super) { __extends(FormatProtection, _super); function FormatProtection() { /// Represents the format protection of a range object. [Api set: ExcelApi 1.2] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting. [Api set: ExcelApi 1.2] /// Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting. [Api set: ExcelApi 1.2] } FormatProtection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return FormatProtection; })(OfficeExtension.ClientObject); Excel.FormatProtection = FormatProtection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var FunctionResult = (function(_super) { __extends(FunctionResult, _super); function FunctionResult() { /// An object containing the result of a function-evaluation operation [Api set: ExcelApi 1.2] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. [Api set: ExcelApi 1.2] /// The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set). [Api set: ExcelApi 1.2] } FunctionResult.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return FunctionResult; })(OfficeExtension.ClientObject); Excel.FunctionResult = FunctionResult; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Functions = (function(_super) { __extends(Functions, _super); function Functions() { /// An object for evaluating Excel functions. [Api set: ExcelApi 1.2] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. } Functions.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Functions.prototype.abs = function(number) { /// /// Returns the absolute value of a number, a number without its sign. [Api set: ExcelApi 1.2] /// /// Is the real number for which you want the absolute value. /// } Functions.prototype.accrInt = function(issue, firstInterest, settlement, rate, par, frequency, basis, calcMethod) { /// /// Returns the accrued interest for a security that pays periodic interest. [Api set: ExcelApi 1.2] /// /// Is the security's issue date, expressed as a serial date number. /// Is the security's first interest date, expressed as a serial date number. /// Is the security's settlement date, expressed as a serial date number. /// Is the security's annual coupon rate. /// Is the security's par value. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// Is a logical value: to accrued interest from issue date = TRUE or omitted; to calculate from last coupon payment date = FALSE. /// } Functions.prototype.accrIntM = function(issue, settlement, rate, par, basis) { /// /// Returns the accrued interest for a security that pays interest at maturity. [Api set: ExcelApi 1.2] /// /// Is the security's issue date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's annual coupon rate. /// Is the security's par value. /// Is the type of day count basis to use. /// } Functions.prototype.acos = function(number) { /// /// Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number. [Api set: ExcelApi 1.2] /// /// Is the cosine of the angle you want and must be from -1 to 1. /// } Functions.prototype.acosh = function(number) { /// /// Returns the inverse hyperbolic cosine of a number. [Api set: ExcelApi 1.2] /// /// Is any real number equal to or greater than 1. /// } Functions.prototype.acot = function(number) { /// /// Returns the arccotangent of a number, in radians in the range 0 to Pi. [Api set: ExcelApi 1.2] /// /// Is the cotangent of the angle you want. /// } Functions.prototype.acoth = function(number) { /// /// Returns the inverse hyperbolic cotangent of a number. [Api set: ExcelApi 1.2] /// /// Is the hyperbolic cotangent of the angle that you want. /// } Functions.prototype.amorDegrc = function(cost, datePurchased, firstPeriod, salvage, period, rate, basis) { /// /// Returns the prorated linear depreciation of an asset for each accounting period. [Api set: ExcelApi 1.2] /// /// Is the cost of the asset. /// Is the date the asset is purchased. /// Is the date of the end of the first period. /// Is the salvage value at the end of life of the asset. /// Is the period. /// Is the rate of depreciation. /// Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days. /// } Functions.prototype.amorLinc = function(cost, datePurchased, firstPeriod, salvage, period, rate, basis) { /// /// Returns the prorated linear depreciation of an asset for each accounting period. [Api set: ExcelApi 1.2] /// /// Is the cost of the asset. /// Is the date the asset is purchased. /// Is the date of the end of the first period. /// Is the salvage value at the end of life of the asset. /// Is the period. /// Is the rate of depreciation. /// Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days. /// } Functions.prototype.and = function(values) { /// /// Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references. /// } Functions.prototype.arabic = function(text) { /// /// Converts a Roman numeral to Arabic. [Api set: ExcelApi 1.2] /// /// Is the Roman numeral you want to convert. /// } Functions.prototype.areas = function(reference) { /// /// Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell. [Api set: ExcelApi 1.2] /// /// Is a reference to a cell or range of cells and can refer to multiple areas. /// } Functions.prototype.asc = function(text) { /// /// Changes full-width (double-byte) characters to half-width (single-byte) characters. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is a text, or a reference to a cell containing a text. /// } Functions.prototype.asin = function(number) { /// /// Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2. [Api set: ExcelApi 1.2] /// /// Is the sine of the angle you want and must be from -1 to 1. /// } Functions.prototype.asinh = function(number) { /// /// Returns the inverse hyperbolic sine of a number. [Api set: ExcelApi 1.2] /// /// Is any real number equal to or greater than 1. /// } Functions.prototype.atan = function(number) { /// /// Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2. [Api set: ExcelApi 1.2] /// /// Is the tangent of the angle you want. /// } Functions.prototype.atan2 = function(xNum, yNum) { /// /// Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi. [Api set: ExcelApi 1.2] /// /// Is the x-coordinate of the point. /// Is the y-coordinate of the point. /// } Functions.prototype.atanh = function(number) { /// /// Returns the inverse hyperbolic tangent of a number. [Api set: ExcelApi 1.2] /// /// Is any real number between -1 and 1 excluding -1 and 1. /// } Functions.prototype.aveDev = function(values) { /// /// Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 arguments for which you want the average of the absolute deviations. /// } Functions.prototype.average = function(values) { /// /// Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numeric arguments for which you want the average. /// } Functions.prototype.averageA = function(values) { /// /// Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 arguments for which you want the average. /// } Functions.prototype.averageIf = function(range, criteria, averageRange) { /// /// Finds average(arithmetic mean) for the cells specified by a given condition or criteria. [Api set: ExcelApi 1.2] /// /// Is the range of cells you want evaluated. /// Is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average. /// Are the actual cells to be used to find the average. If omitted, the cells in range are used. /// } Functions.prototype.averageIfs = function(averageRange, values) { /// /// Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2] /// /// Are the actual cells to be used to find the average. /// List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average. /// } Functions.prototype.bahtText = function(number) { /// /// Converts a number to text (baht). [Api set: ExcelApi 1.2] /// /// Is a number that you want to convert. /// } Functions.prototype.base = function(number, radix, minLength) { /// /// Converts a number into a text representation with the given radix (base). [Api set: ExcelApi 1.2] /// /// Is the number that you want to convert. /// Is the base Radix that you want to convert the number into. /// Is the minimum length of the returned string. If omitted leading zeros are not added. /// } Functions.prototype.besselI = function(x, n) { /// /// Returns the modified Bessel function In(x). [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function. /// Is the order of the Bessel function. /// } Functions.prototype.besselJ = function(x, n) { /// /// Returns the Bessel function Jn(x). [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function. /// Is the order of the Bessel function. /// } Functions.prototype.besselK = function(x, n) { /// /// Returns the modified Bessel function Kn(x). [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function. /// Is the order of the function. /// } Functions.prototype.besselY = function(x, n) { /// /// Returns the Bessel function Yn(x). [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function. /// Is the order of the function. /// } Functions.prototype.beta_Dist = function(x, alpha, beta, cumulative, A, B) { /// /// Returns the beta probability distribution function. [Api set: ExcelApi 1.2] /// /// Is the value between A and B at which to evaluate the function. /// Is a parameter to the distribution and must be greater than 0. /// Is a parameter to the distribution and must be greater than 0. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. /// Is an optional lower bound to the interval of x. If omitted, A = 0. /// Is an optional upper bound to the interval of x. If omitted, B = 1. /// } Functions.prototype.beta_Inv = function(probability, alpha, beta, A, B) { /// /// Returns the inverse of the cumulative beta probability density function (BETA.DIST). [Api set: ExcelApi 1.2] /// /// Is a probability associated with the beta distribution. /// Is a parameter to the distribution and must be greater than 0. /// Is a parameter to the distribution and must be greater than 0. /// Is an optional lower bound to the interval of x. If omitted, A = 0. /// Is an optional upper bound to the interval of x. If omitted, B = 1. /// } Functions.prototype.bin2Dec = function(number) { /// /// Converts a binary number to decimal. [Api set: ExcelApi 1.2] /// /// Is the binary number you want to convert. /// } Functions.prototype.bin2Hex = function(number, places) { /// /// Converts a binary number to hexadecimal. [Api set: ExcelApi 1.2] /// /// Is the binary number you want to convert. /// Is the number of characters to use. /// } Functions.prototype.bin2Oct = function(number, places) { /// /// Converts a binary number to octal. [Api set: ExcelApi 1.2] /// /// Is the binary number you want to convert. /// Is the number of characters to use. /// } Functions.prototype.binom_Dist = function(numberS, trials, probabilityS, cumulative) { /// /// Returns the individual term binomial distribution probability. [Api set: ExcelApi 1.2] /// /// Is the number of successes in trials. /// Is the number of independent trials. /// Is the probability of success on each trial. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE. /// } Functions.prototype.binom_Dist_Range = function(trials, probabilityS, numberS, numberS2) { /// /// Returns the probability of a trial result using a binomial distribution. [Api set: ExcelApi 1.2] /// /// Is the number of independent trials. /// Is the probability of success on each trial. /// Is the number of successes in trials. /// If provided this function returns the probability that the number of successful trials shall lie between numberS and numberS2. /// } Functions.prototype.binom_Inv = function(trials, probabilityS, alpha) { /// /// Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. [Api set: ExcelApi 1.2] /// /// Is the number of Bernoulli trials. /// Is the probability of success on each trial, a number between 0 and 1 inclusive. /// Is the criterion value, a number between 0 and 1 inclusive. /// } Functions.prototype.bitand = function(number1, number2) { /// /// Returns a bitwise 'And' of two numbers. [Api set: ExcelApi 1.2] /// /// Is the decimal representation of the binary number you want to evaluate. /// Is the decimal representation of the binary number you want to evaluate. /// } Functions.prototype.bitlshift = function(number, shiftAmount) { /// /// Returns a number shifted left by shift_amount bits. [Api set: ExcelApi 1.2] /// /// Is the decimal representation of the binary number you want to evaluate. /// Is the number of bits that you want to shift Number left by. /// } Functions.prototype.bitor = function(number1, number2) { /// /// Returns a bitwise 'Or' of two numbers. [Api set: ExcelApi 1.2] /// /// Is the decimal representation of the binary number you want to evaluate. /// Is the decimal representation of the binary number you want to evaluate. /// } Functions.prototype.bitrshift = function(number, shiftAmount) { /// /// Returns a number shifted right by shift_amount bits. [Api set: ExcelApi 1.2] /// /// Is the decimal representation of the binary number you want to evaluate. /// Is the number of bits that you want to shift Number right by. /// } Functions.prototype.bitxor = function(number1, number2) { /// /// Returns a bitwise 'Exclusive Or' of two numbers. [Api set: ExcelApi 1.2] /// /// Is the decimal representation of the binary number you want to evaluate. /// Is the decimal representation of the binary number you want to evaluate. /// } Functions.prototype.ceiling_Math = function(number, significance, mode) { /// /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2] /// /// Is the value you want to round. /// Is the multiple to which you want to round. /// When given and nonzero this function will round away from zero. /// } Functions.prototype.ceiling_Precise = function(number, significance) { /// /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2] /// /// Is the value you want to round. /// Is the multiple to which you want to round. /// } Functions.prototype.char = function(number) { /// /// Returns the character specified by the code number from the character set for your computer. [Api set: ExcelApi 1.2] /// /// Is a number between 1 and 255 specifying which character you want. /// } Functions.prototype.chiSq_Dist = function(x, degFreedom, cumulative) { /// /// Returns the left-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2] /// /// Is the value at which you want to evaluate the distribution, a nonnegative number. /// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. /// } Functions.prototype.chiSq_Dist_RT = function(x, degFreedom) { /// /// Returns the right-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2] /// /// Is the value at which you want to evaluate the distribution, a nonnegative number. /// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// } Functions.prototype.chiSq_Inv = function(probability, degFreedom) { /// /// Returns the inverse of the left-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2] /// /// Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive. /// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// } Functions.prototype.chiSq_Inv_RT = function(probability, degFreedom) { /// /// Returns the inverse of the right-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2] /// /// Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive. /// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// } Functions.prototype.choose = function(indexNum, values) { /// /// Chooses a value or action to perform from a list of values, based on an index number. [Api set: ExcelApi 1.2] /// /// Specifies which value argument is selected. indexNum must be between 1 and 254, or a formula or a reference to a number between 1 and 254. /// List of parameters, whose elements are 1 to 254 numbers, cell references, defined names, formulas, functions, or text arguments from which CHOOSE selects. /// } Functions.prototype.clean = function(text) { /// /// Removes all nonprintable characters from text. [Api set: ExcelApi 1.2] /// /// Is any worksheet information from which you want to remove nonprintable characters. /// } Functions.prototype.code = function(text) { /// /// Returns a numeric code for the first character in a text string, in the character set used by your computer. [Api set: ExcelApi 1.2] /// /// Is the text for which you want the code of the first character. /// } Functions.prototype.columns = function(array) { /// /// Returns the number of columns in an array or reference. [Api set: ExcelApi 1.2] /// /// Is an array or array formula, or a reference to a range of cells for which you want the number of columns. /// } Functions.prototype.combin = function(number, numberChosen) { /// /// Returns the number of combinations for a given number of items. [Api set: ExcelApi 1.2] /// /// Is the total number of items. /// Is the number of items in each combination. /// } Functions.prototype.combina = function(number, numberChosen) { /// /// Returns the number of combinations with repetitions for a given number of items. [Api set: ExcelApi 1.2] /// /// Is the total number of items. /// Is the number of items in each combination. /// } Functions.prototype.complex = function(realNum, iNum, suffix) { /// /// Converts real and imaginary coefficients into a complex number. [Api set: ExcelApi 1.2] /// /// Is the real coefficient of the complex number. /// Is the imaginary coefficient of the complex number. /// Is the suffix for the imaginary component of the complex number. /// } Functions.prototype.concatenate = function(values) { /// /// Joins several text strings into one text string. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 text strings to be joined into a single text string and can be text strings, numbers, or single-cell references. /// } Functions.prototype.confidence_Norm = function(alpha, standardDev, size) { /// /// Returns the confidence interval for a population mean, using a normal distribution. [Api set: ExcelApi 1.2] /// /// Is the significance level used to compute the confidence level, a number greater than 0 and less than 1. /// Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0. /// Is the sample size. /// } Functions.prototype.confidence_T = function(alpha, standardDev, size) { /// /// Returns the confidence interval for a population mean, using a Student's T distribution. [Api set: ExcelApi 1.2] /// /// Is the significance level used to compute the confidence level, a number greater than 0 and less than 1. /// Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0. /// Is the sample size. /// } Functions.prototype.convert = function(number, fromUnit, toUnit) { /// /// Converts a number from one measurement system to another. [Api set: ExcelApi 1.2] /// /// Is the value in from_units to convert. /// Is the units for number. /// Is the units for the result. /// } Functions.prototype.cos = function(number) { /// /// Returns the cosine of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the cosine. /// } Functions.prototype.cosh = function(number) { /// /// Returns the hyperbolic cosine of a number. [Api set: ExcelApi 1.2] /// /// Is any real number. /// } Functions.prototype.cot = function(number) { /// /// Returns the cotangent of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the cotangent. /// } Functions.prototype.coth = function(number) { /// /// Returns the hyperbolic cotangent of a number. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the hyperbolic cotangent. /// } Functions.prototype.count = function(values) { /// /// Counts the number of cells in a range that contain numbers. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 arguments that can contain or refer to a variety of different types of data, but only numbers are counted. /// } Functions.prototype.countA = function(values) { /// /// Counts the number of cells in a range that are not empty. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 arguments representing the values and cells you want to count. Values can be any type of information. /// } Functions.prototype.countBlank = function(range) { /// /// Counts the number of empty cells in a specified range of cells. [Api set: ExcelApi 1.2] /// /// Is the range from which you want to count the empty cells. /// } Functions.prototype.countIf = function(range, criteria) { /// /// Counts the number of cells within a range that meet the given condition. [Api set: ExcelApi 1.2] /// /// Is the range of cells from which you want to count nonblank cells. /// Is the condition in the form of a number, expression, or text that defines which cells will be counted. /// } Functions.prototype.countIfs = function(values) { /// /// Counts the number of cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2] /// /// List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition in the form of a number, expression, or text that defines which cells will be counted. /// } Functions.prototype.coupDayBs = function(settlement, maturity, frequency, basis) { /// /// Returns the number of days from the beginning of the coupon period to the settlement date. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.coupDays = function(settlement, maturity, frequency, basis) { /// /// Returns the number of days in the coupon period that contains the settlement date. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.coupDaysNc = function(settlement, maturity, frequency, basis) { /// /// Returns the number of days from the settlement date to the next coupon date. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.coupNcd = function(settlement, maturity, frequency, basis) { /// /// Returns the next coupon date after the settlement date. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.coupNum = function(settlement, maturity, frequency, basis) { /// /// Returns the number of coupons payable between the settlement date and maturity date. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.coupPcd = function(settlement, maturity, frequency, basis) { /// /// Returns the previous coupon date before the settlement date. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.csc = function(number) { /// /// Returns the cosecant of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the cosecant. /// } Functions.prototype.csch = function(number) { /// /// Returns the hyperbolic cosecant of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the hyperbolic cosecant. /// } Functions.prototype.cumIPmt = function(rate, nper, pv, startPeriod, endPeriod, type) { /// /// Returns the cumulative interest paid between two periods. [Api set: ExcelApi 1.2] /// /// Is the interest rate. /// Is the total number of payment periods. /// Is the present value. /// Is the first period in the calculation. /// Is the last period in the calculation. /// Is the timing of the payment. /// } Functions.prototype.cumPrinc = function(rate, nper, pv, startPeriod, endPeriod, type) { /// /// Returns the cumulative principal paid on a loan between two periods. [Api set: ExcelApi 1.2] /// /// Is the interest rate. /// Is the total number of payment periods. /// Is the present value. /// Is the first period in the calculation. /// Is the last period in the calculation. /// Is the timing of the payment. /// } Functions.prototype.daverage = function(database, field, criteria) { /// /// Averages the values in a column in a list or database that match conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dcount = function(database, field, criteria) { /// /// Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dcountA = function(database, field, criteria) { /// /// Counts nonblank cells in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dget = function(database, field, criteria) { /// /// Extracts from a database a single record that matches the conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dmax = function(database, field, criteria) { /// /// Returns the largest number in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dmin = function(database, field, criteria) { /// /// Returns the smallest number in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dproduct = function(database, field, criteria) { /// /// Multiplies the values in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dstDev = function(database, field, criteria) { /// /// Estimates the standard deviation based on a sample from selected database entries. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dstDevP = function(database, field, criteria) { /// /// Calculates the standard deviation based on the entire population of selected database entries. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dsum = function(database, field, criteria) { /// /// Adds the numbers in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dvar = function(database, field, criteria) { /// /// Estimates variance based on a sample from selected database entries. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.dvarP = function(database, field, criteria) { /// /// Calculates variance based on the entire population of selected database entries. [Api set: ExcelApi 1.2] /// /// Is the range of cells that makes up the list or database. A database is a list of related data. /// Is either the label of the column in double quotation marks or a number that represents the column's position in the list. /// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. /// } Functions.prototype.date = function(year, month, day) { /// /// Returns the number that represents the date in Microsoft Excel date-time code. [Api set: ExcelApi 1.2] /// /// Is a number from 1900 or 1904 (depending on the workbook's date system) to 9999. /// Is a number from 1 to 12 representing the month of the year. /// Is a number from 1 to 31 representing the day of the month. /// } Functions.prototype.datevalue = function(dateText) { /// /// Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code. [Api set: ExcelApi 1.2] /// /// Is text that represents a date in a Microsoft Excel date format, between 1/1/1900 or 1/1/1904 (depending on the workbook's date system) and 12/31/9999. /// } Functions.prototype.day = function(serialNumber) { /// /// Returns the day of the month, a number from 1 to 31. [Api set: ExcelApi 1.2] /// /// Is a number in the date-time code used by Microsoft Excel. /// } Functions.prototype.days = function(endDate, startDate) { /// /// Returns the number of days between the two dates. [Api set: ExcelApi 1.2] /// /// startDate and endDate are the two dates between which you want to know the number of days. /// startDate and endDate are the two dates between which you want to know the number of days. /// } Functions.prototype.days360 = function(startDate, endDate, method) { /// /// Returns the number of days between two dates based on a 360-day year (twelve 30-day months). [Api set: ExcelApi 1.2] /// /// startDate and endDate are the two dates between which you want to know the number of days. /// startDate and endDate are the two dates between which you want to know the number of days. /// Is a logical value specifying the calculation method: U.S. (NASD) = FALSE or omitted; European = TRUE. /// } Functions.prototype.db = function(cost, salvage, life, period, month) { /// /// Returns the depreciation of an asset for a specified period using the fixed-declining balance method. [Api set: ExcelApi 1.2] /// /// Is the initial cost of the asset. /// Is the salvage value at the end of the life of the asset. /// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). /// Is the period for which you want to calculate the depreciation. Period must use the same units as Life. /// Is the number of months in the first year. If month is omitted, it is assumed to be 12. /// } Functions.prototype.dbcs = function(text) { /// /// Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is a text, or a reference to a cell containing a text. /// } Functions.prototype.ddb = function(cost, salvage, life, period, factor) { /// /// Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify. [Api set: ExcelApi 1.2] /// /// Is the initial cost of the asset. /// Is the salvage value at the end of the life of the asset. /// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). /// Is the period for which you want to calculate the depreciation. Period must use the same units as Life. /// Is the rate at which the balance declines. If Factor is omitted, it is assumed to be 2 (the double-declining balance method). /// } Functions.prototype.dec2Bin = function(number, places) { /// /// Converts a decimal number to binary. [Api set: ExcelApi 1.2] /// /// Is the decimal integer you want to convert. /// Is the number of characters to use. /// } Functions.prototype.dec2Hex = function(number, places) { /// /// Converts a decimal number to hexadecimal. [Api set: ExcelApi 1.2] /// /// Is the decimal integer you want to convert. /// Is the number of characters to use. /// } Functions.prototype.dec2Oct = function(number, places) { /// /// Converts a decimal number to octal. [Api set: ExcelApi 1.2] /// /// Is the decimal integer you want to convert. /// Is the number of characters to use. /// } Functions.prototype.decimal = function(number, radix) { /// /// Converts a text representation of a number in a given base into a decimal number. [Api set: ExcelApi 1.2] /// /// Is the number that you want to convert. /// Is the base Radix of the number you are converting. /// } Functions.prototype.degrees = function(angle) { /// /// Converts radians to degrees. [Api set: ExcelApi 1.2] /// /// Is the angle in radians that you want to convert. /// } Functions.prototype.delta = function(number1, number2) { /// /// Tests whether two numbers are equal. [Api set: ExcelApi 1.2] /// /// Is the first number. /// Is the second number. /// } Functions.prototype.devSq = function(values) { /// /// Returns the sum of squares of deviations of data points from their sample mean. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 arguments, or an array or array reference, on which you want DEVSQ to calculate. /// } Functions.prototype.disc = function(settlement, maturity, pr, redemption, basis) { /// /// Returns the discount rate for a security. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's price per $100 face value. /// Is the security's redemption value per $100 face value. /// Is the type of day count basis to use. /// } Functions.prototype.dollar = function(number, decimals) { /// /// Converts a number to text, using currency format. [Api set: ExcelApi 1.2] /// /// Is a number, a reference to a cell containing a number, or a formula that evaluates to a number. /// Is the number of digits to the right of the decimal point. The number is rounded as necessary; if omitted, Decimals = 2. /// } Functions.prototype.dollarDe = function(fractionalDollar, fraction) { /// /// Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number. [Api set: ExcelApi 1.2] /// /// Is a number expressed as a fraction. /// Is the integer to use in the denominator of the fraction. /// } Functions.prototype.dollarFr = function(decimalDollar, fraction) { /// /// Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction. [Api set: ExcelApi 1.2] /// /// Is a decimal number. /// Is the integer to use in the denominator of a fraction. /// } Functions.prototype.duration = function(settlement, maturity, coupon, yld, frequency, basis) { /// /// Returns the annual duration of a security with periodic interest payments. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's annual coupon rate. /// Is the security's annual yield. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.ecma_Ceiling = function(number, significance) { /// /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2] /// /// Is the value you want to round. /// Is the multiple to which you want to round. /// } Functions.prototype.edate = function(startDate, months) { /// /// Returns the serial number of the date that is the indicated number of months before or after the start date. [Api set: ExcelApi 1.2] /// /// Is a serial date number that represents the start date. /// Is the number of months before or after startDate. /// } Functions.prototype.effect = function(nominalRate, npery) { /// /// Returns the effective annual interest rate. [Api set: ExcelApi 1.2] /// /// Is the nominal interest rate. /// Is the number of compounding periods per year. /// } Functions.prototype.eoMonth = function(startDate, months) { /// /// Returns the serial number of the last day of the month before or after a specified number of months. [Api set: ExcelApi 1.2] /// /// Is a serial date number that represents the start date. /// Is the number of months before or after the startDate. /// } Functions.prototype.erf = function(lowerLimit, upperLimit) { /// /// Returns the error function. [Api set: ExcelApi 1.2] /// /// Is the lower bound for integrating ERF. /// Is the upper bound for integrating ERF. /// } Functions.prototype.erfC = function(x) { /// /// Returns the complementary error function. [Api set: ExcelApi 1.2] /// /// Is the lower bound for integrating ERF. /// } Functions.prototype.erfC_Precise = function(X) { /// /// Returns the complementary error function. [Api set: ExcelApi 1.2] /// /// Is the lower bound for integrating ERFC.PRECISE. /// } Functions.prototype.erf_Precise = function(X) { /// /// Returns the error function. [Api set: ExcelApi 1.2] /// /// Is the lower bound for integrating ERF.PRECISE. /// } Functions.prototype.error_Type = function(errorVal) { /// /// Returns a number matching an error value. [Api set: ExcelApi 1.2] /// /// Is the error value for which you want the identifying number, and can be an actual error value or a reference to a cell containing an error value. /// } Functions.prototype.even = function(number) { /// /// Rounds a positive number up and negative number down to the nearest even integer. [Api set: ExcelApi 1.2] /// /// Is the value to round. /// } Functions.prototype.exact = function(text1, text2) { /// /// Checks whether two text strings are exactly the same, and returns TRUE or FALSE. EXACT is case-sensitive. [Api set: ExcelApi 1.2] /// /// Is the first text string. /// Is the second text string. /// } Functions.prototype.exp = function(number) { /// /// Returns e raised to the power of a given number. [Api set: ExcelApi 1.2] /// /// Is the exponent applied to the base e. The constant e equals 2.71828182845904, the base of the natural logarithm. /// } Functions.prototype.expon_Dist = function(x, lambda, cumulative) { /// /// Returns the exponential distribution. [Api set: ExcelApi 1.2] /// /// Is the value of the function, a nonnegative number. /// Is the parameter value, a positive number. /// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. /// } Functions.prototype.fvschedule = function(principal, schedule) { /// /// Returns the future value of an initial principal after applying a series of compound interest rates. [Api set: ExcelApi 1.2] /// /// Is the present value. /// Is an array of interest rates to apply. /// } Functions.prototype.f_Dist = function(x, degFreedom1, degFreedom2, cumulative) { /// /// Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets. [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function, a nonnegative number. /// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. /// } Functions.prototype.f_Dist_RT = function(x, degFreedom1, degFreedom2) { /// /// Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets. [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function, a nonnegative number. /// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// } Functions.prototype.f_Inv = function(probability, degFreedom1, degFreedom2) { /// /// Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x. [Api set: ExcelApi 1.2] /// /// Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive. /// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// } Functions.prototype.f_Inv_RT = function(probability, degFreedom1, degFreedom2) { /// /// Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x. [Api set: ExcelApi 1.2] /// /// Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive. /// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. /// } Functions.prototype.fact = function(number) { /// /// Returns the factorial of a number, equal to 1*2*3*...* Number. [Api set: ExcelApi 1.2] /// /// Is the nonnegative number you want the factorial of. /// } Functions.prototype.factDouble = function(number) { /// /// Returns the double factorial of a number. [Api set: ExcelApi 1.2] /// /// Is the value for which to return the double factorial. /// } Functions.prototype.false = function() { /// /// Returns the logical value FALSE. [Api set: ExcelApi 1.2] /// /// } Functions.prototype.find = function(findText, withinText, startNum) { /// /// Returns the starting position of one text string within another text string. FIND is case-sensitive. [Api set: ExcelApi 1.2] /// /// Is the text you want to find. Use double quotes (empty text) to match the first character in withinText; wildcard characters not allowed. /// Is the text containing the text you want to find. /// Specifies the character at which to start the search. The first character in withinText is character number 1. If omitted, startNum = 1. /// } Functions.prototype.findB = function(findText, withinText, startNum) { /// /// Finds the starting position of one text string within another text string. FINDB is case-sensitive. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is the text you want to find. /// Is the text containing the text you want to find. /// Specifies the character at which to start the search. /// } Functions.prototype.fisher = function(x) { /// /// Returns the Fisher transformation. [Api set: ExcelApi 1.2] /// /// Is the value for which you want the transformation, a number between -1 and 1, excluding -1 and 1. /// } Functions.prototype.fisherInv = function(y) { /// /// Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x. [Api set: ExcelApi 1.2] /// /// Is the value for which you want to perform the inverse of the transformation. /// } Functions.prototype.fixed = function(number, decimals, noCommas) { /// /// Rounds a number to the specified number of decimals and returns the result as text with or without commas. [Api set: ExcelApi 1.2] /// /// Is the number you want to round and convert to text. /// Is the number of digits to the right of the decimal point. If omitted, Decimals = 2. /// Is a logical value: do not display commas in the returned text = TRUE; do display commas in the returned text = FALSE or omitted. /// } Functions.prototype.floor_Math = function(number, significance, mode) { /// /// Rounds a number down, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2] /// /// Is the value you want to round. /// Is the multiple to which you want to round. /// When given and nonzero this function will round towards zero. /// } Functions.prototype.floor_Precise = function(number, significance) { /// /// Rounds a number down, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2] /// /// Is the numeric value you want to round. /// Is the multiple to which you want to round. /// } Functions.prototype.fv = function(rate, nper, pmt, pv, type) { /// /// Returns the future value of an investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2] /// /// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. /// Is the total number of payment periods in the investment. /// Is the payment made each period; it cannot change over the life of the investment. /// Is the present value, or the lump-sum amount that a series of future payments is worth now. If omitted, Pv = 0. /// Is a value representing the timing of payment: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. /// } Functions.prototype.gamma = function(x) { /// /// Returns the Gamma function value. [Api set: ExcelApi 1.2] /// /// Is the value for which you want to calculate Gamma. /// } Functions.prototype.gammaLn = function(x) { /// /// Returns the natural logarithm of the gamma function. [Api set: ExcelApi 1.2] /// /// Is the value for which you want to calculate GAMMALN, a positive number. /// } Functions.prototype.gammaLn_Precise = function(x) { /// /// Returns the natural logarithm of the gamma function. [Api set: ExcelApi 1.2] /// /// Is the value for which you want to calculate GAMMALN.PRECISE, a positive number. /// } Functions.prototype.gamma_Dist = function(x, alpha, beta, cumulative) { /// /// Returns the gamma distribution. [Api set: ExcelApi 1.2] /// /// Is the value at which you want to evaluate the distribution, a nonnegative number. /// Is a parameter to the distribution, a positive number. /// Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.DIST returns the standard gamma distribution. /// Is a logical value: return the cumulative distribution function = TRUE; return the probability mass function = FALSE or omitted. /// } Functions.prototype.gamma_Inv = function(probability, alpha, beta) { /// /// Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x. [Api set: ExcelApi 1.2] /// /// Is the probability associated with the gamma distribution, a number between 0 and 1, inclusive. /// Is a parameter to the distribution, a positive number. /// Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.INV returns the inverse of the standard gamma distribution. /// } Functions.prototype.gauss = function(x) { /// /// Returns 0.5 less than the standard normal cumulative distribution. [Api set: ExcelApi 1.2] /// /// Is the value for which you want the distribution. /// } Functions.prototype.gcd = function(values) { /// /// Returns the greatest common divisor. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 values. /// } Functions.prototype.geStep = function(number, step) { /// /// Tests whether a number is greater than a threshold value. [Api set: ExcelApi 1.2] /// /// Is the value to test against step. /// Is the threshold value. /// } Functions.prototype.geoMean = function(values) { /// /// Returns the geometric mean of an array or range of positive numeric data. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the mean. /// } Functions.prototype.hlookup = function(lookupValue, tableArray, rowIndexNum, rangeLookup) { /// /// Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify. [Api set: ExcelApi 1.2] /// /// Is the value to be found in the first row of the table and can be a value, a reference, or a text string. /// Is a table of text, numbers, or logical values in which data is looked up. tableArray can be a reference to a range or a range name. /// Is the row number in tableArray from which the matching value should be returned. The first row of values in the table is row 1. /// Is a logical value: to find the closest match in the top row (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE. /// } Functions.prototype.harMean = function(values) { /// /// Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the harmonic mean. /// } Functions.prototype.hex2Bin = function(number, places) { /// /// Converts a Hexadecimal number to binary. [Api set: ExcelApi 1.2] /// /// Is the hexadecimal number you want to convert. /// Is the number of characters to use. /// } Functions.prototype.hex2Dec = function(number) { /// /// Converts a hexadecimal number to decimal. [Api set: ExcelApi 1.2] /// /// Is the hexadecimal number you want to convert. /// } Functions.prototype.hex2Oct = function(number, places) { /// /// Converts a hexadecimal number to octal. [Api set: ExcelApi 1.2] /// /// Is the hexadecimal number you want to convert. /// Is the number of characters to use. /// } Functions.prototype.hour = function(serialNumber) { /// /// Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.). [Api set: ExcelApi 1.2] /// /// Is a number in the date-time code used by Microsoft Excel, or text in time format, such as 16:48:00 or 4:48:00 PM. /// } Functions.prototype.hypGeom_Dist = function(sampleS, numberSample, populationS, numberPop, cumulative) { /// /// Returns the hypergeometric distribution. [Api set: ExcelApi 1.2] /// /// Is the number of successes in the sample. /// Is the size of the sample. /// Is the number of successes in the population. /// Is the population size. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. /// } Functions.prototype.hyperlink = function(linkLocation, friendlyName) { /// /// Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet. [Api set: ExcelApi 1.2] /// /// Is the text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path. /// Is text or a number that is displayed in the cell. If omitted, the cell displays the linkLocation text. /// } Functions.prototype.iso_Ceiling = function(number, significance) { /// /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2] /// /// Is the value you want to round. /// Is the optional multiple to which you want to round. /// } Functions.prototype.if = function(logicalTest, valueIfTrue, valueIfFalse) { /// /// Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE. [Api set: ExcelApi 1.2] /// /// Is any value or expression that can be evaluated to TRUE or FALSE. /// Is the value that is returned if logicalTest is TRUE. If omitted, TRUE is returned. You can nest up to seven IF functions. /// Is the value that is returned if logicalTest is FALSE. If omitted, FALSE is returned. /// } Functions.prototype.imAbs = function(inumber) { /// /// Returns the absolute value (modulus) of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the absolute value. /// } Functions.prototype.imArgument = function(inumber) { /// /// Returns the argument q, an angle expressed in radians. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the argument. /// } Functions.prototype.imConjugate = function(inumber) { /// /// Returns the complex conjugate of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the conjugate. /// } Functions.prototype.imCos = function(inumber) { /// /// Returns the cosine of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the cosine. /// } Functions.prototype.imCosh = function(inumber) { /// /// Returns the hyperbolic cosine of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the hyperbolic cosine. /// } Functions.prototype.imCot = function(inumber) { /// /// Returns the cotangent of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the cotangent. /// } Functions.prototype.imCsc = function(inumber) { /// /// Returns the cosecant of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the cosecant. /// } Functions.prototype.imCsch = function(inumber) { /// /// Returns the hyperbolic cosecant of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the hyperbolic cosecant. /// } Functions.prototype.imDiv = function(inumber1, inumber2) { /// /// Returns the quotient of two complex numbers. [Api set: ExcelApi 1.2] /// /// Is the complex numerator or dividend. /// Is the complex denominator or divisor. /// } Functions.prototype.imExp = function(inumber) { /// /// Returns the exponential of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the exponential. /// } Functions.prototype.imLn = function(inumber) { /// /// Returns the natural logarithm of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the natural logarithm. /// } Functions.prototype.imLog10 = function(inumber) { /// /// Returns the base-10 logarithm of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the common logarithm. /// } Functions.prototype.imLog2 = function(inumber) { /// /// Returns the base-2 logarithm of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the base-2 logarithm. /// } Functions.prototype.imPower = function(inumber, number) { /// /// Returns a complex number raised to an integer power. [Api set: ExcelApi 1.2] /// /// Is a complex number you want to raise to a power. /// Is the power to which you want to raise the complex number. /// } Functions.prototype.imProduct = function(values) { /// /// Returns the product of 1 to 255 complex numbers. [Api set: ExcelApi 1.2] /// /// Inumber1, Inumber2,... are from 1 to 255 complex numbers to multiply. /// } Functions.prototype.imReal = function(inumber) { /// /// Returns the real coefficient of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the real coefficient. /// } Functions.prototype.imSec = function(inumber) { /// /// Returns the secant of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the secant. /// } Functions.prototype.imSech = function(inumber) { /// /// Returns the hyperbolic secant of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the hyperbolic secant. /// } Functions.prototype.imSin = function(inumber) { /// /// Returns the sine of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the sine. /// } Functions.prototype.imSinh = function(inumber) { /// /// Returns the hyperbolic sine of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the hyperbolic sine. /// } Functions.prototype.imSqrt = function(inumber) { /// /// Returns the square root of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the square root. /// } Functions.prototype.imSub = function(inumber1, inumber2) { /// /// Returns the difference of two complex numbers. [Api set: ExcelApi 1.2] /// /// Is the complex number from which to subtract inumber2. /// Is the complex number to subtract from inumber1. /// } Functions.prototype.imSum = function(values) { /// /// Returns the sum of complex numbers. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are from 1 to 255 complex numbers to add. /// } Functions.prototype.imTan = function(inumber) { /// /// Returns the tangent of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the tangent. /// } Functions.prototype.imaginary = function(inumber) { /// /// Returns the imaginary coefficient of a complex number. [Api set: ExcelApi 1.2] /// /// Is a complex number for which you want the imaginary coefficient. /// } Functions.prototype.int = function(number) { /// /// Rounds a number down to the nearest integer. [Api set: ExcelApi 1.2] /// /// Is the real number you want to round down to an integer. /// } Functions.prototype.intRate = function(settlement, maturity, investment, redemption, basis) { /// /// Returns the interest rate for a fully invested security. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the amount invested in the security. /// Is the amount to be received at maturity. /// Is the type of day count basis to use. /// } Functions.prototype.ipmt = function(rate, per, nper, pv, fv, type) { /// /// Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2] /// /// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. /// Is the period for which you want to find the interest and must be in the range 1 to Nper. /// Is the total number of payment periods in an investment. /// Is the present value, or the lump-sum amount that a series of future payments is worth now. /// Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, Fv = 0. /// Is a logical value representing the timing of payment: at the end of the period = 0 or omitted, at the beginning of the period = 1. /// } Functions.prototype.irr = function(values, guess) { /// /// Returns the internal rate of return for a series of cash flows. [Api set: ExcelApi 1.2] /// /// Is an array or a reference to cells that contain numbers for which you want to calculate the internal rate of return. /// Is a number that you guess is close to the result of IRR; 0.1 (10 percent) if omitted. /// } Functions.prototype.isErr = function(value) { /// /// Checks whether a value is an error (#VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!) excluding #N/A, and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. /// } Functions.prototype.isError = function(value) { /// /// Checks whether a value is an error (#N/A, #VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!), and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. /// } Functions.prototype.isEven = function(number) { /// /// Returns TRUE if the number is even. [Api set: ExcelApi 1.2] /// /// Is the value to test. /// } Functions.prototype.isFormula = function(reference) { /// /// Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is a reference to the cell you want to test. Reference can be a cell reference, a formula, or name that refers to a cell. /// } Functions.prototype.isLogical = function(value) { /// /// Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. /// } Functions.prototype.isNA = function(value) { /// /// Checks whether a value is #N/A, and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. /// } Functions.prototype.isNonText = function(value) { /// /// Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want tested: a cell; a formula; or a name referring to a cell, formula, or value. /// } Functions.prototype.isNumber = function(value) { /// /// Checks whether a value is a number, and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. /// } Functions.prototype.isOdd = function(number) { /// /// Returns TRUE if the number is odd. [Api set: ExcelApi 1.2] /// /// Is the value to test. /// } Functions.prototype.isText = function(value) { /// /// Checks whether a value is text, and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. /// } Functions.prototype.isoWeekNum = function(date) { /// /// Returns the ISO week number in the year for a given date. [Api set: ExcelApi 1.2] /// /// Is the date-time code used by Microsoft Excel for date and time calculation. /// } Functions.prototype.ispmt = function(rate, per, nper, pv) { /// /// Returns the interest paid during a specific period of an investment. [Api set: ExcelApi 1.2] /// /// Interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. /// Period for which you want to find the interest. /// Number of payment periods in an investment. /// Lump sum amount that a series of future payments is right now. /// } Functions.prototype.isref = function(value) { /// /// Checks whether a value is a reference, and returns TRUE or FALSE. [Api set: ExcelApi 1.2] /// /// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. /// } Functions.prototype.kurt = function(values) { /// /// Returns the kurtosis of a data set. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the kurtosis. /// } Functions.prototype.large = function(array, k) { /// /// Returns the k-th largest value in a data set. For example, the fifth largest number. [Api set: ExcelApi 1.2] /// /// Is the array or range of data for which you want to determine the k-th largest value. /// Is the position (from the largest) in the array or cell range of the value to return. /// } Functions.prototype.lcm = function(values) { /// /// Returns the least common multiple. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 values for which you want the least common multiple. /// } Functions.prototype.left = function(text, numChars) { /// /// Returns the specified number of characters from the start of a text string. [Api set: ExcelApi 1.2] /// /// Is the text string containing the characters you want to extract. /// Specifies how many characters you want LEFT to extract; 1 if omitted. /// } Functions.prototype.leftb = function(text, numBytes) { /// /// Returns the specified number of characters from the start of a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is the text string containing the characters you want to extract. /// Specifies how many characters you want LEFT to return. /// } Functions.prototype.len = function(text) { /// /// Returns the number of characters in a text string. [Api set: ExcelApi 1.2] /// /// Is the text whose length you want to find. Spaces count as characters. /// } Functions.prototype.lenb = function(text) { /// /// Returns the number of characters in a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is the text whose length you want to find. /// } Functions.prototype.ln = function(number) { /// /// Returns the natural logarithm of a number. [Api set: ExcelApi 1.2] /// /// Is the positive real number for which you want the natural logarithm. /// } Functions.prototype.log = function(number, base) { /// /// Returns the logarithm of a number to the base you specify. [Api set: ExcelApi 1.2] /// /// Is the positive real number for which you want the logarithm. /// Is the base of the logarithm; 10 if omitted. /// } Functions.prototype.log10 = function(number) { /// /// Returns the base-10 logarithm of a number. [Api set: ExcelApi 1.2] /// /// Is the positive real number for which you want the base-10 logarithm. /// } Functions.prototype.logNorm_Dist = function(x, mean, standardDev, cumulative) { /// /// Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function, a positive number. /// Is the mean of ln(x). /// Is the standard deviation of ln(x), a positive number. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. /// } Functions.prototype.logNorm_Inv = function(probability, mean, standardDev) { /// /// Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. [Api set: ExcelApi 1.2] /// /// Is a probability associated with the lognormal distribution, a number between 0 and 1, inclusive. /// Is the mean of ln(x). /// Is the standard deviation of ln(x), a positive number. /// } Functions.prototype.lookup = function(lookupValue, lookupVector, resultVector) { /// /// Looks up a value either from a one-row or one-column range or from an array. Provided for backward compatibility. [Api set: ExcelApi 1.2] /// /// Is a value that LOOKUP searches for in lookupVector and can be a number, text, a logical value, or a name or reference to a value. /// Is a range that contains only one row or one column of text, numbers, or logical values, placed in ascending order. /// Is a range that contains only one row or column, the same size as lookupVector. /// } Functions.prototype.lower = function(text) { /// /// Converts all letters in a text string to lowercase. [Api set: ExcelApi 1.2] /// /// Is the text you want to convert to lowercase. Characters in Text that are not letters are not changed. /// } Functions.prototype.mduration = function(settlement, maturity, coupon, yld, frequency, basis) { /// /// Returns the Macauley modified duration for a security with an assumed par value of $100. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's annual coupon rate. /// Is the security's annual yield. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.mirr = function(values, financeRate, reinvestRate) { /// /// Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash. [Api set: ExcelApi 1.2] /// /// Is an array or a reference to cells that contain numbers that represent a series of payments (negative) and income (positive) at regular periods. /// Is the interest rate you pay on the money used in the cash flows. /// Is the interest rate you receive on the cash flows as you reinvest them. /// } Functions.prototype.mround = function(number, multiple) { /// /// Returns a number rounded to the desired multiple. [Api set: ExcelApi 1.2] /// /// Is the value to round. /// Is the multiple to which you want to round number. /// } Functions.prototype.match = function(lookupValue, lookupArray, matchType) { /// /// Returns the relative position of an item in an array that matches a specified value in a specified order. [Api set: ExcelApi 1.2] /// /// Is the value you use to find the value you want in the array, a number, text, or logical value, or a reference to one of these. /// Is a contiguous range of cells containing possible lookup values, an array of values, or a reference to an array. /// Is a number 1, 0, or -1 indicating which value to return. /// } Functions.prototype.max = function(values) { /// /// Returns the largest value in a set of values. Ignores logical values and text. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum. /// } Functions.prototype.maxA = function(values) { /// /// Returns the largest value in a set of values. Does not ignore logical values and text. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum. /// } Functions.prototype.median = function(values) { /// /// Returns the median, or the number in the middle of the set of given numbers. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the median. /// } Functions.prototype.mid = function(text, startNum, numChars) { /// /// Returns the characters from the middle of a text string, given a starting position and length. [Api set: ExcelApi 1.2] /// /// Is the text string from which you want to extract the characters. /// Is the position of the first character you want to extract. The first character in Text is 1. /// Specifies how many characters to return from Text. /// } Functions.prototype.midb = function(text, startNum, numBytes) { /// /// Returns characters from the middle of a text string, given a starting position and length. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is the text string containing the characters you want to extract. /// Is the position of the first character you want to extract in text. /// Specifies how many characters to return from text. /// } Functions.prototype.min = function(values) { /// /// Returns the smallest number in a set of values. Ignores logical values and text. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum. /// } Functions.prototype.minA = function(values) { /// /// Returns the smallest value in a set of values. Does not ignore logical values and text. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum. /// } Functions.prototype.minute = function(serialNumber) { /// /// Returns the minute, a number from 0 to 59. [Api set: ExcelApi 1.2] /// /// Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:00 or 4:48:00 PM. /// } Functions.prototype.mod = function(number, divisor) { /// /// Returns the remainder after a number is divided by a divisor. [Api set: ExcelApi 1.2] /// /// Is the number for which you want to find the remainder after the division is performed. /// Is the number by which you want to divide Number. /// } Functions.prototype.month = function(serialNumber) { /// /// Returns the month, a number from 1 (January) to 12 (December). [Api set: ExcelApi 1.2] /// /// Is a number in the date-time code used by Microsoft Excel. /// } Functions.prototype.multiNomial = function(values) { /// /// Returns the multinomial of a set of numbers. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 values for which you want the multinomial. /// } Functions.prototype.n = function(value) { /// /// Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero). [Api set: ExcelApi 1.2] /// /// Is the value you want converted. /// } Functions.prototype.nper = function(rate, pmt, pv, fv, type) { /// /// Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2] /// /// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. /// Is the payment made each period; it cannot change over the life of the investment. /// Is the present value, or the lump-sum amount that a series of future payments is worth now. /// Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, zero is used. /// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. /// } Functions.prototype.na = function() { /// /// Returns the error value #N/A (value not available). [Api set: ExcelApi 1.2] /// /// } Functions.prototype.negBinom_Dist = function(numberF, numberS, probabilityS, cumulative) { /// /// Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success. [Api set: ExcelApi 1.2] /// /// Is the number of failures. /// Is the threshold number of successes. /// Is the probability of a success; a number between 0 and 1. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE. /// } Functions.prototype.networkDays = function(startDate, endDate, holidays) { /// /// Returns the number of whole workdays between two dates. [Api set: ExcelApi 1.2] /// /// Is a serial date number that represents the start date. /// Is a serial date number that represents the end date. /// Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. /// } Functions.prototype.networkDays_Intl = function(startDate, endDate, weekend, holidays) { /// /// Returns the number of whole workdays between two dates with custom weekend parameters. [Api set: ExcelApi 1.2] /// /// Is a serial date number that represents the start date. /// Is a serial date number that represents the end date. /// Is a number or string specifying when weekends occur. /// Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. /// } Functions.prototype.nominal = function(effectRate, npery) { /// /// Returns the annual nominal interest rate. [Api set: ExcelApi 1.2] /// /// Is the effective interest rate. /// Is the number of compounding periods per year. /// } Functions.prototype.norm_Dist = function(x, mean, standardDev, cumulative) { /// /// Returns the normal distribution for the specified mean and standard deviation. [Api set: ExcelApi 1.2] /// /// Is the value for which you want the distribution. /// Is the arithmetic mean of the distribution. /// Is the standard deviation of the distribution, a positive number. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. /// } Functions.prototype.norm_Inv = function(probability, mean, standardDev) { /// /// Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. [Api set: ExcelApi 1.2] /// /// Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive. /// Is the arithmetic mean of the distribution. /// Is the standard deviation of the distribution, a positive number. /// } Functions.prototype.norm_S_Dist = function(z, cumulative) { /// /// Returns the standard normal distribution (has a mean of zero and a standard deviation of one). [Api set: ExcelApi 1.2] /// /// Is the value for which you want the distribution. /// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. /// } Functions.prototype.norm_S_Inv = function(probability) { /// /// Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one). [Api set: ExcelApi 1.2] /// /// Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive. /// } Functions.prototype.not = function(logical) { /// /// Changes FALSE to TRUE, or TRUE to FALSE. [Api set: ExcelApi 1.2] /// /// Is a value or expression that can be evaluated to TRUE or FALSE. /// } Functions.prototype.now = function() { /// /// Returns the current date and time formatted as a date and time. [Api set: ExcelApi 1.2] /// /// } Functions.prototype.npv = function(rate, values) { /// /// Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values). [Api set: ExcelApi 1.2] /// /// Is the rate of discount over the length of one period. /// List of parameters, whose elements are 1 to 254 payments and income, equally spaced in time and occurring at the end of each period. /// } Functions.prototype.numberValue = function(text, decimalSeparator, groupSeparator) { /// /// Converts text to number in a locale-independent manner. [Api set: ExcelApi 1.2] /// /// Is the string representing the number you want to convert. /// Is the character used as the decimal separator in the string. /// Is the character used as the group separator in the string. /// } Functions.prototype.oct2Bin = function(number, places) { /// /// Converts an octal number to binary. [Api set: ExcelApi 1.2] /// /// Is the octal number you want to convert. /// Is the number of characters to use. /// } Functions.prototype.oct2Dec = function(number) { /// /// Converts an octal number to decimal. [Api set: ExcelApi 1.2] /// /// Is the octal number you want to convert. /// } Functions.prototype.oct2Hex = function(number, places) { /// /// Converts an octal number to hexadecimal. [Api set: ExcelApi 1.2] /// /// Is the octal number you want to convert. /// Is the number of characters to use. /// } Functions.prototype.odd = function(number) { /// /// Rounds a positive number up and negative number down to the nearest odd integer. [Api set: ExcelApi 1.2] /// /// Is the value to round. /// } Functions.prototype.oddFPrice = function(settlement, maturity, issue, firstCoupon, rate, yld, redemption, frequency, basis) { /// /// Returns the price per $100 face value of a security with an odd first period. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's issue date, expressed as a serial date number. /// Is the security's first coupon date, expressed as a serial date number. /// Is the security's interest rate. /// Is the security's annual yield. /// Is the security's redemption value per $100 face value. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.oddFYield = function(settlement, maturity, issue, firstCoupon, rate, pr, redemption, frequency, basis) { /// /// Returns the yield of a security with an odd first period. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's issue date, expressed as a serial date number. /// Is the security's first coupon date, expressed as a serial date number. /// Is the security's interest rate. /// Is the security's price. /// Is the security's redemption value per $100 face value. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.oddLPrice = function(settlement, maturity, lastInterest, rate, yld, redemption, frequency, basis) { /// /// Returns the price per $100 face value of a security with an odd last period. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's last coupon date, expressed as a serial date number. /// Is the security's interest rate. /// Is the security's annual yield. /// Is the security's redemption value per $100 face value. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.oddLYield = function(settlement, maturity, lastInterest, rate, pr, redemption, frequency, basis) { /// /// Returns the yield of a security with an odd last period. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's last coupon date, expressed as a serial date number. /// Is the security's interest rate. /// Is the security's price. /// Is the security's redemption value per $100 face value. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.or = function(values) { /// /// Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. Returns FALSE only if all arguments are FALSE. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 conditions that you want to test that can be either TRUE or FALSE. /// } Functions.prototype.pduration = function(rate, pv, fv) { /// /// Returns the number of periods required by an investment to reach a specified value. [Api set: ExcelApi 1.2] /// /// Is the interest rate per period. /// Is the present value of the investment. /// Is the desired future value of the investment. /// } Functions.prototype.percentRank_Exc = function(array, x, significance) { /// /// Returns the rank of a value in a data set as a percentage of the data set as a percentage (0..1, exclusive) of the data set. [Api set: ExcelApi 1.2] /// /// Is the array or range of data with numeric values that defines relative standing. /// Is the value for which you want to know the rank. /// Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%). /// } Functions.prototype.percentRank_Inc = function(array, x, significance) { /// /// Returns the rank of a value in a data set as a percentage of the data set as a percentage (0..1, inclusive) of the data set. [Api set: ExcelApi 1.2] /// /// Is the array or range of data with numeric values that defines relative standing. /// Is the value for which you want to know the rank. /// Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%). /// } Functions.prototype.percentile_Exc = function(array, k) { /// /// Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive. [Api set: ExcelApi 1.2] /// /// Is the array or range of data that defines relative standing. /// Is the percentile value that is between 0 through 1, inclusive. /// } Functions.prototype.percentile_Inc = function(array, k) { /// /// Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive. [Api set: ExcelApi 1.2] /// /// Is the array or range of data that defines relative standing. /// Is the percentile value that is between 0 through 1, inclusive. /// } Functions.prototype.permut = function(number, numberChosen) { /// /// Returns the number of permutations for a given number of objects that can be selected from the total objects. [Api set: ExcelApi 1.2] /// /// Is the total number of objects. /// Is the number of objects in each permutation. /// } Functions.prototype.permutationa = function(number, numberChosen) { /// /// Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects. [Api set: ExcelApi 1.2] /// /// Is the total number of objects. /// Is the number of objects in each permutation. /// } Functions.prototype.phi = function(x) { /// /// Returns the value of the density function for a standard normal distribution. [Api set: ExcelApi 1.2] /// /// Is the number for which you want the density of the standard normal distribution. /// } Functions.prototype.pi = function() { /// /// Returns the value of Pi, 3.14159265358979, accurate to 15 digits. [Api set: ExcelApi 1.2] /// /// } Functions.prototype.pmt = function(rate, nper, pv, fv, type) { /// /// Calculates the payment for a loan based on constant payments and a constant interest rate. [Api set: ExcelApi 1.2] /// /// Is the interest rate per period for the loan. For example, use 6%/4 for quarterly payments at 6% APR. /// Is the total number of payments for the loan. /// Is the present value: the total amount that a series of future payments is worth now. /// Is the future value, or a cash balance you want to attain after the last payment is made, 0 (zero) if omitted. /// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. /// } Functions.prototype.poisson_Dist = function(x, mean, cumulative) { /// /// Returns the Poisson distribution. [Api set: ExcelApi 1.2] /// /// Is the number of events. /// Is the expected numeric value, a positive number. /// Is a logical value: for the cumulative Poisson probability, use TRUE; for the Poisson probability mass function, use FALSE. /// } Functions.prototype.power = function(number, power) { /// /// Returns the result of a number raised to a power. [Api set: ExcelApi 1.2] /// /// Is the base number, any real number. /// Is the exponent, to which the base number is raised. /// } Functions.prototype.ppmt = function(rate, per, nper, pv, fv, type) { /// /// Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2] /// /// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. /// Specifies the period and must be in the range 1 to nper. /// Is the total number of payment periods in an investment. /// Is the present value: the total amount that a series of future payments is worth now. /// Is the future value, or cash balance you want to attain after the last payment is made. /// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. /// } Functions.prototype.price = function(settlement, maturity, rate, yld, redemption, frequency, basis) { /// /// Returns the price per $100 face value of a security that pays periodic interest. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's annual coupon rate. /// Is the security's annual yield. /// Is the security's redemption value per $100 face value. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.priceDisc = function(settlement, maturity, discount, redemption, basis) { /// /// Returns the price per $100 face value of a discounted security. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's discount rate. /// Is the security's redemption value per $100 face value. /// Is the type of day count basis to use. /// } Functions.prototype.priceMat = function(settlement, maturity, issue, rate, yld, basis) { /// /// Returns the price per $100 face value of a security that pays interest at maturity. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's issue date, expressed as a serial date number. /// Is the security's interest rate at date of issue. /// Is the security's annual yield. /// Is the type of day count basis to use. /// } Functions.prototype.product = function(values) { /// /// Multiplies all the numbers given as arguments. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers, logical values, or text representations of numbers that you want to multiply. /// } Functions.prototype.proper = function(text) { /// /// Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase. [Api set: ExcelApi 1.2] /// /// Is text enclosed in quotation marks, a formula that returns text, or a reference to a cell containing text to partially capitalize. /// } Functions.prototype.pv = function(rate, nper, pmt, fv, type) { /// /// Returns the present value of an investment: the total amount that a series of future payments is worth now. [Api set: ExcelApi 1.2] /// /// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. /// Is the total number of payment periods in an investment. /// Is the payment made each period and cannot change over the life of the investment. /// Is the future value, or a cash balance you want to attain after the last payment is made. /// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. /// } Functions.prototype.quartile_Exc = function(array, quart) { /// /// Returns the quartile of a data set, based on percentile values from 0..1, exclusive. [Api set: ExcelApi 1.2] /// /// Is the array or cell range of numeric values for which you want the quartile value. /// Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4. /// } Functions.prototype.quartile_Inc = function(array, quart) { /// /// Returns the quartile of a data set, based on percentile values from 0..1, inclusive. [Api set: ExcelApi 1.2] /// /// Is the array or cell range of numeric values for which you want the quartile value. /// Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4. /// } Functions.prototype.quotient = function(numerator, denominator) { /// /// Returns the integer portion of a division. [Api set: ExcelApi 1.2] /// /// Is the dividend. /// Is the divisor. /// } Functions.prototype.radians = function(angle) { /// /// Converts degrees to radians. [Api set: ExcelApi 1.2] /// /// Is an angle in degrees that you want to convert. /// } Functions.prototype.rand = function() { /// /// Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation). [Api set: ExcelApi 1.2] /// /// } Functions.prototype.randBetween = function(bottom, top) { /// /// Returns a random number between the numbers you specify. [Api set: ExcelApi 1.2] /// /// Is the smallest integer RANDBETWEEN will return. /// Is the largest integer RANDBETWEEN will return. /// } Functions.prototype.rank_Avg = function(number, ref, order) { /// /// Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned. [Api set: ExcelApi 1.2] /// /// Is the number for which you want to find the rank. /// Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored. /// Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value. /// } Functions.prototype.rank_Eq = function(number, ref, order) { /// /// Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned. [Api set: ExcelApi 1.2] /// /// Is the number for which you want to find the rank. /// Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored. /// Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value. /// } Functions.prototype.rate = function(nper, pmt, pv, fv, type, guess) { /// /// Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR. [Api set: ExcelApi 1.2] /// /// Is the total number of payment periods for the loan or investment. /// Is the payment made each period and cannot change over the life of the loan or investment. /// Is the present value: the total amount that a series of future payments is worth now. /// Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, uses Fv = 0. /// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. /// Is your guess for what the rate will be; if omitted, Guess = 0.1 (10 percent). /// } Functions.prototype.received = function(settlement, maturity, investment, discount, basis) { /// /// Returns the amount received at maturity for a fully invested security. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the amount invested in the security. /// Is the security's discount rate. /// Is the type of day count basis to use. /// } Functions.prototype.replace = function(oldText, startNum, numChars, newText) { /// /// Replaces part of a text string with a different text string. [Api set: ExcelApi 1.2] /// /// Is text in which you want to replace some characters. /// Is the position of the character in oldText that you want to replace with newText. /// Is the number of characters in oldText that you want to replace. /// Is the text that will replace characters in oldText. /// } Functions.prototype.replaceB = function(oldText, startNum, numBytes, newText) { /// /// Replaces part of a text string with a different text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is text in which you want to replace some characters. /// Is the position of the character in oldText that you want to replace with newText. /// Is the number of characters in oldText that you want to replace with newText. /// Is the text that will replace characters in oldText. /// } Functions.prototype.rept = function(text, numberTimes) { /// /// Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string. [Api set: ExcelApi 1.2] /// /// Is the text you want to repeat. /// Is a positive number specifying the number of times to repeat text. /// } Functions.prototype.right = function(text, numChars) { /// /// Returns the specified number of characters from the end of a text string. [Api set: ExcelApi 1.2] /// /// Is the text string that contains the characters you want to extract. /// Specifies how many characters you want to extract, 1 if omitted. /// } Functions.prototype.rightb = function(text, numBytes) { /// /// Returns the specified number of characters from the end of a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2] /// /// Is the text string containing the characters you want to extract. /// Specifies how many characters you want to extract. /// } Functions.prototype.roman = function(number, form) { /// /// Converts an Arabic numeral to Roman, as text. [Api set: ExcelApi 1.2] /// /// Is the Arabic numeral you want to convert. /// Is the number specifying the type of Roman numeral you want. /// } Functions.prototype.round = function(number, numDigits) { /// /// Rounds a number to a specified number of digits. [Api set: ExcelApi 1.2] /// /// Is the number you want to round. /// Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero to the nearest integer. /// } Functions.prototype.roundDown = function(number, numDigits) { /// /// Rounds a number down, toward zero. [Api set: ExcelApi 1.2] /// /// Is any real number that you want rounded down. /// Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer. /// } Functions.prototype.roundUp = function(number, numDigits) { /// /// Rounds a number up, away from zero. [Api set: ExcelApi 1.2] /// /// Is any real number that you want rounded up. /// Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer. /// } Functions.prototype.rows = function(array) { /// /// Returns the number of rows in a reference or array. [Api set: ExcelApi 1.2] /// /// Is an array, an array formula, or a reference to a range of cells for which you want the number of rows. /// } Functions.prototype.rri = function(nper, pv, fv) { /// /// Returns an equivalent interest rate for the growth of an investment. [Api set: ExcelApi 1.2] /// /// Is the number of periods for the investment. /// Is the present value of the investment. /// Is the future value of the investment. /// } Functions.prototype.sec = function(number) { /// /// Returns the secant of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the secant. /// } Functions.prototype.sech = function(number) { /// /// Returns the hyperbolic secant of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the hyperbolic secant. /// } Functions.prototype.second = function(serialNumber) { /// /// Returns the second, a number from 0 to 59. [Api set: ExcelApi 1.2] /// /// Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:23 or 4:48:47 PM. /// } Functions.prototype.seriesSum = function(x, n, m, coefficients) { /// /// Returns the sum of a power series based on the formula. [Api set: ExcelApi 1.2] /// /// Is the input value to the power series. /// Is the initial power to which you want to raise x. /// Is the step by which to increase n for each term in the series. /// Is a set of coefficients by which each successive power of x is multiplied. /// } Functions.prototype.sheet = function(value) { /// /// Returns the sheet number of the referenced sheet. [Api set: ExcelApi 1.2] /// /// Is the name of a sheet or a reference that you want the sheet number of. If omitted the number of the sheet containing the function is returned. /// } Functions.prototype.sheets = function(reference) { /// /// Returns the number of sheets in a reference. [Api set: ExcelApi 1.2] /// /// Is a reference for which you want to know the number of sheets it contains. If omitted the number of sheets in the workbook containing the function is returned. /// } Functions.prototype.sign = function(number) { /// /// Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative. [Api set: ExcelApi 1.2] /// /// Is any real number. /// } Functions.prototype.sin = function(number) { /// /// Returns the sine of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the sine. Degrees * PI()/180 = radians. /// } Functions.prototype.sinh = function(number) { /// /// Returns the hyperbolic sine of a number. [Api set: ExcelApi 1.2] /// /// Is any real number. /// } Functions.prototype.skew = function(values) { /// /// Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the skewness. /// } Functions.prototype.skew_p = function(values) { /// /// Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 254 numbers or names, arrays, or references that contain numbers for which you want the population skewness. /// } Functions.prototype.sln = function(cost, salvage, life) { /// /// Returns the straight-line depreciation of an asset for one period. [Api set: ExcelApi 1.2] /// /// Is the initial cost of the asset. /// Is the salvage value at the end of the life of the asset. /// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). /// } Functions.prototype.small = function(array, k) { /// /// Returns the k-th smallest value in a data set. For example, the fifth smallest number. [Api set: ExcelApi 1.2] /// /// Is an array or range of numerical data for which you want to determine the k-th smallest value. /// Is the position (from the smallest) in the array or range of the value to return. /// } Functions.prototype.sqrt = function(number) { /// /// Returns the square root of a number. [Api set: ExcelApi 1.2] /// /// Is the number for which you want the square root. /// } Functions.prototype.sqrtPi = function(number) { /// /// Returns the square root of (number * Pi). [Api set: ExcelApi 1.2] /// /// Is the number by which p is multiplied. /// } Functions.prototype.stDevA = function(values) { /// /// Estimates standard deviation based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 values corresponding to a sample of a population and can be values or names or references to values. /// } Functions.prototype.stDevPA = function(values) { /// /// Calculates standard deviation based on an entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 values corresponding to a population and can be values, names, arrays, or references that contain values. /// } Functions.prototype.stDev_P = function(values) { /// /// Calculates standard deviation based on the entire population given as arguments (ignores logical values and text). [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers corresponding to a population and can be numbers or references that contain numbers. /// } Functions.prototype.stDev_S = function(values) { /// /// Estimates standard deviation based on a sample (ignores logical values and text in the sample). [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers corresponding to a sample of a population and can be numbers or references that contain numbers. /// } Functions.prototype.standardize = function(x, mean, standardDev) { /// /// Returns a normalized value from a distribution characterized by a mean and standard deviation. [Api set: ExcelApi 1.2] /// /// Is the value you want to normalize. /// Is the arithmetic mean of the distribution. /// Is the standard deviation of the distribution, a positive number. /// } Functions.prototype.substitute = function(text, oldText, newText, instanceNum) { /// /// Replaces existing text with new text in a text string. [Api set: ExcelApi 1.2] /// /// Is the text or the reference to a cell containing text in which you want to substitute characters. /// Is the existing text you want to replace. If the case of oldText does not match the case of text, SUBSTITUTE will not replace the text. /// Is the text you want to replace oldText with. /// Specifies which occurrence of oldText you want to replace. If omitted, every instance of oldText is replaced. /// } Functions.prototype.subtotal = function(functionNum, values) { /// /// Returns a subtotal in a list or database. [Api set: ExcelApi 1.2] /// /// Is the number 1 to 11 that specifies the summary function for the subtotal. /// List of parameters, whose elements are 1 to 254 ranges or references for which you want the subtotal. /// } Functions.prototype.sum = function(values) { /// /// Adds all the numbers in a range of cells. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers to sum. Logical values and text are ignored in cells, included if typed as arguments. /// } Functions.prototype.sumIf = function(range, criteria, sumRange) { /// /// Adds the cells specified by a given condition or criteria. [Api set: ExcelApi 1.2] /// /// Is the range of cells you want evaluated. /// Is the condition or criteria in the form of a number, expression, or text that defines which cells will be added. /// Are the actual cells to sum. If omitted, the cells in range are used. /// } Functions.prototype.sumIfs = function(sumRange, values) { /// /// Adds the cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2] /// /// Are the actual cells to sum. /// List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be added. /// } Functions.prototype.sumSq = function(values) { /// /// Returns the sum of the squares of the arguments. The arguments can be numbers, arrays, names, or references to cells that contain numbers. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numbers, arrays, names, or references to arrays for which you want the sum of the squares. /// } Functions.prototype.syd = function(cost, salvage, life, per) { /// /// Returns the sum-of-years' digits depreciation of an asset for a specified period. [Api set: ExcelApi 1.2] /// /// Is the initial cost of the asset. /// Is the salvage value at the end of the life of the asset. /// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). /// Is the period and must use the same units as Life. /// } Functions.prototype.t = function(value) { /// /// Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not. [Api set: ExcelApi 1.2] /// /// Is the value to test. /// } Functions.prototype.tbillEq = function(settlement, maturity, discount) { /// /// Returns the bond-equivalent yield for a treasury bill. [Api set: ExcelApi 1.2] /// /// Is the Treasury bill's settlement date, expressed as a serial date number. /// Is the Treasury bill's maturity date, expressed as a serial date number. /// Is the Treasury bill's discount rate. /// } Functions.prototype.tbillPrice = function(settlement, maturity, discount) { /// /// Returns the price per $100 face value for a treasury bill. [Api set: ExcelApi 1.2] /// /// Is the Treasury bill's settlement date, expressed as a serial date number. /// Is the Treasury bill's maturity date, expressed as a serial date number. /// Is the Treasury bill's discount rate. /// } Functions.prototype.tbillYield = function(settlement, maturity, pr) { /// /// Returns the yield for a treasury bill. [Api set: ExcelApi 1.2] /// /// Is the Treasury bill's settlement date, expressed as a serial date number. /// Is the Treasury bill's maturity date, expressed as a serial date number. /// Is the Treasury Bill's price per $100 face value. /// } Functions.prototype.t_Dist = function(x, degFreedom, cumulative) { /// /// Returns the left-tailed Student's t-distribution. [Api set: ExcelApi 1.2] /// /// Is the numeric value at which to evaluate the distribution. /// Is an integer indicating the number of degrees of freedom that characterize the distribution. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. /// } Functions.prototype.t_Dist_2T = function(x, degFreedom) { /// /// Returns the two-tailed Student's t-distribution. [Api set: ExcelApi 1.2] /// /// Is the numeric value at which to evaluate the distribution. /// Is an integer indicating the number of degrees of freedom that characterize the distribution. /// } Functions.prototype.t_Dist_RT = function(x, degFreedom) { /// /// Returns the right-tailed Student's t-distribution. [Api set: ExcelApi 1.2] /// /// Is the numeric value at which to evaluate the distribution. /// Is an integer indicating the number of degrees of freedom that characterize the distribution. /// } Functions.prototype.t_Inv = function(probability, degFreedom) { /// /// Returns the left-tailed inverse of the Student's t-distribution. [Api set: ExcelApi 1.2] /// /// Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive. /// Is a positive integer indicating the number of degrees of freedom to characterize the distribution. /// } Functions.prototype.t_Inv_2T = function(probability, degFreedom) { /// /// Returns the two-tailed inverse of the Student's t-distribution. [Api set: ExcelApi 1.2] /// /// Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive. /// Is a positive integer indicating the number of degrees of freedom to characterize the distribution. /// } Functions.prototype.tan = function(number) { /// /// Returns the tangent of an angle. [Api set: ExcelApi 1.2] /// /// Is the angle in radians for which you want the tangent. Degrees * PI()/180 = radians. /// } Functions.prototype.tanh = function(number) { /// /// Returns the hyperbolic tangent of a number. [Api set: ExcelApi 1.2] /// /// Is any real number. /// } Functions.prototype.text = function(value, formatText) { /// /// Converts a value to text in a specific number format. [Api set: ExcelApi 1.2] /// /// Is a number, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value. /// Is a number format in text form from the Category box on the Number tab in the Format Cells dialog box (not General). /// } Functions.prototype.time = function(hour, minute, second) { /// /// Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format. [Api set: ExcelApi 1.2] /// /// Is a number from 0 to 23 representing the hour. /// Is a number from 0 to 59 representing the minute. /// Is a number from 0 to 59 representing the second. /// } Functions.prototype.timevalue = function(timeText) { /// /// Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula. [Api set: ExcelApi 1.2] /// /// Is a text string that gives a time in any one of the Microsoft Excel time formats (date information in the string is ignored). /// } Functions.prototype.today = function() { /// /// Returns the current date formatted as a date. [Api set: ExcelApi 1.2] /// /// } Functions.prototype.trim = function(text) { /// /// Removes all spaces from a text string except for single spaces between words. [Api set: ExcelApi 1.2] /// /// Is the text from which you want spaces removed. /// } Functions.prototype.trimMean = function(array, percent) { /// /// Returns the mean of the interior portion of a set of data values. [Api set: ExcelApi 1.2] /// /// Is the range or array of values to trim and average. /// Is the fractional number of data points to exclude from the top and bottom of the data set. /// } Functions.prototype.true = function() { /// /// Returns the logical value TRUE. [Api set: ExcelApi 1.2] /// /// } Functions.prototype.trunc = function(number, numDigits) { /// /// Truncates a number to an integer by removing the decimal, or fractional, part of the number. [Api set: ExcelApi 1.2] /// /// Is the number you want to truncate. /// Is a number specifying the precision of the truncation, 0 (zero) if omitted. /// } Functions.prototype.type = function(value) { /// /// Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64. [Api set: ExcelApi 1.2] /// /// Can be any value. /// } Functions.prototype.usdollar = function(number, decimals) { /// /// Converts a number to text, using currency format. [Api set: ExcelApi 1.2] /// /// Is a number, a reference to a cell containing a number, or a formula that evaluates to a number. /// Is the number of digits to the right of the decimal point. /// } Functions.prototype.unichar = function(number) { /// /// Returns the Unicode character referenced by the given numeric value. [Api set: ExcelApi 1.2] /// /// Is the Unicode number representing a character. /// } Functions.prototype.unicode = function(text) { /// /// Returns the number (code point) corresponding to the first character of the text. [Api set: ExcelApi 1.2] /// /// Is the character that you want the Unicode value of. /// } Functions.prototype.upper = function(text) { /// /// Converts a text string to all uppercase letters. [Api set: ExcelApi 1.2] /// /// Is the text you want converted to uppercase, a reference or a text string. /// } Functions.prototype.vlookup = function(lookupValue, tableArray, colIndexNum, rangeLookup) { /// /// Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify. By default, the table must be sorted in an ascending order. [Api set: ExcelApi 1.2] /// /// Is the value to be found in the first column of the table, and can be a value, a reference, or a text string. /// Is a table of text, numbers, or logical values, in which data is retrieved. tableArray can be a reference to a range or a range name. /// Is the column number in tableArray from which the matching value should be returned. The first column of values in the table is column 1. /// Is a logical value: to find the closest match in the first column (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE. /// } Functions.prototype.value = function(text) { /// /// Converts a text string that represents a number to a number. [Api set: ExcelApi 1.2] /// /// Is the text enclosed in quotation marks or a reference to a cell containing the text you want to convert. /// } Functions.prototype.varA = function(values) { /// /// Estimates variance based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 value arguments corresponding to a sample of a population. /// } Functions.prototype.varPA = function(values) { /// /// Calculates variance based on the entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 value arguments corresponding to a population. /// } Functions.prototype.var_P = function(values) { /// /// Calculates variance based on the entire population (ignores logical values and text in the population). [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a population. /// } Functions.prototype.var_S = function(values) { /// /// Estimates variance based on a sample (ignores logical values and text in the sample). [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a sample of a population. /// } Functions.prototype.vdb = function(cost, salvage, life, startPeriod, endPeriod, factor, noSwitch) { /// /// Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify. [Api set: ExcelApi 1.2] /// /// Is the initial cost of the asset. /// Is the salvage value at the end of the life of the asset. /// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). /// Is the starting period for which you want to calculate the depreciation, in the same units as Life. /// Is the ending period for which you want to calculate the depreciation, in the same units as Life. /// Is the rate at which the balance declines, 2 (double-declining balance) if omitted. /// Switch to straight-line depreciation when depreciation is greater than the declining balance = FALSE or omitted; do not switch = TRUE. /// } Functions.prototype.weekNum = function(serialNumber, returnType) { /// /// Returns the week number in the year. [Api set: ExcelApi 1.2] /// /// Is the date-time code used by Microsoft Excel for date and time calculation. /// Is a number (1 or 2) that determines the type of the return value. /// } Functions.prototype.weekday = function(serialNumber, returnType) { /// /// Returns a number from 1 to 7 identifying the day of the week of a date. [Api set: ExcelApi 1.2] /// /// Is a number that represents a date. /// Is a number: for Sunday=1 through Saturday=7, use 1; for Monday=1 through Sunday=7, use 2; for Monday=0 through Sunday=6, use 3. /// } Functions.prototype.weibull_Dist = function(x, alpha, beta, cumulative) { /// /// Returns the Weibull distribution. [Api set: ExcelApi 1.2] /// /// Is the value at which to evaluate the function, a nonnegative number. /// Is a parameter to the distribution, a positive number. /// Is a parameter to the distribution, a positive number. /// Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE. /// } Functions.prototype.workDay = function(startDate, days, holidays) { /// /// Returns the serial number of the date before or after a specified number of workdays. [Api set: ExcelApi 1.2] /// /// Is a serial date number that represents the start date. /// Is the number of nonweekend and non-holiday days before or after startDate. /// Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. /// } Functions.prototype.workDay_Intl = function(startDate, days, weekend, holidays) { /// /// Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters. [Api set: ExcelApi 1.2] /// /// Is a serial date number that represents the start date. /// Is the number of nonweekend and non-holiday days before or after startDate. /// Is a number or string specifying when weekends occur. /// Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. /// } Functions.prototype.xirr = function(values, dates, guess) { /// /// Returns the internal rate of return for a schedule of cash flows. [Api set: ExcelApi 1.2] /// /// Is a series of cash flows that correspond to a schedule of payments in dates. /// Is a schedule of payment dates that corresponds to the cash flow payments. /// Is a number that you guess is close to the result of XIRR. /// } Functions.prototype.xnpv = function(rate, values, dates) { /// /// Returns the net present value for a schedule of cash flows. [Api set: ExcelApi 1.2] /// /// Is the discount rate to apply to the cash flows. /// Is a series of cash flows that correspond to a schedule of payments in dates. /// Is a schedule of payment dates that corresponds to the cash flow payments. /// } Functions.prototype.xor = function(values) { /// /// Returns a logical 'Exclusive Or' of all arguments. [Api set: ExcelApi 1.2] /// /// List of parameters, whose elements are 1 to 254 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references. /// } Functions.prototype.year = function(serialNumber) { /// /// Returns the year of a date, an integer in the range 1900 - 9999. [Api set: ExcelApi 1.2] /// /// Is a number in the date-time code used by Microsoft Excel. /// } Functions.prototype.yearFrac = function(startDate, endDate, basis) { /// /// Returns the year fraction representing the number of whole days between start_date and end_date. [Api set: ExcelApi 1.2] /// /// Is a serial date number that represents the start date. /// Is a serial date number that represents the end date. /// Is the type of day count basis to use. /// } Functions.prototype.yield = function(settlement, maturity, rate, pr, redemption, frequency, basis) { /// /// Returns the yield on a security that pays periodic interest. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's annual coupon rate. /// Is the security's price per $100 face value. /// Is the security's redemption value per $100 face value. /// Is the number of coupon payments per year. /// Is the type of day count basis to use. /// } Functions.prototype.yieldDisc = function(settlement, maturity, pr, redemption, basis) { /// /// Returns the annual yield for a discounted security. For example, a treasury bill. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's price per $100 face value. /// Is the security's redemption value per $100 face value. /// Is the type of day count basis to use. /// } Functions.prototype.yieldMat = function(settlement, maturity, issue, rate, pr, basis) { /// /// Returns the annual yield of a security that pays interest at maturity. [Api set: ExcelApi 1.2] /// /// Is the security's settlement date, expressed as a serial date number. /// Is the security's maturity date, expressed as a serial date number. /// Is the security's issue date, expressed as a serial date number. /// Is the security's interest rate at date of issue. /// Is the security's price per $100 face value. /// Is the type of day count basis to use. /// } Functions.prototype.z_Test = function(array, x, sigma) { /// /// Returns the one-tailed P-value of a z-test. [Api set: ExcelApi 1.2] /// /// Is the array or range of data against which to test X. /// Is the value to test. /// Is the population (known) standard deviation. If omitted, the sample standard deviation is used. /// } return Functions; })(OfficeExtension.ClientObject); Excel.Functions = Functions; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var HorizontalAlignment = { __proto__: null, "general": "general", "left": "left", "center": "center", "right": "right", "fill": "fill", "justify": "justify", "centerAcrossSelection": "centerAcrossSelection", "distributed": "distributed", } Excel.HorizontalAlignment = HorizontalAlignment; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var Icon = (function() { function Icon() { /// Represents a cell icon. [Api set: ExcelApi 1.2] /// Represents the index of the icon in the given set. [Api set: ExcelApi 1.2] /// Represents the set that the icon is part of. [Api set: ExcelApi 1.2] } return Icon; })(); Interfaces.Icon.__proto__ = null; Interfaces.Icon = Icon; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var IconSet = { __proto__: null, "invalid": "invalid", "threeArrows": "threeArrows", "threeArrowsGray": "threeArrowsGray", "threeFlags": "threeFlags", "threeTrafficLights1": "threeTrafficLights1", "threeTrafficLights2": "threeTrafficLights2", "threeSigns": "threeSigns", "threeSymbols": "threeSymbols", "threeSymbols2": "threeSymbols2", "fourArrows": "fourArrows", "fourArrowsGray": "fourArrowsGray", "fourRedToBlack": "fourRedToBlack", "fourRating": "fourRating", "fourTrafficLights": "fourTrafficLights", "fiveArrows": "fiveArrows", "fiveArrowsGray": "fiveArrowsGray", "fiveRating": "fiveRating", "fiveQuarters": "fiveQuarters", "threeStars": "threeStars", "threeTriangles": "threeTriangles", "fiveBoxes": "fiveBoxes", } Excel.IconSet = IconSet; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var ImageFittingMode = { __proto__: null, "fit": "fit", "fitAndCenter": "fitAndCenter", "fill": "fill", } Excel.ImageFittingMode = ImageFittingMode; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var InsertShiftDirection = { __proto__: null, "down": "down", "right": "right", } Excel.InsertShiftDirection = InsertShiftDirection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var NamedItem = (function(_super) { __extends(NamedItem, _super); function NamedItem() { /// Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, reference to a range. This object can be used to obtain range object associated with names. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// The name of the object. Read-only. [Api set: ExcelApi 1.1] /// Indicates what type of reference is associated with the name. See Excel.NamedItemType for details. Read-only. [Api set: ExcelApi 1.1] /// Represents the formula that the name is defined to refer to. E.g. =Sheet14!$B$2:$H$12, =4.75, etc. Read-only. [Api set: ExcelApi 1.1] /// Specifies whether the object is visible or not. [Api set: ExcelApi 1.1] } NamedItem.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } NamedItem.prototype.getRange = function() { /// /// Returns the range object that is associated with the name. Throws an exception if the named item's type is not a range. [Api set: ExcelApi 1.1] /// /// } return NamedItem; })(OfficeExtension.ClientObject); Excel.NamedItem = NamedItem; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var NamedItemCollection = (function(_super) { __extends(NamedItemCollection, _super); function NamedItemCollection() { /// A collection of all the nameditem objects that are part of the workbook. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Gets the loaded child items in this collection. } NamedItemCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } NamedItemCollection.prototype.getItem = function(name) { /// /// Gets a nameditem object using its name [Api set: ExcelApi 1.1] /// /// nameditem name. /// } return NamedItemCollection; })(OfficeExtension.ClientObject); Excel.NamedItemCollection = NamedItemCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var NamedItemType = { __proto__: null, "string": "string", "integer": "integer", "double": "double", "boolean": "boolean", "range": "range", } Excel.NamedItemType = NamedItemType; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var PivotTable = (function(_super) { __extends(PivotTable, _super); function PivotTable() { /// Represents an Excel PivotTable. [Api set: ExcelApi 1.3] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Name of the PivotTable. [Api set: ExcelApi 1.3] /// The worksheet containing the current PivotTable. Read-only. [Api set: ExcelApi 1.3] } PivotTable.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } PivotTable.prototype.refresh = function() { /// /// Refreshes the PivotTable. [Api set: ExcelApi 1.3] /// /// } return PivotTable; })(OfficeExtension.ClientObject); Excel.PivotTable = PivotTable; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var PivotTableCollection = (function(_super) { __extends(PivotTableCollection, _super); function PivotTableCollection() { /// Represents a collection of all the PivotTables that are part of the workbook or worksheet. [Api set: ExcelApi 1.3] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Gets the loaded child items in this collection. } PivotTableCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } PivotTableCollection.prototype.getItem = function(name) { /// /// Gets a PivotTable by name. [Api set: ExcelApi 1.3] /// /// Name of the PivotTable to be retrieved. /// } PivotTableCollection.prototype.refreshAll = function() { /// /// Refreshes all the PivotTables in the collection. [Api set: ExcelApi 1.3] /// /// } return PivotTableCollection; })(OfficeExtension.ClientObject); Excel.PivotTableCollection = PivotTableCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Range = (function(_super) { __extends(Range, _super); function Range() { /// Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4). Read-only. [Api set: ExcelApi 1.1] /// Represents range reference for the specified range in the language of the user. Read-only. [Api set: ExcelApi 1.1] /// Number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). Read-only. [Api set: ExcelApi 1.1] /// Represents the total number of columns in the range. Read-only. [Api set: ExcelApi 1.1] /// Represents if all columns of the current range are hidden. [Api set: ExcelApi 1.2] /// Represents the column number of the first cell in the range. Zero-indexed. Read-only. [Api set: ExcelApi 1.1] /// Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only. [Api set: ExcelApi 1.1] /// Represents the formula in A1-style notation. [Api set: ExcelApi 1.1] /// Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. [Api set: ExcelApi 1.1] /// Represents the formula in R1C1-style notation. [Api set: ExcelApi 1.2] /// Represents if all cells of the current range are hidden. [Api set: ExcelApi 1.2] /// Represents Excel's number format code for the given cell. [Api set: ExcelApi 1.1] /// Returns the total number of rows in the range. Read-only. [Api set: ExcelApi 1.1] /// Represents if all rows of the current range are hidden. [Api set: ExcelApi 1.2] /// Returns the row number of the first cell in the range. Zero-indexed. Read-only. [Api set: ExcelApi 1.1] /// Represents the range sort of the current range. [Api set: ExcelApi 1.2] /// Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. Read-only. [Api set: ExcelApi 1.1] /// Represents the type of data of each cell. Read-only. [Api set: ExcelApi 1.1] /// Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.1] /// The worksheet containing the current range. Read-only. [Api set: ExcelApi 1.1] } Range.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Range.prototype.clear = function(applyTo) { /// /// Clear range values, format, fill, border, etc. [Api set: ExcelApi 1.1] /// /// Determines the type of clear action. See Excel.ClearApplyTo for details. /// } Range.prototype.delete = function(shift) { /// /// Deletes the cells associated with the range. [Api set: ExcelApi 1.1] /// /// Specifies which way to shift the cells. See Excel.DeleteShiftDirection for details. /// } Range.prototype.getBoundingRect = function(anotherRange) { /// /// Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16". [Api set: ExcelApi 1.1] /// /// The range object or address or range name. /// } Range.prototype.getCell = function(row, column) { /// /// Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range. [Api set: ExcelApi 1.1] /// /// Row number of the cell to be retrieved. Zero-indexed. /// Column number of the cell to be retrieved. Zero-indexed. /// } Range.prototype.getColumn = function(column) { /// /// Gets a column contained in the range. [Api set: ExcelApi 1.1] /// /// Column number of the range to be retrieved. Zero-indexed. /// } Range.prototype.getColumnsAfter = function(count) { /// /// Gets a certain number of columns to the right of the current Range object. [Api set: ExcelApi 1.2] /// /// The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. /// } Range.prototype.getColumnsBefore = function(count) { /// /// Gets a certain number of columns to the left of the current Range object. [Api set: ExcelApi 1.2] /// /// The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. /// } Range.prototype.getEntireColumn = function() { /// /// Gets an object that represents the entire column of the range. [Api set: ExcelApi 1.1] /// /// } Range.prototype.getEntireRow = function() { /// /// Gets an object that represents the entire row of the range. [Api set: ExcelApi 1.1] /// /// } Range.prototype.getIntersection = function(anotherRange) { /// /// Gets the range object that represents the rectangular intersection of the given ranges. [Api set: ExcelApi 1.1] /// /// The range object or range address that will be used to determine the intersection of ranges. /// } Range.prototype.getLastCell = function() { /// /// Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". [Api set: ExcelApi 1.1] /// /// } Range.prototype.getLastColumn = function() { /// /// Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". [Api set: ExcelApi 1.1] /// /// } Range.prototype.getLastRow = function() { /// /// Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". [Api set: ExcelApi 1.1] /// /// } Range.prototype.getOffsetRange = function(rowOffset, columnOffset) { /// /// Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown. [Api set: ExcelApi 1.1] /// /// The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward. /// The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left. /// } Range.prototype.getResizedRange = function(deltaRows, deltaColumns) { /// /// Gets a Range object similar to the current Range object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns. [Api set: ExcelApi 1.2] /// /// The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it. /// The number of columnsby which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it. /// } Range.prototype.getRow = function(row) { /// /// Gets a row contained in the range. [Api set: ExcelApi 1.1] /// /// Row number of the range to be retrieved. Zero-indexed. /// } Range.prototype.getRowsAbove = function(count) { /// /// Gets a certain number of rows above the current Range object. [Api set: ExcelApi 1.2] /// /// The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. /// } Range.prototype.getRowsBelow = function(count) { /// /// Gets a certain number of rows below the current Range object. [Api set: ExcelApi 1.2] /// /// The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. /// } Range.prototype.getUsedRange = function(valuesOnly) { /// /// Returns the used range of the given range object. [Api set: ExcelApi 1.1] /// /// Considers only cells with values as used cells. [Api set: ExcelApi 1.2] /// } Range.prototype.getVisibleView = function() { /// /// Represents the visible rows of the current range. [Api set: ExcelApi 1.3] /// /// } Range.prototype.insert = function(shift) { /// /// Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space. [Api set: ExcelApi 1.1] /// /// Specifies which way to shift the cells. See Excel.InsertShiftDirection for details. /// } Range.prototype.merge = function(across) { /// /// Merge the range cells into one region in the worksheet. [Api set: ExcelApi 1.2] /// /// Set true to merge cells in each row of the specified range as separate merged cells. The default value is false. /// } Range.prototype.select = function() { /// /// Selects the specified range in the Excel UI. [Api set: ExcelApi 1.1] /// /// } Range.prototype.unmerge = function() { /// /// Unmerge the range cells into separate cells. [Api set: ExcelApi 1.2] /// /// } Range.prototype.track = function() { /// /// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. /// /// } Range.prototype.untrack = function() { /// /// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. /// /// } return Range; })(OfficeExtension.ClientObject); Excel.Range = Range; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeBorder = (function(_super) { __extends(RangeBorder, _super); function RangeBorder() { /// Represents the border of an object. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). [Api set: ExcelApi 1.1] /// Constant value that indicates the specific side of the border. See Excel.BorderIndex for details. Read-only. [Api set: ExcelApi 1.1] /// One of the constants of line style specifying the line style for the border. See Excel.BorderLineStyle for details. [Api set: ExcelApi 1.1] /// Specifies the weight of the border around a range. See Excel.BorderWeight for details. [Api set: ExcelApi 1.1] } RangeBorder.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return RangeBorder; })(OfficeExtension.ClientObject); Excel.RangeBorder = RangeBorder; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeBorderCollection = (function(_super) { __extends(RangeBorderCollection, _super); function RangeBorderCollection() { /// Represents the border objects that make up range border. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Number of border objects in the collection. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } RangeBorderCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } RangeBorderCollection.prototype.getItem = function(index) { /// /// Gets a border object using its name [Api set: ExcelApi 1.1] /// /// Index value of the border object to be retrieved. See Excel.BorderIndex for details. /// } RangeBorderCollection.prototype.getItemAt = function(index) { /// /// Gets a border object using its index [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return RangeBorderCollection; })(OfficeExtension.ClientObject); Excel.RangeBorderCollection = RangeBorderCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeFill = (function(_super) { __extends(RangeFill, _super); function RangeFill() { /// Represents the background of a range object. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") [Api set: ExcelApi 1.1] } RangeFill.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } RangeFill.prototype.clear = function() { /// /// Resets the range background. [Api set: ExcelApi 1.1] /// /// } return RangeFill; })(OfficeExtension.ClientObject); Excel.RangeFill = RangeFill; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeFont = (function(_super) { __extends(RangeFont, _super); function RangeFont() { /// This object represents the font attributes (font name, font size, color, etc.) for an object. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the bold status of font. [Api set: ExcelApi 1.1] /// HTML color code representation of the text color. E.g. #FF0000 represents Red. [Api set: ExcelApi 1.1] /// Represents the italic status of the font. [Api set: ExcelApi 1.1] /// Font name (e.g. "Calibri") [Api set: ExcelApi 1.1] /// Font size. [Api set: ExcelApi 1.1] /// Type of underline applied to the font. See Excel.RangeUnderlineStyle for details. [Api set: ExcelApi 1.1] } RangeFont.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return RangeFont; })(OfficeExtension.ClientObject); Excel.RangeFont = RangeFont; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeFormat = (function(_super) { __extends(RangeFormat, _super); function RangeFormat() { /// A format object encapsulating the range's font, fill, borders, alignment, and other properties. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Collection of border objects that apply to the overall range. Read-only. [Api set: ExcelApi 1.1] /// Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned. [Api set: ExcelApi 1.2] /// Returns the fill object defined on the overall range. Read-only. [Api set: ExcelApi 1.1] /// Returns the font object defined on the overall range. Read-only. [Api set: ExcelApi 1.1] /// Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details. [Api set: ExcelApi 1.1] /// Returns the format protection object for a range. [Api set: ExcelApi 1.2] /// Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned. [Api set: ExcelApi 1.2] /// Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details. [Api set: ExcelApi 1.1] /// Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting [Api set: ExcelApi 1.1] } RangeFormat.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } RangeFormat.prototype.autofitColumns = function() { /// /// Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. [Api set: ExcelApi 1.2] /// /// } RangeFormat.prototype.autofitRows = function() { /// /// Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. [Api set: ExcelApi 1.2] /// /// } return RangeFormat; })(OfficeExtension.ClientObject); Excel.RangeFormat = RangeFormat; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var RangeReference = (function() { function RangeReference() { /// Represents a string reference of the form SheetName!A1:B5, or a global or local named range [Api set: ExcelApi 1.2] /// [Api set: ExcelApi 1.2] } return RangeReference; })(); Interfaces.RangeReference.__proto__ = null; Interfaces.RangeReference = RangeReference; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeSort = (function(_super) { __extends(RangeSort, _super); function RangeSort() { /// Manages sorting operations on Range objects. [Api set: ExcelApi 1.2] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. } RangeSort.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } RangeSort.prototype.apply = function(fields, matchCase, hasHeaders, orientation, method) { /// /// Perform a sort operation. [Api set: ExcelApi 1.2] /// /// The list of conditions to sort on. /// Whether to have the casing impact string ordering. /// Whether the range has a header. /// Whether the operation is sorting rows or columns. /// The ordering method used for Chinese characters. /// } return RangeSort; })(OfficeExtension.ClientObject); Excel.RangeSort = RangeSort; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var RangeUnderlineStyle = { __proto__: null, "none": "none", "single": "single", "double": "double", "singleAccountant": "singleAccountant", "doubleAccountant": "doubleAccountant", } Excel.RangeUnderlineStyle = RangeUnderlineStyle; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var RangeValueType = { __proto__: null, "unknown": "unknown", "empty": "empty", "string": "string", "integer": "integer", "double": "double", "boolean": "boolean", "error": "error", } Excel.RangeValueType = RangeValueType; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeView = (function(_super) { __extends(RangeView, _super); function RangeView() { /// RangeView represents a set of visible cells of the parent range. [Api set: ExcelApi 1.3] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the cell addresses of the RangeView. [Api set: ExcelApi 1.3] /// Returns the number of visible columns. Read-only. [Api set: ExcelApi 1.3] /// Represents the formula in A1-style notation. [Api set: ExcelApi 1.3] /// Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. [Api set: ExcelApi 1.3] /// Represents the formula in R1C1-style notation. [Api set: ExcelApi 1.3] /// Returns a value that represents the index of the RangeView. Read-only. [Api set: ExcelApi 1.3] /// Represents Excel's number format code for the given cell. [Api set: ExcelApi 1.3] /// Returns the number of visible rows. Read-only. [Api set: ExcelApi 1.3] /// Represents a collection of range views associated with the range. Read-only. [Api set: ExcelApi 1.3] /// Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. Read-only. [Api set: ExcelApi 1.3] /// Represents the type of data of each cell. Read-only. [Api set: ExcelApi 1.3] /// Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.3] } RangeView.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } RangeView.prototype.getRange = function() { /// /// Gets the parent range associated with the current RangeView. [Api set: ExcelApi 1.3] /// /// } return RangeView; })(OfficeExtension.ClientObject); Excel.RangeView = RangeView; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RangeViewCollection = (function(_super) { __extends(RangeViewCollection, _super); function RangeViewCollection() { /// Represents a collection of worksheet objects that are part of the workbook. [Api set: ExcelApi 1.3] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Gets the loaded child items in this collection. } RangeViewCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } RangeViewCollection.prototype.getItemAt = function(index) { /// /// Gets a RangeView Row via it's index. Zero-Indexed. [Api set: ExcelApi 1.3] /// /// Index of the visible row. /// } return RangeViewCollection; })(OfficeExtension.ClientObject); Excel.RangeViewCollection = RangeViewCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var SelectionChangedEventArgs = (function() { function SelectionChangedEventArgs() { /// Provides information about the document that raised the SelectionChanged event. [Api set: ExcelApi 1.2] /// Gets the workbook object that raised the SelectionChanged event. [Api set: ExcelApi 1.2] } return SelectionChangedEventArgs; })(); Interfaces.SelectionChangedEventArgs.__proto__ = null; Interfaces.SelectionChangedEventArgs = SelectionChangedEventArgs; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Setting = (function(_super) { __extends(Setting, _super); function Setting() { /// Setting represents a key-value pair of a setting persisted to the document. [Api set: ExcelApi 1.3] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the key that represents the id of the Setting. Read-only. [Api set: ExcelApi 1.3] } Setting.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Setting.prototype.delete = function() { /// /// Deletes the setting. [Api set: ExcelApi 1.3] /// /// } return Setting; })(OfficeExtension.ClientObject); Excel.Setting = Setting; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var SheetVisibility = { __proto__: null, "visible": "visible", "hidden": "hidden", "veryHidden": "veryHidden", } Excel.SheetVisibility = SheetVisibility; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var SortDataOption = { __proto__: null, "normal": "normal", "textAsNumber": "textAsNumber", } Excel.SortDataOption = SortDataOption; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var SortField = (function() { function SortField() { /// Represents a condition in a sorting operation. [Api set: ExcelApi 1.2] /// Represents whether the sorting is done in an ascending fashion. [Api set: ExcelApi 1.2] /// Represents the color that is the target of the condition if the sorting is on font or cell color. [Api set: ExcelApi 1.2] /// Represents additional sorting options for this field. [Api set: ExcelApi 1.2] /// Represents the icon that is the target of the condition if the sorting is on the cell's icon. [Api set: ExcelApi 1.2] /// Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row). [Api set: ExcelApi 1.2] /// Represents the type of sorting of this condition. [Api set: ExcelApi 1.2] } return SortField; })(); Interfaces.SortField.__proto__ = null; Interfaces.SortField = SortField; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var SortMethod = { __proto__: null, "pinYin": "pinYin", "strokeCount": "strokeCount", } Excel.SortMethod = SortMethod; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var SortOn = { __proto__: null, "value": "value", "cellColor": "cellColor", "fontColor": "fontColor", "icon": "icon", } Excel.SortOn = SortOn; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.2] var SortOrientation = { __proto__: null, "rows": "rows", "columns": "columns", } Excel.SortOrientation = SortOrientation; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Table = (function(_super) { __extends(Table, _super); function Table() { /// Represents an Excel table. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents a collection of all the columns in the table. Read-only. [Api set: ExcelApi 1.1] /// Indicates whether the first column contains special formatting. [Api set: ExcelApi 1.3] /// Indicates whether the last column contains special formatting. [Api set: ExcelApi 1.3] /// Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. Read-only. [Api set: ExcelApi 1.1] /// Name of the table. [Api set: ExcelApi 1.1] /// Represents a collection of all the rows in the table. Read-only. [Api set: ExcelApi 1.1] /// Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier. [Api set: ExcelApi 1.3] /// Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier. [Api set: ExcelApi 1.3] /// Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. [Api set: ExcelApi 1.3] /// Indicates whether the header row is visible or not. This value can be set to show or remove the header row. [Api set: ExcelApi 1.1] /// Indicates whether the total row is visible or not. This value can be set to show or remove the total row. [Api set: ExcelApi 1.1] /// Represents the sorting for the table. [Api set: ExcelApi 1.2] /// Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified. [Api set: ExcelApi 1.1] /// The worksheet containing the current table. Read-only. [Api set: ExcelApi 1.2] } Table.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Table.prototype.clearFilters = function() { /// /// Clears all the filters currently applied on the table. [Api set: ExcelApi 1.2] /// /// } Table.prototype.convertToRange = function() { /// /// Converts the table into a normal range of cells. All data is preserved. [Api set: ExcelApi 1.2] /// /// } Table.prototype.delete = function() { /// /// Deletes the table. [Api set: ExcelApi 1.1] /// /// } Table.prototype.getDataBodyRange = function() { /// /// Gets the range object associated with the data body of the table. [Api set: ExcelApi 1.1] /// /// } Table.prototype.getHeaderRowRange = function() { /// /// Gets the range object associated with header row of the table. [Api set: ExcelApi 1.1] /// /// } Table.prototype.getRange = function() { /// /// Gets the range object associated with the entire table. [Api set: ExcelApi 1.1] /// /// } Table.prototype.getTotalRowRange = function() { /// /// Gets the range object associated with totals row of the table. [Api set: ExcelApi 1.1] /// /// } Table.prototype.reapplyFilters = function() { /// /// Reapplies all the filters currently on the table. [Api set: ExcelApi 1.2] /// /// } return Table; })(OfficeExtension.ClientObject); Excel.Table = Table; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var TableCollection = (function(_super) { __extends(TableCollection, _super); function TableCollection() { /// Represents a collection of all the tables that are part of the workbook. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the number of tables in the workbook. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } TableCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } TableCollection.prototype.add = function(address, hasHeaders) { /// /// Create a new table. The range object or source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown. [Api set: ExcelApi 1.1] /// /// A Range object, or a string address or name of the range representing the data source. If the address does not contain a sheet name, the currently-active sheet is used. [Api set: ExcelApi 1.1 for string parameter; 1.3 for accepting a Range object as well] /// Boolean value that indicates whether the data being imported has column labels. If the source does not contain headers (i.e,. when this property set to false), Excel will automatically generate header shifting the data down by one row. /// } TableCollection.prototype.getItem = function(key) { /// /// Gets a table by Name or ID. [Api set: ExcelApi 1.1] /// /// Name or ID of the table to be retrieved. /// } TableCollection.prototype.getItemAt = function(index) { /// /// Gets a table based on its position in the collection. [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return TableCollection; })(OfficeExtension.ClientObject); Excel.TableCollection = TableCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var TableColumn = (function(_super) { __extends(TableColumn, _super); function TableColumn() { /// Represents a column in a table. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Retrieve the filter applied to the column. [Api set: ExcelApi 1.2] /// Returns a unique key that identifies the column within the table. Read-only. [Api set: ExcelApi 1.1] /// Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only. [Api set: ExcelApi 1.1] /// Returns the name of the table column. Read-only. [Api set: ExcelApi 1.1] /// Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.1] } TableColumn.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } TableColumn.prototype.delete = function() { /// /// Deletes the column from the table. [Api set: ExcelApi 1.1] /// /// } TableColumn.prototype.getDataBodyRange = function() { /// /// Gets the range object associated with the data body of the column. [Api set: ExcelApi 1.1] /// /// } TableColumn.prototype.getHeaderRowRange = function() { /// /// Gets the range object associated with the header row of the column. [Api set: ExcelApi 1.1] /// /// } TableColumn.prototype.getRange = function() { /// /// Gets the range object associated with the entire column. [Api set: ExcelApi 1.1] /// /// } TableColumn.prototype.getTotalRowRange = function() { /// /// Gets the range object associated with the totals row of the column. [Api set: ExcelApi 1.1] /// /// } return TableColumn; })(OfficeExtension.ClientObject); Excel.TableColumn = TableColumn; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var TableColumnCollection = (function(_super) { __extends(TableColumnCollection, _super); function TableColumnCollection() { /// Represents a collection of all the columns that are part of the table. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the number of columns in the table. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } TableColumnCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } TableColumnCollection.prototype.add = function(index, values) { /// /// Adds a new column to the table. [Api set: ExcelApi 1.1 requires an index smaller than the total column count; 1.4 allows index to be optional (null or -1) and will append a column at the end.] /// /// Specifies the relative position of the new column. If null or -1, the addition happens at the end. Columns with a higher index will be shifted to the side. Zero-indexed. /// A 2-dimensional array of unformatted values of the table column. /// } TableColumnCollection.prototype.getItem = function(key) { /// /// Gets a column object by Name or ID. [Api set: ExcelApi 1.1] /// /// Column Name or ID. /// } TableColumnCollection.prototype.getItemAt = function(index) { /// /// Gets a column based on its position in the collection. [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return TableColumnCollection; })(OfficeExtension.ClientObject); Excel.TableColumnCollection = TableColumnCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var TableRow = (function(_super) { __extends(TableRow, _super); function TableRow() { /// Represents a row in a table. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only. [Api set: ExcelApi 1.1] /// Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.1] } TableRow.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } TableRow.prototype.delete = function() { /// /// Deletes the row from the table. [Api set: ExcelApi 1.1] /// /// } TableRow.prototype.getRange = function() { /// /// Returns the range object associated with the entire row. [Api set: ExcelApi 1.1] /// /// } return TableRow; })(OfficeExtension.ClientObject); Excel.TableRow = TableRow; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var TableRowCollection = (function(_super) { __extends(TableRowCollection, _super); function TableRowCollection() { /// Represents a collection of all the rows that are part of the table. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns the number of rows in the table. Read-only. [Api set: ExcelApi 1.1] /// Gets the loaded child items in this collection. } TableRowCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } TableRowCollection.prototype.add = function(index, values) { /// /// Adds one or more rows to the table. The return object will be the top of the newly added row(s). [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows.] /// /// Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed. /// A 2-dimensional array of unformatted values of the table row. /// } TableRowCollection.prototype.getItemAt = function(index) { /// /// Gets a row based on its position in the collection. [Api set: ExcelApi 1.1] /// /// Index value of the object to be retrieved. Zero-indexed. /// } return TableRowCollection; })(OfficeExtension.ClientObject); Excel.TableRowCollection = TableRowCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var TableSort = (function(_super) { __extends(TableSort, _super); function TableSort() { /// Manages sorting operations on Table objects. [Api set: ExcelApi 1.2] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents the current conditions used to last sort the table. [Api set: ExcelApi 1.2] /// Represents whether the casing impacted the last sort of the table. [Api set: ExcelApi 1.2] /// Represents Chinese character ordering method last used to sort the table. [Api set: ExcelApi 1.2] } TableSort.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } TableSort.prototype.apply = function(fields, matchCase, method) { /// /// Perform a sort operation. [Api set: ExcelApi 1.2] /// /// The list of conditions to sort on. /// Whether to have the casing impact string ordering. /// The ordering method used for Chinese characters. /// } TableSort.prototype.clear = function() { /// /// Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons. [Api set: ExcelApi 1.2] /// /// } TableSort.prototype.reapply = function() { /// /// Reapplies the current sorting parameters to the table. [Api set: ExcelApi 1.2] /// /// } return TableSort; })(OfficeExtension.ClientObject); Excel.TableSort = TableSort; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.3] var V1CoercionType = { __proto__: null, "matrix": "matrix", "table": "table", "text": "text", "image": "image", } Excel.V1CoercionType = V1CoercionType; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.3] var V1TableEnum = { __proto__: null, "all": "all", "data": "data", "headers": "headers", } Excel.V1TableEnum = V1TableEnum; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { /// [Api set: ExcelApi 1.1] var VerticalAlignment = { __proto__: null, "top": "top", "center": "center", "bottom": "bottom", "justify": "justify", "distributed": "distributed", } Excel.VerticalAlignment = VerticalAlignment; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Workbook = (function(_super) { __extends(Workbook, _super); function Workbook() { /// Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Represents Excel application instance that contains this workbook. Read-only. [Api set: ExcelApi 1.1] /// Represents a collection of bindings that are part of the workbook. Read-only. [Api set: ExcelApi 1.1] /// Represents Excel application instance that contains this workbook. Read-only. [Api set: ExcelApi 1.2] /// Represents a collection of workbook scoped named items (named ranges and constants). Read-only. [Api set: ExcelApi 1.1] /// Represents a collection of PivotTables associated with the workbook. Read-only. [Api set: ExcelApi 1.3] /// Represents a collection of tables associated with the workbook. Read-only. [Api set: ExcelApi 1.1] /// Represents a collection of worksheets associated with the workbook. Read-only. [Api set: ExcelApi 1.1] /// Occurs when the selection in the document is changed. [Api set: ExcelApi 1.2] } Workbook.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Workbook.prototype.getSelectedRange = function() { /// /// Gets the currently selected range from the workbook. [Api set: ExcelApi 1.1] /// /// } Workbook.prototype.onSelectionChanged = { __proto__: null, add: function (handler) { /// Handler for the event. EventArgs: Provides information about the document that raised the SelectionChanged event. /// var eventInfo = new Excel.Interfaces.SelectionChangedEventArgs(); eventInfo.__proto__ = null; handler(eventInfo); }, remove: function (handler) { /// Handler for the event. return; }, removeAll: function () { return; } }; return Workbook; })(OfficeExtension.ClientObject); Excel.Workbook = Workbook; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Worksheet = (function(_super) { __extends(Worksheet, _super); function Worksheet() { /// An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Returns collection of charts that are part of the worksheet. Read-only. [Api set: ExcelApi 1.1] /// Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only. [Api set: ExcelApi 1.1] /// The display name of the worksheet. [Api set: ExcelApi 1.1] /// Collection of PivotTables that are part of the worksheet. Read-only. [Api set: ExcelApi 1.3] /// The zero-based position of the worksheet within the workbook. [Api set: ExcelApi 1.1] /// Returns sheet protection object for a worksheet. [Api set: ExcelApi 1.2] /// Collection of tables that are part of the worksheet. Read-only. [Api set: ExcelApi 1.1] /// The Visibility of the worksheet. [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.] } Worksheet.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Worksheet.prototype.activate = function() { /// /// Activate the worksheet in the Excel UI. [Api set: ExcelApi 1.1] /// /// } Worksheet.prototype.delete = function() { /// /// Deletes the worksheet from the workbook. [Api set: ExcelApi 1.1] /// /// } Worksheet.prototype.getCell = function(row, column) { /// /// Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. [Api set: ExcelApi 1.1] /// /// The row number of the cell to be retrieved. Zero-indexed. /// the column number of the cell to be retrieved. Zero-indexed. /// } Worksheet.prototype.getRange = function(address) { /// /// Gets the range object specified by the address or name. [Api set: ExcelApi 1.1] /// /// The address or the name of the range. If not specified, the entire worksheet range is returned. /// } Worksheet.prototype.getUsedRange = function(valuesOnly) { /// /// The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell. [Api set: ExcelApi 1.1] /// /// Considers only cells with values as used cells (ignores formatting). [Api set: ExcelApi 1.2] /// } return Worksheet; })(OfficeExtension.ClientObject); Excel.Worksheet = Worksheet; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var WorksheetCollection = (function(_super) { __extends(WorksheetCollection, _super); function WorksheetCollection() { /// Represents a collection of worksheet objects that are part of the workbook. [Api set: ExcelApi 1.1] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Gets the loaded child items in this collection. } WorksheetCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } WorksheetCollection.prototype.add = function(name) { /// /// Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call ".activate() on it. [Api set: ExcelApi 1.1] /// /// The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet. /// } WorksheetCollection.prototype.getActiveWorksheet = function() { /// /// Gets the currently active worksheet in the workbook. [Api set: ExcelApi 1.1] /// /// } WorksheetCollection.prototype.getItem = function(key) { /// /// Gets a worksheet object using its Name or ID. [Api set: ExcelApi 1.1] /// /// The Name or ID of the worksheet. /// } return WorksheetCollection; })(OfficeExtension.ClientObject); Excel.WorksheetCollection = WorksheetCollection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var WorksheetProtection = (function(_super) { __extends(WorksheetProtection, _super); function WorksheetProtection() { /// Represents the protection of a sheet object. [Api set: ExcelApi 1.2] /// The request context associated with this object. /// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property. /// Sheet protection options. Read-Only. [Api set: ExcelApi 1.2] /// Indicates if the worksheet is protected. Read-Only. [Api set: ExcelApi 1.2] } WorksheetProtection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } WorksheetProtection.prototype.protect = function(options) { /// /// Protects a worksheet. Fails if the worksheet has been protected. [Api set: ExcelApi 1.2] /// /// sheet protection options. /// } WorksheetProtection.prototype.unprotect = function() { /// /// Unprotects a worksheet. [Api set: ExcelApi 1.2] /// /// } return WorksheetProtection; })(OfficeExtension.ClientObject); Excel.WorksheetProtection = WorksheetProtection; })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var Interfaces; (function (Interfaces) { var WorksheetProtectionOptions = (function() { function WorksheetProtectionOptions() { /// Represents the options in sheet protection. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing using auto filter feature. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing deleting columns. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing deleting rows. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing formatting cells. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing formatting columns. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing formatting rows. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing inserting columns. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing inserting hyperlinks. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing inserting rows. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing using PivotTable feature. [Api set: ExcelApi 1.2] /// Represents the worksheet protection option of allowing using sort feature. [Api set: ExcelApi 1.2] } return WorksheetProtectionOptions; })(); Interfaces.WorksheetProtectionOptions.__proto__ = null; Interfaces.WorksheetProtectionOptions = WorksheetProtectionOptions; })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null})); })(Excel || (Excel = {__proto__: null})); var Excel; (function (Excel) { var RequestContext = (function (_super) { __extends(RequestContext, _super); function RequestContext() { /// /// The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in. /// /// Root object for interacting with the document _super.call(this, null); } return RequestContext; })(OfficeExtension.ClientRequestContext); Excel.RequestContext = RequestContext; Excel.run = function (batch) { /// /// /// Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. /// /// /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). ///
/// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. /// ///
/// /// /// Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. /// /// /// A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". /// /// /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). ///
/// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. /// ///
/// /// /// Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. /// /// /// An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()". /// /// /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). ///
/// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. /// ///
arguments[arguments.length - 1](new Excel.RequestContext()); return new OfficeExtension.Promise(); } })(Excel || (Excel = {__proto__: null})); Excel.__proto__ = null; var Word; (function (Word) { /// [Api set: WordApi] var Alignment = { __proto__: null, "unknown": "unknown", "left": "left", "centered": "centered", "right": "right", "justified": "justified", } Word.Alignment = Alignment; })(Word || (Word = {})); var Word; (function (Word) { var Body = (function(_super) { __extends(Body, _super); function Body() { /// Represents the body of a document or a section. [Api set: WordApi] /// The request context associated with this object /// Gets the collection of rich text content control objects that are in the body. Read-only. [Api set: WordApi] /// Gets the text format of the body. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi] /// Gets the collection of inlinePicture objects that are in the body. The collection does not include floating images. Read-only. [Api set: WordApi] /// Gets the collection of paragraph objects that are in the body. Read-only. [Api set: WordApi] /// Gets the content control that contains the body. Returns null if there isn't a parent content control. Read-only. [Api set: WordApi] /// Gets or sets the style used for the body. This is the name of the pre-installed or custom style. [Api set: WordApi] /// Gets the text of the body. Use the insertText method to insert text. Read-only. [Api set: WordApi] } Body.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Body.prototype.clear = function() { /// /// Clears the contents of the body object. The user can perform the undo operation on the cleared content. [Api set: WordApi] /// /// } Body.prototype.getHtml = function() { /// /// Gets the HTML representation of the body object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Body.prototype.getOoxml = function() { /// /// Gets the OOXML (Office Open XML) representation of the body object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Body.prototype.insertBreak = function(breakType, insertLocation) { /// /// Inserts a break at the specified location in the main document. The insertLocation value can be 'Start' or 'End'. [Api set: WordApi] /// /// Required. The break type to add to the body. /// Required. The value can be 'Start' or 'End'. /// } Body.prototype.insertContentControl = function() { /// /// Wraps the body object with a Rich Text content control. [Api set: WordApi] /// /// } Body.prototype.insertFileFromBase64 = function(base64File, insertLocation) { /// /// Inserts a document into the body at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The base64 encoded content of a .docx file. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Body.prototype.insertHtml = function(html, insertLocation) { /// /// Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The HTML to be inserted in the document. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Body.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) { /// /// Inserts a picture into the body at the specified location. The insertLocation value can be 'Start' or 'End'. [Api set: WordApi] /// /// Required. The base64 encoded image to be inserted in the body. /// Required. The value can be 'Start' or 'End'. /// } Body.prototype.insertOoxml = function(ooxml, insertLocation) { /// /// Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The OOXML to be inserted. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Body.prototype.insertParagraph = function(paragraphText, insertLocation) { /// /// Inserts a paragraph at the specified location. The insertLocation value can be 'Start' or 'End'. [Api set: WordApi] /// /// Required. The paragraph text to be inserted. /// Required. The value can be 'Start' or 'End'. /// } Body.prototype.insertText = function(text, insertLocation) { /// /// Inserts text into the body at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. Text to be inserted. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Body.prototype.search = function(searchText, searchOptions) { /// /// Performs a search with the specified searchOptions on the scope of the body object. The search results are a collection of range objects. [Api set: WordApi] /// /// Required. The search text. /// Optional. Options for the search. /// } Body.prototype.select = function(selectionMode) { /// /// Selects the body and navigates the Word UI to it. [Api set: WordApi] /// /// Optional. The selection mode can be 'Select', 'Start' or 'End'. 'Select' is the default. /// } return Body; })(OfficeExtension.ClientObject); Word.Body = Body; })(Word || (Word = {})); var Word; (function (Word) { /// [Api set: WordApi] var BreakType = { __proto__: null, "page": "page", "next": "next", "sectionNext": "sectionNext", "sectionContinuous": "sectionContinuous", "sectionEven": "sectionEven", "sectionOdd": "sectionOdd", "line": "line", } Word.BreakType = BreakType; })(Word || (Word = {})); var Word; (function (Word) { var ContentControl = (function(_super) { __extends(ContentControl, _super); function ContentControl() { /// Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported. [Api set: WordApi] /// The request context associated with this object /// Gets or sets the appearance of the content control. The value can be 'boundingBox', 'tags' or 'hidden'. [Api set: WordApi] /// Gets or sets a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. [Api set: WordApi] /// Gets or sets a value that indicates whether the user can edit the contents of the content control. [Api set: WordApi] /// Gets or sets the color of the content control. Color is set in "#RRGGBB" format or by using the color name. [Api set: WordApi] /// Gets the collection of content control objects in the content control. Read-only. [Api set: WordApi] /// Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi] /// Gets an integer that represents the content control identifier. Read-only. [Api set: WordApi] /// Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only. [Api set: WordApi] /// Get the collection of paragraph objects in the content control. Read-only. [Api set: WordApi] /// Gets the content control that contains the content control. Returns null if there isn't a parent content control. Read-only. [Api set: WordApi] /// Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. [Api set: WordApi] /// Gets or sets a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. [Api set: WordApi] /// Gets or sets the style used for the content control. This is the name of the pre-installed or custom style. [Api set: WordApi] /// Gets or sets a tag to identify a content control. [Api set: WordApi] /// Gets the text of the content control. Read-only. [Api set: WordApi] /// Gets or sets the title for a content control. [Api set: WordApi] /// Gets the content control type. Only rich text content controls are supported currently. Read-only. [Api set: WordApi] } ContentControl.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } ContentControl.prototype.clear = function() { /// /// Clears the contents of the content control. The user can perform the undo operation on the cleared content. [Api set: WordApi] /// /// } ContentControl.prototype.delete = function(keepContent) { /// /// Deletes the content control and its content. If keepContent is set to true, the content is not deleted. [Api set: WordApi] /// /// Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted. /// } ContentControl.prototype.getHtml = function() { /// /// Gets the HTML representation of the content control object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } ContentControl.prototype.getOoxml = function() { /// /// Gets the Office Open XML (OOXML) representation of the content control object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } ContentControl.prototype.insertBreak = function(breakType, insertLocation) { /// /// Inserts a break at the specified location in the main document. The insertLocation value can be 'Start', 'End', 'Before' or 'After'. [Api set: WordApi] /// /// Required. Type of break. /// Required. The value can be 'Start', 'End', 'Before' or 'After'. /// } ContentControl.prototype.insertFileFromBase64 = function(base64File, insertLocation) { /// /// Inserts a document into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The base64 encoded content of a .docx file. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } ContentControl.prototype.insertHtml = function(html, insertLocation) { /// /// Inserts HTML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The HTML to be inserted in to the content control. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } ContentControl.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) { /// /// Inserts an inline picture into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The base64 encoded image to be inserted in the content control. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } ContentControl.prototype.insertOoxml = function(ooxml, insertLocation) { /// /// Inserts OOXML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The OOXML to be inserted in to the content control. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } ContentControl.prototype.insertParagraph = function(paragraphText, insertLocation) { /// /// Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before' or 'After'. [Api set: WordApi] /// /// Required. The paragrph text to be inserted. /// Required. The value can be 'Start', 'End', 'Before' or 'After'. /// } ContentControl.prototype.insertText = function(text, insertLocation) { /// /// Inserts text into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The text to be inserted in to the content control. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } ContentControl.prototype.search = function(searchText, searchOptions) { /// /// Performs a search with the specified searchOptions on the scope of the content control object. The search results are a collection of range objects. [Api set: WordApi] /// /// Required. The search text. /// Optional. Options for the search. /// } ContentControl.prototype.select = function(selectionMode) { /// /// Selects the content control. This causes Word to scroll to the selection. [Api set: WordApi] /// /// Optional. The selection mode can be 'Select', 'Start' or 'End'. 'Select' is the default. /// } return ContentControl; })(OfficeExtension.ClientObject); Word.ContentControl = ContentControl; })(Word || (Word = {})); var Word; (function (Word) { /// ContentControl appearance [Api set: WordApi] var ContentControlAppearance = { __proto__: null, "boundingBox": "boundingBox", "tags": "tags", "hidden": "hidden", } Word.ContentControlAppearance = ContentControlAppearance; })(Word || (Word = {})); var Word; (function (Word) { var ContentControlCollection = (function(_super) { __extends(ContentControlCollection, _super); function ContentControlCollection() { /// Contains a collection of ContentControl objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported. [Api set: WordApi] /// The request context associated with this object /// Gets the loaded child items in this collection. } ContentControlCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } ContentControlCollection.prototype.getById = function(id) { /// /// Gets a content control by its identifier. [Api set: WordApi] /// /// Required. A content control identifier. /// } ContentControlCollection.prototype.getByTag = function(tag) { /// /// Gets the content controls that have the specified tag. [Api set: WordApi] /// /// Required. A tag set on a content control. /// } ContentControlCollection.prototype.getByTitle = function(title) { /// /// Gets the content controls that have the specified title. [Api set: WordApi] /// /// Required. The title of a content control. /// } ContentControlCollection.prototype.getItem = function(index) { /// /// Gets a content control by its index in the collection. [Api set: WordApi] /// /// The index /// } return ContentControlCollection; })(OfficeExtension.ClientObject); Word.ContentControlCollection = ContentControlCollection; })(Word || (Word = {})); var Word; (function (Word) { /// ContentControl types [Api set: WordApi] var ContentControlType = { __proto__: null, "richText": "richText", } Word.ContentControlType = ContentControlType; })(Word || (Word = {})); var Word; (function (Word) { var Document = (function(_super) { __extends(Document, _super); function Document() { /// The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. [Api set: WordApi] /// The request context associated with this object /// Gets the body of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only. [Api set: WordApi] /// Gets the collection of content control objects that are in the current document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only. [Api set: WordApi] /// Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only. [Api set: WordApi] /// Gets the collection of section objects that are in the document. Read-only. [Api set: WordApi] } Document.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Document.prototype.getSelection = function() { /// /// Gets the current selection of the document. Multiple selections are not supported. [Api set: WordApi] /// /// } Document.prototype.save = function() { /// /// Saves the document. This will use the Word default file naming convention if the document has not been saved before. [Api set: WordApi] /// /// } return Document; })(OfficeExtension.ClientObject); Word.Document = Document; })(Word || (Word = {})); var Word; (function (Word) { var Font = (function(_super) { __extends(Font, _super); function Font() { /// Represents a font. [Api set: WordApi] /// The request context associated with this object /// Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. [Api set: WordApi] /// Gets or sets the color for the specified font. You can provide the value in the "#RRGGBB" format or the color name. [Api set: WordApi] /// Gets or sets a value that indicates whether the font has a double strike through. True if the font is formatted as double strikethrough text, otherwise, false. [Api set: WordApi] /// Gets or sets the highlight color for the specified font. You can provide the value as either in the "#RRGGBB" format or the color name. [Api set: WordApi] /// Gets or sets a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. [Api set: WordApi] /// Gets or sets a value that represents the name of the font. [Api set: WordApi] /// Gets or sets a value that represents the font size in points. [Api set: WordApi] /// Gets or sets a value that indicates whether the font has a strike through. True if the font is formatted as strikethrough text, otherwise, false. [Api set: WordApi] /// Gets or sets a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. [Api set: WordApi] /// Gets or sets a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. [Api set: WordApi] /// Gets or sets a value that indicates the font's underline type. 'None' if the font is not underlined. [Api set: WordApi] } Font.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return Font; })(OfficeExtension.ClientObject); Word.Font = Font; })(Word || (Word = {})); var Word; (function (Word) { /// [Api set: WordApi] var HeaderFooterType = { __proto__: null, "primary": "primary", "firstPage": "firstPage", "evenPages": "evenPages", } Word.HeaderFooterType = HeaderFooterType; })(Word || (Word = {})); var Word; (function (Word) { var InlinePicture = (function(_super) { __extends(InlinePicture, _super); function InlinePicture() { /// Represents an inline picture. [Api set: WordApi] /// The request context associated with this object /// Gets or sets a string that represents the alternative text associated with the inline image [Api set: WordApi] /// Gets or sets a string that contains the title for the inline image. [Api set: WordApi] /// Gets or sets a number that describes the height of the inline image. [Api set: WordApi] /// Gets or sets the hyperlink associated with the inline image. [Api set: WordApi] /// Gets or sets a value that indicates whether the inline image retains its original proportions when you resize it. [Api set: WordApi] /// Gets the paragraph that contains the inline image. Read-only. [Api set: WordApi] /// Gets the content control that contains the inline image. Returns null if there isn't a parent content control. Read-only. [Api set: WordApi] /// Gets or sets a number that describes the width of the inline image. [Api set: WordApi] } InlinePicture.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } InlinePicture.prototype.delete = function() { /// /// Deletes the inline picture from the document. [Api set: WordApi] /// /// } InlinePicture.prototype.getBase64ImageSrc = function() { /// /// Gets the base64 encoded string representation of the inline image. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } InlinePicture.prototype.insertBreak = function(breakType, insertLocation) { /// /// Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The break type to add. /// Required. The value can be 'Before' or 'After'. /// } InlinePicture.prototype.insertContentControl = function() { /// /// Wraps the inline picture with a rich text content control. [Api set: WordApi] /// /// } InlinePicture.prototype.insertFileFromBase64 = function(base64File, insertLocation) { /// /// Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The base64 encoded content of a .docx file. /// Required. The value can be 'Before' or 'After'. /// } InlinePicture.prototype.insertHtml = function(html, insertLocation) { /// /// Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The HTML to be inserted. /// Required. The value can be 'Before' or 'After'. /// } InlinePicture.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) { /// /// Inserts an inline picture at the specified location. The insertLocation value can be 'Replace', 'Before' or 'After'. [Api set: WordApi] /// /// Required. The base64 encoded image to be inserted. /// Required. The value can be 'Replace', 'Before' or 'After'. /// } InlinePicture.prototype.insertOoxml = function(ooxml, insertLocation) { /// /// Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The OOXML to be inserted. /// Required. The value can be 'Before' or 'After'. /// } InlinePicture.prototype.insertParagraph = function(paragraphText, insertLocation) { /// /// Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The paragraph text to be inserted. /// Required. The value can be 'Before' or 'After'. /// } InlinePicture.prototype.insertText = function(text, insertLocation) { /// /// Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. Text to be inserted. /// Required. The value can be 'Before' or 'After'. /// } InlinePicture.prototype.select = function(selectionMode) { /// /// Selects the inline picture. This causes Word to scroll to the selection. [Api set: WordApi] /// /// Optional. The selection mode can be 'Select', 'Start' or 'End'. 'Select' is the default. /// } return InlinePicture; })(OfficeExtension.ClientObject); Word.InlinePicture = InlinePicture; })(Word || (Word = {})); var Word; (function (Word) { var InlinePictureCollection = (function(_super) { __extends(InlinePictureCollection, _super); function InlinePictureCollection() { /// Contains a collection of [inlinePicture](inlinePicture.md) objects. [Api set: WordApi] /// The request context associated with this object /// Gets the loaded child items in this collection. } InlinePictureCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return InlinePictureCollection; })(OfficeExtension.ClientObject); Word.InlinePictureCollection = InlinePictureCollection; })(Word || (Word = {})); var Word; (function (Word) { /// The insertion location types [Api set: WordApi] var InsertLocation = { __proto__: null, "before": "before", "after": "after", "start": "start", "end": "end", "replace": "replace", } Word.InsertLocation = InsertLocation; })(Word || (Word = {})); var Word; (function (Word) { var Paragraph = (function(_super) { __extends(Paragraph, _super); function Paragraph() { /// Represents a single paragraph in a selection, range, content control, or document body. [Api set: WordApi] /// The request context associated with this object /// Gets or sets the alignment for a paragraph. The value can be "left", "centered", "right", or "justified". [Api set: WordApi] /// Gets the collection of content control objects that are in the paragraph. Read-only. [Api set: WordApi] /// Gets or sets the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. [Api set: WordApi] /// Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi] /// Gets the collection of inlinePicture objects that are in the paragraph. The collection does not include floating images. Read-only. [Api set: WordApi] /// Gets or sets the left indent value, in points, for the paragraph. [Api set: WordApi] /// Gets or sets the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. [Api set: WordApi] /// Gets or sets the amount of spacing, in grid lines. after the paragraph. [Api set: WordApi] /// Gets or sets the amount of spacing, in grid lines, before the paragraph. [Api set: WordApi] /// Gets or sets the outline level for the paragraph. [Api set: WordApi] /// Gets the content control that contains the paragraph. Returns null if there isn't a parent content control. Read-only. [Api set: WordApi] /// Gets or sets the right indent value, in points, for the paragraph. [Api set: WordApi] /// Gets or sets the spacing, in points, after the paragraph. [Api set: WordApi] /// Gets or sets the spacing, in points, before the paragraph. [Api set: WordApi] /// Gets or sets the style used for the paragraph. This is the name of the pre-installed or custom style. [Api set: WordApi] /// Gets the text of the paragraph. Read-only. [Api set: WordApi] } Paragraph.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Paragraph.prototype.clear = function() { /// /// Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. [Api set: WordApi] /// /// } Paragraph.prototype.delete = function() { /// /// Deletes the paragraph and its content from the document. [Api set: WordApi] /// /// } Paragraph.prototype.getHtml = function() { /// /// Gets the HTML representation of the paragraph object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Paragraph.prototype.getOoxml = function() { /// /// Gets the Office Open XML (OOXML) representation of the paragraph object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Paragraph.prototype.insertBreak = function(breakType, insertLocation) { /// /// Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The break type to add to the document. /// Required. The value can be 'Before' or 'After'. /// } Paragraph.prototype.insertContentControl = function() { /// /// Wraps the paragraph object with a rich text content control. [Api set: WordApi] /// /// } Paragraph.prototype.insertFileFromBase64 = function(base64File, insertLocation) { /// /// Inserts a document into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The base64 encoded content of a .docx file. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Paragraph.prototype.insertHtml = function(html, insertLocation) { /// /// Inserts HTML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The HTML to be inserted in the paragraph. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Paragraph.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) { /// /// Inserts a picture into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The base64 encoded image to be inserted. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Paragraph.prototype.insertOoxml = function(ooxml, insertLocation) { /// /// Inserts OOXML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. The OOXML to be inserted in the paragraph. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Paragraph.prototype.insertParagraph = function(paragraphText, insertLocation) { /// /// Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The paragraph text to be inserted. /// Required. The value can be 'Before' or 'After'. /// } Paragraph.prototype.insertText = function(text, insertLocation) { /// /// Inserts text into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'. [Api set: WordApi] /// /// Required. Text to be inserted. /// Required. The value can be 'Replace', 'Start' or 'End'. /// } Paragraph.prototype.search = function(searchText, searchOptions) { /// /// Performs a search with the specified searchOptions on the scope of the paragraph object. The search results are a collection of range objects. [Api set: WordApi] /// /// Required. The search text. /// Optional. Options for the search. /// } Paragraph.prototype.select = function(selectionMode) { /// /// Selects and navigates the Word UI to the paragraph. [Api set: WordApi] /// /// Optional. The selection mode can be 'Select', 'Start' or 'End'. 'Select' is the default. /// } return Paragraph; })(OfficeExtension.ClientObject); Word.Paragraph = Paragraph; })(Word || (Word = {})); var Word; (function (Word) { var ParagraphCollection = (function(_super) { __extends(ParagraphCollection, _super); function ParagraphCollection() { /// Contains a collection of [paragraph](paragraph.md) objects. [Api set: WordApi] /// The request context associated with this object /// Gets the loaded child items in this collection. } ParagraphCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return ParagraphCollection; })(OfficeExtension.ClientObject); Word.ParagraphCollection = ParagraphCollection; })(Word || (Word = {})); var Word; (function (Word) { var Range = (function(_super) { __extends(Range, _super); function Range() { /// Represents a contiguous area in a document. [Api set: WordApi] /// The request context associated with this object /// Gets the collection of content control objects that are in the range. Read-only. [Api set: WordApi] /// Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi] /// Gets the collection of inline picture objects that are in the range. Read-only. [Api set: WordApi] /// Gets the collection of paragraph objects that are in the range. Read-only. [Api set: WordApi] /// Gets the content control that contains the range. Returns null if there isn't a parent content control. Read-only. [Api set: WordApi] /// Gets or sets the style used for the range. This is the name of the pre-installed or custom style. [Api set: WordApi] /// Gets the text of the range. Read-only. [Api set: WordApi] } Range.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Range.prototype.clear = function() { /// /// Clears the contents of the range object. The user can perform the undo operation on the cleared content. [Api set: WordApi] /// /// } Range.prototype.delete = function() { /// /// Deletes the range and its content from the document. [Api set: WordApi] /// /// } Range.prototype.getHtml = function() { /// /// Gets the HTML representation of the range object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Range.prototype.getOoxml = function() { /// /// Gets the OOXML representation of the range object. [Api set: WordApi] /// /// var result = new OfficeExtension.ClientResult(); result.__proto__ = null; result.value = ''; return result; } Range.prototype.insertBreak = function(breakType, insertLocation) { /// /// Inserts a break at the specified location in the main document. The insertLocation value can be 'Replace', 'Before' or 'After'. [Api set: WordApi] /// /// Required. The break type to add. /// Required. The value can be 'Replace', 'Before' or 'After'. /// } Range.prototype.insertContentControl = function() { /// /// Wraps the range object with a rich text content control. [Api set: WordApi] /// /// } Range.prototype.insertFileFromBase64 = function(base64File, insertLocation) { /// /// Inserts a document at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before' or 'After'. [Api set: WordApi] /// /// Required. The base64 encoded content of a .docx file. /// Required. The value can be 'Replace', 'Start', 'End', 'Before' or 'After'. /// } Range.prototype.insertHtml = function(html, insertLocation) { /// /// Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before' or 'After'. [Api set: WordApi] /// /// Required. The HTML to be inserted. /// Required. The value can be 'Replace', 'Start', 'End', 'Before' or 'After'. /// } Range.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) { /// /// Inserts a picture at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before' or 'After'. [Api set: WordApi] /// /// Required. The base64 encoded image to be inserted. /// Required. The value can be 'Replace', 'Start', 'End', 'Before' or 'After'. /// } Range.prototype.insertOoxml = function(ooxml, insertLocation) { /// /// Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before' or 'After'. [Api set: WordApi] /// /// Required. The OOXML to be inserted. /// Required. The value can be 'Replace', 'Start', 'End', 'Before' or 'After'. /// } Range.prototype.insertParagraph = function(paragraphText, insertLocation) { /// /// Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. [Api set: WordApi] /// /// Required. The paragraph text to be inserted. /// Required. The value can be 'Before' or 'After'. /// } Range.prototype.insertText = function(text, insertLocation) { /// /// Inserts text at the specified location. The insertLocation value can be 'Replace', 'Start', 'End', 'Before' or 'After'. [Api set: WordApi] /// /// Required. Text to be inserted. /// Required. The value can be 'Replace', 'Start', 'End', 'Before' or 'After'. /// } Range.prototype.search = function(searchText, searchOptions) { /// /// Performs a search with the specified searchOptions on the scope of the range object. The search results are a collection of range objects. [Api set: WordApi] /// /// Required. The search text. /// Optional. Options for the search. /// } Range.prototype.select = function(selectionMode) { /// /// Selects and navigates the Word UI to the range. [Api set: WordApi] /// /// Optional. The selection mode can be 'Select', 'Start' or 'End'. 'Select' is the default. /// } return Range; })(OfficeExtension.ClientObject); Word.Range = Range; })(Word || (Word = {})); var Word; (function (Word) { var SearchOptions = (function(_super) { __extends(SearchOptions, _super); function SearchOptions() { /// Specifies the options to be included in a search operation. [Api set: WordApi] /// The request context associated with this object /// Gets or sets a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. [Api set: WordApi] /// Gets or sets a value that indicates whether to ignore all white space between words. Corresponds to the Ignore white-space characters check box in the Find and Replace dialog box. [Api set: WordApi] /// Gets or sets a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box (Edit menu). [Api set: WordApi] /// Gets or sets a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. [Api set: WordApi] /// Gets or sets a value that indicates whether to find words that sound similar to the search string. Corresponds to the Sounds like check box in the Find and Replace dialog box [Api set: WordApi] /// Gets or sets a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. [Api set: WordApi] /// Gets or sets a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. [Api set: WordApi] /// Gets or sets a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. [Api set: WordApi] } SearchOptions.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return SearchOptions; })(OfficeExtension.ClientObject); Word.SearchOptions = SearchOptions; })(Word || (Word = {})); var Word; (function (Word) { var SearchResultCollection = (function(_super) { __extends(SearchResultCollection, _super); function SearchResultCollection() { /// Contains a collection of [range](range.md) objects as a result of a search operation. [Api set: WordApi] /// The request context associated with this object /// Gets the loaded child items in this collection. } SearchResultCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return SearchResultCollection; })(OfficeExtension.ClientObject); Word.SearchResultCollection = SearchResultCollection; })(Word || (Word = {})); var Word; (function (Word) { var Section = (function(_super) { __extends(Section, _super); function Section() { /// Represents a section in a Word document. [Api set: WordApi] /// The request context associated with this object /// Gets the body of the section. This does not include the header/footer and other section metadata. Read-only. [Api set: WordApi] } Section.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } Section.prototype.getFooter = function(type) { /// /// Gets one of the section's footers. [Api set: WordApi] /// /// Required. The type of footer to return. This value can be: 'primary', 'firstPage' or 'evenPages'. /// } Section.prototype.getHeader = function(type) { /// /// Gets one of the section's headers. [Api set: WordApi] /// /// Required. The type of header to return. This value can be: 'primary', 'firstPage' or 'evenPages'. /// } return Section; })(OfficeExtension.ClientObject); Word.Section = Section; })(Word || (Word = {})); var Word; (function (Word) { var SectionCollection = (function(_super) { __extends(SectionCollection, _super); function SectionCollection() { /// Contains the collection of the document's [section](section.md) objects. [Api set: WordApi] /// The request context associated with this object /// Gets the loaded child items in this collection. } SectionCollection.prototype.load = function(option) { /// /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. /// /// /// } return SectionCollection; })(OfficeExtension.ClientObject); Word.SectionCollection = SectionCollection; })(Word || (Word = {})); var Word; (function (Word) { /// [Api set: WordApi] var SelectionMode = { __proto__: null, "select": "select", "start": "start", "end": "end", } Word.SelectionMode = SelectionMode; })(Word || (Word = {})); var Word; (function (Word) { /// Underline types [Api set: WordApi] var UnderlineType = { __proto__: null, "none": "none", "single": "single", "word": "word", "double": "double", "dotted": "dotted", "hidden": "hidden", "thick": "thick", "dashLine": "dashLine", "dotLine": "dotLine", "dotDashLine": "dotDashLine", "twoDotDashLine": "twoDotDashLine", "wave": "wave", } Word.UnderlineType = UnderlineType; })(Word || (Word = {})); var Word; (function (Word) { var RequestContext = (function (_super) { __extends(RequestContext, _super); function RequestContext() { /// /// The RequestContext object facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in. /// /// Root object for interacting with the document _super.call(this, null); } return RequestContext; })(OfficeExtension.ClientRequestContext); Word.RequestContext = RequestContext; Word.run = function (batch) { /// /// Executes a batch script that performs actions on the Word object model. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. /// /// /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). ///
/// The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in. /// batch(new Word.RequestContext()); return new OfficeExtension.IPromise(); } })(Word || (Word = {})); Word.__proto__ = null;