word package

Clases

Word.Body	Representa el cuerpo de un documento o una sección.
Word.ContentControl	Representa un control de contenido. Los controles de contenido son regiones delimitadas y posiblemente con etiquetas de un documento que funcionan como contenedores para tipos de contenido específicos. Los controles de contenido individuales pueden incluir contenido como imágenes, tablas o párrafos de texto con formato. Actualmente, solo se admiten los controles de contenido de texto enriquecido, texto sin formato y casilla.
Word.ContentControlCollection	Contiene una colección de Word. Objetos ContentControl. Los controles de contenido son regiones delimitadas y posiblemente con etiquetas de un documento que funcionan como contenedores para tipos de contenido específicos. Los controles de contenido individuales pueden incluir contenido como imágenes, tablas o párrafos de texto con formato. Actualmente, solo se admiten controles de contenido de texto enriquecido y texto sin formato.
Word.Document	El objeto Document es el objeto del nivel superior. Un objeto Document contiene una o más secciones, controles de contenido y el cuerpo que contiene el contenido del documento.
Word.Font	Representa una fuente.
Word.InlinePicture	Representa una imagen incorporada.
Word.InlinePictureCollection	Contiene una colección de Word. Objetos InlinePicture.
Word.Paragraph	Representa un solo párrafo de una selección, intervalo, control de contenido o cuerpo del documento.
Word.ParagraphCollection	Contiene una colección de Word. Objetos paragraph.
Word.Range	Representa un área contigua en un documento.
Word.RangeCollection	Contiene una colección de Word. Objetos Range.
Word.RequestContext	El objeto RequestContext facilita las solicitudes a la aplicación Word. Dado que el complemento de Office y la aplicación Word se ejecutan en dos procesos diferentes, el contexto de solicitud es necesario para obtener acceso al modelo de objetos Word desde el complemento.
Word.SearchOptions	Especifica las opciones que se van a incluir en una operación de búsqueda. Para obtener más información sobre cómo usar las opciones de búsqueda en las API de JavaScript de Word, lea Usar opciones de búsqueda para buscar texto en el complemento de Word.
Word.Section	Representa una sección de un documento de Word.
Word.SectionCollection	Contiene la colección del Word del documento. Objetos Section.

Interfaces

