Word.Paragraph class

Referencia

Paquete:: word

Representa un solo párrafo de una selección, intervalo, control de contenido o cuerpo del documento.

Extends: OfficeExtension.ClientObject

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // The collection of paragraphs of the current selection returns the full paragraphs contained in it.
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  paragraph.load("text");

  await context.sync();
  console.log(paragraph.text);
});

Propiedades

alignment	Especifica la alineación de un párrafo. El valor puede ser 'left', 'centered', 'right' o 'justified'.
contentControls	Obtiene la colección de objetos de control de contenido del párrafo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
firstLineIndent	Especifica el valor, en puntos, para una primera línea o sangría colgante. Use un valor positivo para establecer una sangría de primera línea y usar un valor negativo para establecer una sangría francesa.
font	Obtiene el formato de texto del párrafo. Úselo para obtener y establecer el nombre de la fuente, el tamaño, el color y otras propiedades.
inlinePictures	Obtiene la colección de objetos InlinePicture del párrafo. La colección no incluye imágenes flotantes.
leftIndent	Especifica el valor de sangría izquierda, en puntos, para el párrafo.
lineSpacing	Especifica el espaciado de línea, en puntos, para el párrafo especificado. En la interfaz de usuario de Word, este valor se divide entre 12.
lineUnitAfter	Especifica la cantidad de espaciado, en líneas de cuadrícula, después del párrafo.
lineUnitBefore	Especifica la cantidad de espaciado, en líneas de cuadrícula, antes del párrafo.
outlineLevel	Especifica el nivel de esquema del párrafo.
parentContentControl	Obtiene el control de contenido que contiene el párrafo. Produce un `ItemNotFound` error si no hay un control de contenido primario.
rightIndent	Especifica el valor de sangría derecha, en puntos, para el párrafo.
spaceAfter	Especifica el espaciado, en puntos, después del párrafo.
spaceBefore	Especifica el espaciado, en puntos, antes del párrafo.
style	Especifica el nombre de estilo del párrafo. Use esta propiedad para los estilos personalizados y los nombres de estilo localizados. Para usar los estilos integrados portátiles entre configuraciones regionales, consulte la propiedad "styleBuiltIn".
text	Obtiene el texto del párrafo.

Métodos

clear()	Borra el contenido del objeto de párrafo. El usuario puede realizar la operación de deshacer en el contenido borrado.
delete()	Elimina el párrafo y su contenido del documento.
getHtml()	Obtiene una representación HTML del objeto de párrafo. Cuando se representa en una página web o un visor HTML, el formato será una coincidencia cercana, pero no exacta, del formato del documento. Este método no devuelve exactamente el mismo HTML para el mismo documento en distintas plataformas (Windows, Mac, Word en la web, etc.). Si necesita fidelidad exacta o coherencia entre plataformas, use `Paragraph.getOoxml()` y convierta el XML devuelto en HTML.
getOoxml()	Obtiene la representación Office Open XML (OOXML) del objeto de párrafo.
insertBreak(breakType, insertLocation)	Inserta un salto en la ubicación especificada del documento principal.
insertContentControl(contentControlType)	Ajusta el objeto Paragraph con un control de contenido.
insertFileFromBase64(base64File, insertLocation)	Inserta un documento en el párrafo en la ubicación especificada.
insertHtml(html, insertLocation)	Inserta HTML en el párrafo en la ubicación especificada.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Inserta una imagen en el párrafo en la ubicación especificada.
insertOoxml(ooxml, insertLocation)	Inserta OOXML en el párrafo en la ubicación especificada.
insertParagraph(paragraphText, insertLocation)	Inserta un párrafo en la ubicación especificada.
insertText(text, insertLocation)	Inserta texto en el párrafo en la ubicación especificada.
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(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
search(searchText, searchOptions)	Realiza una búsqueda con las SearchOptions especificadas en el ámbito del objeto de párrafo. Los resultados de la búsqueda son una colección de objetos de intervalo.
select(selectionMode)	Selecciona y se desplaza por la interfaz de usuario de Word hasta el párrafo.
select(selectionModeString)	Selecciona y se desplaza por la interfaz de usuario de Word hasta el párrafo.
set(properties, options)	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)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()	Invalida el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto de API a `JSON.stringify()`. (`JSON.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto original `Word.Paragraph` es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Word.Interfaces.ParagraphData`) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()	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.
untrack()	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.

Detalles de las propiedades

alignment

