Word. Range class

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

readonly endnotes: Word.NoteItemCollection;

Valor de propiedad

Word.NoteItemCollection

Comentarios

fields

Obtiene la colección de objetos de campo del intervalo.

readonly fields: Word.FieldCollection;

Valor de propiedad

Word.FieldCollection

Comentarios

font

Obtiene el formato de texto del intervalo. Ú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 intervalo.

readonly footnotes: Word.NoteItemCollection;

Valor de propiedad

Word.NoteItemCollection

Comentarios

Ejemplos

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

// Gets the footnotes in the selected document range.
await Word.run(async (context) => {
  const footnotes: Word.NoteItemCollection = context.document.getSelection().footnotes;
  footnotes.load("length");
  await context.sync();

  console.log("Number of footnotes in the selected range: " + footnotes.items.length);
});

hyperlink

Obtiene el primer hipervínculo del intervalo, o establece un hipervínculo en el intervalo. Todos los hipervínculos del intervalo se eliminan cuando establece un hipervínculo nuevo en el intervalo. Use un '#' para separar la parte de dirección de la parte de ubicación opcional.

hyperlink: string;

Valor de propiedad

string

Comentarios

inlinePictures

Obtiene la colección de objetos de imagen incorporada del intervalo.

readonly inlinePictures: Word.InlinePictureCollection;

Valor de propiedad

Word.InlinePictureCollection

Comentarios

[ Conjunto de API: WordApi 1.2 ]

isEmpty

Comprueba si la longitud del intervalo es cero.

readonly isEmpty: boolean;

Valor de propiedad

boolean

Comentarios

lists

Obtiene la colección de objetos de lista en el intervalo.

readonly lists: Word.ListCollection;

Valor de propiedad

Word.ListCollection

Comentarios

paragraphs

Obtiene la colección de objetos de párrafo en el intervalo.

readonly paragraphs: Word.ParagraphCollection;

Valor de propiedad

Word.ParagraphCollection

Comentarios

Importante: En el caso de los conjuntos de requisitos 1.1 y 1.2, no se devuelven los párrafos de las tablas totalmente contenidos dentro de este intervalo. A partir del conjunto de requisitos 1.3, también se devuelven los párrafos de dichas tablas.

parentBody

Obtiene el cuerpo primario del intervalo.

readonly parentBody: Word.Body;

Valor de propiedad

Word.Body

Comentarios

parentContentControl

Obtiene el control de contenido admitido actualmente que contiene el intervalo. Produce un ItemNotFound error si no hay un control de contenido primario.

readonly parentContentControl: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

Ejemplos

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

