Office365Tasks Control

Properties   Methods   Events   Config Settings   Errors  

The Office365Tasks control provides an easy way to manage todo tasks in Microsoft 365.

Syntax

Office365Tasks

Remarks

This control provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the control, first set the Authorization property to a valid OAuth token. The Office365Tasks control can be used for creating new tasks/task lists/checklist items; retrieving, updating, or deleting existing tasks/task lists/checklist items; and several other functionalities supported by the Microsoft Graph API.

This control requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The control has the following defaults:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what OAuthGrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL and OAuthServerTokenURL properties. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this control. 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 control. 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 method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The control will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the control will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the control will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the control will use an authorization code to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize 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 control will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the control 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 OAuthRefreshToken property is set, or a refresh token is cached, then the control will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: Office365Tasks office365task = new Office365Tasks(); office365task.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; office365task.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365task.OAuth.ClientId = CLIENT_ID; office365task.OAuth.ClientSecret = CLIENT_SECRET; office365task.Authorize();

Client Credentials

When using the Client Credentials grant type, the control will act as a service instead of authorizing and authenticating as a user. This allows for the control to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Implicit

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

When using the Implicit grant type, the control will request the authorization server to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize 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 control 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 control will not be able to automatically get a fresh token once it expires.

Password

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

When using the Resource Owner Password Credentials grant type, the control will authenticate as the resource owner. This allows for the control to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this OAuthGrantType the control requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the control to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite user.readwrite Contacts.Read Contacts.ReadWrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365task.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Creating a Task List

To create a task list using the Office365Tasks components we make use of the CreateTaskList method. The CreateTaskList method will create a new task list with a name specified through the name parameter.

Creating a task list: office365task.CreateTaskList("My tasklist");

After creating a task list with the basic information, select the task list to be edited in the TaskLists collection, edit its fields and make a call to the UpdateTaskList method. To edit the newly created task list select the first task list in the collection.

Example (Update The First Task List Of The Collection) // Set a new name for the newly created task list office365task.TaskLists[0].DisplayName = "new name"; office365task.UpdateTaskList(0);

Listing Task Lists

Information about task lists fetched by the component can be accessed through the members of the TaskLists properties. The TaskLists properties is populated when the ListTaskLists method is called.

The ListTaskLists method will list the task lists and make the TaskListList event to fire with the appropriate data about the task lists received.

By default, the component will fetch one page of 100 task lists when ListTaskLists is called. If additional task lists remain, the ListTaskListsMarker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if ListTaskLists is then called again, if called the next page of task lists will be fetched. The example below populates the TaskLists properties with all the task lists associated with the account. do { office365task.ListTaskLists(); } while (office365task.Config("ListTaskListsMarker").Length > 0);

The task lists page size may also be changed by using the TaskListsPageSize configuration setting.

Deleting a Task List

To delete a task list use the DeleteTaskList method, provide the Id of the task list as the argument. The task list will stay in the TaskLists collection until ListTaskLists method is called again.

Example (Delete Task List)

// List task lists and deleting the task list named "new name" office365task.ListTaskLists(); for (int i = 0; i < office365task.TaskLists.Count; i++) { if (office365task.TaskLists[i].DisplayName == "new name") { office365task.DeleteTaskList(office365task.TaskLists[i].Id); break; } // Note: the component would let you name more than one task list with the same name so the example would delete the first encounter with the task list that has the specified name }

Creating a Task

To create a task using the Office365Tasks components we make use of the CreateTask method. The CreateTask method will create a new task with a name specified through the subject parameter inside the task list specified through the taskListId parameter.

Creating a task: office365task.CreateTaskList("My task list"); office365task.CreateTask("My task", office365task.TaskLists[0].Id); //creating a task named "My task" inside the "My task list" task list

After creating a task with the basic information, select the task to be edited in the Tasks collection, edit its fields and make a call to the UpdateTask method. To edit the newly created task select the first task in the collection.

Example (Update The First Task Of The Collection) // Set properties to update office365task.Tasks[0].Title = "new title"; office365task.Tasks[0].Categories = "new category"; office365task.Tasks[0].Importance = TOTImportances.otiNormal; office365task.Tasks[0].IsReminderOn = true; office365task.UpdateTask(0);

Listing Tasks

Information about tasks fetched by the component can be accessed through the members of the Tasks properties. The Tasks properties is populated when the ListTasks method is called.

The ListTasks method will list the tasks inside the task list specified through the taskListId parameter and make the TaskList event to fire with the appropriate data about the tasks received.

By default, the component will fetch one page of 100 tasks when ListTasks is called. If additional tasks remain, the ListTasksMarker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if ListTasks is then called again, if called the next page of tasks will be fetched. The example below populates the Tasks properties with all the tasks associated with a task list. do { office365task.ListTasks(office365task.TaskLists[0].Id); } while(office365task.ListTasksMarker.Length > 0)

Deleting a Task

To delete a task use the DeleteTask method, provide the Id of the task list where the task belongs to and the Id of the task you want to delete as arguments. The task will stay in the Tasks collection until ListTasks method is called again.

Example (Delete Task)

// List tasks and deleting the task named "new title" office365task.ListTasks(office365task.TaskLists[0].Id); for (int i = 0; i < office365task.Tasks.Count; i++) { if (office365task.Tasks[i].Title == "new title") { office365task.DeleteTask(office365task.TaskLists[0].Id, office365task.Task[i].Id); break; } // Note: the component would let you name more than one task with the same name so the example would delete the first encounter with the task that has the specified name }

Creating a Checklist Item

To create a checklist item using the Office365Tasks components we make use of the CreateCheckListItem. The CreateCheckListItem method will create a new checklist item with a name specified through the name parameter belonging to a task specified through the taskId parameter inside the task list specified through the taskListId parameter.

Creating a checklist item: office365task.CreateTaskList("My task list"); office365task.CreateTask("My task", office365task.TaskLists[0].Id); //creating a task named "My task" inside the "My task list" task list office365task.CreateCheckListItem("My checklist item", office365task.TaskLists[0].Id, office365task.Tasks[0].Id); // creating a checklist item named "My checklist item" inside the "My task" task

