word package

Classes

Word.Body	Representa o corpo de um documento ou de uma seção.
Word.ContentControl	Representa um controle de conteúdo. Controles de conteúdo são regiões limitadas e possivelmente rotuladas de um documento, que servem como contêineres para tipos específicos de conteúdo. Os controles de conteúdo individuais podem incluir conteúdo, como imagens, tabelas ou parágrafos de texto formatado. Atualmente, há suporte apenas para controles de conteúdo de texto, texto sem formatação e caixa de seleção.
Word.ContentControlCollection	Contém uma coleção de Word. Objetos ContentControl. Os controles de conteúdo são regiões associadas e potencialmente rotuladas em um documento que servem como contêineres para tipos específicos de conteúdo. Os controles de conteúdo individuais podem incluir conteúdo, como imagens, tabelas ou parágrafos de texto formatado. Atualmente, há suporte apenas para controles de conteúdo de texto e texto simples.
Word.Document	O objeto Document é o objeto de nível superior. Um objeto Document contém uma ou mais seções, controles de conteúdo e o corpo que inclui o conteúdo do documento.
Word.Font	Representa uma fonte.
Word.InlinePicture	Representa uma imagem embutida.
Word.InlinePictureCollection	Contém uma coleção de Word. Objetos InlinePicture.
Word.Paragraph	Representa um único parágrafo em uma seleção, intervalo, controle de conteúdo ou corpo do documento.
Word.ParagraphCollection	Contém uma coleção de Word. Objetos de parágrafo.
Word.Range	Representa uma área contígua em um documento.
Word.RangeCollection	Contém uma coleção de Word. Objetos range.
Word.RequestContext	O objeto RequestContext facilita solicitações para o aplicativo Word. Como o suplemento do Office e o aplicativo Word são executados em dois processos diferentes, o contexto de solicitação é necessário para obter acesso ao modelo de objeto Word do suplemento.
Word.SearchOptions	Especifica as opções a serem incluídas em uma operação de pesquisa. Para saber mais sobre como usar opções de pesquisa nas APIs JavaScript Word, leia Usar opções de pesquisa para encontrar texto no suplemento Word.
Word.Section	Representa uma seção em um documento do Word.
Word.SectionCollection	Contém a coleção do Word do documento. Objetos de seção.

Interfaces

