# Office365Excel Component

The Office365Excel component provides an easy way to manage workbooks in One Drive. The component includes support for creating, deleting, updating and listing workbooks and worksheets.

## Syntax

```text
nsoftware.CloudSheets.Office365Excel
```

## Remarks

This component provides an easy to use interface for Excel Workbooks using Microsoft Graph API for Excel. To use the component, first set the [Authorization](#authorization-property-office365excel-component) property to a valid OAuth token. The Office365Excel component can be used for creating new worksheets, retrieving, deleting and updating existing ones; and several other functionalities supported by the Microsoft Excel API.

This component requires authentication via OAuth 2.0. First, perform OAuth authentication using the [OAuth](#oauth-property-office365excel-component) property to set the appropriate fields for the chosen [ClientProfile](#OAuthSettings_f_ClientProfile) and [GrantType](#OAuthSettings_f_GrantType).

The component has the following defaults:

|  |  |
| --- | --- |
| Authorization Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" |
| Token Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/token" |
| Scopes | "offline_access files.readwrite user.read" |

Below is a brief description of the different [ClientProfile](#OAuthSettings_f_ClientProfile) and [GrantType](#OAuthSettings_f_GrantType) values that are supported by this component. For a more in-depth description of what needs to be set, refer to the service documentation.

### Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the component. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the [Authorize](#authorize-method-office365excel-component) method should be called. If the authorization and authentication was successful, then the [AccessToken](#OAuthSettings_f_AccessToken) field will be populated. Additionally, if a *refresh token* was provided the [RefreshToken](#OAuthSettings_f_RefreshToken) field will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the [AccessToken](#OAuthSettings_f_AccessToken) will be expired. When a method that makes requests to the service provider is called or the [Authorize](#authorize-method-office365excel-component) method is called the component will automatically check to see if the *access token* is expired. If it is, it will then automatically try to get a new [AccessToken](#OAuthSettings_f_AccessToken). If the [Authorize](#authorize-method-office365excel-component) method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the [GrantType](#OAuthSettings_f_GrantType) field. To force the component to only check the *access token* when the [Authorize](#authorize-method-office365excel-component) method is called, the [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) configuration setting can be set to false.

A brief description of the supported values for the [GrantType](#OAuthSettings_f_GrantType) field are below. For more information, see the service documentation.

**Authorization Code**

When using the *Authorization Code* grant type, the component will use an *authorization code* to get an *access token*. For this [GrantType](#OAuthSettings_f_GrantType) the component expects a [ClientId](#OAuthSettings_f_ClientId), [ClientSecret](#OAuthSettings_f_ClientSecret), [ServerAuthURL](#OAuthSettings_f_ServerAuthURL), and [ServerTokenURL](#OAuthSettings_f_ServerTokenURL) to be set. When the [Authorize](#authorize-method-office365excel-component) method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the *authorization code*, setting the [AuthorizationCode](#OAuthSettings_f_AuthorizationCode) field, from the redirect. Immediately, the component will make a request to the token server to exchange the *authorization code* for an *access token*. The token server will return an *access token* and possibly a *refresh token*. If the [RefreshToken](#OAuthSettings_f_RefreshToken) field is set, or a *refresh token* is cached, then the component will not launch the browser and use the *refresh token* in its request to the token server instead of an *authorization code*.

**Example: **

```csharp
Office365Excel oexcel = new Office365Excel();

oexcel.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
oexcel.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
oexcel.OAuth.ClientId = CLIENT_ID;
oexcel.OAuth.ClientSecret = CLIENT_SECRET;

oexcel.Authorize();
```

 **Implicit**

Note: This grant type is considered insecure and should only be used when necessary.

When using the *Implicit* grant type, the component will request the authorization server to get an *access token*. For this [GrantType](#OAuthSettings_f_GrantType) the component expects a [ClientId](#OAuthSettings_f_ClientId), [ClientSecret](#OAuthSettings_f_ClientSecret), and [ServerAuthURL](#OAuthSettings_f_ServerAuthURL) to be set. When the [Authorize](#authorize-method-office365excel-component) method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the *access token* from the redirect.

A disadvantage of the grant type is that can not use a *refresh token* to silently get a new *access token*. Most service providers offer a way to silently get a new *access token*. See the service documentation for specifics. This means the component will not be able to automatically get a fresh token once it expires.

### Web Profile

 This profile is similar to setting the component to the Application profile and Authorization Code grant type except the component will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that [ClientId](#OAuthSettings_f_ClientId), [ClientSecret](#OAuthSettings_f_ClientSecret), [ServerAuthURL](#OAuthSettings_f_ServerAuthURL), [ServerTokenURL](#OAuthSettings_f_ServerTokenURL), and the [ReturnURL](#OAuthSettings_f_ReturnURL) fields to be set. Before calling the [Authorize](#authorize-method-office365excel-component) method, the [WebAuthURL](#OAuthSettings_f_WebAuthURL) field should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The *redirect_uri* parameter of this URL is mapped to the [ReturnURL](#OAuthSettings_f_ReturnURL) field. The [ReturnURL](#OAuthSettings_f_ReturnURL) field should be set to some web server that will parse the *authorization code* out of the query parameter from the redirect. Once the *authorization code* is parsed, it should be passed back to the server where it is then set to the [AuthorizationCode](#OAuthSettings_f_AuthorizationCode) field. Once that is set, the [Authorize](#authorize-method-office365excel-component) method can be called to exchange the *authorization code* for an *access token* and *refresh token* if provided. The component will then cache these values like normal and use them to make requests. If the [RefreshToken](#OAuthSettings_f_RefreshToken) field is set, or a *refresh token* is cached, then the [Authorize](#authorize-method-office365excel-component) method can immediately be called to make a request to the token server to get a new *access token*.

### External OAuth Support

 For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using a separate OAuth client. Once complete you should have an authorization string which looks like:

```text
Bearer ACCESS_TOKEN_VALUE
```

Assign this value to the [Authorization](#authorization-property-office365excel-component) property before attempting any operations. Setting the [Authorization](#authorization-property-office365excel-component) property will cause the component to ignore the values set in the [OAuth](#oauth-property-office365excel-component) property.

 For Example:

```csharp
Oauth oauth = new Oauth();

oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.AuthorizationScope = "offline_access files.readwrite user.read";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;

oexcel.Authorization = oauth.GetAuthorization();
```

 Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

### Creating a Workbook

Use the [CreateWorkbook](#createworkbook-method-office365excel-component) method in the Office365Excel component to create a new workbook in One Drive. The *Name* parameter will determine the name of the new workbook. Once created, the workbook attributes cannot be updated.

**Creating a workbook:**

```csharp
oexcel.CreateWorkbook("NewWorkbook");
```

Call [DeleteWorkbook](#deleteworkbook-method-office365excel-component) and provide the workbook Id if you want to delete the workbook. The workbook will be removed permanently.

**Example (Delete a Workbook)**

```csharp
// List workbooks to get the target workbook Id
oexcel.ListWorkbooks();

oexcel.DeleteWorkbook(oexcel.Workbooks[0].Id)
```

### Listing Workbooks

Information about workbooks fetched by the component can be accessed through the [Workbooks](#workbooks-property-office365excel-component) collection. The [Workbooks](#workbooks-property-office365excel-component) collection is populated when the [ListWorkbooks](#listworkbooks-method-office365excel-component) method is called.

By default, the component will fetch one page of 100 workbooks when [ListWorkbooks](#listworkbooks-method-office365excel-component) is called. If additional workbooks remain in the folder, the [WorkbooksMarker](#workbooksmarker-property-office365excel-component) property will be populated and subsequent calls to [ListWorkbooks](#listworkbooks-method-office365excel-component) will fetch the next page of workbooks. The example below populates the [Workbooks](#workbooks-property-office365excel-component) collection with all the workbooks associated with the account.

```csharp
do
{
    oexcel.ListWorkbooks();
} while (oexcel.WorkbooksMarker.Length > 0);
```

The workbook page size may also be changed by using the WorkbooksPageSize configuration setting.

 **Creating a new session: **

```csharp
// Load the workbook first
oexcel.LoadWorkbook(workbookId);

oexcel.CreateSession(true);     // Creating a persistent session

oexcel.CreateSession(false);    // Creating a non-persistent session
```

### Creating Worksheets

To add a new worksheet use the [AddWorksheet](#addworksheet-method-office365excel-component) method. The newly added worksheet will be in the beginning of the [Worksheets](#worksheets-property-office365excel-component) collection.

**Example (Create a new worksheet in a specific workbook)**

```csharp
oexcel.LoadWorkbook(workbookId);		// A workbook must be loaded before calling AddWorksheet()

oexcel.AddWorksheet("Second wsheet");
```

 After creating a worksheet with the basic information, select the worksheet to be edited in the [Worksheets](#worksheets-property-office365excel-component) collection, edit its fields and make a call to the [UpdateWorksheet](#updateworksheet-method-office365excel-component) method. To edit the newly created worksheet select the first worksheet in the collection.

**Example (Update The First Worksheet Of The List)**

```csharp
// Set properties to update
oexcel.Worksheets[0].Visibility = TOEWorksheetVisibilities.oewvHidden;
oexcel.Worksheets[0].Position = 2;

oexcel.UpdateWorksheet();
```

### Loading a Worksheet

 To load a worksheet in the collection, call the [LoadWorksheet](#loadworksheet-method-office365excel-component) method and provide the worksheetId as the sole parameter. This will cause the worksheet to be added to the beginning of the [Worksheets](#worksheets-property-office365excel-component) collection

 **Example (Load Worksheet)**

```csharp
string worksheetId = "worksheetId";

oexcel.LoadWorksheet(worksheetId);
OEWorksheet worksheet = oexcel.Worksheets[0];

// Update attributes or cell values...
```

### Loading a Range

 To load a range, call the [LoadRange](#loadrange-method-office365excel-component) method and provide the two arguments: *WorksheetId* to specify the worksheet to be partially loaded and *Range* to specify the range which will be loaded, the latter uses 'A1:B2' notation. (See [Cell](#cell-property-office365excel-component))

 **Example (Load a Range)**

```csharp
string worksheetId = "worksheetId";   // Replace with actual worksheet Id

oexcel.LoadRange(worksheetId, "A1:D10");   // We can only work with cells inside the loaded range
OEWorksheet worksheet = oexcel.Worksheets[0];

// Access the retrieved worksheet

oexcel.RowCount;   // Number of rows in the loaded worksheet
oexcel.ColumnCount;    // Number of columns in the loaded worksheet
oexcel.Cell = "A1";    // Select the first cell
oexcel.CellValue = "1";    // Insert value in first cell

oexcel.UpdateWorksheet();
```

 Attempting to update or modify any cells outside the loaded range that was specified by the *Range* parameter will result in an error being thrown.

### Deleting a Worksheet

To delete a worksheet use the [DeleteWorksheet](#deleteworksheet-method-office365excel-component) method and provide the Id of the worksheet. The worksheet will be deleted permanently.

**Example (Delete Worksheets)**

```csharp
// Delete all hidden worksheets in the Worksheets collection
foreach (OEWorksheet worksheet in oexcel.Worksheets)
{
  if (worksheet.Visibility == TOEWorksheetVisibilities.oewvHidden)
  {
    oexcel.DeleteWorksheet(worksheet.WorksheetId);
  }
}
```

## Property List

*The following is the full list of the properties of the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Authorization](#authorization-property-office365excel-component) | An OAuth Authorization String. |
| [Cell](#cell-property-office365excel-component) | Represents a specific cell in a Worksheet. |
| [CellColumnIndex](#cellcolumnindex-property-office365excel-component) | The column index of the selected cell. |
| [CellFormula](#cellformula-property-office365excel-component) | The formula entered by the user in the selected cell. |
| [CellRowIndex](#cellrowindex-property-office365excel-component) | The row index of the selected cell. |
| [CellText](#celltext-property-office365excel-component) | The text currently displayed in the cell. This includes user-entered text or the visible result of a formula. |
| [CellValue](#cellvalue-property-office365excel-component) | The user entered value of the cell. |
| [CellValueType](#cellvaluetype-property-office365excel-component) | Represents the type of data stored in the cell. |
| [ColumnCount](#columncount-property-office365excel-component) | The number of columns in the loaded worksheet or range grid. |
| [Firewall](#firewall-property-office365excel-component) | A set of properties related to firewall access. |
| [FirstColumn](#firstcolumn-property-office365excel-component) | The column index of the first column in the currently loaded range. |
| [FirstRow](#firstrow-property-office365excel-component) | Represents the index of the first row in the currently loaded range. |
| [OAuth](#oauth-property-office365excel-component) | The OAuth settings. |
| [Proxy](#proxy-property-office365excel-component) | A set of properties related to proxy access. |
| [RowCount](#rowcount-property-office365excel-component) | Indicates the total number of rows in the currently loaded worksheet or range grid. |
| [SessionId](#sessionid-property-office365excel-component) | Current session ID. |
| [SSLAcceptServerCert](#sslacceptservercert-property-office365excel-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#sslcert-property-office365excel-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLProvider](#sslprovider-property-office365excel-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#sslservercert-property-office365excel-component) | The server certificate for the last established connection. |
| [Workbooks](#workbooks-property-office365excel-component) | The collection of workbooks listed by the server. |
| [WorkbooksMarker](#workbooksmarker-property-office365excel-component) | A pagination marker for listing workbooks. |
| [Worksheets](#worksheets-property-office365excel-component) | The collection of worksheets in the current workbook. |

## Method List

*The following is the full list of the methods of the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AddWorksheet](#addworksheet-method-office365excel-component) | Adds a new worksheet at the end of the workbook. |
| [Authorize](#authorize-method-office365excel-component) | Get the authorization string required to access the protected resource. |
| [Clear](#clear-method-office365excel-component) | Clears all the values of the loaded range or worksheet. |
| [CloseSession](#closesession-method-office365excel-component) | Close the existing workbook session. |
| [Config](#config-method-office365excel-component) | Sets or retrieves a configuration setting. |
| [CreateSession](#createsession-method-office365excel-component) | Create new workbook session. |
| [CreateWorkbook](#createworkbook-method-office365excel-component) | Creates a new workbook on the server. |
| [DeleteColumn](#deletecolumn-method-office365excel-component) | Deletes a column at the specified index. |
| [DeleteRow](#deleterow-method-office365excel-component) | Deletes a row at the given index. |
| [DeleteWorkbook](#deleteworkbook-method-office365excel-component) | Delete the workbook with given Id. |
| [DeleteWorksheet](#deleteworksheet-method-office365excel-component) | Delete the worksheet with given Id. |
| [InsertColumn](#insertcolumn-method-office365excel-component) | Inserts a single empty column at the index specified. |
| [InsertRow](#insertrow-method-office365excel-component) | Inserts a single empty row at the index specified. |
| [Interrupt](#interrupt-method-office365excel-component) | Interrupt the current method. |
| [ListWorkbooks](#listworkbooks-method-office365excel-component) | Lists the workbooks. |
| [LoadRange](#loadrange-method-office365excel-component) | Load the specified range of cells in the worksheet. |
| [LoadWorkbook](#loadworkbook-method-office365excel-component) | Load the workbook's worksheets list from the server. Set as first in Worksheets collection. |
| [LoadWorksheet](#loadworksheet-method-office365excel-component) | Load the worksheet's data (used range). |
| [RefreshSession](#refreshsession-method-office365excel-component) | Refreshes the existing workbook session. |
| [Reset](#reset-method-office365excel-component) | This method will reset the component. |
| [SendCustomRequest](#sendcustomrequest-method-office365excel-component) | Send a custom HTTP request. |
| [UpdateWorksheet](#updateworksheet-method-office365excel-component) | Update the current loaded worksheet properties and the cells data. |

## Event List

*The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Error](#error-event-office365excel-component) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-office365excel-component) | Fired once for each log message. |
| [SSLServerAuthentication](#sslserverauthentication-event-office365excel-component) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-office365excel-component) | Fired when secure connection progress messages are available. |
| [Transfer](#transfer-event-office365excel-component) | Fired while a document transfers (delivers document). |
| [WorkbookList](#workbooklist-event-office365excel-component) | Fired when a workbook is retrieved from the server. |

## Config Settings

*The following is a list of config settings for the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [WorkbooksPageSize](#WorkbooksPageSize) | Page size limit for fetching workbooks. |
| [XChildCount](#XChildCount) | The number of child elements of the current element. |
| [XChildName\[i\]](#XChildName[i]) | The name of the child element. |
| [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. |
| [XElement](#XElement) | The name of the current element. |
| [XParent](#XParent) | The parent of the current element. |
| [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. |
| [XSubTree](#XSubTree) | A snapshot of the current element in the document. |
| [XText](#XText) | The text of the current element. |
| [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. |
| [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. |
| [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. |
| [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. |
| [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. |
| [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. |
| [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. |
| [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. |
| [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. |
| [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. |
| [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. |
| [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
| [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. |
| [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. |
| [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. |
| [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. |
| [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. |
| [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. |
| [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. |
| [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. |
| [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. |
| [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. |
| [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. |
| [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. |
| [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. |
| [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. |
| [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. |
| [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. |
| [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. |
| [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [AllowNTLMFallback](#AllowNTLMFallback) | Whether to allow fallback from Negotiate to NTLM when authenticating. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the component. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the component will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the component. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxHeaders](#MaxHeaders) | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| [MaxHTTPCookies](#MaxHTTPCookies) | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the component. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UsePlatformDeflate](#UsePlatformDeflate) | Whether to use the platform implementation to decompress compressed responses. |
| [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallListener](#FirewallListener) | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the component binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [CACertFilePaths](#CACertFilePaths) | The paths to CA certificate files when using Mono on Unix/Linux. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Authorization Property ([Office365Excel](#office365excel-component) Component)

An OAuth Authorization String.

## Syntax

```text
public string Authorization { get; set; }
```

## Default Value

""

## Remarks

This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.

**Example**

```text
Oauth oauth = new Oauth();

oauth.ClientId = "clientId";
oauth.ClientSecret = "clientSecret";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "offline_access files.readwrite user.read";
oauth.ClientProfile = OAuthClientProfiles.ocpApplication;
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;

oexcel.Authorization = oauth.GetAuthorization();
```

This property is not available at design time.

# Cell Property ([Office365Excel](#office365excel-component) Component)

Represents a specific cell in a Worksheet.

## Syntax

```text
public string Cell { get; set; }
```

## Default Value

"A1"

## Remarks

This property is used to specify a target cell for reading or writing operations. It accepts standard A1 notation, making it easy to reference cells within a worksheet. An example of A1 notation can be 'B6' which represents the cell in the 6th row, column B.

This property is not available at design time.

# CellColumnIndex Property ([Office365Excel](#office365excel-component) Component)

The column index of the selected cell.

## Syntax

```text
public int CellColumnIndex { get; set; }
```

## Default Value

0

## Remarks

The valid range for CellColumnIndex is from 0 up to [ColumnCount](#columncount-property-office365excel-component) - 1. For example, the index for column 'A' will be 0 and the index for the last column will be [ColumnCount](#columncount-property-office365excel-component) - 1.

Works together with [CellRowIndex](#cellrowindex-property-office365excel-component) to select a cell.

This property is not available at design time.

# CellFormula Property ([Office365Excel](#office365excel-component) Component)

The formula entered by the user in the selected cell.

## Syntax

```text
public string CellFormula { get; set; }
```

## Default Value

""

## Remarks

The *CellFormula* property holds the formula assigned to a cell.

The formula takes precedence over a direct cell value. If a formula is set, the cell's computed value will be derived from it. The *CellText* property will only be updated after the worksheet is synchronized with the server.

This property is not available at design time.

# CellRowIndex Property ([Office365Excel](#office365excel-component) Component)

The row index of the selected cell.

## Syntax

```text
public int CellRowIndex { get; set; }
```

## Default Value

0

## Remarks

The valid range for CellRowIndex is from 0 up to [RowCount](#rowcount-property-office365excel-component) - 1. For example, the index for row 1 will be 0 and the index for the last row will be [RowCount](#rowcount-property-office365excel-component) - 1.

Used alongside [CellColumnIndex](#cellcolumnindex-property-office365excel-component) to reference a specific cell numerically.

This property is not available at design time.

# CellText Property ([Office365Excel](#office365excel-component) Component)

The text currently displayed in the cell. This includes user-entered text or the visible result of a formula.

## Syntax

```text
public string CellText { get; }
```

## Default Value

""

## Remarks

The *CellText* property is read-only and reflects the text content displayed in the cell.

If a formula is present, *CellText* returns the evaluated result of the formula, not the formula itself. If the cell is empty, the default value will be an empty string.

This property is read-only and not available at design time.

# CellValue Property ([Office365Excel](#office365excel-component) Component)

The user entered value of the cell.

## Syntax

```text
public string CellValue { get; set; }
```

## Default Value

""

## Remarks

The *CellValue* property reflects the raw value that the user has entered into the cell.

This value may differ from *CellText* if a formula is applied, as *CellText* shows the evaluated result of the formula. The CellText value will be updated only after updating the worksheet on the server.

This property is not available at design time.

# CellValueType Property ([Office365Excel](#office365excel-component) Component)

Represents the type of data stored in the cell.

## Syntax

```text
public string CellValueType { get; }
```

## Default Value

"Empty"

## Remarks

The *CellValueType* is read-only and indicates the type of the cell's value.

The possible values are:

- Unknown
- Empty
- String
- Integer
- Double
- Boolean
- Error

The default value is *Empty*, meaning the cell has no value assigned.

This property is read-only and not available at design time.

# ColumnCount Property ([Office365Excel](#office365excel-component) Component)

The number of columns in the loaded worksheet or range grid.

## Syntax

```text
public int ColumnCount { get; }
```

## Default Value

0

## Remarks

Use with [RowCount](#rowcount-property-office365excel-component) to iterate over all cells in a selected range for updates or validation.

This property is read-only and not available at design time.

# Firewall Property ([Office365Excel](#office365excel-component) Component)

A set of properties related to firewall access.

## Syntax

```text
public Firewall Firewall { get; set; }
```

## Remarks

This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect.

 Please refer to the [Firewall](#firewall-type) type for a complete list of fields.

# FirstColumn Property ([Office365Excel](#office365excel-component) Component)

The column index of the first column in the currently loaded range.

## Syntax

```text
public string FirstColumn { get; }
```

## Default Value

"A"

## Remarks

Combined with [ColumnCount](#columncount-property-office365excel-component), it defines the horizontal scope of the loaded range. This is represented in A1 notation. For example, if FirstColumn returns 'D', this would represent the the 4th column.

This property is read-only and not available at design time.

# FirstRow Property ([Office365Excel](#office365excel-component) Component)

Represents the index of the first row in the currently loaded range.

## Syntax

```text
public string FirstRow { get; }
```

## Default Value

"1"

## Remarks

Useful for identifying the starting row when working with a specific data range or when pagination is required. This is given in A1 notation. For example, if FirstRow returns '8', this would represent the 8th row.

Works together with [RowCount](#rowcount-property-office365excel-component) to establish the loaded vertical range.

This property is read-only and not available at design time.

# OAuth Property ([Office365Excel](#office365excel-component) Component)

The OAuth settings.

## Syntax

```text
public OAuthSettings OAuth { get; }
```

## Remarks

This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information.

This property is read-only and not available at design time.

 Please refer to the [OAuthSettings](#oauthsettings-type) type for a complete list of fields.

# Proxy Property ([Office365Excel](#office365excel-component) Component)

A set of properties related to proxy access.

## Syntax

```text
public Proxy Proxy { get; set; }
```

## Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

 Please refer to the [Proxy](#proxy-type) type for a complete list of fields.

# RowCount Property ([Office365Excel](#office365excel-component) Component)

Indicates the total number of rows in the currently loaded worksheet or range grid.

## Syntax

```text
public int RowCount { get; }
```

## Default Value

0

## Remarks

Allows defining loops to iterate through all rows in a worksheet.

Can be used in combination with [ColumnCount](#columncount-property-office365excel-component) to process an entire worksheet or loaded range dynamically.

This property is read-only and not available at design time.

# SessionId Property ([Office365Excel](#office365excel-component) Component)

Current session ID.

## Syntax

```text
public string SessionId { get; set; }
```

## Default Value

""

## Remarks

The *SessionID* is assigned when a session is created and remains valid for the duration of the session. If the session is not a persistent session, *SessionId* will be empty.

This property is not available at design time.

# SSLAcceptServerCert Property ([Office365Excel](#office365excel-component) Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

## Syntax

```text
public Certificate SSLAcceptServerCert { get; set; }
```

## Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLCert Property ([Office365Excel](#office365excel-component) Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
public Certificate SSLCert { get; set; }
```

## Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLProvider Property ([Office365Excel](#office365excel-component) Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

## Syntax

```text
public Office365ExcelSSLProviders SSLProvider { get; set; }
enum Office365ExcelSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}
```

## Default Value

0

## Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

The .NET Standard library will always use the internal implementation on all platforms.

# SSLServerCert Property ([Office365Excel](#office365excel-component) Component)

The server certificate for the last established connection.

## Syntax

```text
public Certificate SSLServerCert { get; }
```

## Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# Workbooks Property ([Office365Excel](#office365excel-component) Component)

The collection of workbooks listed by the server.

## Syntax

```text
public OEWorkbookList Workbooks { get; }
```

## Remarks

This collection contains a list of workbooks returned by the server. It is populated when [ListWorkbooks](#listworkbooks-method-office365excel-component) is called.

This property is not available at design time.

 Please refer to the [OEWorkbook](#oeworkbook-type) type for a complete list of fields.

# WorkbooksMarker Property ([Office365Excel](#office365excel-component) Component)

A pagination marker for listing workbooks.

## Syntax

```text
public string WorkbooksMarker { get; set; }
```

## Default Value

""

## Remarks

This property is populated if there are still unlisted workbooks after [ListWorkbooks](#listworkbooks-method-office365excel-component) is called. This contains a token that will be included in subsequent calls to [ListWorkbooks](#listworkbooks-method-office365excel-component). This will cause the next page of workbooks to be listed and added to the end of the [Workbooks](#workbooks-property-office365excel-component) collection.

This can be used to navigate through large sets of spreadsheets when listing them from the server.

**Example (List All Workbooks): **

```text
do
{
  oexcel.ListWorkbooks();
} while (oexcel.WorkbooksMarker.Length > 0);
```

This property is not available at design time.

# Worksheets Property ([Office365Excel](#office365excel-component) Component)

The collection of worksheets in the current workbook.

## Syntax

```text
public OEWorksheetList Worksheets { get; }
```

## Remarks

This collection contains a list of worksheets returned by the server. It is populated when [LoadWorkbook](#loadworkbook-method-office365excel-component) is called.

This property is not available at design time.

 Please refer to the [OEWorksheet](#oeworksheet-type) type for a complete list of fields.

# AddWorksheet Method ([Office365Excel](#office365excel-component) Component)

Adds a new worksheet at the end of the workbook.

## Syntax

```text
public void AddWorksheet(string title);

Async Version
public async Task AddWorksheet(string title);
public async Task AddWorksheet(string title, CancellationToken cancellationToken);
```

## Remarks

*Title* specifies the title of the new worksheet. When this method is called, the worksheet is placed at the end of the workbook, meanwhile in the [Worksheets](#worksheets-property-office365excel-component) collection, the worksheet will be first with an index of 0.

If you need to modify additional properties of the newly added sheet or customize it even further, call [LoadWorksheet](#loadworksheet-method-office365excel-component), modify the desired properties, then call [UpdateWorksheet](#updateworksheet-method-office365excel-component).

**Example (Adding a New Worksheet)**

```csharp
oexcel.LoadWorkbook(workbookId);

oexcel.AddWorksheet("New worksheet");   // The new sheet will be added at the end of the workbook

string lastAddedWorksheet = oexcel.Worksheets[0].WorksheetId;   // The new sheet will be in the beginning of the Worksheets collection
```

# Authorize Method ([Office365Excel](#office365excel-component) Component)

Get the authorization string required to access the protected resource.

## Syntax

```text
public void Authorize();

Async Version
public async Task Authorize();
public async Task Authorize(CancellationToken cancellationToken);
```

## Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the [ClientProfile](#OAuthSettings_f_ClientProfile) field and the [GrantType](#OAuthSettings_f_GrantType) field. This method is **not** to be used in conjunction with the [Authorization](#authorization-property-office365excel-component) property. It should instead be used when setting the [OAuth](#oauth-property-office365excel-component) property.

For more information, see the introduction section.

# Clear Method ([Office365Excel](#office365excel-component) Component)

Clears all the values of the loaded range or worksheet.

## Syntax

```text
public void Clear();

Async Version
public async Task Clear();
public async Task Clear(CancellationToken cancellationToken);
```

## Remarks

This method will only clear the values of the loaded range or worksheet. Before calling this method, either [LoadRange](#loadrange-method-office365excel-component) or [LoadWorksheet](#loadworksheet-method-office365excel-component) should be called.

**Example (Clear a Worksheet or Range)**

```csharp
oexcel.LoadRange(worksheetId, "A1:B5");
oexcel.Clear();     //Only the specified loaded range will have their cell values clear

oexcel.LoadWorksheet(worksheetId);
oexcel.Clear();     //All values in the worksheet will be cleared
```

# CloseSession Method ([Office365Excel](#office365excel-component) Component)

Close the existing workbook session.

## Syntax

```text
public void CloseSession();

Async Version
public async Task CloseSession();
public async Task CloseSession(CancellationToken cancellationToken);
```

## Remarks

This method ends the current session and releases any resources associated with it. The session cannot be reused after closing.

# Config Method ([Office365Excel](#office365excel-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-office365excel-component) for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-office365excel-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateSession Method ([Office365Excel](#office365excel-component) Component)

Create new workbook session.

## Syntax

```text
public void CreateSession(bool persistent);

Async Version
public async Task CreateSession(bool persistent);
public async Task CreateSession(bool persistent, CancellationToken cancellationToken);
```

## Remarks

This method will create a new workbook session. It should be called after a workbook is loaded. *Persistent* specifies whether the session to be created will be persistent or not. If set to true, *Persistent* will cause all changes made to the workbook to be persisted (saved). Use persistent sessions when making continuous changes one after another. When set to false, any changes done during the lifetime of the session will be lost, unless saved before the session expires.

**Example (Create a new session)**

```csharp
oexcel.LoadWorkbook(workbookId);    // Make sure a workbook is loaded

oexcel.CreateSession(true);     // Create a persistent session
```

# CreateWorkbook Method ([Office365Excel](#office365excel-component) Component)

Creates a new workbook on the server.

## Syntax

```text
public void CreateWorkbook(string name);

Async Version
public async Task CreateWorkbook(string name);
public async Task CreateWorkbook(string name, CancellationToken cancellationToken);
```

## Remarks

This method creates a new Workbook.

*Name* specifies the name of the new workbook to be created.

The newly created workbook will be at the root of OneDrive. Once CreateWorkbook has been called, the new workbook item will be added at the beginning of the workbook collection.

**Example (Create new Workbook)**

```csharp
// Create a new Workbook
oexcel.CreateWorkbook("NewWorkbook");
OEWorkbook latestWorkbook = oexcel.Workbooks[0];    // Newly added workbook will be at the beginning of the Workbooks collection
```

# DeleteColumn Method ([Office365Excel](#office365excel-component) Component)

Deletes a column at the specified index.

## Syntax

```text
public void DeleteColumn(int index);

Async Version
public async Task DeleteColumn(int index);
public async Task DeleteColumn(int index, CancellationToken cancellationToken);
```

## Remarks

Call the method when a worksheet or range is loaded to delete a column specified by the *Index* parameter.

The Index is zero based according to the beginning of a worksheet, not a loaded range (see [CellColumnIndex](#cellcolumnindex-property-office365excel-component)). If the requested index is outside the loaded range an error will be thrown.

**Example (Delete a column)**

```csharp
// Delete a column after loading a worksheet

string worksheetId = oexcel.Worksheets[0].WorksheetId;

oexcel.LoadWorksheet(worksheetId);

oexcel.DeleteColumn(5);     // Deleted column 'F'

// Delete a column after loading a range

oexcel.LoadRange(worksheetId, "A10:D10");

oexcel.DeleteColumn(7);     // Index is outside the loaded range (Column 'H')

oexcel.DeleteColumn(2);     // Deletion is successful
```

# DeleteRow Method ([Office365Excel](#office365excel-component) Component)

Deletes a row at the given index.

## Syntax

```text
public void DeleteRow(int index);

Async Version
public async Task DeleteRow(int index);
public async Task DeleteRow(int index, CancellationToken cancellationToken);
```

## Remarks

*Index* specifies the row that will be deleted.

When a row is deleted, the loaded sheet or range will shrink. The *Index* is zero-based according to the beginning of the sheet, not the loaded range (see [CellRowIndex](#cellrowindex-property-office365excel-component)). If the requested index is outside the loaded range or sheet, an error will be thrown.

**Example (Delete a row)**

```csharp
// Delete a row after loading a worksheet

string worksheetId = oexcel.Worksheets[0].WorksheetId;

oexcel.LoadWorksheet(worksheetId);

oexcel.DeleteRow(5);     // Deleted 4th row

// Delete a row after loading a range

oexcel.LoadRange(worksheetId, "A1:D10");

oexcel.DeleteRow(19);     // Index is outside the loaded range (20th row)

oexcel.DeleteRow(2);     // Deletion is successful
```

# DeleteWorkbook Method ([Office365Excel](#office365excel-component) Component)

Delete the workbook with given Id.

## Syntax

```text
public void DeleteWorkbook(string id);

Async Version
public async Task DeleteWorkbook(string id);
public async Task DeleteWorkbook(string id, CancellationToken cancellationToken);
```

## Remarks

*Id* specifies the Id of the workbook that will be deleted.

When DeleteWorkbook is called the workbook is deleted permanently, the workbook is also removed from the [Workbooks](#workbooks-property-office365excel-component) collection.

# DeleteWorksheet Method ([Office365Excel](#office365excel-component) Component)

Delete the worksheet with given Id.

## Syntax

```text
public void DeleteWorksheet(string id);

Async Version
public async Task DeleteWorksheet(string id);
public async Task DeleteWorksheet(string id, CancellationToken cancellationToken);
```

## Remarks

This method deletes a worksheet identified by the *Id* parameter. The deleted worksheet is deleted permanently.

# InsertColumn Method ([Office365Excel](#office365excel-component) Component)

Inserts a single empty column at the index specified.

## Syntax

```text
public void InsertColumn(int index);

Async Version
public async Task InsertColumn(int index);
public async Task InsertColumn(int index, CancellationToken cancellationToken);
```

## Remarks

Use the InsertColumn to insert a column anywhere in the worksheet.

*Index* determines the index at which the column will be inserted.

When a column is inserted, the loaded range or worksheet will be extended using the cell attributes from the existing column at the index. Note that the index is zero based according to the beginning of the worksheet, not a loaded range (see [CellColumnIndex](#cellcolumnindex-property-office365excel-component)). If the requested index is outside the loaded range or worksheet, an error will be thrown.

**Example (Insert a column after loading a range)**

```csharp
// Load the first 6 columns (A-F)
oexcel.LoadRange(worksheetId, "A1:F10");

var colCountBefore = oexcel.ColumnCount;     // Column count is 6

// Insert a column
oexcel.InsertColumn(3);

var colCountAfter = oexcel.ColumnCount;    // Column count is 7, the range is extended
```

# InsertRow Method ([Office365Excel](#office365excel-component) Component)

Inserts a single empty row at the index specified.

## Syntax

```text
public void InsertRow(int index);

Async Version
public async Task InsertRow(int index);
public async Task InsertRow(int index, CancellationToken cancellationToken);
```

## Remarks

Use InsertRow to insert a row anywhere in the worksheet.

*Index* determines the index at which the row will be inserted. When a row is inserted, the loaded range or worksheet will be extended using the cell attributes from the existing row at the index. Note that the index is zero based according to the beginning of the worksheet, not a loaded range (see [CellRowIndex](#cellrowindex-property-office365excel-component)). If the requested index is outside the loaded range or worksheet, an error will be thrown.

**Example (Insert a row after loading a range)**

```csharp
// Load 20 rows
oexcel.LoadRange(worksheetId, "A1:A20");

var rowCountBefore = oexcel.RowCount;     // Row count is 20

// Insert a row
oexcel.InsertRow(3);

var rowCountAfter= oexcel.RowCount;    // Row count is 21, the range is extended
```

# Interrupt Method ([Office365Excel](#office365excel-component) Component)

Interrupt the current method.

## Syntax

```text
public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);
```

## Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

# ListWorkbooks Method ([Office365Excel](#office365excel-component) Component)

Lists the workbooks.

## Syntax

```text
public void ListWorkbooks();

Async Version
public async Task ListWorkbooks();
public async Task ListWorkbooks(CancellationToken cancellationToken);
```

## Remarks

Lists all workbooks associated with the current user. The retrieved workbooks are added to the [Workbooks](#workbooks-property-office365excel-component) collection, which is cleared before being repopulated with the latest data. For each workbook retrieved, the [WorkbookList](#workbooklist-event-office365excel-component) event is fired.

# LoadRange Method ([Office365Excel](#office365excel-component) Component)

Load the specified range of cells in the worksheet.

## Syntax

```text
public void LoadRange(string id, string range);

Async Version
public async Task LoadRange(string id, string range);
public async Task LoadRange(string id, string range, CancellationToken cancellationToken);
```

## Remarks

*Id* specifies the worksheet to be partially loaded.

*Range* specifies the range which will be loaded. This uses 'A1:B2' notation. When LoadRange is called the loaded worksheet is set as the first one in the [Worksheets](#worksheets-property-office365excel-component) collection.

If an attempt to access cells outside the loaded range is made, an error with be thrown.

**Example (Load a specific range)**

```csharp
oexcel.LoadRange(worksheetId, "A10:D20");    // Loading rows from 10 to 20 and columns from A to D

oexcel.Cell = "A13";   // Any cells within A10:D20 can be modified and updated
oexcel.CellValue = "13th row";

oexcel.UpdateWorksheet();
```

# LoadWorkbook Method ([Office365Excel](#office365excel-component) Component)

Load the workbook's worksheets list from the server. Set as first in Worksheets collection.

## Syntax

```text
public void LoadWorkbook(string id);

Async Version
public async Task LoadWorkbook(string id);
public async Task LoadWorkbook(string id, CancellationToken cancellationToken);
```

## Remarks

This method is used to load a single workbook in the [Workbooks](#workbooks-property-office365excel-component) collection, together with all its worksheets and properties. If other workbooks exist in the collection because [ListWorkbooks](#listworkbooks-method-office365excel-component) has been called before, calling LoadWorkbook will set the specified workbook at the first index in the collection.

# LoadWorksheet Method ([Office365Excel](#office365excel-component) Component)

Load the worksheet's data (used range).

## Syntax

```text
public void LoadWorksheet(string id);

Async Version
public async Task LoadWorksheet(string id);
public async Task LoadWorksheet(string id, CancellationToken cancellationToken);
```

## Remarks

This method loads the worksheet's data, specifically, the range of the worksheet that is in use. The loaded worksheet is set as the first in the [Worksheets](#worksheets-property-office365excel-component) collection.

Use [UpdateWorksheet](#updateworksheet-method-office365excel-component), [InsertRow](#insertrow-method-office365excel-component), [Clear](#clear-method-office365excel-component) or the [Cell](#cell-property-office365excel-component) properties to modify and update the worksheet or its cells.

# RefreshSession Method ([Office365Excel](#office365excel-component) Component)

Refreshes the existing workbook session.

## Syntax

```text
public void RefreshSession();

Async Version
public async Task RefreshSession();
public async Task RefreshSession(CancellationToken cancellationToken);
```

## Remarks

This method renews the current session, keeping it active without losing any existing data or changes.

Useful for extending the session lifespan in persistent mode or preventing session timeouts during long-running operations.

# Reset Method ([Office365Excel](#office365excel-component) Component)

This method will reset the component.

## Syntax

```text
public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
```

## Remarks

This method will reset the component's properties to their default values.

# SendCustomRequest Method ([Office365Excel](#office365excel-component) Component)

Send a custom HTTP request.

## Syntax

```text
public void SendCustomRequest(string HTTPMethod, string URL, string postData);

Async Version
public async Task SendCustomRequest(string HTTPMethod, string URL, string postData);
public async Task SendCustomRequest(string HTTPMethod, string URL, string postData, CancellationToken cancellationToken);
```

## Remarks

This method can be used to send a custom HTTP request to the server.

**Example (Send a custom request): **

```text
String data = @"{
""name"": ""A New Workbook.xlsx"",
""file"": {}
}";
String url = "https://graph.microsoft.com/v1.0/me/drive/root/children";
oexcel.SendCustomRequest("POST", url, data);
```

# UpdateWorksheet Method ([Office365Excel](#office365excel-component) Component)

Update the current loaded worksheet properties and the cells data.

## Syntax

```text
public void UpdateWorksheet();

Async Version
public async Task UpdateWorksheet();
public async Task UpdateWorksheet(CancellationToken cancellationToken);
```

## Remarks

Call the UpdateWorksheet method after making changes to the worksheet properties or the cell data. This method takes no parameters and uses the values of the first worksheet in the [Worksheets](#worksheets-property-office365excel-component) collection. Once UpdateWorksheet is called, it will automatically get back the range or worksheet data with updated values.

**Example (Updating a worksheet)**

```csharp
// Load the worksheet we want to update
oexcel.LoadWorksheet(worksheetId);

// Modify worksheet properties
oexcel.Worksheets[0].Name = "NewUpdatedTitle";
oexcel.Worksheets[0].Position = 2;
oexcel.Worksheets[0].Visibility = TOEWorksheetVisibilities.oewvHidden;

oexcel.Cell = "A5";
oexcel.CellValue = "Hello";

oexcel.UpdateWorksheet();    // Update worksheet after modifying properties and/or cells
```

# Error Event ([Office365Excel](#office365excel-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, Office365ExcelErrorEventArgs e);

public class Office365ExcelErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-office365excel-component) section.

# Log Event ([Office365Excel](#office365excel-component) Component)

Fired once for each log message.

## Syntax

```text
public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, Office365ExcelLogEventArgs e);

public class Office365ExcelLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}
```

## Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

*LogLevel* indicates the level of message. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

*Message* is the log entry.

*LogType* identifies the type of log entry. Possible values are as follows:

- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"

# SSLServerAuthentication Event ([Office365Excel](#office365excel-component) Component)

Fired after the server presents its certificate to the client.

## Syntax

```text
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, Office365ExcelSSLServerAuthenticationEventArgs e);

public class Office365ExcelSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}
```

## Remarks

During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

 When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True.

# SSLStatus Event ([Office365Excel](#office365excel-component) Component)

Fired when secure connection progress messages are available.

## Syntax

```text
public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, Office365ExcelSSLStatusEventArgs e);

public class Office365ExcelSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# Transfer Event ([Office365Excel](#office365excel-component) Component)

Fired while a document transfers (delivers document).

## Syntax

```text
public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, Office365ExcelTransferEventArgs e);

public class Office365ExcelTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }  public byte[] TextB { get; }
}
```

## Remarks

The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers).

The *Direction* parameter shows whether the client (0) or the server (1) is sending the data.

The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

# WorkbookList Event ([Office365Excel](#office365excel-component) Component)

Fired when a workbook is retrieved from the server.

## Syntax

```text
public event OnWorkbookListHandler OnWorkbookList;

public delegate void OnWorkbookListHandler(object sender, Office365ExcelWorkbookListEventArgs e);

public class Office365ExcelWorkbookListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
}
```

## Remarks

The WorkbookList event is fired for each workbook retrieved from the server when [ListWorkbooks](#listworkbooks-method-office365excel-component) is called.

# Certificate Type

This is the digital certificate being used.

## Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *string (read-only)*
Default: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

 **ExpirationDate** *string (read-only)*
Default: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *string (read-only)*
Default: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **Fingerprint** *string (read-only)*
Default: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

 **FingerprintSHA1** *string (read-only)*
Default: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

 **FingerprintSHA256** *string (read-only)*
Default: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

 **Issuer** *string (read-only)*
Default: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

 **PrivateKey** *string (read-only)*
Default: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *bool (read-only)*
Default: False

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *string (read-only)*
Default: ""

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *string (read-only)*
Default: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **PublicKeyAlgorithm** *string (read-only)*
Default: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

 **PublicKeyLength** *int (read-only)*
Default: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **SerialNumber** *string (read-only)*
Default: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

 **SignatureAlgorithm** *string (read-only)*
Default: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

 **Store** *string*
Default: "MY"

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StoreB** *byte []*
Default: "MY"

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StorePassword** *string*
Default: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

 **StoreType** *CertStoreTypes*
Default: 0

The type of certificate store for this certificate.

 The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This field can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr component by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *string (read-only)*
Default: ""

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *string (read-only)*
Default: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA1** *string (read-only)*
Default: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA256** *string (read-only)*
Default: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **Usage** *string (read-only)*
Default: ""

The text description of [UsageFlags](#Certificate_f_UsageFlags).

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

 **UsageFlags** *int (read-only)*
Default: 0

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

This functionality currently is not available when the provider is OpenSSL.

 **Version** *string (read-only)*
Default: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **Subject** *string*
Default: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

If a field value contains a comma, it must be quoted.

 **Encoded** *string*
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

 **EncodedB** *byte []*
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(string certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# Firewall Type

The firewall the component will connect through.

## Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType).

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *bool*
Default: False

Whether to automatically detect and use firewall system settings, if available.

 **FirewallType** *FirewallTypes*
Default: 0

The type of firewall to connect through. The applicable values are as follows:

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. |

 **Host** *string*
Default: ""

The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.

 **Password** *string*
Default: ""

A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

 **Port** *int*
Default: 0

The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details.

NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details.

 **User** *string*
Default: ""

A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component throws an exception.

## Constructors

```text
public Firewall();
```

# OAuthSettings Type

The settings used to authenticate with the service provider.

## Remarks

This type is used to give the component the necessary information needed to complete the OAuth process.

The following fields are available:

- [AccessToken](#OAuthSettings_f_AccessToken)

- [AuthorizationCode](#OAuthSettings_f_AuthorizationCode)

- [AuthorizationScope](#OAuthSettings_f_AuthorizationScope)

- [ClientId](#OAuthSettings_f_ClientId)

- [ClientProfile](#OAuthSettings_f_ClientProfile)

- [ClientSecret](#OAuthSettings_f_ClientSecret)

- [GrantType](#OAuthSettings_f_GrantType)

- [RefreshToken](#OAuthSettings_f_RefreshToken)

- [RequestRefreshToken](#OAuthSettings_f_RequestRefreshToken)

- [ReturnURL](#OAuthSettings_f_ReturnURL)

- [ServerAuthURL](#OAuthSettings_f_ServerAuthURL)

- [ServerTokenURL](#OAuthSettings_f_ServerTokenURL)

- [Timeout](#OAuthSettings_f_Timeout)

- [WebAuthURL](#OAuthSettings_f_WebAuthURL)

## Fields

 **AccessToken** *string*
Default: ""

The access token returned by the authorization server. This is set when the component makes a request to the token server.

 **AuthorizationCode** *string*
Default: ""

The authorization code that is exchanged for an access token. This is required to be set when the [ClientProfile](#OAuthSettings_f_ClientProfile) field is set to the Web profile. Otherwise, this field is for information purposes only.

 **AuthorizationScope** *string*
Default: ""

The scope request or response parameter used during authorization.

 **ClientId** *string*
Default: ""

The id of the client assigned when registering the application.

 **ClientProfile** *CloudOAuthClientProfiles*
Default: 0

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

|  |  |
| --- | --- |
| 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
| 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |

 **ClientSecret** *string*
Default: ""

The secret value for the client assigned when registering the application.

 **GrantType** *OAuthSettingsGrantTypes*
Default: 0

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

|  |  |
| --- | --- |
| 0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
| 1 (cogtImplicit) | Implicit grant type |
| 2 (cogtPassword) | Resource Owner Password Credentials grant type |
| 3 (cogtClientCredentials) | Client Credentials grant type |

 **RefreshToken** *string*
Default: ""

Specifies the refresh token received from or sent to the authorization server. This field is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the [GrantType](#OAuthSettings_f_GrantType) field is set to a grant that can use refresh tokens.

 **RequestRefreshToken** *bool*
Default: True

Specifies whether the component will request a refresh token during authorization. By default, this value is *True*.

When *True*, the component will automatically add the necessary scopes or parameters to obtain a refresh token. When *False*, this field will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

NOTE: This field is only applicable when the [GrantType](#OAuthSettings_f_GrantType) field is set to *cogtAuthorizationCode*.

 **ReturnURL** *string*
Default: ""

The URL where the user (browser) returns after authenticating. This field is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this field should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

 **ServerAuthURL** *string*
Default: ""

The URL of the authorization server.

 **ServerTokenURL** *string*
Default: ""

The URL of the token server used to obtain the access token.

 **Timeout** *int*
Default: 60

The amount of time (in seconds) the component will wait for a response from the browser in the LaunchBrowser event. The default value is 60.

 **WebAuthURL** *string (read-only)*
Default: ""

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

## Constructors

```text
public OAuthSettings();
```

# OEWorkbook Type

Holds information about a workbook.

## Remarks

Holds information about a workbook.

The following fields are available:

- [Id](#OEWorkbook_f_Id)

- [Name](#OEWorkbook_f_Name)

- [URL](#OEWorkbook_f_URL)

## Fields

 **Id** *string (read-only)*
Default: ""

The unique identifier of the workbook.

 **Name** *string (read-only)*
Default: ""

Name of the workbook.

 **URL** *string (read-only)*
Default: ""

The URL of the workbook in One Drive.

## Constructors

```text
public OEWorkbook();
```

# OEWorksheet Type

Holds information about a worksheet.

## Remarks

Holds information about a worksheet.

The following fields are available:

- [Name](#OEWorksheet_f_Name)

- [Position](#OEWorksheet_f_Position)

- [Visibility](#OEWorksheet_f_Visibility)

- [WorksheetId](#OEWorksheet_f_WorksheetId)

## Fields

 **Name** *string*
Default: ""

The name of the worksheet.

 **Position** *int*
Default: 0

The zero-based position of the worksheet within the workbook.

 **Visibility** *TOEWorksheetVisibilities*
Default: 0

The visibility of the worksheet.

Possible values are:

|  |  |
| --- | --- |
| 0 (oewvVisible) | Marks the worksheet as visible. |
| 1 (oewvHidden) | Marks the worksheet as hidden. |
| 2 (oewvVeryHidden) | Marks the worksheet as very hidden. |

 **WorksheetId** *string (read-only)*
Default: ""

The unique identifier of the worksheet.

## Constructors

```text
public OEWorksheet();
```

# Proxy Type

The proxy the component will connect to.

## Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme).

The following fields are available:

- [AuthScheme](#Proxy_f_AuthScheme)

- [AutoDetect](#Proxy_f_AutoDetect)

- [Password](#Proxy_f_Password)

- [Port](#Proxy_f_Port)

- [Server](#Proxy_f_Server)

- [SSL](#Proxy_f_SSL)

- [User](#Proxy_f_User)

## Fields

 **AuthScheme** *ProxyAuthSchemes*
Default: 0

The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set.

[AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected.

By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the component will attempt basic authentication.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password).

 **AutoDetect** *bool*
Default: False

Whether to automatically detect and use proxy system settings, if available. The default value is *false*.

 **Password** *string*
Default: ""

A password if authentication is to be used for the proxy.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

 **Port** *int*
Default: 80

The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details.

 **Server** *string*
Default: ""

If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned.

 **SSL** *ProxySSLTypes*
Default: 0

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

|  |  |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |

 **User** *string*
Default: ""

A username if authentication is to be used for the proxy.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

## Constructors

```text
public Proxy();
```

```text
public Proxy(string server, int port);
```

```text
public Proxy(string server, int port, string user, string password);
```

# Config Settings ([Office365Excel](#office365excel-component) Component)

 The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-office365excel-component) method.

### Office365Excel Config Settings

**WorkbooksPageSize**: Page size limit for fetching workbooks.This setting specifies the workbooks list page size, or the maximum number of workbooks that will be fetched from the server in one get call.

The default value is *100*.

**XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XElement**: The name of the current element.This configuration setting provides the name of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XParent**: The parent of the current element.This configuration setting provides the parent of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response.

When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element.

XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:

| Accessor | Description |
| --- | --- |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |
| name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) |
| . | The current element. |
| .. | The parent element. |

 NOTE: XPath indices are *1-based*.

For example, assume the following XML and JSON responses.

XML:

```text
<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>
```

JSON:

```text
{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}
```

The following are examples of valid XPaths for these responses:

| Description | XML XPath | JSON XPath |
| --- | --- | --- |
| Document root | / | /json |
| Specific element | /firstlevel/one | /json/firstlevel/one |
| i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |

This list is not exhaustive, but it provides a general idea of the possibilities.

**XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XText**: The text of the current element.This configuration setting provides the inner text of the current element.

The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only.

### OAuth Config Settings

**OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated.

**OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following:

|  |  |
| --- | --- |
| Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [Authorize](#authorize-method-office365excel-component) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |

**OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *true* and the [Authorization](#authorization-property-office365excel-component) property is not set, the component will automatically get a new access token if it has the necessary properties to do so without user interaction.

For example, when using the Authorization Code grant type, the [RefreshToken](#OAuthSettings_f_RefreshToken) field should be set to a valid refresh token. When using the Client Credential grant type however, the component does not need any additional properties set as it can already get a new access token without user interaction.

**OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the component will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the component will wait indefinitely.

**OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [Authorize](#authorize-method-office365excel-component) if it is empty.

If set to *true* (default) the *redirect_uri* will be sent in all cases. If set to *false* the *redirect_uri* will only be sent if it has a value.

**OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the component is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service.

To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath).

**OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXElement**: The name of the current element.Provides the name of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXParent**: The parent of the current element.Provides the parent of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token.

XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:

| Accessor | Description |
| --- | --- |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |

 Here are some examples of valid XPaths and some common claims:

| Description | JSON XPath |
| --- | --- |
| Document root | /json |
| Specific element | /json/element_one |
| Username Claim (Microsoft Specific) | /json/preferred_username |
| Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |

This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [OAuthJWTXText](#OAuthJWTXText).

**OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXText**: The text of the current element.Provides the inner text of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the [ClientProfile](#OAuthSettings_f_ClientProfile) is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:

```text
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
```

Additionally, this will also be updated to hold the parameters returned in the response.

```text
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
  string name = component.Config("OAuthParamName[" + i + "]");
  string value = component.Config("OAuthParamValue[" + i + "]");
}
```

**OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username field when the [GrantType](#OAuthSettings_f_GrantType) is set to the password grant type and [Authorize](#authorize-method-office365excel-component) is called.

**OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *true*. Possible values are:

- 1 (Plain)
- 2 (S256/SHA256 - default)

**OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [Authorize](#authorize-method-office365excel-component) method and the [WebAuthURL](#OAuthSettings_f_WebAuthURL) field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb [ClientProfile](#OAuthSettings_f_ClientProfile), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request.

**OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *true* (default), the [Reset](#reset-method-office365excel-component) method will reset the OAuth settings including any authorization fields like [AccessToken](#OAuthSettings_f_AccessToken) and [RefreshToken](#OAuthSettings_f_RefreshToken). This means the [Authorize](#authorize-method-office365excel-component) method must be called again to get new authorization information. When set to *false*, the [Reset](#reset-method-office365excel-component) method will **not** reset the [OAuth](#oauth-property-office365excel-component) property and the OAuth* configuration settings. This allows for the component to be reset without having to get authorization again.

**OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *true* (default), the same embedded web server instance will be used for multiple requests. If set to *false* the embedded web server will be created and destroyed on each call to [Authorize](#authorize-method-office365excel-component)

**OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET

```text
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
```

 C++

```text
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
```

**OAuthUsePKCE**: Specifies if PKCE should be used.If set to *true* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code [GrantType](#OAuthSettings_f_GrantType). The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used.

**OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*.

This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the component will automatically start and stop the web server when [Authorize](#authorize-method-office365excel-component) is called. In certain cases, it is required to start the webserver before calling [Authorize](#authorize-method-office365excel-component). For example, if the [ReturnURL](#OAuthSettings_f_ReturnURL) needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the [OAuthReUseWebServer](#OAuthReUseWebServer) is set to true, the server will not be automatically stopped, and this configuration setting must be set to *"false"* to stop the embedded web server.

**OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL.

The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) field specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword).

[OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) field in order to specify the certificate to be used during SSL.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are:

|  |  |
| --- | --- |
| 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. |
| 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. |
| 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
| 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |

 Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

If a field value contains a comma, it must be quoted.

Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [Authorize](#authorize-method-office365excel-component) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.

**OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when [ClientProfile](#OAuthSettings_f_ClientProfile) is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the [ReturnURL](#OAuthSettings_f_ReturnURL). This should be set to the hostname only, not the full URL.

The default value is *localhost*.

**OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

**OAuthWebServerResponse**: The custom response that will be displayed to the user.When [Authorize](#authorize-method-office365excel-component) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.

**OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the component adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The component only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms.

When True, the component adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.

The default value is True.

**AllowNTLMFallback**: Whether to allow fallback from Negotiate to NTLM when authenticating.This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. NOTE: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the [Authorization](#authorization-property-office365excel-component) property in the form "Basic [encoded-user-password]".

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-office365excel-component) event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the component.If set to True, the URL passed to the component will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.

**Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the component will perform a GET on the new location.The default value is False. If set to True, the component will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the component.This property specifies the HTTP version used by the component. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

**HTTP/2 Notes**

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.

**HTTP/3 Notes**

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *true*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-office365excel-component) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

**MaxHeaders**: Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

**MaxHTTPCookies**: Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the component beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme).

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the component.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

**UsePlatformDeflate**: Whether to use the platform implementation to decompress compressed responses.This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to *True* (default), the platform implementation is used. If set to *False*, an internal implementation is used.

**UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*.

When *True* (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the component whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by components that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The LocalHost setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the component will use IPv4 exclusively. When set to *1*, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**CACertFilePaths**: The paths to CA certificate files when using Mono on Unix/Linux.This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

*/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem*

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-office365excel-component) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-office365excel-component) is set to *Platform*.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the component will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-office365excel-component) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.

When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-office365excel-component) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#sslprovider-property-office365excel-component) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#sslprovider-property-office365excel-component) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the component will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-office365excel-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-office365excel-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the component when the [SSLProvider](#sslprovider-property-office365excel-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-office365excel-component) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-office365excel-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-office365excel-component) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-office365excel-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

This functionality is currently not available in Java or when the provider is OpenSSL.

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#sslprovider-property-office365excel-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

Setting this configuration setting to *true* tells the component to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

# Trappable Errors ([Office365Excel](#office365excel-component) Component)

### Office365Excel Errors

|  |  |
| --- | --- |
| 1301 | Invalid Input Error. |