Word.Interfaces.AnnotationCollectionData	Interfaz que describe los datos devueltos mediante una llamada a annotationCollection.toJSON().
Word.Interfaces.AnnotationCollectionUpdateData	Interfaz para actualizar datos en el objeto AnnotationCollection, para su uso en annotationCollection.set({ ... }).
Word.Interfaces.AnnotationData	Interfaz que describe los datos devueltos mediante una llamada a annotation.toJSON().
Word.Interfaces.BodyData	Interfaz que describe los datos devueltos mediante una llamada a body.toJSON().
Word.Interfaces.BodyLoadOptions	Representa el cuerpo de un documento o una sección.
Word.Interfaces.BodyUpdateData	Interfaz para actualizar datos en el objeto Body, para su uso en body.set({ ... }).
Word.Interfaces.CheckboxContentControlData	Interfaz que describe los datos devueltos mediante una llamada a checkboxContentControl.toJSON().
Word.Interfaces.CheckboxContentControlUpdateData	Interfaz para actualizar datos en el objeto CheckboxContentControl, para su uso en checkboxContentControl.set({ ... }).
Word.Interfaces.CollectionLoadOptions	Proporciona formas de cargar las propiedades de solo un subconjunto de miembros de una colección.
Word.Interfaces.CommentCollectionData	Interfaz que describe los datos devueltos mediante una llamada a commentCollection.toJSON().
Word.Interfaces.CommentCollectionUpdateData	Interfaz para actualizar datos en el objeto CommentCollection, para su uso en commentCollection.set({ ... }).
Word.Interfaces.CommentContentRangeData	Interfaz que describe los datos devueltos mediante una llamada a commentContentRange.toJSON().
Word.Interfaces.CommentContentRangeUpdateData	Interfaz para actualizar datos en el objeto CommentContentRange, para su uso en commentContentRange.set({ ... }).
Word.Interfaces.CommentData	Interfaz que describe los datos devueltos mediante una llamada a comment.toJSON().
Word.Interfaces.CommentReplyCollectionData	Interfaz que describe los datos devueltos mediante una llamada a commentReplyCollection.toJSON().
Word.Interfaces.CommentReplyCollectionUpdateData	Interfaz para actualizar datos en el objeto CommentReplyCollection, para su uso en commentReplyCollection.set({ ... }).
Word.Interfaces.CommentReplyData	Interfaz que describe los datos devueltos mediante una llamada a commentReply.toJSON().
Word.Interfaces.CommentReplyUpdateData	Interfaz para actualizar datos en el objeto CommentReply, para su uso en commentReply.set({ ... }).
Word.Interfaces.CommentUpdateData	Interfaz para actualizar datos en el objeto Comment, para su uso en comment.set({ ... }).
Word.Interfaces.ContentControlCollectionData	Interfaz que describe los datos devueltos mediante una llamada a contentControlCollection.toJSON().
Word.Interfaces.ContentControlCollectionLoadOptions	Contiene una colección de Word. Objetos ContentControl. Los controles de contenido son regiones delimitadas y posiblemente con etiquetas de un documento que funcionan como contenedores para tipos de contenido específicos. Los controles de contenido individuales pueden incluir contenido como imágenes, tablas o párrafos de texto con formato. Actualmente, solo se admiten controles de contenido de texto enriquecido y texto sin formato.
Word.Interfaces.ContentControlCollectionUpdateData	Interfaz para actualizar datos en el objeto ContentControlCollection, para su uso en contentControlCollection.set({ ... }).
Word.Interfaces.ContentControlData	Interfaz que describe los datos devueltos mediante una llamada a contentControl.toJSON().
Word.Interfaces.ContentControlLoadOptions	Representa un control de contenido. Los controles de contenido son regiones delimitadas y posiblemente con etiquetas de un documento que funcionan como contenedores para tipos de contenido específicos. Los controles de contenido individuales pueden incluir contenido como imágenes, tablas o párrafos de texto con formato. Actualmente, solo se admiten los controles de contenido de texto enriquecido, texto sin formato y casilla.
Word.Interfaces.ContentControlUpdateData	Interfaz para actualizar datos en el objeto ContentControl, para su uso en contentControl.set({ ... }).
Word.Interfaces.CritiqueAnnotationData	Interfaz que describe los datos devueltos mediante una llamada a critiqueAnnotation.toJSON().
Word.Interfaces.CustomPropertyCollectionData	Interfaz que describe los datos devueltos mediante una llamada a customPropertyCollection.toJSON().
Word.Interfaces.CustomPropertyCollectionUpdateData	Interfaz para actualizar datos en el objeto CustomPropertyCollection, para su uso en customPropertyCollection.set({ ... }).
Word.Interfaces.CustomPropertyData	Interfaz que describe los datos devueltos mediante una llamada a customProperty.toJSON().
Word.Interfaces.CustomPropertyUpdateData	Interfaz para actualizar datos en el objeto CustomProperty, para su uso en customProperty.set({ ... }).
Word.Interfaces.CustomXmlPartCollectionData	Interfaz que describe los datos devueltos mediante una llamada a customXmlPartCollection.toJSON().
Word.Interfaces.CustomXmlPartCollectionUpdateData	Interfaz para actualizar datos en el objeto CustomXmlPartCollection, para su uso en customXmlPartCollection.set({ ... }).
Word.Interfaces.CustomXmlPartData	Interfaz que describe los datos devueltos mediante una llamada a customXmlPart.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionData	Interfaz que describe los datos devueltos mediante una llamada a customXmlPartScopedCollection.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData	Interfaz para actualizar datos en el objeto CustomXmlPartScopedCollection, para su uso en customXmlPartScopedCollection.set({ ... }).
Word.Interfaces.DocumentCreatedData	Interfaz que describe los datos devueltos mediante una llamada a documentCreated.toJSON().
Word.Interfaces.DocumentCreatedUpdateData	Interfaz para actualizar datos en el objeto DocumentCreated, para su uso en documentCreated.set({ ... }).
Word.Interfaces.DocumentData	Interfaz que describe los datos devueltos mediante una llamada a document.toJSON().
Word.Interfaces.DocumentLoadOptions	El objeto Document es el objeto del nivel superior. Un objeto Document contiene una o más secciones, controles de contenido y el cuerpo que contiene el contenido del documento.
Word.Interfaces.DocumentPropertiesData	Interfaz que describe los datos devueltos mediante una llamada a documentProperties.toJSON().
Word.Interfaces.DocumentPropertiesUpdateData	Interfaz para actualizar datos en el objeto DocumentProperties, para su uso en documentProperties.set({ ... }).
Word.Interfaces.DocumentUpdateData	Interfaz para actualizar datos en el objeto Document, para su uso en document.set({ ... }).
Word.Interfaces.FieldCollectionData	Interfaz que describe los datos devueltos mediante una llamada a fieldCollection.toJSON().
Word.Interfaces.FieldCollectionUpdateData	Interfaz para actualizar datos en el objeto FieldCollection, para su uso en fieldCollection.set({ ... }).
Word.Interfaces.FieldData	Interfaz que describe los datos devueltos mediante una llamada a field.toJSON().
Word.Interfaces.FieldUpdateData	Interfaz para actualizar datos en el objeto Field, para su uso en field.set({ ... }).
Word.Interfaces.FontData	Interfaz que describe los datos devueltos mediante una llamada a font.toJSON().
Word.Interfaces.FontLoadOptions	Representa una fuente.
Word.Interfaces.FontUpdateData	Interfaz para actualizar datos en el objeto Font, para su uso en font.set({ ... }).
Word.Interfaces.InlinePictureCollectionData	Interfaz que describe los datos devueltos mediante una llamada a inlinePictureCollection.toJSON().
Word.Interfaces.InlinePictureCollectionLoadOptions	Contiene una colección de Word. Objetos InlinePicture.
Word.Interfaces.InlinePictureCollectionUpdateData	Interfaz para actualizar datos en el objeto InlinePictureCollection, para su uso en inlinePictureCollection.set({ ... }).
Word.Interfaces.InlinePictureData	Interfaz que describe los datos devueltos mediante una llamada a inlinePicture.toJSON().
Word.Interfaces.InlinePictureLoadOptions	Representa una imagen incorporada.
Word.Interfaces.InlinePictureUpdateData	Interfaz para actualizar datos en el objeto InlinePicture, para su uso en inlinePicture.set({ ... }).
Word.Interfaces.ListCollectionData	Interfaz que describe los datos devueltos mediante una llamada a listCollection.toJSON().
Word.Interfaces.ListCollectionUpdateData	Interfaz para actualizar datos en el objeto ListCollection, para su uso en listCollection.set({ ... }).
Word.Interfaces.ListData	Interfaz que describe los datos devueltos mediante una llamada a list.toJSON().
Word.Interfaces.ListItemData	Interfaz que describe los datos devueltos mediante una llamada a listItem.toJSON().
Word.Interfaces.ListItemUpdateData	Interfaz para actualizar datos en el objeto ListItem, para su uso en listItem.set({ ... }).
Word.Interfaces.NoteItemCollectionData	Interfaz que describe los datos devueltos mediante una llamada a noteItemCollection.toJSON().
Word.Interfaces.NoteItemCollectionUpdateData	Interfaz para actualizar datos en el objeto NoteItemCollection, para su uso en noteItemCollection.set({ ... }).
Word.Interfaces.NoteItemData	Interfaz que describe los datos devueltos mediante una llamada a noteItem.toJSON().
Word.Interfaces.NoteItemUpdateData	Interfaz para actualizar datos en el objeto NoteItem, para su uso en noteItem.set({ ... }).
Word.Interfaces.ParagraphCollectionData	Interfaz que describe los datos devueltos mediante una llamada a paragraphCollection.toJSON().
Word.Interfaces.ParagraphCollectionLoadOptions	Contiene una colección de Word. Objetos paragraph.
Word.Interfaces.ParagraphCollectionUpdateData	Interfaz para actualizar datos en el objeto ParagraphCollection, para su uso en paragraphCollection.set({ ... }).
Word.Interfaces.ParagraphData	Interfaz que describe los datos devueltos mediante una llamada a paragraph.toJSON().
Word.Interfaces.ParagraphFormatData	Interfaz que describe los datos devueltos mediante una llamada a paragraphFormat.toJSON().
Word.Interfaces.ParagraphFormatUpdateData	Interfaz para actualizar datos en el objeto ParagraphFormat, para su uso en paragraphFormat.set({ ... }).
Word.Interfaces.ParagraphLoadOptions	Representa un solo párrafo de una selección, intervalo, control de contenido o cuerpo del documento.
Word.Interfaces.ParagraphUpdateData	Interfaz para actualizar datos en el objeto Paragraph, para su uso en paragraph.set({ ... }).
Word.Interfaces.RangeCollectionData	Interfaz que describe los datos devueltos mediante una llamada a rangeCollection.toJSON().
Word.Interfaces.RangeCollectionLoadOptions	Contiene una colección de Word. Objetos Range.
Word.Interfaces.RangeCollectionUpdateData	Interfaz para actualizar datos en el objeto RangeCollection, para su uso en rangeCollection.set({ ... }).
Word.Interfaces.RangeData	Interfaz que describe los datos devueltos mediante una llamada a range.toJSON().
Word.Interfaces.RangeLoadOptions	Representa un área contigua en un documento.
Word.Interfaces.RangeUpdateData	Interfaz para actualizar datos en el objeto Range, para su uso en range.set({ ... }).
Word.Interfaces.SearchOptionsData	Interfaz que describe los datos devueltos mediante una llamada a searchOptions.toJSON().
Word.Interfaces.SearchOptionsLoadOptions	Especifica las opciones que se van a incluir en una operación de búsqueda. Para obtener más información sobre cómo usar las opciones de búsqueda en las API de JavaScript de Word, lea Usar opciones de búsqueda para buscar texto en el complemento de Word.
Word.Interfaces.SearchOptionsUpdateData	Interfaz para actualizar datos en el objeto SearchOptions, para su uso en searchOptions.set({ ... }).
Word.Interfaces.SectionCollectionData	Interfaz que describe los datos devueltos mediante una llamada a sectionCollection.toJSON().
Word.Interfaces.SectionCollectionLoadOptions	Contiene la colección del Word del documento. Objetos Section.
Word.Interfaces.SectionCollectionUpdateData	Interfaz para actualizar datos en el objeto SectionCollection, para su uso en sectionCollection.set({ ... }).
Word.Interfaces.SectionData	Interfaz que describe los datos devueltos mediante una llamada a section.toJSON().
Word.Interfaces.SectionLoadOptions	Representa una sección de un documento de Word.
Word.Interfaces.SectionUpdateData	Interfaz para actualizar datos en el objeto Section, para su uso en section.set({ ... }).
Word.Interfaces.SettingCollectionData	Interfaz que describe los datos devueltos mediante una llamada a settingCollection.toJSON().
Word.Interfaces.SettingCollectionUpdateData	Interfaz para actualizar datos en el objeto SettingCollection, para su uso en settingCollection.set({ ... }).
Word.Interfaces.SettingData	Interfaz que describe los datos devueltos mediante una llamada a setting.toJSON().
Word.Interfaces.SettingUpdateData	Interfaz para actualizar datos en el objeto Setting, para su uso en setting.set({ ... }).
Word.Interfaces.ShadingData	Interfaz que describe los datos devueltos mediante una llamada a shading.toJSON().
Word.Interfaces.ShadingUpdateData	Interfaz para actualizar datos en el objeto Shading, para su uso en shading.set({ ... }).
Word.Interfaces.StyleCollectionData	Interfaz que describe los datos devueltos mediante una llamada a styleCollection.toJSON().
Word.Interfaces.StyleCollectionUpdateData	Interfaz para actualizar datos en el objeto StyleCollection, para su uso en styleCollection.set({ ... }).
Word.Interfaces.StyleData	Interfaz que describe los datos devueltos mediante una llamada a style.toJSON().
Word.Interfaces.StyleUpdateData	Interfaz para actualizar datos en el objeto Style, para su uso en style.set({ ... }).
Word.Interfaces.TableBorderData	Interfaz que describe los datos devueltos mediante una llamada a tableBorder.toJSON().
Word.Interfaces.TableBorderUpdateData	Interfaz para actualizar datos en el objeto TableBorder, para su uso en tableBorder.set({ ... }).
Word.Interfaces.TableCellCollectionData	Interfaz que describe los datos devueltos mediante una llamada a tableCellCollection.toJSON().
Word.Interfaces.TableCellCollectionUpdateData	Interfaz para actualizar datos en el objeto TableCellCollection, para su uso en tableCellCollection.set({ ... }).
Word.Interfaces.TableCellData	Interfaz que describe los datos devueltos mediante una llamada a tableCell.toJSON().
Word.Interfaces.TableCellUpdateData	Interfaz para actualizar datos en el objeto TableCell, para su uso en tableCell.set({ ... }).
Word.Interfaces.TableCollectionData	Interfaz que describe los datos devueltos mediante una llamada a tableCollection.toJSON().
Word.Interfaces.TableCollectionUpdateData	Interfaz para actualizar datos en el objeto TableCollection, para su uso en tableCollection.set({ ... }).
Word.Interfaces.TableData	Interfaz que describe los datos devueltos mediante una llamada a table.toJSON().
Word.Interfaces.TableRowCollectionData	Interfaz que describe los datos devueltos mediante una llamada a tableRowCollection.toJSON().
Word.Interfaces.TableRowCollectionUpdateData	Interfaz para actualizar datos en el objeto TableRowCollection, para su uso en tableRowCollection.set({ ... }).
Word.Interfaces.TableRowData	Interfaz que describe los datos devueltos mediante una llamada a tableRow.toJSON().
Word.Interfaces.TableRowUpdateData	Interfaz para actualizar datos en el objeto TableRow, para su uso en tableRow.set({ ... }).
Word.Interfaces.TableStyleData	Interfaz que describe los datos devueltos mediante una llamada a tableStyle.toJSON().
Word.Interfaces.TableStyleUpdateData	Interfaz para actualizar datos en el objeto TableStyle, para su uso en tableStyle.set({ ... }).
Word.Interfaces.TableUpdateData	Interfaz para actualizar datos en el objeto Table, para su uso en table.set({ ... }).
Word.Interfaces.TrackedChangeCollectionData	Interfaz que describe los datos devueltos mediante una llamada a trackedChangeCollection.toJSON().
Word.Interfaces.TrackedChangeCollectionUpdateData	Interfaz para actualizar datos en el objeto TrackedChangeCollection, para su uso en trackedChangeCollection.set({ ... }).
Word.Interfaces.TrackedChangeData	Interfaz que describe los datos devueltos mediante una llamada a trackedChange.toJSON().