Word.Interfaces.AnnotationCollectionData	Uma interface que descreve os dados retornados chamando annotationCollection.toJSON().
Word.Interfaces.AnnotationCollectionUpdateData	Uma interface para atualizar dados no objeto AnnotationCollection, para uso em annotationCollection.set({ ... }).
Word.Interfaces.AnnotationData	Uma interface que descreve os dados retornados chamando annotation.toJSON().
Word.Interfaces.BodyData	Uma interface que descreve os dados retornados chamando body.toJSON().
Word.Interfaces.BodyLoadOptions	Representa o corpo de um documento ou de uma seção.
Word.Interfaces.BodyUpdateData	Uma interface para atualizar dados no objeto Body, para uso em body.set({ ... }).
Word.Interfaces.CheckboxContentControlData	Uma interface que descreve os dados retornados chamando checkboxContentControl.toJSON().
Word.Interfaces.CheckboxContentControlUpdateData	Uma interface para atualizar dados no objeto CheckboxContentControl, para uso em checkboxContentControl.set({ ... }).
Word.Interfaces.CollectionLoadOptions	Fornece maneiras de carregar propriedades de apenas um subconjunto de membros de uma coleção.
Word.Interfaces.CommentCollectionData	Uma interface que descreve os dados retornados chamando commentCollection.toJSON().
Word.Interfaces.CommentCollectionUpdateData	Uma interface para atualizar dados no objeto CommentCollection, para uso em commentCollection.set({ ... }).
Word.Interfaces.CommentContentRangeData	Uma interface que descreve os dados retornados chamando commentContentRange.toJSON().
Word.Interfaces.CommentContentRangeUpdateData	Uma interface para atualizar dados no objeto CommentContentRange, para uso em commentContentRange.set({ ... }).
Word.Interfaces.CommentData	Uma interface que descreve os dados retornados chamando comment.toJSON().
Word.Interfaces.CommentReplyCollectionData	Uma interface que descreve os dados retornados chamando commentReplyCollection.toJSON().
Word.Interfaces.CommentReplyCollectionUpdateData	Uma interface para atualizar dados no objeto CommentReplyCollection, para uso em commentReplyCollection.set({ ... }).
Word.Interfaces.CommentReplyData	Uma interface que descreve os dados retornados chamando commentReply.toJSON().
Word.Interfaces.CommentReplyUpdateData	Uma interface para atualizar dados no objeto CommentReply, para uso em commentReply.set({ ... }).
Word.Interfaces.CommentUpdateData	Uma interface para atualizar dados no objeto Comment, para uso em comment.set({ ... }).
Word.Interfaces.ContentControlCollectionData	Uma interface que descreve os dados retornados chamando contentControlCollection.toJSON().
Word.Interfaces.ContentControlCollectionLoadOptions	Contém uma coleção de Word. Objetos ContentControl. Os controles de conteúdo são regiões associadas e potencialmente rotuladas em um documento que servem como contêineres para tipos específicos de conteúdo. Os controles de conteúdo individuais podem incluir conteúdo, como imagens, tabelas ou parágrafos de texto formatado. Atualmente, há suporte apenas para controles de conteúdo de texto e texto simples.
Word.Interfaces.ContentControlCollectionUpdateData	Uma interface para atualizar dados no objeto ContentControlCollection, para uso em contentControlCollection.set({ ... }).
Word.Interfaces.ContentControlData	Uma interface que descreve os dados retornados chamando contentControl.toJSON().
Word.Interfaces.ContentControlLoadOptions	Representa um controle de conteúdo. Controles de conteúdo são regiões limitadas e possivelmente rotuladas de um documento, que servem como contêineres para tipos específicos de conteúdo. Os controles de conteúdo individuais podem incluir conteúdo, como imagens, tabelas ou parágrafos de texto formatado. Atualmente, há suporte apenas para controles de conteúdo de texto, texto sem formatação e caixa de seleção.
Word.Interfaces.ContentControlUpdateData	Uma interface para atualizar dados no objeto ContentControl, para uso em contentControl.set({ ... }).
Word.Interfaces.CritiqueAnnotationData	Uma interface que descreve os dados retornados chamando critiqueAnnotation.toJSON().
Word.Interfaces.CustomPropertyCollectionData	Uma interface que descreve os dados retornados chamando customPropertyCollection.toJSON().
Word.Interfaces.CustomPropertyCollectionUpdateData	Uma interface para atualizar dados no objeto CustomPropertyCollection, para uso em customPropertyCollection.set({ ... }).
Word.Interfaces.CustomPropertyData	Uma interface que descreve os dados retornados chamando customProperty.toJSON().
Word.Interfaces.CustomPropertyUpdateData	Uma interface para atualizar dados no objeto CustomProperty, para uso em customProperty.set({ ... }).
Word.Interfaces.CustomXmlPartCollectionData	Uma interface que descreve os dados retornados chamando customXmlPartCollection.toJSON().
Word.Interfaces.CustomXmlPartCollectionUpdateData	Uma interface para atualizar dados no objeto CustomXmlPartCollection, para uso em customXmlPartCollection.set({ ... }).
Word.Interfaces.CustomXmlPartData	Uma interface que descreve os dados retornados chamando customXmlPart.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionData	Uma interface que descreve os dados retornados chamando customXmlPartScopedCollection.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData	Uma interface para atualizar dados no objeto CustomXmlPartScopedCollection, para uso em customXmlPartScopedCollection.set({ ... }).
Word.Interfaces.DocumentCreatedData	Uma interface que descreve os dados retornados chamando documentCreated.toJSON().
Word.Interfaces.DocumentCreatedUpdateData	Uma interface para atualizar dados no objeto DocumentCreated, para uso em documentCreated.set({ ... }).
Word.Interfaces.DocumentData	Uma interface que descreve os dados retornados chamando document.toJSON().
Word.Interfaces.DocumentLoadOptions	O objeto Document é o objeto de nível superior. Um objeto Document contém uma ou mais seções, controles de conteúdo e o corpo que inclui o conteúdo do documento.
Word.Interfaces.DocumentPropertiesData	Uma interface que descreve os dados retornados chamando documentProperties.toJSON().
Word.Interfaces.DocumentPropertiesUpdateData	Uma interface para atualizar dados no objeto DocumentProperties, para uso em documentProperties.set({ ... }).
Word.Interfaces.DocumentUpdateData	Uma interface para atualizar dados no objeto Document, para uso em document.set({ ... }).
Word.Interfaces.FieldCollectionData	Uma interface que descreve os dados retornados chamando fieldCollection.toJSON().
Word.Interfaces.FieldCollectionUpdateData	Uma interface para atualizar dados no objeto FieldCollection, para uso em fieldCollection.set({ ... }).
Word.Interfaces.FieldData	Uma interface que descreve os dados retornados chamando field.toJSON().
Word.Interfaces.FieldUpdateData	Uma interface para atualizar dados no objeto Field, para uso em field.set({ ... }).
Word.Interfaces.FontData	Uma interface que descreve os dados retornados chamando font.toJSON().
Word.Interfaces.FontLoadOptions	Representa uma fonte.
Word.Interfaces.FontUpdateData	Uma interface para atualizar dados no objeto Font, para uso em font.set({ ... }).
Word.Interfaces.InlinePictureCollectionData	Uma interface que descreve os dados retornados chamando inlinePictureCollection.toJSON().
Word.Interfaces.InlinePictureCollectionLoadOptions	Contém uma coleção de Word. Objetos InlinePicture.
Word.Interfaces.InlinePictureCollectionUpdateData	Uma interface para atualizar dados no objeto InlinePictureCollection, para uso em inlinePictureCollection.set({ ... }).
Word.Interfaces.InlinePictureData	Uma interface que descreve os dados retornados chamando inlinePicture.toJSON().
Word.Interfaces.InlinePictureLoadOptions	Representa uma imagem embutida.
Word.Interfaces.InlinePictureUpdateData	Uma interface para atualizar dados no objeto InlinePicture, para uso em inlinePicture.set({ ... }).
Word.Interfaces.ListCollectionData	Uma interface que descreve os dados retornados chamando listCollection.toJSON().
Word.Interfaces.ListCollectionUpdateData	Uma interface para atualizar dados no objeto ListCollection, para uso em listCollection.set({ ... }).
Word.Interfaces.ListData	Uma interface que descreve os dados retornados chamando list.toJSON().
Word.Interfaces.ListItemData	Uma interface que descreve os dados retornados chamando listItem.toJSON().
Word.Interfaces.ListItemUpdateData	Uma interface para atualizar dados no objeto ListItem, para uso em listItem.set({ ... }).
Word.Interfaces.NoteItemCollectionData	Uma interface que descreve os dados retornados chamando noteItemCollection.toJSON().
Word.Interfaces.NoteItemCollectionUpdateData	Uma interface para atualizar dados no objeto NoteItemCollection, para uso em noteItemCollection.set({ ... }).
Word.Interfaces.NoteItemData	Uma interface que descreve os dados retornados chamando noteItem.toJSON().
Word.Interfaces.NoteItemUpdateData	Uma interface para atualizar dados no objeto NoteItem, para uso em noteItem.set({ ... }).
Word.Interfaces.ParagraphCollectionData	Uma interface que descreve os dados retornados chamando paragraphCollection.toJSON().
Word.Interfaces.ParagraphCollectionLoadOptions	Contém uma coleção de Word. Objetos de parágrafo.
Word.Interfaces.ParagraphCollectionUpdateData	Uma interface para atualizar dados no objeto ParagraphCollection, para uso em paragraphCollection.set({ ... }).
Word.Interfaces.ParagraphData	Uma interface que descreve os dados retornados chamando paragraph.toJSON().
Word.Interfaces.ParagraphFormatData	Uma interface que descreve os dados retornados chamando paragraphFormat.toJSON().
Word.Interfaces.ParagraphFormatUpdateData	Uma interface para atualizar dados no objeto ParagraphFormat, para uso em paragraphFormat.set({ ... }).
Word.Interfaces.ParagraphLoadOptions	Representa um único parágrafo em uma seleção, intervalo, controle de conteúdo ou corpo do documento.
Word.Interfaces.ParagraphUpdateData	Uma interface para atualizar dados no objeto Parágrafo, para uso em paragraph.set({ ... }).
Word.Interfaces.RangeCollectionData	Uma interface que descreve os dados retornados chamando rangeCollection.toJSON().
Word.Interfaces.RangeCollectionLoadOptions	Contém uma coleção de Word. Objetos range.
Word.Interfaces.RangeCollectionUpdateData	Uma interface para atualizar dados no objeto RangeCollection, para uso em rangeCollection.set({ ... }).
Word.Interfaces.RangeData	Uma interface que descreve os dados retornados chamando range.toJSON().
Word.Interfaces.RangeLoadOptions	Representa uma área contígua em um documento.
Word.Interfaces.RangeUpdateData	Uma interface para atualizar dados no objeto Range, para uso em range.set({ ... }).
Word.Interfaces.SearchOptionsData	Uma interface que descreve os dados retornados chamando searchOptions.toJSON().
Word.Interfaces.SearchOptionsLoadOptions	Especifica as opções a serem incluídas em uma operação de pesquisa. Para saber mais sobre como usar opções de pesquisa nas APIs JavaScript Word, leia Usar opções de pesquisa para encontrar texto no suplemento Word.
Word.Interfaces.SearchOptionsUpdateData	Uma interface para atualizar dados no objeto SearchOptions, para uso em searchOptions.set({ ... }).
Word.Interfaces.SectionCollectionData	Uma interface que descreve os dados retornados chamando sectionCollection.toJSON().
Word.Interfaces.SectionCollectionLoadOptions	Contém a coleção do Word do documento. Objetos de seção.
Word.Interfaces.SectionCollectionUpdateData	Uma interface para atualizar dados no objeto SectionCollection, para uso em sectionCollection.set({ ... }).
Word.Interfaces.SectionData	Uma interface que descreve os dados retornados chamando section.toJSON().
Word.Interfaces.SectionLoadOptions	Representa uma seção em um documento do Word.
Word.Interfaces.SectionUpdateData	Uma interface para atualizar dados no objeto Section, para uso em section.set({ ... }).
Word.Interfaces.SettingCollectionData	Uma interface que descreve os dados retornados chamando settingCollection.toJSON().
Word.Interfaces.SettingCollectionUpdateData	Uma interface para atualizar dados no objeto SettingCollection, para uso em settingCollection.set({ ... }).
Word.Interfaces.SettingData	Uma interface que descreve os dados retornados chamando setting.toJSON().
Word.Interfaces.SettingUpdateData	Uma interface para atualizar dados no objeto Configuração, para uso em setting.set({ ... }).
Word.Interfaces.ShadingData	Uma interface que descreve os dados retornados chamando shading.toJSON().
Word.Interfaces.ShadingUpdateData	Uma interface para atualizar dados no objeto Sombreamento, para uso em shading.set({ ... }).
Word.Interfaces.StyleCollectionData	Uma interface que descreve os dados retornados chamando styleCollection.toJSON().
Word.Interfaces.StyleCollectionUpdateData	Uma interface para atualizar dados no objeto StyleCollection, para uso em styleCollection.set({ ... }).
Word.Interfaces.StyleData	Uma interface que descreve os dados retornados chamando style.toJSON().
Word.Interfaces.StyleUpdateData	Uma interface para atualizar dados no objeto Style, para uso em style.set({ ... }).
Word.Interfaces.TableBorderData	Uma interface que descreve os dados retornados chamando tableBorder.toJSON().
Word.Interfaces.TableBorderUpdateData	Uma interface para atualizar dados no objeto TableBorder, para uso em tableBorder.set({ ... }).
Word.Interfaces.TableCellCollectionData	Uma interface que descreve os dados retornados chamando tableCellCollection.toJSON().
Word.Interfaces.TableCellCollectionUpdateData	Uma interface para atualizar dados no objeto TableCellCollection, para uso em tableCellCollection.set({ ... }).
Word.Interfaces.TableCellData	Uma interface que descreve os dados retornados chamando tableCell.toJSON().
Word.Interfaces.TableCellUpdateData	Uma interface para atualizar dados no objeto TableCell, para uso em tableCell.set({ ... }).
Word.Interfaces.TableCollectionData	Uma interface que descreve os dados retornados chamando tableCollection.toJSON().
Word.Interfaces.TableCollectionUpdateData	Uma interface para atualizar dados no objeto TableCollection, para uso em tableCollection.set({ ... }).
Word.Interfaces.TableData	Uma interface que descreve os dados retornados chamando table.toJSON().
Word.Interfaces.TableRowCollectionData	Uma interface que descreve os dados retornados chamando tableRowCollection.toJSON().
Word.Interfaces.TableRowCollectionUpdateData	Uma interface para atualizar dados no objeto TableRowCollection, para uso em tableRowCollection.set({ ... }).
Word.Interfaces.TableRowData	Uma interface que descreve os dados retornados chamando tableRow.toJSON().
Word.Interfaces.TableRowUpdateData	Uma interface para atualizar dados no objeto TableRow, para uso em tableRow.set({ ... }).
Word.Interfaces.TableStyleData	Uma interface que descreve os dados retornados chamando tableStyle.toJSON().
Word.Interfaces.TableStyleUpdateData	Uma interface para atualizar dados no objeto TableStyle, para uso em tableStyle.set({ ... }).
Word.Interfaces.TableUpdateData	Uma interface para atualizar dados no objeto Table, para uso em table.set({ ... }).
Word.Interfaces.TrackedChangeCollectionData	Uma interface que descreve os dados retornados chamando trackedChangeCollection.toJSON().
Word.Interfaces.TrackedChangeCollectionUpdateData	Uma interface para atualizar dados no objeto TrackedChangeCollection, para uso em trackedChangeCollection.set({ ... }).
Word.Interfaces.TrackedChangeData	Uma interface que descreve os dados retornados chamando trackedChange.toJSON().

