Word. Inline Picture class

altTextTitle

Especifica uma cadeia de caracteres que contém o título da imagem embutida.

altTextTitle: string;

Valor da propriedade

string

Comentários

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

height

Especifica um número que descreve a altura da imagem embutida.

height: number;

Valor da propriedade

number

Comentários

hyperlink

Especifica um hiperlink na imagem. Use um '#' para separar a parte do endereço da parte de localização opcional.

hyperlink: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

imageFormat

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o formato da imagem embutida.

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

Valor da propriedade

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

Comentários

Exemplos

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

Especifica um valor que indica se a imagem embutida mantém suas proporções originais quando você a redimensiona.

lockAspectRatio: boolean;

Valor da propriedade

boolean

Comentários

paragraph

Obtém o parágrafo pai que inclui a imagem embutida.

readonly paragraph: Word.Paragraph;

Valor da propriedade

Word.Paragraph

Comentários

parentContentControl

Obtém o controle de conteúdo que inclui a imagem embutida. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.

readonly parentContentControl: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

parentContentControlOrNullObject

Obtém o controle de conteúdo que inclui a imagem embutida. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

parentTable

Obtém a tabela que contém a imagem embutida. Gerará um ItemNotFound erro se ele não estiver contido em uma tabela.

readonly parentTable: Word.Table;

Valor da propriedade

Word.Table

Comentários

parentTableCell

Obtém a célula de tabela que contém a imagem embutida. Gerará um ItemNotFound erro se ele não estiver contido em uma célula de tabela.

readonly parentTableCell: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

parentTableCellOrNullObject

Obtém a célula de tabela que contém a imagem embutida. Se ele não estiver contido em uma célula de tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

parentTableOrNullObject

Obtém a tabela que contém a imagem embutida. Se ele não estiver contido em uma tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentTableOrNullObject: Word.Table;

Valor da propriedade

Word.Table

Comentários

width

Especifica um número que descreve a largura da imagem embutida.

width: number;

Valor da propriedade

number

Comentários

Detalhes do método

delete()

Exclui a imagem embutida do documento.

delete(): void;

Retornos

void

Comentários

getBase64ImageSrc()

Obtém a representação de cadeia de caracteres codificada base64 da imagem embutida.

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

Retornos

OfficeExtension.ClientResult<string>

Comentários

Exemplos

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

Obtém a próxima imagem embutida. Gerará um ItemNotFound erro se essa imagem embutida for a última.

getNext(): Word.InlinePicture;

Retornos

Word.InlinePicture

Comentários

Exemplos

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

Obtém a próxima imagem embutida. Se essa imagem embutida for a última, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getNextOrNullObject(): Word.InlinePicture;

Retornos

Word.InlinePicture

Comentários

Exemplos

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

Obtém a imagem, ou então, os pontos inicial ou final da imagem, como um intervalo.

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

Parâmetros

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

Opcional. O local de intervalo deve ser 'Whole', 'Start'ou 'End'.

Retornos

Word.Range

Comentários

insertBreak(breakType, insertLocation)

Insere uma quebra no local especificado no documento principal.

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

Parâmetros

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

Obrigatório. O tipo de interrupção a ser adicionado.

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

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

void

Comentários

insertContentControl()

Quebra a imagem embutida com um controle de conteúdo de rich text.

insertContentControl(): Word.ContentControl;

Retornos

Word.ContentControl

Comentários

insertFileFromBase64(base64File, insertLocation)

Insere um documento no local especificado.

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

Parâmetros

base64File: string

Obrigatório. O conteúdo codificado em Base64 de um arquivo .docx.

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

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

Word.Range

Comentários

Observação: não há suporte para inserção se o documento inserido contiver um controle ActiveX (provavelmente em um campo de formulário). Considere substituir esse campo de formulário por um controle de conteúdo ou outra opção apropriada para seu cenário.

insertHtml(html, insertLocation)

Insere HTML no local especificado.

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

Parâmetros

html: string

Obrigatório. O HTML a ser inserido.

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

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

Word.Range

Comentários

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Insere uma imagem embutida no local especificado.

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

Parâmetros

base64EncodedImage: string

Obrigatório. A imagem codificada base64 a ser inserida.

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

Obrigatório. O valor deve ser 'Replace', 'Before', ou 'After'.

Retornos

Word.InlinePicture

Comentários

insertOoxml(ooxml, insertLocation)

Insere um formato OOXML no local especificado.

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

Parâmetros

ooxml: string

Obrigatório. O formato OOXML a inserir.

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

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

Word.Range

Comentários

insertParagraph(paragraphText, insertLocation)

Insere um parágrafo no local especificado.

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

Parâmetros

paragraphText: string

Obrigatório. O texto do parágrafo a ser inserido.

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

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

Word.Paragraph

Comentários

insertText(text, insertLocation)

Insere um texto no local especificado.

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

Parâmetros

text: string

Obrigatório. Texto a inserir.

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

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

Word.Range

Comentários

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options: Word.Interfaces.InlinePictureLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.InlinePicture

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Word.InlinePicture

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.InlinePicture

select(selectionMode)

Seleciona a imagem embutida. Isso faz com que o Word role até a seleção.

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

Parâmetros

selectionMode: Word.SelectionMode

Opcional. O modo de seleção deve ser 'Select', 'Start' ou 'End'. 'Select' é o padrão.

Retornos

void

Comentários

select(selectionModeString)

Seleciona a imagem embutida. Isso faz com que o Word role até a seleção.

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

Parâmetros

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

Opcional. O modo de seleção deve ser 'Select', 'Start' ou 'End'. 'Select' é o padrão.

Retornos

void

Comentários