Office-Addin-Scripts

A function can perform specific actions when a user cancels the function execution.

Requirements:

• Use the @cancelable tag (though it is automatically detected if the last parameter is of type CustomFunctions.CancelableInvocation).
• The last parameter must be of type CustomFunctions.CancelableInvocation.
• Assign a callback to the oncanceled property of that parameter to define the cancellation behavior.
• Constraints: A function cannot have both @cancelable and @streaming tags.

/**
 * @customfunction LONG_TASK
 * @param invocation
 */
function longTask(invocation: CustomFunctions.CancelableInvocation): void {
  invocation.oncanceled = () => {
    console.log("Task was canceled");
  };
}

If your custom function needs to know where it is being evaluated or where its inputs are located, use these tags.

• @requiresAddress: Indicates the address of the cell where the function is being evaluated should be provided. The last parameter must be of type CustomFunctions.Invocation or a derived type. The address property will contain the cell address.
• @requiresParameterAddresses: Indicates the addresses of the input parameters should be provided. The last parameter must be of type CustomFunctions.Invocation or a derived type. The parameterAddresses property will contain an array of addresses for each parameter.

The @linkedEntityLoadService tag marks a special custom function used as the loadFunction for user-defined LinkedEntityDataDomains.

Requirements:

• Must accept and return a single non-repeating, non-optional, scalar parameter of type unknown.
• Must not be an XLL-compatible custom function.
• Must allow rich data as input.
• Behavior: These functions are excluded from the autocomplete drop-down list and Formula Builder.
• Constraints: Cannot be combined with @streaming, @volatile, @requiresAddress, @requiresParameterAddresses, @excludeFromAutoComplete, @action, or @capturesCallingObject.

Streaming functions allow a function to return values over time rather than a single result.

Requirements:

• Use the @streaming tag.
• The last parameter must be of type CustomFunctions.StreamingInvocation<ResultType>.
• The function must return void.
• Instead of returning a value, call setResult(result: ResultType) on the last parameter.
• setResult() can be called with an Error to indicate a failure.
• Constraints: Streaming functions cannot be marked as @volatile and cannot be used with @cancelable.

/**
 * @customfunction STREAM_DATA
 * @param callback
 */
function streamData(callback: CustomFunctions.StreamingInvocation<string>): void {
  // ... logic to produce data ...
  callback.setResult("First chunk");
  callback.setResult("Second chunk");
}

The @action tag identifies a function that is run when a user-defined Action is triggered. These functions are intended to be called only by the Excel runtime.

Requirements:

• Must accept a single non-repeating, non-optional, scalar parameter of type unknown.
• Must have a return type of void.
• Must not be an XLL-compatible custom function.
• Must allow rich data as input.
• Behavior: These functions are excluded from the autocomplete drop-down list and Formula Builder.
• Constraints: Cannot be combined with @linkedEntityLoadService, @capturesCallingObject, @streaming, @volatile, or @excludeFromAutoComplete.

Install the package via npm to manage SSL certificates for development servers using https://localhost.

Upon installation, a development CA certificate and a localhost key/certificate are generated in <userhome>/.office-addin-dev-certs. By default, certificates are valid for 30 days.

npm install office-addin-dev-certs