Especifica la alineación de un párrafo. El valor puede ser 'left', 'centered', 'right' o 'justified'.

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Center last paragraph alignment.
  context.document.body.paragraphs.getLast().alignment = "Centered";

  await context.sync();
});

contentControls

Obtiene la colección de objetos de control de contenido del párrafo.

readonly contentControls: Word.ContentControlCollection;

Valor de propiedad

Word.ContentControlCollection

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

firstLineIndent

Especifica el valor, en puntos, para una primera línea o sangría colgante. Use un valor positivo para establecer una sangría de primera línea y usar un valor negativo para establecer una sangría francesa.

firstLineIndent: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

font

Obtiene el formato de texto del párrafo. Úselo para obtener y establecer el nombre de la fuente, el tamaño, el color y otras propiedades.

readonly font: Word.Font;

Valor de propiedad

Word.Font

Comentarios

[ Conjunto de API: WordApi 1.1 ]

inlinePictures

Obtiene la colección de objetos InlinePicture del párrafo. La colección no incluye imágenes flotantes.

readonly inlinePictures: Word.InlinePictureCollection;

Valor de propiedad

Word.InlinePictureCollection

Comentarios

[ Conjunto de API: WordApi 1.1 ]

leftIndent

Especifica el valor de sangría izquierda, en puntos, para el párrafo.

leftIndent: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Indent the first paragraph.
  context.document.body.paragraphs.getFirst().leftIndent = 75; //units = points

  return context.sync();
});

lineSpacing

Especifica el espaciado de línea, en puntos, para el párrafo especificado. En la interfaz de usuario de Word, este valor se divide entre 12.

lineSpacing: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Adjust line spacing.
  context.document.body.paragraphs.getFirst().lineSpacing = 20;

  await context.sync();
});

lineUnitAfter

Especifica la cantidad de espaciado, en líneas de cuadrícula, después del párrafo.

lineUnitAfter: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Set the space (in line units) after the first paragraph.
  context.document.body.paragraphs.getFirst().lineUnitAfter = 1;

  await context.sync();
});

lineUnitBefore

Especifica la cantidad de espaciado, en líneas de cuadrícula, antes del párrafo.

lineUnitBefore: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Set the space (in line units) before the first paragraph.
  context.document.body.paragraphs.getFirst().lineUnitBefore = 1;

  await context.sync();
});

outlineLevel

Especifica el nivel de esquema del párrafo.

outlineLevel: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

parentContentControl

Obtiene el control de contenido que contiene el párrafo. Produce un ItemNotFound error si no hay un control de contenido primario.

readonly parentContentControl: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

[ Conjunto de API: WordApi 1.1 ]

rightIndent

Especifica el valor de sangría derecha, en puntos, para el párrafo.

rightIndent: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

spaceAfter

Especifica el espaciado, en puntos, después del párrafo.

spaceAfter: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Set the space (in points) after the first paragraph.
  context.document.body.paragraphs.getFirst().spaceAfter = 20;

  await context.sync();
});

spaceBefore

Especifica el espaciado, en puntos, antes del párrafo.

spaceBefore: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

style

Especifica el nombre de estilo del párrafo. Use esta propiedad para los estilos personalizados y los nombres de estilo localizados. Para usar los estilos integrados portátiles entre configuraciones regionales, consulte la propiedad "styleBuiltIn".

style: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-use").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body: Word.Body = context.document.body;
    body.clear();
    body.insertParagraph(
      "Do you want to create a solution that extends the functionality of Word? You can use the Office Add-ins platform to extend Word clients running on the web, on a Windows desktop, or on a Mac.",
      "Start"
    );
    const paragraph: Word.Paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

text

Obtiene el texto del párrafo.

readonly text: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // The collection of paragraphs of the current selection returns the full paragraphs contained in it.
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  paragraph.load("text");

  await context.sync();
  console.log(paragraph.text);
});

Detalles del método

clear()

Borra el contenido del objeto de párrafo. El usuario puede realizar la operación de deshacer en el contenido borrado.

clear(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for all of the paragraphs.
    paragraphs.load('style');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to clear the contents of the first paragraph.
    paragraphs.items[0].clear();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Cleared the contents of the first paragraph.');
});

delete()

Elimina el párrafo y su contenido del documento.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the text property for all of the paragraphs.
    paragraphs.load('text');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to delete the first paragraph.
    paragraphs.items[0].delete();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Deleted the first paragraph.');
});

getHtml()

