Word.DocumentProperties class

ドキュメント プロパティを表します。

Extends

注釈

[ API セット: WordApi 1.3 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

プロパティ

applicationName

ドキュメントのアプリケーション名を取得します。

author

ドキュメントの作成者を指定します。

category

ドキュメントのカテゴリを指定します。

comments

ドキュメントのメタデータの [コメント] フィールドを指定します。 これらは、ドキュメント内で行われたユーザーによるコメントには接続されません。

company

ドキュメントの会社を指定します。

context

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

creationDate

ドキュメントの作成日を取得します。

customProperties

ドキュメントのカスタム プロパティのコレクションを取得します。

format

ドキュメントの形式を指定します。

keywords

ドキュメントのキーワードを指定します。

lastAuthor

ドキュメントの最後の作成者を取得します。

lastPrintDate

ドキュメントを最後に印刷した日を取得します。

lastSaveTime

ドキュメントを最後に保存した時刻を取得します。

manager

ドキュメントのマネージャーを指定します。

revisionNumber

ドキュメントのリビジョン番号を取得します。

security

ドキュメントのセキュリティ設定を取得します。 ディスク上のファイルに対するアクセス制限があります。 その他の設定は、ドキュメント保護の設定です。 使用可能な値の一部は 0 = ディスク上のファイルが読み取り/書き込みです。1 = ドキュメントの保護: ファイルは暗号化され、開くにはパスワードが必要です。2 = ドキュメントの保護: 常に読み取り専用として開きます。3 = ドキュメントの保護: #1 と #2 の両方。4 = ディスク上のファイルは読み取り専用です。5 = #1 と #4 の両方。6 = #2 と #4 の両方。7 = #1、#2、および #4 のすべて。8 = ドキュメントの保護: 編集を読み取り専用に制限します。9 = #1 と #8 の両方。10 = #2 と #8 の両方。11 = #1、#2、および #8 のすべて。12 = #4 と #8 の両方。13 = #1、#4、および #8 のすべて。14 = #2、#4、および #8 のすべて。15 = #1、#2、#4、および #8 のすべて。

subject

ドキュメントの件名を指定します。

template

ドキュメントのテンプレートを取得します。

title

ドキュメントのタイトルを指定します。

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

toJSON()

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

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

プロパティの詳細

applicationName

ドキュメントのアプリケーション名を取得します。

readonly applicationName: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

author

ドキュメントの作成者を指定します。

author: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

category

ドキュメントのカテゴリを指定します。

category: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

comments

ドキュメントのメタデータの [コメント] フィールドを指定します。 これらは、ドキュメント内で行われたユーザーによるコメントには接続されません。

comments: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

company

ドキュメントの会社を指定します。

company: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

context

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

context: RequestContext;

プロパティ値

creationDate

ドキュメントの作成日を取得します。

readonly creationDate: Date;

プロパティ値

Date

注釈

[ API セット: WordApi 1.3 ]

customProperties

ドキュメントのカスタム プロパティのコレクションを取得します。

readonly customProperties: Word.CustomPropertyCollection;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

format

ドキュメントの形式を指定します。

format: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

keywords

ドキュメントのキーワードを指定します。

keywords: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

lastAuthor

ドキュメントの最後の作成者を取得します。

readonly lastAuthor: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

lastPrintDate

ドキュメントを最後に印刷した日を取得します。

readonly lastPrintDate: Date;

プロパティ値

Date

注釈

[ API セット: WordApi 1.3 ]

lastSaveTime

ドキュメントを最後に保存した時刻を取得します。

readonly lastSaveTime: Date;

プロパティ値

Date

注釈

[ API セット: WordApi 1.3 ]

manager

ドキュメントのマネージャーを指定します。

manager: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

revisionNumber

ドキュメントのリビジョン番号を取得します。

readonly revisionNumber: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

security

ドキュメントのセキュリティ設定を取得します。 ディスク上のファイルに対するアクセス制限があります。 その他の設定は、ドキュメント保護の設定です。 使用可能な値の一部は 0 = ディスク上のファイルが読み取り/書き込みです。1 = ドキュメントの保護: ファイルは暗号化され、開くにはパスワードが必要です。2 = ドキュメントの保護: 常に読み取り専用として開きます。3 = ドキュメントの保護: #1 と #2 の両方。4 = ディスク上のファイルは読み取り専用です。5 = #1 と #4 の両方。6 = #2 と #4 の両方。7 = #1、#2、および #4 のすべて。8 = ドキュメントの保護: 編集を読み取り専用に制限します。9 = #1 と #8 の両方。10 = #2 と #8 の両方。11 = #1、#2、および #8 のすべて。12 = #4 と #8 の両方。13 = #1、#4、および #8 のすべて。14 = #2、#4、および #8 のすべて。15 = #1、#2、#4、および #8 のすべて。

readonly security: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.3 ]

subject

ドキュメントの件名を指定します。

subject: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

template

ドキュメントのテンプレートを取得します。

readonly template: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

title

ドキュメントのタイトルを指定します。

title: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

メソッドの詳細

load(options)

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

load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties;

パラメーター

options
Word.Interfaces.DocumentPropertiesLoadOptions

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

戻り値

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.DocumentProperties;

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.DocumentProperties;

パラメーター

propertyNamesAndPaths

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

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

戻り値

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Word.Interfaces.DocumentPropertiesUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.DocumentProperties): void;

パラメーター

戻り値

void

toJSON()

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

toJSON(): Word.Interfaces.DocumentPropertiesData;

戻り値

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.DocumentProperties;

戻り値

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

untrack(): Word.DocumentProperties;

戻り値