Excel.DocumentTask class

パッケージ:

excel

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクを表します。

Extends

OfficeExtension.ClientObject

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

使用元

• Excel.Comment: assignTask、getTask、getTaskOrNullObject
• Excel.CommentReply: assignTask、 getTask、 getTaskOrNullObject
• Excel.DocumentTaskCollection: getItem、 getItemAt、 getItemOrNullObject、 items

プロパティ

assignees	タスクの担当者のコレクションを返します。
changes	タスクの変更レコードを取得します。
comment	タスクに関連付けられているコメントを取得します。
completedBy	タスクを完了した最新のユーザーを取得します。
completedDateTime	タスクが完了した日時を取得します。 すべての日付は UTC になります。
context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
createdBy	タスクを作成したユーザーを取得します。
createdDateTime	タスクが作成された日時を取得します。 すべての日付は UTC になります。
id	タスクの ID を取得します。
percentComplete	タスクの完了率を指定します。 これは 0 から 100 の範囲の値です。100 は完了したタスクを表します。
priority	タスクの優先順位を指定します。 これは 0 から 10 の範囲の値です。0 は最高の優先度を表します。
startAndDueDateTime	タスクを開始する日時と期限を指定します。
title	タスクのタイトルを指定します。

メソッド

assign(assignee)	指定されたユーザーを、タスクに関連付けられている担当者のリストに追加します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
toJSON()	API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.DocumentTask オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.DocumentTaskData と型指定) を返します。
unassign(assignee)	タスクにアタッチされている担当者のリストから指定されたユーザーを削除します。
unassignAll()	タスクに関連付けられている担当者のリストからすべてのユーザーを削除します。

プロパティの詳細

assignees

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの担当者のコレクションを返します。

readonly assignees: Excel.EmailIdentity[];

プロパティ値

Excel.EmailIdentity[]

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

changes

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの変更レコードを取得します。

readonly changes: Excel.DocumentTaskChangeCollection;

プロパティ値

Excel.DocumentTaskChangeCollection

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

comment

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクに関連付けられているコメントを取得します。

readonly comment: Excel.Comment;

プロパティ値

Excel.Comment

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

completedBy

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクを完了した最新のユーザーを取得します。

readonly completedBy: Excel.EmailIdentity;

プロパティ値

Excel.EmailIdentity

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

completedDateTime

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクが完了した日時を取得します。 すべての日付は UTC になります。

readonly completedDateTime: Date;

プロパティ値

Date

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

createdBy

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクを作成したユーザーを取得します。

readonly createdBy: Excel.EmailIdentity;

プロパティ値

Excel.EmailIdentity

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

createdDateTime

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクが作成された日時を取得します。 すべての日付は UTC になります。

readonly createdDateTime: Date;

プロパティ値

Date

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

id

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの ID を取得します。

readonly id: string;

プロパティ値

string

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

percentComplete

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの完了率を指定します。 これは 0 から 100 の範囲の値です。100 は完了したタスクを表します。

percentComplete: number;

プロパティ値

number

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

priority

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの優先順位を指定します。 これは 0 から 10 の範囲の値です。0 は最高の優先度を表します。

priority: number;

プロパティ値

number

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

startAndDueDateTime

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクを開始する日時と期限を指定します。

startAndDueDateTime: Excel.DocumentTaskSchedule;

プロパティ値

Excel.DocumentTaskSchedule

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

title

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクのタイトルを指定します。

title: string;

プロパティ値

string

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

メソッドの詳細

assign(assignee)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

指定されたユーザーを、タスクに関連付けられている担当者のリストに追加します。

assign(assignee: Excel.EmailIdentity): void;

パラメーター

assignee

Excel.EmailIdentity

担当者リストに追加するユーザーの ID。

返品

void

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

load(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.DocumentTaskLoadOptions): Excel.DocumentTask;

パラメーター

options

Excel.Interfaces.DocumentTaskLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Excel.DocumentTask

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.DocumentTask;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Excel.DocumentTask

load(propertyNamesAndPaths)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DocumentTask;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Excel.DocumentTask

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.DocumentTask オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.DocumentTaskData と型指定) を返します。

toJSON(): Excel.Interfaces.DocumentTaskData;

返品

Excel.Interfaces.DocumentTaskData

unassign(assignee)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクにアタッチされている担当者のリストから指定されたユーザーを削除します。

unassign(assignee: Excel.EmailIdentity): void;

パラメーター

assignee

Excel.EmailIdentity

担当者リストから削除するユーザーの ID。

返品

void

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

unassignAll()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクに関連付けられている担当者のリストからすべてのユーザーを削除します。

unassignAll(): void;

返品

void

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)