After creating a checklist item with the basic information, select the checklist item to be edited in the CheckListItems collection, edit its fields and make a call to the UpdateCheckListItem method. To edit the newly created checklist item select the first checklist item in the collection.

Example (Update The First checklist item Of The collection) // Set properties to update office365task.CheckListItems[0].DisplayName = "new name"; office365task.CheckListItems[0].IsChecked= true; office365task.UpdateCheckListItem(0);

Listing Checklist Items

Information about checklist item fetched by the component can be accessed through the members of the CheckListItems properties. The CheckListItems properties is populated when the ListCheckListItems method is called.

The ListCheckListItems method will list the checklist items belonging to a task specified through the taskId inside the task list specified through the taskListId parameter and make the CheckListItemList event to fire with the appropriate data about the checklist items received. office365task.ListCheckListItems(office365task.TaskLists[0].Id, office365task.Tasks[0].Id);

Deleting a Checklist Item

To delete a checklist item use the DeleteCheckListItem method, provide the Id of the task list where the task that has the checklist item you want to delete is, the id of the task that has the checklist item you want to delete and finally the Id of the checklist item you want to delete as arguments. The checklist item will stay in the CheckListItems collection until ListCheckListItems method is called again.

Example (Delete Checklist Item)

// List checklist items and deleting the checklist item named "new name" office365task.ListCheckListItems(office365task.TaskLists[0].Id, office365task.Tasks[0].Id); for (int i = 0; i < office365task.CheckListItems.Count; i++) { if (office365task.CheckListItems[i].DisplayName == "new name") { office365task.DeleteCheckListItem(office365task.TaskLists[0].Id, office365task.Tasks[0].Id, office365task.CheckListItems[i].Id); break; } // Note: the component would let you name more than one checklist item with the same name so the example would delete the first encounter with the checklist item that has the specified name }

Property List

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

Method List

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

Event List

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

Config Settings

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

AttachmentsCount Property (Office365Tasks Control)

The number of records in the Attachment arrays.

Syntax

office365taskscontrol.AttachmentsCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFileName
• AttachmentId
• AttachmentJSON
• AttachmentLastModifiedDate
• AttachmentName
• AttachmentSize
• AttachmentTaskId
• AttachmentTaskListId

The array indices start at 0 and end at AttachmentsCount - 1.

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (Office365Tasks Control)

This property contains the content type of the attachment.

Syntax

office365taskscontrol.AttachmentContentType(AttachmentIndex)

Default Value

""

Remarks

This field contains the content type of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

AttachmentData Property (Office365Tasks Control)

This property contains the raw data of the attachment.

Syntax

office365taskscontrol.AttachmentData(AttachmentIndex)[=string]

Default Value

""

Remarks

This field contains the raw data of the attachment. Only after calling the RetrieveAttachment method

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttachmentDataB.

This property is not available at design time.

Data Type

Binary String

AttachmentFileName Property (Office365Tasks Control)

This property contains the local file name associated with the attachment.

Syntax

office365taskscontrol.AttachmentFileName(AttachmentIndex)[=string]

Default Value

""

Remarks

This field contains the local file name associated with the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentId Property (Office365Tasks Control)

This property contains the attachment identifier of the attachment.

Syntax

office365taskscontrol.AttachmentId(AttachmentIndex)

Default Value

""

Remarks

This field contains the attachment identifier of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

AttachmentJSON Property (Office365Tasks Control)

A JSON representation of the attachment.

Syntax

office365taskscontrol.AttachmentJSON(AttachmentIndex)[=string]

Default Value

""

Remarks

A JSON representation of the attachment. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentLastModifiedDate Property (Office365Tasks Control)

This property contains the date and time when the attachment was last modified.

Syntax

office365taskscontrol.AttachmentLastModifiedDate(AttachmentIndex)[=string]

Default Value

""

Remarks

This field contains the date and time when the attachment was last modified.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (Office365Tasks Control)

This property contains the name of the attachment.

Syntax

office365taskscontrol.AttachmentName(AttachmentIndex)[=string]

Default Value

""

Remarks

This field contains the name of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentSize Property (Office365Tasks Control)

This property contains the size in bytes of the attachment.

Syntax

office365taskscontrol.AttachmentSize(AttachmentIndex)[=integer]

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

Integer

AttachmentTaskId Property (Office365Tasks Control)

This property contains the task identifier of the attachment.

Syntax

office365taskscontrol.AttachmentTaskId(AttachmentIndex)

Default Value

""

Remarks

This field contains the task identifier of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

AttachmentTaskListId Property (Office365Tasks Control)

The ID of the task list that contains the task.

Syntax

office365taskscontrol.AttachmentTaskListId(AttachmentIndex)

Default Value

""

Remarks

The ID of the task list that contains the task.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

Authorization Property (Office365Tasks Control)

An OAuth Authorization String.

Syntax

office365taskscontrol.Authorization[=string]

Default Value

""

Remarks

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

Example

Oauth oauth = new Oauth(); oauth.ClientId = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "user.read"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365tasks.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

CheckListItemsCount Property (Office365Tasks Control)

The number of records in the CheckListItem arrays.

Syntax

office365taskscontrol.CheckListItemsCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CheckListItemCheckedDateTime
• CheckListItemCreatedDateTime
• CheckListItemDisplayName
• CheckListItemId
• CheckListItemIsChecked
• CheckListItemTaskId
• CheckListItemTaskListId

The array indices start at 0 and end at CheckListItemsCount - 1.

This property is not available at design time.

Data Type

Integer

CheckListItemCheckedDateTime Property (Office365Tasks Control)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

office365taskscontrol.CheckListItemCheckedDateTime(CheckListItemIndex)

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The CheckListItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemCreatedDateTime Property (Office365Tasks Control)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

