Word. Inline Picture class

altTextTitle

Especifica una cadena que contiene el título de la imagen insertada.

altTextTitle: string;

Valor de propiedad

string

Comentarios

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Word.RequestContext

height

Especifica un número que describe el alto de la imagen insertada.

height: number;

Valor de propiedad

number

Comentarios

hyperlink

Especifica un hipervínculo en la imagen. Use un '#' para separar la parte de dirección de la parte de ubicación opcional.

hyperlink: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

imageFormat

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el formato de la imagen insertada.

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

Valor de propiedad

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

Comentarios

Ejemplos

// 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 un valor que indica si la imagen insertada conserva sus proporciones originales al cambiar su tamaño.

lockAspectRatio: boolean;

Valor de propiedad

boolean

Comentarios

paragraph

Obtiene el párrafo primario que contiene la imagen incorporada.

readonly paragraph: Word.Paragraph;

Valor de propiedad

Word.Paragraph

Comentarios

parentContentControl

Obtiene el control de contenido que contiene la imagen incorporada. Produce un ItemNotFound error si no hay un control de contenido primario.

readonly parentContentControl: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

parentContentControlOrNullObject

Obtiene el control de contenido que contiene la imagen incorporada. Si no hay un control de contenido primario, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

parentTable

Obtiene la tabla que contiene la imagen incorporada. Produce un ItemNotFound error si no está incluido en una tabla.

readonly parentTable: Word.Table;

Valor de propiedad

Word.Table

Comentarios

parentTableCell

Obtiene la celda de tabla que contiene la imagen incorporada. Produce un ItemNotFound error si no está contenido en una celda de tabla.

readonly parentTableCell: Word.TableCell;

Valor de propiedad

Word.TableCell

Comentarios

parentTableCellOrNullObject

Obtiene la celda de tabla que contiene la imagen incorporada. Si no está contenido en una celda de tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

readonly parentTableCellOrNullObject: Word.TableCell;

Valor de propiedad

Word.TableCell

Comentarios

parentTableOrNullObject

Obtiene la tabla que contiene la imagen incorporada. Si no está contenido en una tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

readonly parentTableOrNullObject: Word.Table;

Valor de propiedad

Word.Table

Comentarios

width

Especifica un número que describe el ancho de la imagen insertada.

width: number;

Valor de propiedad

number

Comentarios

Detalles del método

delete()

Elimina la imagen incorporada del documento.

delete(): void;

Devoluciones

void

Comentarios

getBase64ImageSrc()

Obtiene la representación de cadena codificada en Base64 de la imagen insertada.

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

Ejemplos

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

Obtiene la siguiente imagen incorporada. Produce un ItemNotFound error si esta imagen insertada es la última.

getNext(): Word.InlinePicture;

Devoluciones

Word.InlinePicture

Comentarios

Ejemplos

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

Obtiene la siguiente imagen incorporada. Si esta imagen insertada es la última, este método devolverá un objeto con su isNullObject propiedad establecida trueen . Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getNextOrNullObject(): Word.InlinePicture;

Devoluciones

Word.InlinePicture

Comentarios

Ejemplos

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

Obtiene la imagen, o el punto de inicio o final de la imagen, como un 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. La ubicación del intervalo debe ser "Whole", "Start" o "End".

Devoluciones

Word.Range

Comentarios

insertBreak(breakType, insertLocation)

Inserta un salto en la ubicación especificada del 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"

Obligatorio. Tipo de interrupción que se va a agregar.

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

Obligatorio. El valor debe ser "Before" o "After".

Devoluciones

void

Comentarios

insertContentControl()

Ajusta la imagen incorporada con un control de contenido de texto enriquecido.

insertContentControl(): Word.ContentControl;

Devoluciones

Word.ContentControl

Comentarios

insertFileFromBase64(base64File, insertLocation)

Inserta un documento en la ubicación especificada.

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

Parámetros

base64File: string

Obligatorio. Contenido codificado en Base64 de un archivo .docx.

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

Obligatorio. El valor debe ser "Before" o "After".

Devoluciones

Word.Range

Comentarios

Nota: La inserción no se admite si el documento que se está insertando contiene un control ActiveX (probablemente en un campo de formulario). Considere la posibilidad de reemplazar este tipo de campo de formulario por un control de contenido u otra opción adecuada para su escenario.

insertHtml(html, insertLocation)

Inserta HTML en la ubicación especificada.

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

Parámetros

html: string

Obligatorio. Html que se va a insertar.

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

Obligatorio. El valor debe ser "Before" o "After".

Devoluciones

Word.Range

Comentarios

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Inserta una imagen incorporada en la ubicación especificada.

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

Parámetros

base64EncodedImage: string

Obligatorio. Imagen codificada en Base64 que se va a insertar.

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

Obligatorio. El valor debe ser "Replace", "Before" o "After".

Devoluciones

Word.InlinePicture

Comentarios

insertOoxml(ooxml, insertLocation)

Inserta OOXML en la ubicación especificada.

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

Parámetros

ooxml: string

Obligatorio. OOXML que se va a insertar.

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

Obligatorio. El valor debe ser "Before" o "After".

Devoluciones

Word.Range

Comentarios

insertParagraph(paragraphText, insertLocation)

Inserta un párrafo en la ubicación especificada.

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

Parámetros

paragraphText: string

Obligatorio. Texto de párrafo que se va a insertar.

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

Obligatorio. El valor debe ser "Before" o "After".

Devoluciones

Word.Paragraph

Comentarios

insertText(text, insertLocation)

Inserta texto en la ubicación especificada.

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

Parámetros

text: string

Obligatorio. Texto que se va a insertar.

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

Obligatorio. El valor debe ser "Before" o "After".

Devoluciones

Word.Range

Comentarios

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options: Word.Interfaces.InlinePictureLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.InlinePicture

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames: string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Word.InlinePicture

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Word.InlinePicture

select(selectionMode)

Selecciona la imagen incorporada. Esto hace que Word se desplace hasta la selección.

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

Parámetros

selectionMode: Word.SelectionMode

Opcional. El modo de selección debe ser "Seleccionar", "Iniciar" o "Finalizar". 'Select' es el valor predeterminado.

Devoluciones

void

Comentarios

select(selectionModeString)

Selecciona la imagen incorporada. Esto hace que Word se desplace hasta la selección.

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

Parámetros

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

Opcional. El modo de selección debe ser "Seleccionar", "Iniciar" o "Finalizar". 'Select' es el valor predeterminado.

Devoluciones

void

Comentarios