ExcelClient Class

Reference

Definition

Namespace:: Microsoft.Hpc.Excel

Assembly:: Microsoft.Hpc.Excel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an engine that implements the partition, calculate, and merge model that Microsoft HPC Pack 2016 Services for Excel uses to run calculations in a workbook in parallel on an HPC cluster. The workbook must implement the callback macro framework.

[System.Runtime.InteropServices.ComVisible(false)]
public class ExcelClient : IDisposable

type ExcelClient = class
    interface IDisposable

Public Class ExcelClient
Implements IDisposable

Inheritance: Object
ExcelClient

Attributes: ComVisibleAttribute

Implements: IDisposable

Constructors

ExcelClient()

Initializes a new instance of the ExcelClient class.

Fields

Version

Represents the version of the Excel client.

Properties

DependFiles
Driver	Gets the ExcelDriver object that interacts with the currently open Excel workbook.
MacroResource

Methods

BeginRun(Boolean, AsyncCallback, Object)	Starts a calculation asynchronously for the Excel workbook using the partition, calculate, and merge model that Microsoft HPC Pack 2016 Services for Excel uses to run calculations. The calculation runs on the HPC cluster with the head node that you specified when you called the OpenSession method, unless you specify that the calculation should run on the local computer.
Cancel()	Cancels any currently running Excel calculations without closing the SOA session.
CloseSession()	Closes the session that you opened by calling the OpenSession method subject to a default timeout period, and closes all instances of Excel that are running on the compute nodes.
CloseSession(Int32)	Closes the session that you opened by calling the OpenSession method subject to the specified timeout period, and closes all instances of Excel that are running on the compute nodes.
Dispose()	Releases all of the resources that the object allocated.
Dispose(Boolean)
EndRun(IAsyncResult)	Ends a asynchronous calculation from an Excel workbook on an HPC cluster that you began by calling the BeginRun(Boolean, AsyncCallback, Object) method.
Initialize(String)	Initializes the Excel SOA client by creating a new instance of the ExcelDriver class to interact with the Excel workbook located at the specified path.
Initialize(Workbook)	Initializes the Excel SOA client by creating a new instance of the ExcelDriver class to interact with the Excel workbook that is represented by the specified Workbook object.
OpenSession(SessionStartInfo, String)	Starts a new SOA session using the settings in the specified SessionStartInfo object to perform calculations from the specified Excel workbook on an HPC cluster.
OpenSession(String, Int32, Int32, SessionUnitType, String)	Starts a new SOA session using the specified resource settings to perform calculations from the specified Excel workbook on the HPC cluster with the specified head node.
Run(Boolean)	Starts the calculation for the Excel workbook using the partition, calculate, and merge model that Microsoft HPC Pack 2016 Services for Excel uses to run calculations. The calculation runs on the HPC cluster with the head node that you specified when you called the OpenSession method, unless you specify that the calculation should run on the local computer.

Events

ErrorHandler

An event that is raised when the response handler receives errors from the HPC cluster.

Applies to