office365taskscontrol.CheckListItemCreatedDateTime(CheckListItemIndex)

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The CheckListItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemDisplayName Property (Office365Tasks Control)

Indicates the title of the checklistItem.

Syntax

office365taskscontrol.CheckListItemDisplayName(CheckListItemIndex)[=string]

Default Value

""

Remarks

Indicates the title of the checklistItem.

The CheckListItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

This property is not available at design time.

Data Type

String

CheckListItemId Property (Office365Tasks Control)

The unique identifier of the task.

Syntax

office365taskscontrol.CheckListItemId(CheckListItemIndex)

Default Value

""

Remarks

The unique identifier of the task.

The CheckListItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemIsChecked Property (Office365Tasks Control)

State that indicates whether the item is checked off or not.

Syntax

office365taskscontrol.CheckListItemIsChecked(CheckListItemIndex)[=boolean]

Default Value

False

Remarks

State that indicates whether the item is checked off or not.

The CheckListItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

This property is not available at design time.

Data Type

Boolean

CheckListItemTaskId Property (Office365Tasks Control)

The ID of the task that contains the subtask.

Syntax

office365taskscontrol.CheckListItemTaskId(CheckListItemIndex)

Default Value

""

Remarks

The ID of the task that contains the subtask.

The CheckListItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemTaskListId Property (Office365Tasks Control)

The ID of the task list that contains the task.

Syntax

office365taskscontrol.CheckListItemTaskListId(CheckListItemIndex)

Default Value

""

Remarks

The ID of the task list that contains the task.

The CheckListItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

FirewallAutoDetect Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (Office365Tasks Control)

The type of firewall to connect through.

Syntax

office365taskscontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (Office365Tasks Control)

The name or IP address of the firewall (optional).

Syntax

