Word.InlinePicture class
インライン画像を表します。
- Extends
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml
// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
context.document.body.paragraphs
.getLast()
.insertParagraph("", "After")
.insertInlinePictureFromBase64(base64Image, "End");
await context.sync();
});
プロパティ
| alt |
インライン イメージに関連付けられている代替テキストを表す文字列を指定します。 |
| alt |
インライン イメージのタイトルを含む文字列を指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| height | インライン イメージの高さを表す数値を指定します。 |
| hyperlink | イメージ上のハイパーリンクを指定します。 '#' を使用して、アドレス部分をオプションの場所部分から分離します。 |
| lock |
インライン イメージのサイズを変更するときに元の比率を保持するかどうかを示す値を指定します。 |
| parent |
インライン画像を含むコンテンツ コントロールを取得します。 |
| width | インライン イメージの幅を表す数値を指定します。 |
メソッド
| get |
インライン イメージの Base64 でエンコードされた文字列表現を取得します。 |
| insert |
リッチ テキストのコンテンツ コントロールでインライン画像をラップします。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを呼び出しで |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に を呼び出す |
プロパティの詳細
altTextDescription
インライン イメージに関連付けられている代替テキストを表す文字列を指定します。
altTextDescription: string;プロパティ値
string
注釈
altTextTitle
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
height
hyperlink
イメージ上のハイパーリンクを指定します。 '#' を使用して、アドレス部分をオプションの場所部分から分離します。
hyperlink: string;プロパティ値
string
注釈
lockAspectRatio
インライン イメージのサイズを変更するときに元の比率を保持するかどうかを示す値を指定します。
lockAspectRatio: boolean;プロパティ値
boolean
注釈
parentContentControl
インライン画像を含むコンテンツ コントロールを取得します。 ItemNotFound親コンテンツ コントロールがない場合は、エラーをスローします。
readonly parentContentControl: Word.ContentControl;プロパティ値
注釈
width
メソッドの詳細
getBase64ImageSrc()
インライン イメージの Base64 でエンコードされた文字列表現を取得します。
getBase64ImageSrc(): OfficeExtension.ClientResult<string>;戻り値
OfficeExtension.ClientResult<string>
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml
// Gets the first image in the document.
await Word.run(async (context) => {
const firstPicture = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`);
// Get the image encoded as Base64.
const base64 = firstPicture.getBase64ImageSrc();
await context.sync();
console.log(base64.value);
});
insertContentControl()
リッチ テキストのコンテンツ コントロールでインライン画像をラップします。
insertContentControl(): Word.ContentControl;戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.InlinePicture;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.InlinePicture;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.InlinePictureUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.InlinePicture): void;パラメーター
- properties
- Word.InlinePicture
戻り値
void
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出toJSONします)。一方、元のWord。InlinePicture オブジェクトは API オブジェクトです。メソッドは、元のtoJSONオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (としてWord.Interfaces.InlinePictureData型指定) を返します。
toJSON(): Word.Interfaces.InlinePictureData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを呼び出しで .sync 使用していて、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.InlinePicture;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に を呼び出す context.sync() 必要があります。
untrack(): Word.InlinePicture;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示