Excel.DocumentTask class
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクを表します。
- Extends
注釈
[ API セット: ExcelApi BETA (プレビューのみ) ]
プロパティ
| assignees | タスクの担当者のコレクションを返します。 |
| changes | タスクの変更レコードを取得します。 |
| comment | タスクに関連付けられているコメントを取得します。 |
| completed |
タスクを完了した最新のユーザーを取得します。 |
| completed |
タスクが完了した日時を取得します。 すべての日付は UTC です。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| created |
タスクを作成したユーザーを取得します。 |
| created |
タスクが作成された日付と時刻を取得します。 すべての日付は UTC です。 |
| id | タスクの ID を取得します。 |
| percent |
タスクの完了率を指定します。 これは 0 から 100 までの値で、100 は完了したタスクを表します。 |
| priority | タスクの優先度を指定します。 これは 0 から 10 までの値で、0 は最も高い優先順位を表します。 |
| start |
タスクを開始する日時と期限を取得または設定します。 |
| title | タスクのタイトルを指定します。 |
メソッド
| assign(assignee) | タスクにアタッチされている担当者の一覧に、指定したユーザーを追加します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
| unassign(assignee) | タスクにアタッチされている担当者の一覧から、指定したユーザーを削除します。 |
| unassign |
タスクにアタッチされている担当者の一覧からすべてのユーザーを削除します。 |
プロパティの詳細
assignees
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの担当者のコレクションを返します。
readonly assignees: Excel.EmailIdentity[];プロパティ値
注釈
changes
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの変更レコードを取得します。
readonly changes: Excel.DocumentTaskChangeCollection;プロパティ値
注釈
comment
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクに関連付けられているコメントを取得します。
readonly comment: Excel.Comment;プロパティ値
注釈
completedBy
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクを完了した最新のユーザーを取得します。
readonly completedBy: Excel.EmailIdentity;プロパティ値
注釈
completedDateTime
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクが完了した日時を取得します。 すべての日付は UTC です。
readonly completedDateTime: Date;プロパティ値
Date
注釈
context
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
createdBy
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクを作成したユーザーを取得します。
readonly createdBy: Excel.EmailIdentity;プロパティ値
注釈
createdDateTime
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクが作成された日付と時刻を取得します。 すべての日付は UTC です。
readonly createdDateTime: Date;プロパティ値
Date
注釈
id
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの ID を取得します。
readonly id: string;プロパティ値
string
注釈
percentComplete
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの完了率を指定します。 これは 0 から 100 までの値で、100 は完了したタスクを表します。
percentComplete: number;プロパティ値
number
注釈
priority
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの優先度を指定します。 これは 0 から 10 までの値で、0 は最も高い優先順位を表します。
priority: number;プロパティ値
number
注釈
startAndDueDateTime
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクを開始する日時と期限を取得または設定します。
startAndDueDateTime: Excel.DocumentTaskSchedule;プロパティ値
注釈
title
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクのタイトルを指定します。
title: string;プロパティ値
string
注釈
メソッドの詳細
assign(assignee)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクにアタッチされている担当者の一覧に、指定したユーザーを追加します。
assign(assignee: Excel.EmailIdentity): void;パラメーター
- assignee
- Excel.EmailIdentity
割り当て先リストに追加するユーザーの ID。
戻り値
void
注釈
load(options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.DocumentTaskLoadOptions): Excel.DocumentTask;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.DocumentTask;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DocumentTask;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.DocumentTask オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.DocumentTaskData として型指定) を返します。
toJSON(): Excel.Interfaces.DocumentTaskData;戻り値
unassign(assignee)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクにアタッチされている担当者の一覧から、指定したユーザーを削除します。
unassign(assignee: Excel.EmailIdentity): void;パラメーター
- assignee
- Excel.EmailIdentity
担当者リストから削除するユーザーの ID。
戻り値
void
注釈
unassignAll()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクにアタッチされている担当者の一覧からすべてのユーザーを削除します。
unassignAll(): void;戻り値
void
注釈
Office Add-ins