Obtiene una representación HTML del objeto de párrafo. Cuando se representa en una página web o un visor HTML, el formato será una coincidencia cercana, pero no exacta, del formato del documento. Este método no devuelve exactamente el mismo HTML para el mismo documento en distintas plataformas (Windows, Mac, Word en la web, etc.). Si necesita fidelidad exacta o coherencia entre plataformas, use Paragraph.getOoxml() y convierta el XML devuelto en HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for all of the paragraphs.
    paragraphs.load('style');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a set of commands to get the HTML of the first paragraph.
    const html = paragraphs.items[0].getHtml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Paragraph HTML: ' + html.value);
});

getOoxml()

Obtiene la representación Office Open XML (OOXML) del objeto de párrafo.

getOoxml(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    paragraphs.load({select: 'style', top: 2} );

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a set of commands to get the OOXML of the first paragraph.
    const ooxml = paragraphs.items[0].getOoxml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Paragraph OOXML: ' + ooxml.value);
});

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 salto que se va a agregar al documento.

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

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

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to insert a page break after the first paragraph.
    paragraph.insertBreak(Word.BreakType.page, Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted a page break after the paragraph.');
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-line-and-page-breaks.yaml

Word.run(async (context) => {
  context.document.body.paragraphs.getFirst().insertBreak(Word.BreakType.line, "After");

  await context.sync();
  console.log("success");
});

insertContentControl(contentControlType)

Ajusta el objeto Paragraph con un control de contenido.

insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl;

Parámetros

contentControlType: richText | plainText | checkBox | dropDownList | comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"

Opcional. Tipo de control de contenido que se va a insertar. Debe ser "RichText", "PlainText", "CheckBox", "DropDownList" o "ComboBox". El valor predeterminado es "RichText".

Devoluciones

Word.ContentControl

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Nota: El contentControlType parámetro se introdujo en WordApi 1.5. PlainText se agregó compatibilidad en WordApi 1.5. CheckBox se agregó compatibilidad en WordApi 1.7. DropDownList y ComboBox se agregó compatibilidad en WordApi 1.9.

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to wrap the first paragraph in a rich text content control.
    paragraph.insertContentControl();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Wrapped the first paragraph in a content control.');
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml

// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
  let paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.

  await context.sync();

  for (let i = 0; i < paragraphs.items.length; i++) {
    let contentControl = paragraphs.items[i].insertContentControl();
    // For even, tag "even".
    if (i % 2 === 0) {
      contentControl.tag = "even";
    } else {
      contentControl.tag = "odd";
    }
  }
  console.log("Content controls inserted: " + paragraphs.items.length);

  await context.sync();
});

insertFileFromBase64(base64File, insertLocation)

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

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parámetros

base64File: string

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

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obligatorio. El valor debe ser "Replace", "Start" o "End".

Devoluciones

Word.Range

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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 el párrafo en la ubicación especificada.

insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parámetros

html: string

Obligatorio. HTML que se va a insertar en el párrafo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obligatorio. El valor debe ser "Replace", "Start" o "End".

Devoluciones

Word.Range

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to insert HTML content at the end of the first paragraph.
    paragraph.insertHtml('<strong>Inserted HTML.</strong>', Word.InsertLocation.end);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted HTML content at the end of the first paragraph.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Inserta una imagen en el párrafo en la ubicación especificada.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;

Parámetros

base64EncodedImage: string

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

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obligatorio. El valor debe ser "Replace", "Start" o "End".

Devoluciones

Word.InlinePicture

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for all of the paragraphs.
    paragraphs.load('style');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    const b64encodedImg = "iVBORw0KGgoAAAANSUhEUgAAAB4AAAANCAIAAAAxEEnAAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACFSURBVDhPtY1BEoQwDMP6/0+XgIMTBAeYoTqso9Rkx1zG+tNj1H94jgGzeNSjteO5vtQQuG2seO0av8LzGbe3anzRoJ4ybm/VeKEerAEbAUpW4aWQCmrGFWykRzGBCnYy2ha3oAIq2MloW9yCCqhgJ6NtcQsqoIKdjLbFLaiACnYyf2fODbrjZcXfr2F4AAAAAElFTkSuQmCC";

    // Queue a command to insert a base64 encoded image at the beginning of the first paragraph.
    paragraph.insertInlinePictureFromBase64(b64encodedImg, Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Added an image to the first paragraph.');
});

insertOoxml(ooxml, insertLocation)

Inserta OOXML en el párrafo en la ubicación especificada.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parámetros

ooxml: string

