Word.Range class

Referencia

Paquete:: word

Representa un área contigua en un documento.

Extends: OfficeExtension.ClientObject

Comentarios

Ejemplos

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

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

Propiedades

contentControls	Obtiene la colección de objetos de control de contenido del intervalo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
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.
inlinePictures	Obtiene la colección de objetos de imagen incorporada del intervalo.
paragraphs	Obtiene la colección de objetos de párrafo en el intervalo.
parentContentControl	Obtiene el control de contenido admitido actualmente que contiene el intervalo. Produce un `ItemNotFound` error si no hay un control de contenido primario.
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".
text	Obtiene el texto del intervalo.

Métodos

clear()	Borra el contenido del objeto de intervalo. El usuario puede realizar la operación de deshacer en el contenido borrado.
delete()	Elimina el intervalo y su contenido del documento.
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.
getOoxml()	Obtiene la representación OOXML del objeto de intervalo.
insertBreak(breakType, insertLocation)	Inserta un salto en la ubicación especificada del documento principal.
insertContentControl(contentControlType)	Ajusta el objeto Range con un control de contenido.
insertFileFromBase64(base64File, insertLocation)	Inserta un documento en la ubicación especificada.
insertHtml(html, insertLocation)	Inserta HTML en la ubicación especificada.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Inserta una imagen en la ubicación especificada.
insertOoxml(ooxml, insertLocation)	Inserta OOXML en la ubicación especificada.
insertParagraph(paragraphText, insertLocation)	Inserta un párrafo en la ubicación especificada.
insertText(text, insertLocation)	Inserta texto en la ubicación especificada.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
search(searchText, searchOptions)	Realiza una búsqueda con las SearchOptions especificadas en el ámbito del objeto range. Los resultados de la búsqueda son una colección de objetos de intervalo.
select(selectionMode)	Selecciona y se desplaza por la interfaz de usuario de Word hasta el intervalo.
select(selectionModeString)	Selecciona y se desplaza por la interfaz de usuario de Word hasta el intervalo.
set(properties, options)	Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()	Invalida el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto de API a `JSON.stringify()`. (`JSON.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto original `Word.Range` es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Word.Interfaces.RangeData`) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()	Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre `.sync` llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
untrack()	Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar `context.sync()` a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

contentControls

Obtiene la colección de objetos de control de contenido del intervalo.

readonly contentControls: Word.ContentControlCollection;

Valor de propiedad

Word.ContentControlCollection

Comentarios

[ Conjunto de API: WordApi 1.1 ]

context

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

context: RequestContext;

Valor de propiedad

Word.RequestContext

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

[ Conjunto de API: WordApi 1.1 ]

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 ]

paragraphs

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

readonly paragraphs: Word.ParagraphCollection;

Valor de propiedad

Word.ParagraphCollection

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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.

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

[ Conjunto de API: WordApi 1.1 ]

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

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

[ Conjunto de API: WordApi 1.1 ]

text

Obtiene el texto del intervalo.

readonly text: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

[ Conjunto de API: WordApi 1.1 ]

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

delete()

Elimina el intervalo y su contenido del documento.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

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

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

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

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

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

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

getOoxml()

Obtiene la representación OOXML del objeto de intervalo.

getOoxml(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Ejemplos

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

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

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

[ Conjunto de API: WordApi 1.1 ]

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

insertContentControl(contentControlType)

Ajusta el objeto Range con un control de contenido.

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

Parámetros

contentControlType: richText | plainText | checkBox | "RichText" | "PlainText" | "CheckBox"

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

Devoluciones

Word.ContentControl

Comentarios

[ Conjunto de API: WordApi 1.1 ]

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

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

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

[ Conjunto de API: WordApi 1.1 ]

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

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

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

[ Conjunto de API: WordApi 1.1 ]

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

[ Conjunto de API: WordApi 1.1 ]

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

[ Conjunto de API: WordApi 1.1 ]

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

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

[ Conjunto de API: WordApi 1.1 ]

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

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

[ Conjunto de API: WordApi 1.1 ]

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

[ Conjunto de API: WordApi 1.1 ]

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

[ Conjunto de API: WordApi 1.1 ]

set(properties, options)

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

set(properties: Interfaces.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

toJSON()

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

toJSON(): Word.Interfaces.RangeData;

Devoluciones

Word.Interfaces.RangeData

track()

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

track(): Word.Range;

Devoluciones

Word.Range

untrack()

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

untrack(): Word.Range;

Devoluciones

Word.Range

Compartir a través de

Word.Range class

Comentarios

Ejemplos

Propiedades

Métodos

Detalles de las propiedades

contentControls

Valor de propiedad

Comentarios

context

Valor de propiedad

font

Valor de propiedad

Comentarios

inlinePictures

Valor de propiedad

Comentarios

paragraphs

Valor de propiedad

Comentarios

parentContentControl

Valor de propiedad

Comentarios

Ejemplos

style

Valor de propiedad

Comentarios

text

Valor de propiedad

Comentarios

Detalles del método

clear()

Devoluciones

Comentarios

Ejemplos

delete()

Devoluciones

Comentarios

Ejemplos

getHtml()

Devoluciones

Comentarios

Ejemplos

getOoxml()

Devoluciones

Comentarios

Ejemplos

insertBreak(breakType, insertLocation)

Parámetros

Devoluciones

Comentarios

Ejemplos

insertContentControl(contentControlType)

Parámetros

Devoluciones

Comentarios

Ejemplos

insertFileFromBase64(base64File, insertLocation)

Parámetros

Devoluciones

Comentarios

Ejemplos

insertHtml(html, insertLocation)

Parámetros

Devoluciones

Comentarios

Ejemplos

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Parámetros

Devoluciones

Comentarios

insertOoxml(ooxml, insertLocation)

Parámetros

Devoluciones

Comentarios

Ejemplos

insertParagraph(paragraphText, insertLocation)

Parámetros

Devoluciones