Word. Paragraph class

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

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

endnotes

Obtiene la colección de notas al final del párrafo.

readonly endnotes: Word.NoteItemCollection;

Valor de propiedad

Word.NoteItemCollection

Comentarios

[ Conjunto de API: WordApi 1.5 ]

fields

Obtiene la colección de campos del párrafo.

readonly fields: Word.FieldCollection;

Valor de propiedad

Word.FieldCollection

Comentarios

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

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

footnotes

Obtiene la colección de notas al pie del párrafo.

readonly footnotes: Word.NoteItemCollection;

Valor de propiedad

Word.NoteItemCollection

Comentarios

[ Conjunto de API: WordApi 1.5 ]

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

isLastParagraph

Indica el párrafo que es el último dentro de su cuerpo primario.

readonly isLastParagraph: boolean;

Valor de propiedad

boolean

Comentarios

isListItem

Comprueba si el párrafo es un elemento de lista.

readonly isListItem: boolean;

Valor de propiedad

boolean

Comentarios

leftIndent

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

leftIndent: number;

Valor de propiedad

number

Comentarios

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

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

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

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

list

Obtiene la lista a la que pertenece este párrafo. Produce un ItemNotFound error si el párrafo no está en una lista.

readonly list: Word.List;

Valor de propiedad

Word.List

Comentarios

listItem

Obtiene ListItem para el párrafo. Produce un ItemNotFound error si el párrafo no forma parte de una lista.

readonly listItem: Word.ListItem;

Valor de propiedad

Word.ListItem

Comentarios

listItemOrNullObject

Obtiene ListItem para el párrafo. Si el párrafo no forma parte de una lista, 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 listItemOrNullObject: Word.ListItem;

Valor de propiedad

Word.ListItem

Comentarios

listOrNullObject

Obtiene la lista a la que pertenece este párrafo. Si el párrafo no está en una lista, 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 listOrNullObject: Word.List;

Valor de propiedad

Word.List

Comentarios

outlineLevel

Especifica el nivel de esquema del párrafo.

outlineLevel: number;

Valor de propiedad

number

Comentarios

parentBody

Obtiene el cuerpo primario del párrafo.

readonly parentBody: Word.Body;

Valor de propiedad

Word.Body

Comentarios

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

parentContentControlOrNullObject

Obtiene el control de contenido que contiene el párrafo. 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 el párrafo. 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 el párrafo. 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 el párrafo. 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 el párrafo. 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

rightIndent

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

rightIndent: number;

Valor de propiedad

number

Comentarios

spaceAfter

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

spaceAfter: number;

Valor de propiedad

number

Comentarios

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

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

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

styleBuiltIn

Especifica el nombre de estilo integrado para el párrafo. Use esta propiedad para los estilos integrados que son portátiles entre configuraciones regionales. Para usar estilos personalizados o nombres de estilo localizados, consulte la propiedad "style".

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valor de propiedad

Comentarios

Ejemplos

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