// Toggles the isChecked property of the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,checkboxContentControl/isChecked");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,checkboxContentControl/isChecked");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
  console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
  selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
  selectedContentControl.load("id,checkboxContentControl/isChecked");
  await context.sync();

  console.log(
    "isChecked state after:",
    `id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
  );
});

parentContentControlOrNullObject

Obtiene el control de contenido admitido actualmente que contiene el intervalo. 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 intervalo. 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 intervalo. 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 intervalo. 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 intervalo. 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

style

Especifica el nombre de estilo del intervalo. 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

styleBuiltIn

Especifica el nombre de estilo integrado para el intervalo. 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 header: Word.Range = context.document.body.insertText("This is a sample Heading 1 Title!!\n",
        "Start" /*this means at the beginning of the body */);
    header.styleBuiltIn = Word.BuiltInStyleName.heading1;

    await context.sync();
});

tables

Obtiene la colección de objetos de tabla en el intervalo.

readonly tables: Word.TableCollection;

Valor de propiedad

Word.TableCollection

Comentarios

text

Obtiene el texto del intervalo.

readonly text: string;

Valor de propiedad

string

Comentarios

Detalles del método

clear()

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

clear(): void;

Devoluciones

void

Comentarios

OfficeExtension.ClientResult<Word.LocationRelation>

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to clear the contents of the proxy range object.
    range.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 selection (range object)');
});

compareLocationWith(range)

Compara esta ubicación del intervalo con otra ubicación de este.

compareLocationWith(range: Word.Range): OfficeExtension.ClientResult<Word.LocationRelation>;

Parámetros

range: Word.Range

Obligatorio. Intervalo que se va a comparar con este intervalo.

Devoluciones

Comentarios

Ejemplos

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

// Compares the location of one paragraph in relation to another paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("items");

  await context.sync();

  const firstParagraphAsRange: Word.Range = paragraphs.items[0].getRange();
  const secondParagraphAsRange: Word.Range = paragraphs.items[1].getRange();

  const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);

  await context.sync();

  const locationValue: Word.LocationRelation = comparedLocation.value;
  console.log(`Location of the first paragraph in relation to the second paragraph: ${locationValue}`);
});

delete()

Elimina el intervalo 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) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to delete the range object.
    range.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 selection (range object)');
});

expandTo(range)

Devuelve un nuevo intervalo que se extiende desde este intervalo en cualquier dirección para cubrir otro intervalo. Este intervalo no cambia. Produce un ItemNotFound error si los dos intervalos no tienen una unión.

expandTo(range: Word.Range): Word.Range;

Parámetros

range: Word.Range

Obligatorio. Otro rango.

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

expandToOrNullObject(range)

Devuelve un nuevo intervalo que se extiende desde este intervalo en cualquier dirección para cubrir otro intervalo. Este intervalo no cambia. Si los dos intervalos no tienen una unión, 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).

expandToOrNullObject(range: Word.Range): Word.Range;

Parámetros

range: Word.Range

Obligatorio. Otro rango.

Devoluciones

Word.Range

Comentarios

getBookmarks(includeHidden, includeAdjacent)

Obtiene los nombres de todos los marcadores del intervalo o se superponen. Un marcador está oculto si su nombre comienza con el carácter de subrayado.

getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult<string[]>;

Parámetros

includeHidden: boolean

Opcional. Indica si se deben incluir marcadores ocultos. El valor predeterminado es false, lo que indica que se excluyen los marcadores ocultos.

includeAdjacent: boolean

Opcional. Indica si se deben incluir marcadores adyacentes al intervalo. El valor predeterminado es false, lo que indica que se excluyen los marcadores adyacentes.

Devoluciones

OfficeExtension.ClientResult<string[]>

Comentarios

getComments()

Obtiene los comentarios asociados al intervalo.

getComments(): Word.CommentCollection;

Devoluciones

Word.CommentCollection

Comentarios

Ejemplos

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

// Gets the comments in the selected content.
await Word.run(async (context) => {
  const comments: Word.CommentCollection = context.document.getSelection().getComments();

  // Load objects to log in the console.
  comments.load();
  await context.sync();

  console.log("Comments:", comments);
});

getContentControls(options)

Obtiene los controles de contenido admitidos actualmente en el intervalo.

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

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.

Ejemplos

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

// Deletes the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  console.log(`About to delete checkbox content control with id: ${selectedContentControl.id}`);
  selectedContentControl.delete(false);
  await context.sync();

  console.log("Deleted checkbox content control.");
});

getHtml()

Obtiene una representación HTML del objeto de intervalo. 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 Range.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) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the HTML of the current selection.
    const html = range.getHtml();

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

getHyperlinkRanges()

Obtiene intervalos secundarios de hipervínculo dentro del intervalo.

getHyperlinkRanges(): Word.RangeCollection;

Devoluciones

Word.RangeCollection

Comentarios

Ejemplos

await Word.run(async (context) => {
    // Get the entire document body.
    const bodyRange = context.document.body.getRange(Word.RangeLocation.whole);

    // Get all the ranges that only consist of hyperlinks.
    const hyperLinks = bodyRange.getHyperlinkRanges();
    hyperLinks.load("hyperlink");
    await context.sync();

    // Log each hyperlink.
    hyperLinks.items.forEach((linkRange) => {
        console.log(linkRange.hyperlink);
    });
});

getNextTextRange(endingMarks, trimSpacing)

Obtiene el siguiente intervalo de texto mediante signos de puntuación u otras marcas finales. Produce un ItemNotFound error si este intervalo de texto es el último.

getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range;

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 inicio y el final del intervalo devuelto. El valor predeterminado es false, lo que indica que se incluyen los caracteres de espaciado al principio y al final del intervalo.

Devoluciones

Word.Range

Comentarios

getNextTextRangeOrNullObject(endingMarks, trimSpacing)

Obtiene el siguiente intervalo de texto mediante signos de puntuación u otras marcas finales. Si este intervalo de texto 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).

getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Parámetros

endingMarks: string[]

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

trimSpacing: boolean

Devoluciones

Word.Range

Comentarios

getOoxml()

Obtiene la representación OOXML del objeto de intervalo.

getOoxml(): OfficeExtension.ClientResult<string>;

Devoluciones

Comentarios

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the OOXML of the current selection.
    const ooxml = range.getOoxml();

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

getRange(rangeLocation)

Clona el intervalo u obtiene el punto inicial o final del intervalo como un intervalo nuevo.

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/10-content-controls/insert-and-change-dropdown-list-content-control.yaml

// Places a dropdown list content control at the end of the selection.
await Word.run(async (context) => {
  let selection = context.document.getSelection();
  selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.dropDownList);
  await context.sync();

  console.log("Dropdown list content control inserted at the end of the selection.");
});

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

Ejemplos

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

// Gets the reviewed text.
await Word.run(async (context) => {
  const range: Word.Range = context.document.getSelection();
  const before = range.getReviewedText(Word.ChangeTrackingVersion.original);
  const after = range.getReviewedText(Word.ChangeTrackingVersion.current);

  await context.sync();

  console.log("Reviewed text (before):", before.value, "Reviewed text (after):", after.value);
});

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

getTextRanges(endingMarks, trimSpacing)

Obtiene los intervalos secundarios de texto del intervalo 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

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

getTrackedChanges()

Obtiene la colección de los objetos TrackedChange del intervalo.

getTrackedChanges(): Word.TrackedChangeCollection;

Devoluciones

Word.TrackedChangeCollection

Comentarios

[ Conjunto de API: WordApi 1.6 ]

insertBookmark(name)

Inserta un marcador en el intervalo. Si existe un marcador con el mismo nombre en algún lugar, se elimina primero.

insertBookmark(name: string): void;

Parámetros

name: string

Obligatorio. Nombre del marcador que no distingue mayúsculas de minúsculas. Solo se admiten caracteres alfanuméricos y de subrayado. Debe comenzar con una letra, pero si desea etiquetar el marcador como oculto, inicie el nombre con un carácter de subrayado. Los nombres no pueden tener más de 40 caracteres.

Devoluciones

void

Comentarios

Nota: Las condiciones de inserción de un marcador son similares a hacerlo en la interfaz de usuario de Word. Para obtener más información sobre cómo administrar marcadores en la interfaz de usuario de Word, vea Agregar o eliminar marcadores en un documento de Word o mensaje de Outlook.

insertBreak(breakType, insertLocation)

Inserta un salto en la ubicación especificada del documento principal.

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

Parámetros

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

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

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

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

Devoluciones

void

Comentarios

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert a page break after the selected text.
    range.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 selected text.');
});

insertComment(commentText)

Inserte un comentario en el intervalo.

insertComment(commentText: string): Word.Comment;

Parámetros

commentText: string

Obligatorio. Texto del comentario que se va a insertar.

Devoluciones

Word.Comment

comment (objeto)

Comentarios

Ejemplos

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

// Sets a comment on the selected content.
await Word.run(async (context) => {
  const text = $("#comment-text")
    .val()
    .toString();
  const comment: Word.Comment = context.document.getSelection().insertComment(text);

  // Load object to log in the console.
  comment.load();
  await context.sync();

  console.log("Comment inserted:", comment);
});

insertContentControl(contentControlType)

Ajusta el objeto Range 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

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

// Simulates creation of a template. First searches the document for instances of the string "Contractor",
// then changes the format  of each search result,
// then wraps each search result within a content control,
// finally sets a tag and title property on each content control.
await Word.run(async (context) => {
    const results: Word.RangeCollection = context.document.body.search("Contractor");
    results.load("font/bold");

    // Check to make sure these content controls haven't been added yet.
    const customerContentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("customer");
    customerContentControls.load("text");
    await context.sync();

  if (customerContentControls.items.length === 0) {
    for (let i = 0; i < results.items.length; i++) { 
        results.items[i].font.bold = true;
        let cc: Word.ContentControl = results.items[i].insertContentControl();
        cc.tag = "customer";  // This value is used in the next step of this sample.
        cc.title = "Customer Name " + i;
    }
  }
    await context.sync();
});

insertEndnote(insertText)

Inserta una nota al final. La referencia de notas al final se coloca después del intervalo.

insertEndnote(insertText?: string): Word.NoteItem;

Parámetros

insertText: string

Opcional. Texto que se va a insertar en el cuerpo de la nota al final. El valor predeterminado es "".

Devoluciones

Word.NoteItem

Comentarios

insertField(insertLocation, fieldType, text, removeFormatting)

Inserta un campo en la ubicación especificada.

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field;

Parámetros

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatorio. Ubicación relativa al intervalo donde se insertará el campo. El valor debe ser "Replace", "Start", "End", "Before" o "After".

fieldType: Word.FieldType

Opcional. Puede ser cualquier constante FieldType. El valor predeterminado es Empty.

text: string

Opcional. Propiedades o opciones adicionales si es necesario para el tipo de campo especificado.

removeFormatting: boolean

Opcional. true para quitar el formato que se aplica al campo durante las actualizaciones, false de lo contrario. El valor predeterminado es false.

Devoluciones

Word.Field

Comentarios

Importante:

En Word en Windows y Mac, la API admite la inserción y administración de todos los tipos enumerados en Word. FieldType excepto Word.FieldType.others.

En Word en la web, la API admite la inserción y administración de los siguientes tipos de campo.

Word.FieldType.addin
Word.FieldType.date
Word.FieldType.hyperlink
Word.FieldType.toc

Ejemplos

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

// Inserts a Date field before selection.
await Word.run(async (context) => {
  const range: Word.Range = context.document.getSelection().getRange();

  const field: Word.Field = range.insertField(Word.InsertLocation.before, Word.FieldType.date, '\\@ "M/d/yyyy h:mm am/pm"', true);

  field.load("result,code");
  await context.sync();

  if (field.isNullObject) {
    console.log("There are no fields in this document.");
  } else {
    console.log("Code of the field: " + field.code, "Result of the field: " + JSON.stringify(field.result));
  }
});

insertField(insertLocation, fieldTypeString, text, removeFormatting)

Inserta un campo en la ubicación especificada.

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldTypeString?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field;

Parámetros

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatorio. Ubicación relativa al intervalo donde se insertará el campo. El valor debe ser "Replace", "Start", "End", "Before" o "After".

fieldTypeString: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"

Opcional. Puede ser cualquier constante FieldType. El valor predeterminado es Empty.

text: string

Opcional. Propiedades o opciones adicionales si es necesario para el tipo de campo especificado.

removeFormatting: boolean

Opcional. true para quitar el formato que se aplica al campo durante las actualizaciones, false de lo contrario. El valor predeterminado es false.

Devoluciones

Word.Field

Comentarios

Importante:

En Word en Windows y Mac, la API admite la inserción y administración de todos los tipos enumerados en Word. FieldType excepto Word.FieldType.others.

En Word en la web, la API admite la inserción y administración de los siguientes tipos de campo.

Word.FieldType.addin
Word.FieldType.date
Word.FieldType.hyperlink
Word.FieldType.toc

insertFileFromBase64(base64File, insertLocation)

Inserta un documento en la ubicación especificada.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parámetros

base64File: string

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

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

Devoluciones

Word.Range

Comentarios

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

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert base64 encoded .docx at the beginning of the range.
    // You'll need to implement getBase64() to make this work.
    range.insertFileFromBase64(getBase64(), 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 base64 encoded text to the beginning of the range.');
});

insertFootnote(insertText)

Inserta una nota al pie. La referencia al pie se coloca después del intervalo.

insertFootnote(insertText?: string): Word.NoteItem;

Parámetros

insertText: string

Opcional. Texto que se va a insertar en el cuerpo de la nota al pie. El valor predeterminado es "".

Devoluciones

Word.NoteItem

Comentarios

Ejemplos

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

// Sets a footnote on the selected content.
await Word.run(async (context) => {
  const text = $("#input-footnote")
    .val()
    .toString();
  const footnote: Word.NoteItem = context.document.getSelection().insertFootnote(text);
  await context.sync();

  console.log("Inserted footnote.");
});

insertHtml(html, insertLocation)

Inserta HTML en la ubicación especificada.

insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parámetros

html: string

Obligatorio. Html que se va a insertar.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

Devoluciones

Word.Range

Comentarios

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', 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('HTML added to the beginning of the range.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Inserta una imagen en la ubicación especificada.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;

Parámetros

base64EncodedImage: string

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

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

Devoluciones

Word.InlinePicture

Comentarios

[ Conjunto de API: WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

Inserta OOXML en la ubicación especificada.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parámetros

ooxml: string

Obligatorio. OOXML que se va a insertar.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

Devoluciones

Word.Range

Comentarios

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert OOXML in to the beginning of the range.
    range.insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", 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('OOXML added to the beginning of the range.');
});

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

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

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph after the range.
    range.insertParagraph('Content of a new paragraph', 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('Paragraph added to the end of the range.');
});

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 la ubicación especificada.

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parámetros

text: string

Obligatorio. Texto que se va a insertar.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

Devoluciones

Word.Range

Comentarios

Ejemplos

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph at the end of the range.
    range.insertText('New text inserted into the range.', 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('Text added to the end of the range.');
});

intersectWith(range)

Devuelve un intervalo nuevo como la intersección de este intervalo con otro. Este intervalo no cambia. Produce un ItemNotFound error si los dos intervalos no se superponen o son adyacentes.

intersectWith(range: Word.Range): Word.Range;

Parámetros

range: Word.Range

Obligatorio. Otro rango.

Devoluciones

Word.Range

Comentarios

intersectWithOrNullObject(range)

Devuelve un intervalo nuevo como la intersección de este intervalo con otro. Este intervalo no cambia. Si los dos intervalos no se superponen ni son adyacentes, 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).

intersectWithOrNullObject(range: Word.Range): Word.Range;

Parámetros

range: Word.Range

Obligatorio. Otro rango.

Devoluciones

Word.Range

Comentarios

load(options)

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

load(options?: Word.Interfaces.RangeLoadOptions): Word.Range;

Parámetros

options: Word.Interfaces.RangeLoadOptions

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

Devoluciones

Word.Range

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

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

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

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

search(searchText, searchOptions)

Realiza una búsqueda con las SearchOptions especificadas en el ámbito del objeto range. 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 intervalo.

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

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

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);

    // Queue a command to select the HTML that was inserted.
    range.select();

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

select(selectionModeString)

Selecciona y se desplaza por la interfaz de usuario de Word hasta el intervalo.

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

Parámetros

properties: Word.Interfaces.RangeUpdateData

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

set(properties)

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

set(properties: Word.Range): void;

Parámetros

properties: Word.Range

Devoluciones

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

Divide el intervalo en intervalos secundarios mediante delimitadores.

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

Parámetros

delimiters: string[]

Obligatorio. Los delimitadores como una matriz de cadenas.

multiParagraphs: boolean

Opcional. Indica si un intervalo secundario devuelto puede abarcar varios párrafos. El valor predeterminado es false, lo que indica que los límites de párrafo también se usan como delimitadores.

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