Word.InlinePicture class

Especifica una cadena que representa el texto alternativo asociado a la imagen insertada.

altTextDescription: string;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

altTextTitle: string;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

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

height: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

Comentarios

[ Conjunto de API: WordApiDesktop 1.1 ]

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

Especifica un valor que indica si la imagen insertada conserva sus proporciones originales al cambiar su tamaño.

lockAspectRatio: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

readonly paragraph: Word.Paragraph;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

width: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Elimina la imagen incorporada del documento.

delete(): void;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

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

getNext(): Word.InlinePicture;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

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

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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

insertContentControl(): Word.ContentControl;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Inserta un documento en la ubicación especificada.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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.

Inserta HTML en la ubicación especificada.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

Inserta OOXML en la ubicación especificada.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

Inserta texto en la ubicación especificada.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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

Devoluciones

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

Devoluciones

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

Devoluciones

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

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

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

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.2 ]

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.InlinePicture): void;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.InlinePicture es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.InlinePictureData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.InlinePictureData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.InlinePicture;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.InlinePicture;

Devoluciones