await Word.run(async (context) => {
    const paragraph: Word.Paragraph = context.document.body.insertParagraph("Timeline", "End");
    paragraph.styleBuiltIn = "Heading2";
    const paragraph2: Word.Paragraph = context.document.body.insertParagraph("The Services shall commence on July 31, 2015, and shall continue through July 29, 2015.", "End");
    paragraph2.styleBuiltIn = "Normal";
    const paragraph3: Word.Paragraph = context.document.body.insertParagraph("Project Costs by Phase", "End");
    paragraph3.styleBuiltIn = "Heading2";
    // Note a content control with the title of "ProjectCosts" is added. Content will be replaced later.
    const paragraph4: Word.Paragraph = context.document.body.insertParagraph("<Add Project Costs Here>", "End");
    paragraph4.styleBuiltIn = "Normal";
    paragraph4.font.highlightColor = "#FFFF00";
    const contentControl: Word.ContentControl = paragraph4.insertContentControl();
    contentControl.title = "ProjectCosts";
    const paragraph5: Word.Paragraph = context.document.body.insertParagraph("Project Team", "End");
    paragraph5.styleBuiltIn = "Heading2";
    paragraph5.font.highlightColor = "#FFFFFF";
    const paragraph6: Word.Paragraph = context.document.body.insertParagraph("Terms of Work", "End");
    paragraph6.styleBuiltIn = "Heading1";
    const paragraph7: Word.Paragraph = context.document.body.insertParagraph("Contractor shall provide the Services and Deliverable(s) as follows:", "End");
    paragraph7.styleBuiltIn = "Normal";
    const paragraph8: Word.Paragraph = context.document.body.insertParagraph("Out-of-Pocket Expenses / Invoice Procedures", "End");
    paragraph8.styleBuiltIn = "Heading2";
    const paragraph9 : Word.Paragraph= context.document.body.insertParagraph("Client will be invoiced monthly for the consulting services and T&L expenses. Standard Contractor invoicing is assumed to be acceptable. Invoices are due upon receipt. client will be invoiced all costs associated with out-of-pocket expenses (including, without limitation, costs and expenses associated with meals, lodging, local transportation and any other applicable business expenses) listed on the invoice as a separate line item. Reimbursement for out-of-pocket expenses in connection with performance of this SOW, when authorized and up to the limits set forth in this SOW, shall be in accordance with Client's then-current published policies governing travel and associated business expenses, which information shall be provided by the Client Project Manager.", "End");
    paragraph9.styleBuiltIn = "Normal";
    // Insert a page break at the end of the document.
    context.document.body.insertBreak("Page", "End");

    await context.sync();
});

tableNestingLevel

Obtiene el nivel de la tabla del párrafo. Devuelve 0 si el párrafo no está en una tabla.

readonly tableNestingLevel: number;

Valor de propiedad

number

Comentarios

text

Obtiene el texto del párrafo.

readonly text: string;

Valor de propiedad

string

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

uniqueLocalId

Obtiene una cadena que representa el identificador de párrafo en la sesión actual. El identificador está en formato GUID estándar 8-4-4-4-12 sin llaves y difiere entre sesiones y coautores.

readonly uniqueLocalId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.6 ]

Ejemplos

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function paragraphChanged(args: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    const results = [];
    for (let id of args.uniqueLocalIds) {
      let para = context.document.getParagraphByUniqueLocalId(id);
      para.load("uniqueLocalId");

      results.push({ para: para, text: para.getText() });
    }

    await context.sync();

    for (let result of results) {
      console.log(`${args.type}: ID ${result.para.uniqueLocalId}:-`, result.text.value);
    }
  });
}

Detalles del método

attachToList(listId, level)

Permite que el párrafo se una a una lista existente en el nivel especificado. Se produce un error si el párrafo no puede unirse a la lista o si este ya es un elemento de lista.

attachToList(listId: number, level: number): Word.List;

Parámetros

listId: number

Obligatorio. Identificador de una lista existente.

level: number

Obligatorio. Nivel de la lista.

Devoluciones

Word.List

Comentarios

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

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

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

detachFromList()

Mueve este párrafo fuera de la lista, si este es un elemento de lista.

detachFromList(): void;

Devoluciones

void

Comentarios

getAnnotations()

Obtiene las anotaciones establecidas en este objeto Paragraph.

getAnnotations(): Word.AnnotationCollection;

Devoluciones

Word.AnnotationCollection

Comentarios

[ Conjunto de API: WordApi 1.7 ]

getComments()

Obtiene los comentarios asociados al párrafo.

getComments(): Word.CommentCollection;

Devoluciones

Word.CommentCollection

Comentarios

getContentControls(options)

Obtiene los controles de contenido admitidos actualmente en el párrafo.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Parámetros

options: Word.ContentControlOptions

Opcional. Opciones que definen qué controles de contenido se devuelven.

Devoluciones

Word.ContentControlCollection

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Importante: Si se proporcionan tipos específicos en el parámetro options, solo se devuelven los controles de contenido de los tipos admitidos. Tenga en cuenta que se iniciará una excepción en el uso de métodos de un Word genérico. ContentControl que no son relevantes para el tipo específico. Con el tiempo, se pueden admitir tipos adicionales de controles de contenido. Por lo tanto, el complemento debe solicitar y controlar tipos específicos de controles de contenido.

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

Comentarios

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

getNext()

Obtiene el párrafo siguiente. Produce un ItemNotFound error si el párrafo es el último.

