Word.InlinePicture class

インライン イメージに関連付けられている代替テキストを表す文字列を指定します。

altTextDescription: string;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

インライン イメージのタイトルを含む文字列を指定します。

altTextTitle: string;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

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

context: RequestContext;

プロパティ値

インライン イメージの高さを表す数値を指定します。

height: number;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

イメージ上のハイパーリンクを指定します。 '#' を使用して、アドレス部分をオプションの場所部分から分離します。

hyperlink: string;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

インライン イメージの形式を取得します。

readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";

プロパティ値

注釈

[ API セット: WordApiDesktop 1.1 ]

例

// 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: Word.InlinePicture = context.document.body.inlinePictures.getFirst();
  firstPicture.load("width, height, imageFormat");

  await context.sync();
  console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`, `Image format: ${firstPicture.imageFormat}`);
  // Get the image encoded as Base64.
  const base64 = firstPicture.getBase64ImageSrc();

  await context.sync();
  console.log(base64.value);
});

インライン イメージのサイズを変更するときに元の比率を保持するかどうかを示す値を指定します。

lockAspectRatio: boolean;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

インライン イメージを含む親段落を取得します。

readonly paragraph: Word.Paragraph;

プロパティ値

注釈

[ API セット: WordApi 1.2 ]

インライン画像を含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 ItemNotFound エラーをスローします。

readonly parentContentControl: Word.ContentControl;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

インライン画像を含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentContentControlOrNullObject: Word.ContentControl;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

インライン イメージを含むテーブルを取得します。 テーブルに含まれていない場合は、 ItemNotFound エラーをスローします。

readonly parentTable: Word.Table;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

インライン イメージを含むテーブルのセルを取得します。 テーブル セルに含まれていない場合は、 ItemNotFound エラーをスローします。

readonly parentTableCell: Word.TableCell;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

インライン イメージを含むテーブルのセルを取得します。 テーブル セルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentTableCellOrNullObject: Word.TableCell;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

インライン イメージを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentTableOrNullObject: Word.Table;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

インライン イメージの幅を表す数値を指定します。

width: number;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

ドキュメントからインライン画像を削除します。

delete(): void;

戻り値

注釈

[ API セット: WordApi 1.2 ]

インライン イメージの Base64 でエンコードされた文字列表現を取得します。

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

戻り値

注釈

[ API セット: WordApi 1.1 ]

例

// 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: Word.InlinePicture = context.document.body.inlinePictures.getFirst();
  firstPicture.load("width, height, imageFormat");

  await context.sync();
  console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`, `Image format: ${firstPicture.imageFormat}`);
  // Get the image encoded as Base64.
  const base64 = firstPicture.getBase64ImageSrc();

  await context.sync();
  console.log(base64.value);
});

次のインライン画像を取得します。 このインライン イメージが最後のイメージである場合は、 ItemNotFound エラーをスローします。

getNext(): Word.InlinePicture;

戻り値

注釈

[ API セット: WordApi 1.3 ]

例

// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the first inline picture.
    const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();

    // Queue a command to load the alternative text title of the picture.
    firstPicture.load('altTextTitle');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (firstPicture.isNullObject) {
        console.log('There are no inline pictures in this document.')
    } else {
        console.log(firstPicture.altTextTitle);
    }
}); 

次のインライン画像を取得します。 このインライン イメージが最後のイメージの場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getNextOrNullObject(): Word.InlinePicture;

戻り値

注釈

[ API セット: WordApi 1.3 ]

例

// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the first inline picture.
    const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();

    // Queue a command to load the alternative text title of the picture.
    firstPicture.load('altTextTitle');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (firstPicture.isNullObject) {
        console.log('There are no inline pictures in this document.')
    } else {
        console.log(firstPicture.altTextTitle);
    }
}); 

範囲として、画像、あるいは画像の開始点または終了点を取得します。

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

メイン文書の指定した位置に、区切りを挿入します。

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

リッチ テキストのコンテンツ コントロールでインライン画像をラップします。

insertContentControl(): Word.ContentControl;

戻り値

注釈

[ API セット: WordApi 1.1 ]

指定した位置に文書を挿入します。

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

注: 挿入するドキュメントに ActiveX コントロールが含まれている場合 (フォーム フィールドの可能性があります)、挿入はサポートされません。 このようなフォーム フィールドを、シナリオに適したコンテンツ コントロールまたはその他のオプションに置き換えることを検討してください。

指定した位置に HTML を挿入します。

insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

指定された位置にインライン画像を挿入します。

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

指定した位置に OOXML を挿入します。

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

指定した位置に、段落を挿入します。

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

指定した位置にテキストを挿入します。

insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

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

load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture;

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

インライン画像を選択します。 その結果、Word は選択範囲にスクロールされます。

select(selectionMode?: Word.SelectionMode): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

インライン画像を選択します。 その結果、Word は選択範囲にスクロールされます。

select(selectionModeString?: "Select" | "Start" | "End"): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.2 ]

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

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

パラメーター

戻り値

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

set(properties: Word.InlinePicture): void;

パラメーター

戻り値

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

toJSON(): Word.Interfaces.InlinePictureData;

戻り値

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

track(): Word.InlinePicture;

戻り値

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

untrack(): Word.InlinePicture;

戻り値