Obligatorio. OOXML que se va a insertar en el párrafo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obligatorio. El valor debe ser "Replace", "Start" o "End".

Devoluciones

Word.Range

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

[ Conjunto de API: WordApi 1.1 ]

insertText(text, insertLocation)

Inserta texto en el párrafo en la ubicación especificada.

insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parámetros

text: string

Obligatorio. Texto que se va a insertar.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obligatorio. El valor debe ser "Replace", "Start" o "End".

Devoluciones

Word.Range

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-in-different-locations.yaml

await Word.run(async (context) => {
  // Replace the last paragraph.
  const range: Word.Range = context.document.body.paragraphs.getLast().insertText("Just replaced the last paragraph!", "Replace");
  range.font.highlightColor = "black";
  range.font.color = "white";

  await context.sync();
});

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.ParagraphLoadOptions): Word.Paragraph;

Parámetros

options: Word.Interfaces.ParagraphLoadOptions

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

Devoluciones

Word.Paragraph

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.Paragraph;

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.Paragraph

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.Paragraph;

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.Paragraph

search(searchText, searchOptions)

Realiza una búsqueda con las SearchOptions especificadas en el ámbito del objeto de párrafo. Los resultados de la búsqueda son una colección de objetos de intervalo.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parámetros

searchText: string

Obligatorio. Texto de búsqueda.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Opcional. Opciones de la búsqueda.

Devoluciones

Word.RangeCollection

Comentarios

[ Conjunto de API: WordApi 1.1 ]

select(selectionMode)

Selecciona y se desplaza por la interfaz de usuario de Word hasta el párrafo.

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

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/scroll-to-range.yaml

await Word.run(async (context) => {
  // If select is called with no parameters, it selects the object.
  context.document.body.paragraphs.getLast().select();

  await context.sync();
});

...

await Word.run(async (context) => {
  // Select can be at the start or end of a range; this by definition moves the insertion point without selecting the range.
  context.document.body.paragraphs.getLast().select(Word.SelectionMode.end);

  await context.sync();
});

select(selectionModeString)

Selecciona y se desplaza por la interfaz de usuario de Word hasta el párrafo.

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

[ Conjunto de API: WordApi 1.1 ]

set(properties, options)

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.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties: Word.Interfaces.ParagraphUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options: OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/multiple-property-set.yaml

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  paragraph.set({
    leftIndent: 30,
    font: {
      bold: true,
      color: "red"
    }
  });

  await context.sync();
});

...

await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  const secondParagraph: Word.Paragraph = firstParagraph.getNext();
  firstParagraph.load("text, font/color, font/bold, leftIndent");

  await context.sync();

  secondParagraph.set(firstParagraph);

  await context.sync();
});

set(properties)

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

set(properties: Word.Paragraph): void;

Parámetros

properties: Word.Paragraph

Devoluciones

void

toJSON()

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.Paragraph es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ParagraphData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.ParagraphData;

Devoluciones

Word.Interfaces.ParagraphData

track()

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.Paragraph;

Devoluciones

Word.Paragraph

untrack()

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.Paragraph;

Devoluciones

Word.Paragraph

Compartir a través de

Word.Paragraph class

Comentarios

Ejemplos

Propiedades

Métodos

Detalles de las propiedades

alignment

Valor de propiedad

Comentarios

Ejemplos

contentControls

Valor de propiedad

Comentarios

context

Valor de propiedad

firstLineIndent

Valor de propiedad

Comentarios

font

Valor de propiedad

Comentarios

inlinePictures

Valor de propiedad

Comentarios

leftIndent

Valor de propiedad

Comentarios

Ejemplos

lineSpacing

Valor de propiedad

Comentarios

Ejemplos

lineUnitAfter

Valor de propiedad

Comentarios

Ejemplos

lineUnitBefore

Valor de propiedad

Comentarios

Ejemplos

outlineLevel

Valor de propiedad

Comentarios

parentContentControl

Valor de propiedad

Comentarios

rightIndent

Valor de propiedad

Comentarios

spaceAfter

Valor de propiedad

Comentarios

Ejemplos

spaceBefore

Valor de propiedad

Comentarios

style

Valor de propiedad

Comentarios

Ejemplos

text

Valor de propiedad

Comentarios

Ejemplos

Detalles del método

clear()

Devoluciones

Comentarios

Ejemplos

delete()

Devoluciones

Comentarios

Ejemplos

getHtml()

Devoluciones

Comentarios

Ejemplos

getOoxml()

Devoluciones