Enumerações

Word.Alignment
Word.BreakType	Especifica a forma de uma quebra.
Word.ContentControlAppearance	Aparência contentControl.
Word.ContentControlType	Especifica os tipos e subtipos de controle de conteúdo com suporte.
Word.ErrorCodes
Word.HeaderFooterType
Word.InsertLocation	Os tipos de local de inserção.
Word.SaveBehavior	Especifica o comportamento de salvamento para Document.save.
Word.SelectionMode	Este enum define onde o cursor (ponto de inserção) no documento está após uma seleção.
Word.UnderlineType	Os estilos com suporte para o formato sublinhado.

Funções

Word.run(objects, batch)	Executa um script em lote que executa ações no modelo de objeto Word, usando o RequestContext de objetos de API criados anteriormente.
Word.run(object, batch)	Executa um script em lote que executa ações no modelo de objeto Word, usando o RequestContext de um objeto de API criado anteriormente. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.
Word.run(batch)	Executa um script em lote que executa ações no modelo de objeto Word, usando um novo RequestContext. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

Detalhes da função

Word.run(objects, batch)

Executa um script em lote que executa ações no modelo de objeto Word, usando o RequestContext de objetos de API criados anteriormente.

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

Parâmetros

objects

OfficeExtension.ClientObject[]

