Word. Inline Picture class

altTextTitle

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

altTextTitle: string;

プロパティ値

string

注釈

context

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

context: RequestContext;

プロパティ値

Word.RequestContext

height

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

height: number;

プロパティ値

number

注釈

hyperlink

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

hyperlink: string;

プロパティ値

string

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

imageFormat

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

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

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

プロパティ値

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

注釈

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/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, imageFormat");

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

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

lockAspectRatio

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

lockAspectRatio: boolean;

プロパティ値

boolean

注釈

paragraph

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

readonly paragraph: Word.Paragraph;

プロパティ値

Word.Paragraph

注釈

parentContentControl

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

readonly parentContentControl: Word.ContentControl;

プロパティ値

Word.ContentControl

注釈

parentContentControlOrNullObject

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

readonly parentContentControlOrNullObject: Word.ContentControl;

プロパティ値

Word.ContentControl

注釈

parentTable

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

readonly parentTable: Word.Table;

プロパティ値

Word.Table

注釈

parentTableCell

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

readonly parentTableCell: Word.TableCell;

プロパティ値

Word.TableCell

注釈

parentTableCellOrNullObject

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

readonly parentTableCellOrNullObject: Word.TableCell;

プロパティ値

Word.TableCell

注釈

parentTableOrNullObject

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

readonly parentTableOrNullObject: Word.Table;

プロパティ値

Word.Table

注釈

width

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

width: number;

プロパティ値

number

注釈

メソッドの詳細

delete()

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

delete(): void;

戻り値

void

注釈

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);
});

getNext()

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

getNext(): Word.InlinePicture;

戻り値

Word.InlinePicture

注釈

例

// 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);
    }
});

getNextOrNullObject()

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

getNextOrNullObject(): Word.InlinePicture;

戻り値

Word.InlinePicture

注釈

例

// 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)

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

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

パラメーター

rangeLocation: whole | start | end | "Whole" | "Start" | "End"

オプション。範囲の場所は、'Whole'、'Start'、または 'End' である必要があります。

戻り値

Word.Range

注釈

insertBreak(breakType, insertLocation)

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

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

パラメーター

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

必須です。追加する中断の種類。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

戻り値

void

注釈

insertContentControl()

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

insertContentControl(): Word.ContentControl;

戻り値

Word.ContentControl

注釈

insertFileFromBase64(base64File, insertLocation)

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

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

パラメーター

base64File: string

必須です。 .docx ファイルの Base64 でエンコードされたコンテンツ。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

戻り値

Word.Range

注釈

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

insertHtml(html, insertLocation)

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

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

パラメーター

html: string

必須です。挿入する HTML。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

戻り値

Word.Range

注釈

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

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

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

パラメーター

base64EncodedImage: string

必須です。挿入する Base64 でエンコードされたイメージ。

insertLocation: replace | before | after | "Replace" | "Before" | "After"

必須です。値は、'Replace'、'Before'、または 'After' である必要があります。

戻り値

Word.InlinePicture

注釈

insertOoxml(ooxml, insertLocation)

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

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

パラメーター

ooxml: string

必須です。挿入する OOXML を指定します。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

戻り値

Word.Range

注釈

insertParagraph(paragraphText, insertLocation)

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

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

パラメーター

paragraphText: string

必須です。挿入する段落テキスト。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

戻り値

Word.Paragraph

注釈

insertText(text, insertLocation)

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

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

パラメーター

text: string

必須です。挿入するテキスト。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

戻り値

Word.Range

注釈

load(options)

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

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

パラメーター

options: Word.Interfaces.InlinePictureLoadOptions

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

戻り値

Word.InlinePicture

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

Word.InlinePicture

load(propertyNamesAndPaths)

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

パラメーター

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

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

戻り値

Word.InlinePicture

select(selectionMode)

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

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

パラメーター

selectionMode: Word.SelectionMode

オプション。選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。

戻り値

void

注釈

select(selectionModeString)

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

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

パラメーター

selectionModeString: "Select" | "Start" | "End"

オプション。選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。

戻り値

void

注釈