Enumeraciones

Word.Alignment
Word.BreakType	Especifica la forma de un salto.
Word.ContentControlAppearance	Apariencia de ContentControl.
Word.ContentControlType	Especifica los tipos y subtipos de control de contenido admitidos.
Word.ErrorCodes
Word.HeaderFooterType
Word.InsertLocation	Tipos de ubicación de inserción.
Word.SaveBehavior	Especifica el comportamiento de guardado de Document.save.
Word.SelectionMode	Esta enumeración establece dónde está el cursor (punto de inserción) del documento después de una selección.
Word.UnderlineType	Estilos admitidos para el formato de subrayado.

Funciones

Word.run(objects, batch)	Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Word mediante requestContext de objetos de API creados anteriormente.
Word.run(object, batch)	Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Word, mediante requestContext de un objeto de API creado anteriormente. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.
Word.run(batch)	Ejecuta un script por lotes que realiza acciones en el modelo de objetos Word mediante un nuevo RequestContext. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

Detalles de la función

Word.run(objects, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Word mediante requestContext de objetos de API creados anteriormente.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Parámetros

objects

OfficeExtension.ClientObject[]

Matriz de objetos de API creados anteriormente. La matriz se validará para asegurarse de que todos los objetos comparten el mismo contexto. El lote usará este RequestContext compartido, lo que significa que cualquier cambio aplicado a estos objetos será recogido por "context.sync()".

batch

(context: Word.RequestContext) => Promise<T>

Función que toma un RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). El parámetro de contexto facilita las solicitudes a la aplicación Word. Dado que el complemento de Office y la aplicación Word se ejecutan en dos procesos diferentes, RequestContext es necesario para obtener acceso al modelo de objetos Word desde el complemento.

Devoluciones

Promise<T>

Word.run(object, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Word, mediante requestContext de un objeto de API creado anteriormente. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Parámetros

object

OfficeExtension.ClientObject

Objeto de API creado anteriormente. El lote usará el mismo RequestContext que el objeto pasado, lo que significa que cualquier cambio aplicado al objeto será recogido por "context.sync()".

batch

(context: Word.RequestContext) => Promise<T>

Función que toma un RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). El parámetro de contexto facilita las solicitudes a la aplicación Word. Dado que el complemento de Office y la aplicación Word se ejecutan en dos procesos diferentes, RequestContext es necesario para obtener acceso al modelo de objetos Word desde el complemento.

Devoluciones

Promise<T>

Word.run(batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos Word mediante un nuevo RequestContext. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Parámetros

batch

(context: Word.RequestContext) => Promise<T>

Función que toma un RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). El parámetro de contexto facilita las solicitudes a la aplicación Word. Dado que el complemento de Office y la aplicación Word se ejecutan en dos procesos diferentes, RequestContext es necesario para obtener acceso al modelo de objetos Word desde el complemento.

Devoluciones

Promise<T>