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 |
Word.Interfaces.AnnotationCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.AnnotationData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.BodyData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.BodyLoadOptions |
Representa el cuerpo de un documento o una sección. |
Word.Interfaces.BodyUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.BorderCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.BorderCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.BorderData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.BorderUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CheckboxContentControlData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CheckboxContentControlUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CollectionLoadOptions |
Proporciona formas de cargar las propiedades de solo un subconjunto de miembros de una colección. |
Word.Interfaces.ComboBoxContentControlData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CommentCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CommentCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CommentContentRangeData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CommentContentRangeUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CommentData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CommentReplyCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CommentReplyCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CommentReplyData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CommentReplyUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CommentUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ContentControlCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
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 |
Word.Interfaces.ContentControlData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ContentControlListItemCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ContentControlListItemCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ContentControlListItemData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ContentControlListItemUpdateData |
Interfaz para actualizar datos en el |
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 |
Word.Interfaces.CritiqueAnnotationData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CustomPropertyCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CustomPropertyCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CustomPropertyData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CustomPropertyUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CustomXmlPartCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.CustomXmlPartData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CustomXmlPartScopedCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.DocumentCreatedData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.DocumentCreatedUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.DocumentData |
Interfaz que describe los datos devueltos mediante una llamada a |
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 |
Word.Interfaces.DocumentPropertiesUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.DocumentUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.DropDownListContentControlData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.FieldCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.FieldCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.FieldData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.FieldUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.FontData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.FontLoadOptions |
Representa una fuente. |
Word.Interfaces.FontUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.InlinePictureCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.InlinePictureCollectionLoadOptions |
Contiene una colección de Word. Objetos InlinePicture. |
Word.Interfaces.InlinePictureCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.InlinePictureData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.InlinePictureLoadOptions |
Representa una imagen incorporada. |
Word.Interfaces.InlinePictureUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ListCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ListCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ListData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ListItemData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ListItemUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ListLevelCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ListLevelCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ListLevelData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ListLevelUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ListTemplateData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ListTemplateUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.NoteItemCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.NoteItemCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.NoteItemData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.NoteItemUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ParagraphCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ParagraphCollectionLoadOptions |
Contiene una colección de Word. Objetos paragraph. |
Word.Interfaces.ParagraphCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ParagraphData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ParagraphFormatData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ParagraphFormatUpdateData |
Interfaz para actualizar datos en el |
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 |
Word.Interfaces.RangeCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.RangeCollectionLoadOptions |
Contiene una colección de Word. Objetos Range. |
Word.Interfaces.RangeCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.RangeData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.RangeLoadOptions |
Representa un área contigua en un documento. |
Word.Interfaces.RangeUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.SearchOptionsData |
Interfaz que describe los datos devueltos mediante una llamada a |
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 |
Word.Interfaces.SectionCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.SectionCollectionLoadOptions |
Contiene la colección del Word del documento. Objetos Section. |
Word.Interfaces.SectionCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.SectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.SectionLoadOptions |
Representa una sección de un documento de Word. |
Word.Interfaces.SectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.SettingCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.SettingCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.SettingData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.SettingUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.ShadingData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.ShadingUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.StyleCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.StyleCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.StyleData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.StyleUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableBorderData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableBorderUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableCellCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableCellCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableCellData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableCellUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableRowCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableRowCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableRowData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableRowUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableStyleData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TableStyleUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TableUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TrackedChangeCollectionData |
Interfaz que describe los datos devueltos mediante una llamada a |
Word.Interfaces.TrackedChangeCollectionUpdateData |
Interfaz para actualizar datos en el |
Word.Interfaces.TrackedChangeData |
Interfaz que describe los datos devueltos mediante una llamada a |
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 |
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. |
Ejecuta un script por lotes que realiza acciones en el modelo de objetos de Word mediante requestContext de objetos de API creados anteriormente. |
Word. |
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. |
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
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>