getNext(): Word.Paragraph;

Devoluciones

Word.Paragraph

Comentarios

getNextOrNullObject()

Obtiene el párrafo siguiente. Si el párrafo es el último, 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).

getNextOrNullObject(): Word.Paragraph;

Devoluciones

Word.Paragraph

Comentarios

getOoxml()

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

getOoxml(): OfficeExtension.ClientResult<string>;

Devoluciones

Comentarios

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

getPrevious()

Obtiene el párrafo anterior. Produce un ItemNotFound error si el párrafo es el primero.

getPrevious(): Word.Paragraph;

Devoluciones

Word.Paragraph

Comentarios

getPreviousOrNullObject()

Obtiene el párrafo anterior. Si el párrafo es el primero, 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).

getPreviousOrNullObject(): Word.Paragraph;

Devoluciones

Word.Paragraph

Comentarios

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 commands to create a proxy object for the next-to-last paragraph.
    const indexOfLastParagraph = paragraphs.items.length - 1;
    const precedingParagraph = paragraphs.items[indexOfLastParagraph].getPreviousOrNullObject();

    // Queue a command to load the text of the preceding paragraph.
    precedingParagraph.load('text');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (precedingParagraph.isNullObject) {
        console.log('There are no paragraphs before the current one.');
    } else {
        console.log('The preceding paragraph is: ' + precedingParagraph.text);
    }
});

getRange(rangeLocation)

Obtiene el párrafo completo, o el punto de inicio o final del párrafo, como un intervalo.

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

Parámetros

rangeLocation: whole | start | end | after | content | "Whole" | "Start" | "End" | "After" | "Content"

Opcional. La ubicación del intervalo debe ser "Whole", "Start", "End", "After" o "Content".

Devoluciones

Word.Range

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) => {
  // Get the complete sentence (as range) associated with the insertion point.
  const sentences: Word.RangeCollection = context.document
    .getSelection()
    .getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
  sentences.load("$none");
  await context.sync();

  // Expand the range to the end of the paragraph to get all the complete sentences.
  const sentencesToTheEndOfParagraph: Word.RangeCollection = sentences.items[0]
    .getRange()
    .expandTo(
      context.document
        .getSelection()
        .paragraphs.getFirst()
        .getRange(Word.RangeLocation.end)
    )
    .getTextRanges(["."], false /* Don't trim spaces*/);
  sentencesToTheEndOfParagraph.load("text");
  await context.sync();

  for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
    console.log(sentencesToTheEndOfParagraph.items[i].text);
  }
});

getReviewedText(changeTrackingVersion)

Obtiene texto revisado en función de la selección de ChangeTrackingVersion.

getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;

Parámetros

changeTrackingVersion: Word.ChangeTrackingVersion

Opcional. El valor debe ser "Original" o "Current". El valor predeterminado es "Current".

Devoluciones

Comentarios

getReviewedText(changeTrackingVersionString)

Obtiene texto revisado en función de la selección de ChangeTrackingVersion.

getReviewedText(changeTrackingVersionString?: "Original" | "Current"): OfficeExtension.ClientResult<string>;

Parámetros

changeTrackingVersionString: "Original" | "Current"

Opcional. El valor debe ser "Original" o "Current". El valor predeterminado es "Current".

Devoluciones

Comentarios

getText(options)

Devuelve el texto del párrafo. Esto excluye ecuaciones, gráficos (por ejemplo, imágenes, vídeos, dibujos) y caracteres especiales que marcan diverso contenido (por ejemplo, para controles de contenido, campos, comentarios, notas al pie, notas al final). De forma predeterminada, se excluyen el texto oculto y el texto marcados como eliminados.

getText(options?: Word.GetTextOptions | {
            IncludeHiddenText?: boolean;
            IncludeTextMarkedAsDeleted?: boolean;
        }): OfficeExtension.ClientResult<string>;

Parámetros

options: Word.GetTextOptions | { IncludeHiddenText?: boolean; IncludeTextMarkedAsDeleted?: boolean; }

Opcional. Opciones que definen si el resultado final debe incluir texto oculto y texto marcado como eliminado.

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.7 ]

getTextRanges(endingMarks, trimSpacing)