Uma matriz de objetos de API criados anteriormente. A matriz será validada para garantir que todos os objetos compartilhem o mesmo contexto. O lote usará esse RequestContext compartilhado, o que significa que todas as alterações aplicadas a esses objetos serão captadas por "context.sync()".

batch

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

Uma função que recebe um RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita solicitações para o aplicativo Word. Como o suplemento do Office e o aplicativo Word são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto Word do suplemento.

Retornos

Promise<T>

Word.run(object, batch)

Executa um script em lote que executa ações no modelo de objeto Word, usando o RequestContext de um objeto de API criado anteriormente. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

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

Parâmetros

object

OfficeExtension.ClientObject

Um objeto de API criado anteriormente. O lote usará o mesmo RequestContext que o objeto passado, o que significa que todas as alterações aplicadas ao objeto serão captadas por "context.sync()".

batch

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

Uma função que recebe um RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita solicitações para o aplicativo Word. Como o suplemento do Office e o aplicativo Word são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto Word do suplemento.

Retornos

Promise<T>

Word.run(batch)

Executa um script em lote que executa ações no modelo de objeto Word, usando um novo RequestContext. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

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

Parâmetros

batch

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

Uma função que recebe um RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita solicitações para o aplicativo Word. Como o suplemento do Office e o aplicativo Word são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto Word do suplemento.

Retornos

Promise<T>