Word.Interfaces.CustomPropertyCollectionLoadOptions interface

Word.CustomProperty オブジェクトのコレクションを格納します。

注釈

[ API セット: WordApi 1.3 ]

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

key

コレクション内の各項目について: カスタム プロパティのキーを取得します。

type

コレクション内の各項目について: カスタム プロパティの値型を取得します。 使用できる値は、文字列、数値、日付、ブール値です。

value

コレクション内の各項目の場合: カスタム プロパティの値を指定します。 Web 上の Word と docx ファイル形式では、これらのプロパティを任意に長くできますが、デスクトップ バージョンの Word では文字列値が 255 16 ビット文字に切り捨てられます (サロゲート ペアを分割することで無効な Unicode が作成される可能性があります)。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

key

コレクション内の各項目について: カスタム プロパティのキーを取得します。

key?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

type

コレクション内の各項目について: カスタム プロパティの値型を取得します。 使用できる値は、文字列、数値、日付、ブール値です。

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

value

コレクション内の各項目の場合: カスタム プロパティの値を指定します。 Web 上の Word と docx ファイル形式では、これらのプロパティを任意に長くできますが、デスクトップ バージョンの Word では文字列値が 255 16 ビット文字に切り捨てられます (サロゲート ペアを分割することで無効な Unicode が作成される可能性があります)。

value?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]