Word.BuildingBlock class
テンプレートの文書パーツを表します。 文書パーツとは、オートテキストに似た、あらかじめ作成されたコンテンツで、テキスト、画像、形式などを含むことがあります。
- Extends
注釈
使用元
- Word.BuildingBlockCollection: add, getItemAt
- Word.BuildingBlockEntryCollection: add, getItemAt
- Word.BuildingBlockGalleryContentControl: placeholderText
- Word.ContentControlPlaceholderOptions: buildingBlock
- Word.DatePickerContentControl: placeholderText
- Word.GroupContentControl: placeholderText
- Word.PictureContentControl: placeholderText
- Word.RepeatingSectionContentControl: placeholderText
プロパティ
| category | 文書パーツのカテゴリを表す |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| description | 文書パーツの説明を指定します。 |
| id | 文書パーツの内部 ID 番号を返します。 |
| index | コレクション内のこの文書パーツの位置を返します。 |
| insert |
文書パーツの内容をドキュメントに挿入する方法を表す |
| name | 文書パーツの名前を指定します。 |
| type | ビルディング ブロックの型を表す |
| value | 文書パーツの内容を指定します。 |
メソッド
| delete() | 文書パーツを削除します。 |
| insert(range, rich |
文書内の文書ブロックの値を挿入し、文書内の文書ブロックの内容を表す |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
category
文書パーツのカテゴリを表す BuildingBlockCategory オブジェクトを返します。
readonly category: Word.BuildingBlockCategory;プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
description
id
index
insertType
文書パーツの内容をドキュメントに挿入する方法を表す DocPartInsertType 値を指定します。
insertType: Word.DocPartInsertType | "Content" | "Paragraph" | "Page";プロパティ値
Word.DocPartInsertType | "Content" | "Paragraph" | "Page"
注釈
name
type
ビルディング ブロックの型を表す BuildingBlockTypeItem オブジェクトを返します。
readonly type: Word.BuildingBlockTypeItem;プロパティ値
注釈
value
メソッドの詳細
delete()
insert(range, richText)
文書内の文書ブロックの値を挿入し、文書内の文書ブロックの内容を表す Range オブジェクトを返します。
insert(range: Word.Range, richText: boolean): Word.Range;パラメーター
- range
- Word.Range
文書パーツを挿入する範囲。
- richText
-
boolean
リッチ テキストとして挿入するかどうかを指定します。
返品
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.BuildingBlockLoadOptions): Word.BuildingBlock;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.BuildingBlock;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.BuildingBlock;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.BuildingBlockUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.BuildingBlockUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.BuildingBlock): void;パラメーター
- properties
- Word.BuildingBlock
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.BuildingBlock オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.BuildingBlockData と型指定) を返します。
toJSON(): Word.Interfaces.BuildingBlockData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.BuildingBlock;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.BuildingBlock;