office365taskscontrol.FirewallHost[=string]

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (Office365Tasks Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

office365taskscontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (Office365Tasks Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

office365taskscontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (Office365Tasks Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

office365taskscontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

ListTasksMarker Property (Office365Tasks Control)

The page marker for listing tasks.

Syntax

office365taskscontrol.ListTasksMarker[=string]

Default Value

""

Remarks

This property is populated if there are still unlisted tasks after ListTasks is called. It contains the nextLink that will be included as an OData parameter if ListTasks is called again. This will cause the next page of tasks to be listed and added to the end of the Tasks collection.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (Office365Tasks Control)

The access token returned by the authorization server.

Syntax

office365taskscontrol.OAuthAccessToken[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (Office365Tasks Control)

The authorization code that is exchanged for an access token.

Syntax

office365taskscontrol.OAuthAuthorizationCode[=string]

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (Office365Tasks Control)

The scope request or response parameter used during authorization.

Syntax

office365taskscontrol.OAuthAuthorizationScope[=string]

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (Office365Tasks Control)

The id of the client assigned when registering the application.

Syntax

office365taskscontrol.OAuthClientId[=string]

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (Office365Tasks Control)

The type of client that is requesting authorization.

Syntax

office365taskscontrol.OAuthClientProfile[=integer]

Possible Values

cocpApplication(0), 
cocpWeb(1)

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.OAuthClientSecret[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (Office365Tasks Control)

The OAuth grant type used to acquire an OAuth access token.

Syntax

office365taskscontrol.OAuthGrantType[=integer]

Possible Values

cogtAuthorizationCode(0), 
cogtImplicit(1), 
cogtPassword(2), 
cogtClientCredentials(3)

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (Office365Tasks Control)

Specifies the refresh token received from or sent to the authorization server.

Syntax

office365taskscontrol.OAuthRefreshToken[=string]

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (Office365Tasks Control)

Specifies whether the control will request a refresh token during authorization.

Syntax

office365taskscontrol.OAuthRequestRefreshToken[=boolean]

Default Value

True

Remarks

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

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

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (Office365Tasks Control)

The URL where the user (browser) returns after authenticating.

Syntax

office365taskscontrol.OAuthReturnURL[=string]

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the control when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property 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.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (Office365Tasks Control)

The URL of the authorization server.

Syntax

office365taskscontrol.OAuthServerAuthURL[=string]

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.OAuthServerTokenURL[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (Office365Tasks Control)

The URL to which the user should be re-directed for authorization.

Syntax

office365taskscontrol.OAuthWebAuthURL

Default Value

""

Remarks

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.

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

Data Type

String

ProxyAuthScheme Property (Office365Tasks Control)

The type of authorization to perform when connecting to the proxy.

Syntax

office365taskscontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

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

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.ProxyPassword[=string]

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (Office365Tasks Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

office365taskscontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (Office365Tasks Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

office365taskscontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (Office365Tasks Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

office365taskscontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.ProxyUser[=string]

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (Office365Tasks Control)

The date on which this certificate becomes valid.

Syntax

office365taskscontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (Office365Tasks Control)

The date on which the certificate expires.

Syntax

office365taskscontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (Office365Tasks Control)

A comma-delimited list of extended key usage identifiers.

Syntax

office365taskscontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (Office365Tasks Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (Office365Tasks Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (Office365Tasks Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (Office365Tasks Control)

The issuer of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (Office365Tasks Control)

The private key of the certificate (if available).

Syntax

office365taskscontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

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

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (Office365Tasks Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (Office365Tasks Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

office365taskscontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (Office365Tasks Control)

The public key of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (Office365Tasks Control)

The textual description of the certificate's public key algorithm.

Syntax

office365taskscontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (Office365Tasks Control)

The length of the certificate's public key (in bits).

Syntax

office365taskscontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (Office365Tasks Control)

The serial number of the certificate encoded as a string.

Syntax

office365taskscontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (Office365Tasks Control)

The text description of the certificate's signature algorithm.

Syntax

office365taskscontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (Office365Tasks Control)

The name of the certificate store for the client certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (Office365Tasks Control)

The type of certificate store for this certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (Office365Tasks Control)

The MD5 hash of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (Office365Tasks Control)

The SHA-1 hash of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (Office365Tasks Control)

The SHA-256 hash of the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (Office365Tasks Control)

The text description of UsageFlags .

Syntax

office365taskscontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (Office365Tasks Control)

The flags that show intended use for the certificate.

Syntax

office365taskscontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (Office365Tasks Control)

The certificate's version number.

Syntax

office365taskscontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (Office365Tasks Control)

The subject of the certificate used for client authentication.

Syntax

office365taskscontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (Office365Tasks Control)

The certificate (PEM/Base64 encoded).

Syntax

office365taskscontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (Office365Tasks Control)

The date on which this certificate becomes valid.

Syntax

office365taskscontrol.SSLCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (Office365Tasks Control)

The date on which the certificate expires.

Syntax

office365taskscontrol.SSLCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (Office365Tasks Control)

A comma-delimited list of extended key usage identifiers.

Syntax

office365taskscontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (Office365Tasks Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (Office365Tasks Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (Office365Tasks Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (Office365Tasks Control)

The issuer of the certificate.

Syntax

office365taskscontrol.SSLCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (Office365Tasks Control)

The private key of the certificate (if available).

Syntax

office365taskscontrol.SSLCertPrivateKey

Default Value

""

Remarks

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

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (Office365Tasks Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

office365taskscontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (Office365Tasks Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

office365taskscontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (Office365Tasks Control)

The public key of the certificate.

Syntax

office365taskscontrol.SSLCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (Office365Tasks Control)

The textual description of the certificate's public key algorithm.

Syntax

office365taskscontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (Office365Tasks Control)

The length of the certificate's public key (in bits).

Syntax

office365taskscontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (Office365Tasks Control)

The serial number of the certificate encoded as a string.

Syntax

office365taskscontrol.SSLCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (Office365Tasks Control)

The text description of the certificate's signature algorithm.

Syntax

office365taskscontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertStore Property (Office365Tasks Control)

The name of the certificate store for the client certificate.

Syntax

office365taskscontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (Office365Tasks Control)

The type of certificate store for this certificate.

Syntax

office365taskscontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (Office365Tasks Control)

The MD5 hash of the certificate.

Syntax

office365taskscontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (Office365Tasks Control)

The SHA-1 hash of the certificate.

Syntax

office365taskscontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (Office365Tasks Control)

The SHA-256 hash of the certificate.

Syntax

office365taskscontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertUsage Property (Office365Tasks Control)

The text description of UsageFlags .

Syntax

office365taskscontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (Office365Tasks Control)

The flags that show intended use for the certificate.

Syntax

office365taskscontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (Office365Tasks Control)

The certificate's version number.

Syntax

office365taskscontrol.SSLCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (Office365Tasks Control)

The subject of the certificate used for client authentication.

Syntax

office365taskscontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (Office365Tasks Control)

The certificate (PEM/Base64 encoded).

Syntax

office365taskscontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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:

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (Office365Tasks Control)

The date on which this certificate becomes valid.

Syntax

office365taskscontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (Office365Tasks Control)

The date on which the certificate expires.

Syntax

office365taskscontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (Office365Tasks Control)

A comma-delimited list of extended key usage identifiers.

Syntax

office365taskscontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (Office365Tasks Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLServerCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (Office365Tasks Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (Office365Tasks Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

office365taskscontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (Office365Tasks Control)

The issuer of the certificate.

Syntax

office365taskscontrol.SSLServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (Office365Tasks Control)

The private key of the certificate (if available).

Syntax

office365taskscontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

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

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (Office365Tasks Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

office365taskscontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (Office365Tasks Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

office365taskscontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (Office365Tasks Control)

The public key of the certificate.

Syntax

office365taskscontrol.SSLServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (Office365Tasks Control)

The textual description of the certificate's public key algorithm.

Syntax

office365taskscontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (Office365Tasks Control)

The length of the certificate's public key (in bits).

Syntax

office365taskscontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (Office365Tasks Control)

The serial number of the certificate encoded as a string.

Syntax

office365taskscontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (Office365Tasks Control)

The text description of the certificate's signature algorithm.

Syntax

office365taskscontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (Office365Tasks Control)

The name of the certificate store for the client certificate.

Syntax

office365taskscontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.SSLServerCertStorePassword

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (Office365Tasks Control)

The type of certificate store for this certificate.

Syntax

office365taskscontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (Office365Tasks Control)

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

Syntax

office365taskscontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (Office365Tasks Control)

The MD5 hash of the certificate.

Syntax

office365taskscontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (Office365Tasks Control)

The SHA-1 hash of the certificate.

Syntax

office365taskscontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (Office365Tasks Control)

The SHA-256 hash of the certificate.

Syntax

office365taskscontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (Office365Tasks Control)

The text description of UsageFlags .

Syntax

office365taskscontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (Office365Tasks Control)

The flags that show intended use for the certificate.

Syntax

office365taskscontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (Office365Tasks Control)

The certificate's version number.

Syntax

office365taskscontrol.SSLServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (Office365Tasks Control)

The subject of the certificate used for client authentication.

Syntax

office365taskscontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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=support@nsoftware.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (Office365Tasks Control)

The certificate (PEM/Base64 encoded).

Syntax

office365taskscontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

TaskListsCount Property (Office365Tasks Control)

The number of records in the TaskList arrays.

Syntax

office365taskscontrol.TaskListsCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• TaskListDisplayName
• TaskListId
• TaskListIsDefault
• TaskListIsOwner
• TaskListIsShared

The array indices start at 0 and end at TaskListsCount - 1.

This property is not available at design time.

Data Type

Integer

TaskListDisplayName Property (Office365Tasks Control)

the name of the task list.

Syntax

office365taskscontrol.TaskListDisplayName(TaskListIndex)[=string]

Default Value

""

Remarks

the name of the task list

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

This property is not available at design time.

Data Type

String

TaskListId Property (Office365Tasks Control)

The unique identifier of the task list.

Syntax

office365taskscontrol.TaskListId(TaskListIndex)

Default Value

""

Remarks

The unique identifier of the task list.

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

String

TaskListIsDefault Property (Office365Tasks Control)

True if this is the default task list where new tasks are created by default, false otherwise.

Syntax

office365taskscontrol.TaskListIsDefault(TaskListIndex)

Default Value

False

Remarks

True if this is the default task list where new tasks are created by default, false otherwise

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

Boolean

TaskListIsOwner Property (Office365Tasks Control)

True if the user is the owner of the given task list.

Syntax

office365taskscontrol.TaskListIsOwner(TaskListIndex)

Default Value

False

Remarks

True if the user is the owner of the given task list.

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

Boolean

TaskListIsShared Property (Office365Tasks Control)

True if the task list is shared with other users.

Syntax

office365taskscontrol.TaskListIsShared(TaskListIndex)

Default Value

False

Remarks

True if the task list is shared with other users.

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

Boolean

TasksCount Property (Office365Tasks Control)

The number of records in the Task arrays.

Syntax

office365taskscontrol.TasksCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• TaskBody
• TaskBodyLastModifiedDateTime
• TaskCategories
• TaskCompletedDateTime
• TaskCompletedTimeZone
• TaskCreatedDateTime
• TaskDueDateTime
• TaskDueTimeZone
• TaskHasAttachments
• TaskId
• TaskImportance
• TaskIsReminderOn
• TaskJSON
• TaskLastModifiedDateTime
• TaskListDisplayName
• TaskListId
• TaskListIsDefault
• TaskListIsOwner
• TaskListIsShared
• TaskRecurDayOfMonth
• TaskRecurDaysOfWeek
• TaskRecurEndDate
• TaskRecurFirstDayOfWeek
• TaskRecurIndex
• TaskRecurInterval
• TaskRecurMonth
• TaskRecurNumberOfOccurrences
• TaskRecurRangeType
• TaskRecurStartDate
• TaskRecurTimeZone
• TaskRecurType
• TaskReminderDateTime
• TaskReminderTimeZone
• TaskStartDateTime
• TaskStartTimeZone
• TaskStatus
• TaskTaskListId
• TaskTitle

The array indices start at 0 and end at TasksCount - 1.

This property is not available at design time.

Data Type

Integer

TaskBody Property (Office365Tasks Control)

The task body that typically contains information about the task.

Syntax

office365taskscontrol.TaskBody(TaskIndex)[=string]

Default Value

""

Remarks

The task body that typically contains information about the task. Note that only HTML type is supported.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskBodyLastModifiedDateTime Property (Office365Tasks Control)

The date and time when the task body was last modified.

Syntax

office365taskscontrol.TaskBodyLastModifiedDateTime(TaskIndex)

Default Value

""

Remarks

The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskCategories Property (Office365Tasks Control)

The categories associated with the task.

Syntax

office365taskscontrol.TaskCategories(TaskIndex)[=string]

Default Value

""

Remarks

The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory defined for the user.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskCompletedDateTime Property (Office365Tasks Control)

The date and time the task was finished.

Syntax

office365taskscontrol.TaskCompletedDateTime(TaskIndex)[=string]

Default Value

""

Remarks

The date and time the task was finished.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskCompletedTimeZone Property (Office365Tasks Control)

The time zone of the time the task was finished.

Syntax

office365taskscontrol.TaskCompletedTimeZone(TaskIndex)[=string]

Default Value

""

Remarks

The time zone of the time the task was finished.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskCreatedDateTime Property (Office365Tasks Control)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

office365taskscontrol.TaskCreatedDateTime(TaskIndex)

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskDueDateTime Property (Office365Tasks Control)

The date and time the task is to be finished.

Syntax

office365taskscontrol.TaskDueDateTime(TaskIndex)[=string]

Default Value

""

Remarks

The date and time the task is to be finished.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskDueTimeZone Property (Office365Tasks Control)

The time zone of the time the task is to be finished.

Syntax

office365taskscontrol.TaskDueTimeZone(TaskIndex)[=string]

Default Value

""

Remarks

The time zone of the time the task is to be finished.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskHasAttachments Property (Office365Tasks Control)

Set to true if the task has attachments.

Syntax

office365taskscontrol.TaskHasAttachments(TaskIndex)

Default Value

False

Remarks

Set to true if the task has attachments.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

Boolean

TaskId Property (Office365Tasks Control)

The unique identifier of the task.

Syntax

office365taskscontrol.TaskId(TaskIndex)

Default Value

""

Remarks

The unique identifier of the task.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskImportance Property (Office365Tasks Control)

The importance of the task.

Syntax

office365taskscontrol.TaskImportance(TaskIndex)[=integer]

Possible Values

otiLow(0), 
otiNormal(1), 
otiHigh(2)

Default Value

0

Remarks

The importance of the task.

Possible values are:

• 0 (otiLow)
• 1 (otiNormal)
• 2 (otiHigh)

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskIsReminderOn Property (Office365Tasks Control)

Set to true if an alert is set to remind the user of the task.

Syntax

office365taskscontrol.TaskIsReminderOn(TaskIndex)[=boolean]

Default Value

False

Remarks

Set to true if an alert is set to remind the user of the task.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Boolean

TaskJSON Property (Office365Tasks Control)

A JSON representation of the task.

Syntax

office365taskscontrol.TaskJSON(TaskIndex)[=string]

Default Value

""

Remarks

A JSON representation of the task. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskLastModifiedDateTime Property (Office365Tasks Control)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Syntax

office365taskscontrol.TaskLastModifiedDateTime(TaskIndex)

Default Value

""

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskRecurDayOfMonth Property (Office365Tasks Control)

The day of the month on which the task occurs.

Syntax

office365taskscontrol.TaskRecurDayOfMonth(TaskIndex)[=integer]

Default Value

0

Remarks

The day of the month on which the task occurs. Required if type is absoluteMonthly or absoluteYearly.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurDaysOfWeek Property (Office365Tasks Control)

A space separated collection of the days of the week on which the task occurs.

Syntax

office365taskscontrol.TaskRecurDaysOfWeek(TaskIndex)[=string]

Default Value

""

Remarks

A space separated collection of the days of the week on which the task occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the task falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurEndDate Property (Office365Tasks Control)

The date to stop applying the recurrence pattern.

Syntax

office365taskscontrol.TaskRecurEndDate(TaskIndex)[=string]

Default Value

""

Remarks

The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the task, the last occurrence of the meeting may not be this date. Required if type is endDate.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurFirstDayOfWeek Property (Office365Tasks Control)

The first day of the week.

Syntax

office365taskscontrol.TaskRecurFirstDayOfWeek(TaskIndex)[=string]

Default Value

""

Remarks

The first day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. Default is sunday. Required if type is weekly.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurIndex Property (Office365Tasks Control)

Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month.

Syntax

office365taskscontrol.TaskRecurIndex(TaskIndex)[=string]

Default Value

""

Remarks

Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month. The possible values are: first, second, third, fourth, last. Default is first. Optional and used if type is relativeMonthly or relativeYearly.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurInterval Property (Office365Tasks Control)

The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.

Syntax

office365taskscontrol.TaskRecurInterval(TaskIndex)[=integer]

Default Value

0

Remarks

The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required. Set to 0 to disable recurrence.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurMonth Property (Office365Tasks Control)

The month in which the task occurs.

Syntax

office365taskscontrol.TaskRecurMonth(TaskIndex)[=integer]

Default Value

0

Remarks

The month in which the task occurs. This is a number from 1 to 12.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurNumberOfOccurrences Property (Office365Tasks Control)

The number of times to repeat the task.

Syntax

office365taskscontrol.TaskRecurNumberOfOccurrences(TaskIndex)[=integer]

Default Value

0

Remarks

The number of times to repeat the task. Required and must be positive if type is numbered.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurRangeType Property (Office365Tasks Control)

The recurrence range.

Syntax

office365taskscontrol.TaskRecurRangeType(TaskIndex)[=integer]

Possible Values

otrrtEndDate(0), 
otrrtNoEnd(1), 
otrrtNumbered(2)

Default Value

0

Remarks

The recurrence range.

Possible values are:

• 0 (otrrtEndDate)
• 1 (otrrtNoEnd)
• 2 (otrrtNumbered)

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurStartDate Property (Office365Tasks Control)

The date to start applying the recurrence pattern.

Syntax

office365taskscontrol.TaskRecurStartDate(TaskIndex)[=string]

Default Value

""

Remarks

The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the task. Must be the same value as the start property of the recurring task. Required.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurTimeZone Property (Office365Tasks Control)

Time zone for the startDate and endDate properties.

Syntax

office365taskscontrol.TaskRecurTimeZone(TaskIndex)[=string]

Default Value

""

Remarks

Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurType Property (Office365Tasks Control)

The recurrence pattern type Possible values are: 0 (otrtDaily) 1 (otrtWeekly) 2 (otrtAbsoluteMonthly) 3 (otrtRelativeMonthly) 4 (otrtAbsoluteYearly) 5 (otrtRelativeYearly) .

Syntax

office365taskscontrol.TaskRecurType(TaskIndex)[=integer]

Possible Values

otrtDaily(0), 
otrtWeekly(1), 
otrtAbsoluteMonthly(2), 
otrtRelativeMonthly(3), 
otrtAbsoluteYearly(4), 
otrtRelativeYearly(5)

Default Value

0

Remarks

The recurrence pattern type

Possible values are:

• 0 (otrtDaily)
• 1 (otrtWeekly)
• 2 (otrtAbsoluteMonthly)
• 3 (otrtRelativeMonthly)
• 4 (otrtAbsoluteYearly)
• 5 (otrtRelativeYearly)

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskReminderDateTime Property (Office365Tasks Control)

The date and time for a reminder alert of the task to occur.

Syntax

office365taskscontrol.TaskReminderDateTime(TaskIndex)[=string]

Default Value

""

Remarks

The date and time for a reminder alert of the task to occur.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskReminderTimeZone Property (Office365Tasks Control)

The time zone of the time for a reminder alert of the task to occur.

Syntax

office365taskscontrol.TaskReminderTimeZone(TaskIndex)[=string]

Default Value

""

Remarks

The time zone of the time for a reminder alert of the task to occur.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskStartDateTime Property (Office365Tasks Control)

The date and time at which the task is scheduled to start.

Syntax

office365taskscontrol.TaskStartDateTime(TaskIndex)[=string]

Default Value

""

Remarks

The date and time at which the task is scheduled to start.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskStartTimeZone Property (Office365Tasks Control)

The time zone of the time at which the task is scheduled to start.

Syntax

office365taskscontrol.TaskStartTimeZone(TaskIndex)[=string]

Default Value

""

Remarks

The time zone of the time at which the task is scheduled to start.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskStatus Property (Office365Tasks Control)

The status of the task.

Syntax

office365taskscontrol.TaskStatus(TaskIndex)[=integer]

Possible Values

otsNotStarted(0), 
otsInProgress(1), 
otsCompleted(2), 
otsWaitingOnOthers(3), 
otsDeferred(4)

Default Value

0

Remarks

The status of the task.

Possible values are:

• 0 (otsNotStarted)
• 1 (otsInProgress)
• 2 (otsCompleted)
• 3 (otsWaitingOnOthers)
• 4 (otsDeferred)

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskTaskListId Property (Office365Tasks Control)

The ID of the task list that contains the task.

Syntax

office365taskscontrol.TaskTaskListId(TaskIndex)

Default Value

""

Remarks

The ID of the task list that contains the task.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskTitle Property (Office365Tasks Control)

A brief description of the task.

Syntax

office365taskscontrol.TaskTitle(TaskIndex)[=string]

Default Value

""

Remarks

A brief description of the task.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

AddAttachment Method (Office365Tasks Control)

Adds a file attachment to an existing task.

Syntax

office365taskscontrol.AddAttachment TaskListId, TaskId, Name, LocalFile

Remarks

This method adds a file attachment to an existing task, specified by the TaskId parameter. To add a more complex attachment, set the Name and LocalFile parameters to empty strings and the control will use the first attachment in the Attachments properties. As a note, this will not clear the Attachments properties. If the file is larger than the value set in the AttachmentSimpleUploadLimit configuration, then the control will use an upload session to upload the attachment in fragments. The size of the fragments are specified in the AttachmentFragmentSize configuration. To add an attachment from stream use the SetAttachmentInStream method.

Authorize Method (Office365Tasks Control)

Get the authorization string required to access the protected resource.

Syntax

office365taskscontrol.Authorize 

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 OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

Config Method (Office365Tasks Control)

Sets or retrieves a configuration setting.

Syntax

office365taskscontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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, you must call Config("PROPERTY"). The value will be returned as a string.

CreateCheckListItem Method (Office365Tasks Control)

Creates a subtask.

Syntax

office365taskscontrol.CreateCheckListItem Subject, TaskListId, TaskId

Remarks

Creates a subtask from the specified taskListId and taskId with the specified name. The subject parameter defines the name of the subtask.

The name of the subtask can be updated after creation by calling the UpdateCheckListItem method.

CreateTask Method (Office365Tasks Control)

Creates a task.

Syntax

office365taskscontrol.CreateTask Subject, TaskListId

Remarks

Creates a new task from the specified taskListId with the specified name. The subject parameter defines the name of the task.

The name of the task can be updated after creation by calling the UpdateTask method.

CreateTaskList Method (Office365Tasks Control)

Creates a new task list.

Syntax

office365taskscontrol.CreateTaskList Name

Remarks

Creates a new task list with the specified name. The name parameter defines the name of the task list.

The name of the task list can be updated after creation by calling the UpdateTaskList method.

DeleteAttachment Method (Office365Tasks Control)

Deletes an attachment.

Syntax

office365taskscontrol.DeleteAttachment TaskListId, TaskId, Id

Remarks

This method deletes an attachment. id takes the ID of the task the attachment is attached to. attachmentId takes the attachment ID of an existing attachment. This will not remove the attachment from the Attachments properties.

DeleteCheckListItem Method (Office365Tasks Control)

Deletes a subtask.

Syntax

office365taskscontrol.DeleteCheckListItem TaskListId, TaskId, Id

Remarks

Deletes a subtask identified by taskListId, taskId and id parameters. taskListId and taskIdthe parameters identifies the Task list and Task that the subtask to be deleted belongs to and id parameter identifies the subtask to be deleted. The specified subtask will be permanently removed. This operation will not remove the subtask from the CheckListItems collection

DeleteTask Method (Office365Tasks Control)

Deletes a task.

Syntax

office365taskscontrol.DeleteTask TaskListId, Id

Remarks

Deletes a task identified by taskListId and id parameters. taskListId parameter identifies the Task list that the task to be deleted belongs to and id parameter identifies the task to be deleted. The specified task will be permanently removed. This operation will not remove the task from the Tasks collection

DeleteTaskList Method (Office365Tasks Control)

Deletes a task list.

Syntax

office365taskscontrol.DeleteTaskList Id

Remarks

Deletes a Task list identified by the id parameter. The Task list and all its associated tasks will be removed, this operation will not remove the Task list from the TaskLists collection.

GetCheckListItem Method (Office365Tasks Control)

Retrieves the subtask by Id.

Syntax

office365taskscontrol.GetCheckListItem TaskListId, TaskId, Id

Remarks

This method retrieves a subtask specified by its ID and adds the subtask to the beginning of the CheckListItems list. If the subtask already exists in the CheckListItems collection, it will be removed and then added to the beginning, preventing duplication.

Example(Retrieving a subtask) office365task.GetCheckListItem("taskListId", "taskId", "id"); office365task.CheckListItems[0]; //the retrieved subtask

GetTask Method (Office365Tasks Control)

Retrieves the task by Id.

Syntax

office365taskscontrol.GetTask TaskListId, Id

Remarks

This method retrieves a task specified by its ID and adds the task to the beginning of the Tasks list. If the task already exists in the Tasks collection, it will be removed and then added to the beginning, preventing duplication.

Example(Retrieving a task) office365task.GetTask("taskListId", "id"); office365task.Tasks[0]; //the retrieved task

GetTaskField Method (Office365Tasks Control)

Retrieves the task property value by JSONPath.

Syntax

office365taskscontrol.GetTaskField index, JsonPath

Remarks

This method retrieves a specific field within the task's JSON field. The first parameter, index, represents the index of the task in the Tasks collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.

Example (Access Fields of a Task)

office365task.GetTaskField(0, "/json/title"); // The title of the task

Interrupt Method (Office365Tasks Control)

Interrupt the current method.

Syntax

office365taskscontrol.Interrupt 

Remarks

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

ListAttachments Method (Office365Tasks Control)

Lists all of a task's attachments.

Syntax

office365taskscontrol.ListAttachments TaskListId, TaskId

Remarks

This method lists all of a task's attachments. This method clears and populates the Attachments properties. For each attachment retrieved, the AttachmentList event is fired.

ListCheckListItems Method (Office365Tasks Control)

Lists the subtasks.

Syntax

office365taskscontrol.ListCheckListItems TaskListId, TaskId

Remarks

Retrieves a list of subtasks from the specified Task, identified by the taskListId and the taskId parameters. The retrieved subtasks are added to the CheckListItems collection. For each subtask retrieved, the CheckListItemList event is fired.

ListTaskLists Method (Office365Tasks Control)

Lists the task lists.

Syntax

office365taskscontrol.ListTaskLists 

Remarks

List all Task lists associated with the current user. The retrieved Task lists are added to the TaskLists collection. For each Task list retrieved, the TaskListList event is fired.

ListTasks Method (Office365Tasks Control)

Lists the tasks.

Syntax

office365taskscontrol.ListTasks TaskListId

Remarks

Retrieves a list of tasks from the specified Task list, identified by the taskListId parameter. The retrieved Task lists are added to the Tasks collection. For each Task list retrieved, the TaskList event is fired.

Reset Method (Office365Tasks Control)

This method will reset the control.

Syntax

office365taskscontrol.Reset 

Remarks

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

RetrieveAttachment Method (Office365Tasks Control)

Retrieves a task's attachment.

Syntax

office365taskscontrol.RetrieveAttachment TaskListId, TaskId, Id

Remarks

This method retrieves an attachment. id specifies the task ID for the task the attachment is attached to. The content data returns in this case

The fetched attachment can be accessed through the Attachment* properties.

SendCustomRequest Method (Office365Tasks Control)

Send a custom HTTP request.

Syntax

office365taskscontrol.SendCustomRequest HTTPMethod, URL, PostData

Remarks

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

SetTaskField Method (Office365Tasks Control)

Sets the task field value by JSONPath.

Syntax

office365taskscontrol.SetTaskField index, JsonPath, Value, ValueType

Remarks

This method updates a specific field within the event's JSON representation. The parameters for this method are as follows: the first parameter, index, represents the index of the event in the Tasks collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)
• 6 (Raw)

Example (Set/Edit Fields of a Task before Updating): // Create a task office365task.CreateTask("task name", taskListId); office365task.SetTaskField(0, "/json/body", "Task body", 2); // Update notes field office365task.SetTaskField(0, "/json/title", "new task name", 2); // Update title field // Update task office365task.UpdateTask(0);

For a full list of the fields a task has/can have, please refer to the official documentation of the Microsoft Graph API documentation.

UpdateCheckListItem Method (Office365Tasks Control)

Updates a subtask.

Syntax

office365taskscontrol.UpdateCheckListItem index

Remarks

This method allows you to update an existing subtask. The index parameter specifies the position of the task in the CheckListItems collection. The method uses this index to take all the data from the specified subtask and update the corresponding subtask on the server.

To update a subtask, edit the desired task fields within the CheckListItems collection. Then, call the UpdateCheckListItem method with the index of the subtask. Note that changing the JSON data will overwrite the entire subtask, ignoring other field edits made before setting the JSON.

The OTCheckListItem type used in the CheckListItems collection includes the fields of a subtask. Refer to the OTCheckListItem type for a complete list of fields.

UpdateTask Method (Office365Tasks Control)

Updates a task.

Syntax

office365taskscontrol.UpdateTask index

Remarks

This method allows you to update an existing task. The index parameter specifies the position of the task in the Tasks collection. The method uses this index to take all the data from the specified task and update the corresponding task on the server.

To update a task, edit the desired task fields within the Tasks collection. Then, call the UpdateTask method with the index of the task. Note that changing the JSON data will overwrite the entire task, ignoring other field edits made before setting the JSON.

The OTTaskItem type used in the Tasks collection includes the fields of a task. Refer to the OTTaskItem type for a complete list of fields. If you need to add other fields, you can use the SetTaskField method. For a complete list of fields a task can have, please refer to the Microsoft Graph API overview

UpdateTaskList Method (Office365Tasks Control)

Updates a task list.

Syntax

office365taskscontrol.UpdateTaskList index

Remarks

This method allows you to update an existing task list. The index parameter specifies the position of the task list in the TaskLists collection. The method uses this index to take all the data from the specified task list and update the corresponding task list on the server.

To update a task list, edit the desired task list fields within the TaskLists collection. Then, call the UpdateTaskList method with the index of the task list. Note that changing the JSON data will overwrite the entire task list, ignoring other field edits made before setting the JSON.

The OTTaskList type used in the TaskLists collection includes the fields of a task list. Refer to the OTTaskList type for a complete list of fields.

AttachmentList Event (Office365Tasks Control)

Fired when an attachment is retrieved from the server.

Syntax

Sub office365taskscontrol_AttachmentList(Id As String, Name As String, ContentType As String, LastModifiedDateTime As String, Size As Integer)

Remarks

The AttachmentList event is fired for each attachment retrieved from the server when ListAttachments is called. This event provides the attachment's Id, Name, ContentType, LastModifiedDateTime and Size.

CheckListItemList Event (Office365Tasks Control)

Fired when a subtask is retrieved from the server.

Syntax

Sub office365taskscontrol_CheckListItemList(Id As String, TaskId As String, TaskListId As String, Subject As String)

Remarks

The CheckListItemList event is fired for each subtask retrieved from the server when ListCheckListItems is called. This event provides the subtask's Id, TaskId, TaskListId and Subject.

Error Event (Office365Tasks Control)

Fired when information is available about errors during data delivery.

Syntax

Sub office365taskscontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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 section.

Log Event (Office365Tasks Control)

Fired once for each log message.

Syntax

Sub office365taskscontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

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

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 (Office365Tasks Control)

Fired after the server presents its certificate to the client.

Syntax

Sub office365taskscontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 (Office365Tasks Control)

Fired when secure connection progress messages are available.

Syntax

Sub office365taskscontrol_SSLStatus(Message As String)

Remarks

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

TaskList Event (Office365Tasks Control)

Fired when a task is retrieved from the server.

Syntax

Sub office365taskscontrol_TaskList(Id As String, TaskListId As String, Subject As String)

Remarks

The TaskList event is fired for each task retrieved from the server when ListTasks is called. This event provides the task's Id, TaskListId and Subject.

TaskListList Event (Office365Tasks Control)

Fired when a task list is retrieved from the server.

Syntax

Sub office365taskscontrol_TaskListList(Id As String, Name As String)

Remarks

The TaskListList event is fired for each task list retrieved from the server when ListTaskLists is called. This event provides the task list's Id and Name.

Transfer Event (Office365Tasks Control)

Fired while a document transfers (delivers document).

Syntax

Sub office365taskscontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

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.

Config Settings (Office365Tasks Control)

Office365Tasks Config Settings

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

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

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----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-----

-----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-----

-----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-----

Socket Config Settings