Obtiene los intervalos de texto del párrafo mediante signos de puntuación u otras marcas finales.

getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;

Parámetros

endingMarks: string[]

Obligatorio. Los signos de puntuación y/u otras marcas finales como una matriz de cadenas.

trimSpacing: boolean

Opcional. Indica si se deben recortar los caracteres de espaciado (espacios, tabulaciones, saltos de columna y marcas finales de párrafo) desde el principio y el final de los intervalos devueltos en la colección de intervalos. El valor predeterminado es false, lo que indica que los caracteres de espaciado al principio y al final de los intervalos se incluyen en la colección de intervalos.

Devoluciones

Word.RangeCollection

Comentarios

getTrackedChanges()

Obtiene la colección de los objetos TrackedChange del párrafo.

getTrackedChanges(): Word.TrackedChangeCollection;

Devoluciones

Word.TrackedChangeCollection

Comentarios

[ Conjunto de API: WordApi 1.6 ]

insertAnnotations(annotations)

Inserta anotaciones en este objeto Paragraph.

insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult<string[]>;

Parámetros

annotations: Word.AnnotationSet

Anotaciones que se van a establecer.

Devoluciones

OfficeExtension.ClientResult<string[]>

Matriz de los identificadores de anotaciones insertadas.

Comentarios

[ Conjunto de API: WordApi 1.7 ]

Ejemplos

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

// Adds annotations to the selected paragraph.
await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const options: Word.CritiquePopupOptions = {
    brandingTextResourceId: "PG.TabLabel",
    subtitleResourceId: "PG.HelpCommand.TipTitle",
    titleResourceId: "PG.HelpCommand.Label",
    suggestions: ["suggestion 1", "suggestion 2", "suggestion 3"]
  };
  const critique1: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.red,
    start: 1,
    length: 3,
    popupOptions: options
  };
  const critique2: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.green,
    start: 6,
    length: 1,
    popupOptions: options
  };
  const critique3: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.blue,
    start: 10,
    length: 3,
    popupOptions: options
  };
  const critique4: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.lavender,
    start: 14,
    length: 3,
    popupOptions: options
  };
  const critique5: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.berry,
    start: 18,
    length: 10,
    popupOptions: options
  };
  const annotationSet: Word.AnnotationSet = {
    critiques: [critique1, critique2, critique3, critique4, critique5]
  };

  const annotationIds = paragraph.insertAnnotations(annotationSet);

  await context.sync();

  console.log("Annotations inserted:", annotationIds.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

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

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

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

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

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

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

insertTable(rowCount, columnCount, insertLocation, values)

Inserta una tabla con el número especificado de filas y columnas.

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;

Parámetros

rowCount: number

Obligatorio. Número de filas de la tabla.

columnCount: number

Obligatorio. Número de columnas de la tabla.

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

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

values: string[][]

Matriz 2D opcional. Si se especifican las cadenas correspondientes en la matriz, se rellenan las celdas.

Devoluciones

Word.Table

Comentarios

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

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

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

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

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

split(delimiters, trimDelimiters, trimSpacing)

Divide el párrafo en intervalos secundarios mediante delimitadores.

split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;

Parámetros

delimiters: string[]

Obligatorio. Los delimitadores como una matriz de cadenas.

trimDelimiters: boolean

Opcional. Indica si se deben recortar los delimitadores de los intervalos de la colección de intervalos. El valor predeterminado es false, lo que indica que los delimitadores se incluyen en los intervalos devueltos en la colección de intervalos.

trimSpacing: boolean

Devoluciones

Word.RangeCollection

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/split-words-of-first-paragraph.yaml

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  const words = paragraph.split([" "], true /* trimDelimiters*/, true /* trimSpaces */);
  words.load("text");

  await context.sync();

  for (let i = 0; i < words.items.length; i++) {
    if (i >= 1) {
      words.items[i - 1].font.highlightColor = "#FFFFFF";
    }
    words.items[i].font.highlightColor = "#FFFF00";

    await context.sync();
    await pause(200);
  }
});

startNewList()

Inicia una nueva lista con este párrafo. Se produce un error si el párrafo ya es un elemento de lista.

startNewList(): Word.List;

Devoluciones

Word.List

Comentarios