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, apenas são suportados controlos de conteúdo de rich text, texto simples e caixa de verificaçã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, apenas são suportados controlos de conteúdo de texto formatado 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. Intervalo de objetos.
Word.RequestContext	O objeto RequestContext facilita os pedidos à aplicação Word. Uma vez que o suplemento do Office e o Word aplicação são executados em dois processos diferentes, o contexto do pedido é necessário para obter acesso ao modelo de objeto Word a partir do suplemento.
Word.SearchOptions	Especifica as opções a serem incluídas em uma operação de pesquisa. Para saber mais sobre como utilizar as opções de pesquisa nas APIs javaScript Word, leia Utilizar opções de pesquisa para localizar texto no seu 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 secção.

Interfaces

Word.Interfaces.AnnotationCollectionData	Uma interface que descreve os dados devolvidos ao chamar annotationCollection.toJSON().
Word.Interfaces.AnnotationCollectionUpdateData	Uma interface para atualizar dados no AnnotationCollection objeto, para utilização no annotationCollection.set({ ... }).
Word.Interfaces.AnnotationData	Uma interface que descreve os dados devolvidos ao chamar annotation.toJSON().
Word.Interfaces.BodyData	Uma interface que descreve os dados devolvidos ao chamar 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 Body objeto, para utilização no body.set({ ... }).
Word.Interfaces.BorderCollectionData	Uma interface que descreve os dados devolvidos ao chamar borderCollection.toJSON().
Word.Interfaces.BorderCollectionUpdateData	Uma interface para atualizar dados no BorderCollection objeto, para utilização no borderCollection.set({ ... }).
Word.Interfaces.BorderData	Uma interface que descreve os dados devolvidos ao chamar border.toJSON().
Word.Interfaces.BorderUpdateData	Uma interface para atualizar dados no Border objeto, para utilização no border.set({ ... }).
Word.Interfaces.CheckboxContentControlData	Uma interface que descreve os dados devolvidos ao chamar checkboxContentControl.toJSON().
Word.Interfaces.CheckboxContentControlUpdateData	Uma interface para atualizar dados no CheckboxContentControl objeto, para utilização no checkboxContentControl.set({ ... }).
Word.Interfaces.CollectionLoadOptions	Fornece formas de carregar propriedades de apenas um subconjunto de membros de uma coleção.
Word.Interfaces.CommentCollectionData	Uma interface que descreve os dados devolvidos ao chamar commentCollection.toJSON().
Word.Interfaces.CommentCollectionUpdateData	Uma interface para atualizar dados no CommentCollection objeto, para utilização no commentCollection.set({ ... }).
Word.Interfaces.CommentContentRangeData	Uma interface que descreve os dados devolvidos ao chamar commentContentRange.toJSON().
Word.Interfaces.CommentContentRangeUpdateData	Uma interface para atualizar dados no CommentContentRange objeto, para utilização no commentContentRange.set({ ... }).
Word.Interfaces.CommentData	Uma interface que descreve os dados devolvidos ao chamar comment.toJSON().
Word.Interfaces.CommentReplyCollectionData	Uma interface que descreve os dados devolvidos ao chamar commentReplyCollection.toJSON().
Word.Interfaces.CommentReplyCollectionUpdateData	Uma interface para atualizar dados no CommentReplyCollection objeto, para utilização no commentReplyCollection.set({ ... }).
Word.Interfaces.CommentReplyData	Uma interface que descreve os dados devolvidos ao chamar commentReply.toJSON().
Word.Interfaces.CommentReplyUpdateData	Uma interface para atualizar dados no CommentReply objeto, para utilização no commentReply.set({ ... }).
Word.Interfaces.CommentUpdateData	Uma interface para atualizar dados no Comment objeto, para utilização no comment.set({ ... }).
Word.Interfaces.ContentControlCollectionData	Uma interface que descreve os dados devolvidos ao chamar 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, apenas são suportados controlos de conteúdo de texto formatado e texto simples.
Word.Interfaces.ContentControlCollectionUpdateData	Uma interface para atualizar dados no ContentControlCollection objeto, para utilização no contentControlCollection.set({ ... }).
Word.Interfaces.ContentControlData	Uma interface que descreve os dados devolvidos ao chamar 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, apenas são suportados controlos de conteúdo de rich text, texto simples e caixa de verificação.
Word.Interfaces.ContentControlUpdateData	Uma interface para atualizar dados no ContentControl objeto, para utilização no contentControl.set({ ... }).
Word.Interfaces.CritiqueAnnotationData	Uma interface que descreve os dados devolvidos ao chamar critiqueAnnotation.toJSON().
Word.Interfaces.CustomPropertyCollectionData	Uma interface que descreve os dados devolvidos ao chamar customPropertyCollection.toJSON().
Word.Interfaces.CustomPropertyCollectionUpdateData	Uma interface para atualizar dados no CustomPropertyCollection objeto, para utilização no customPropertyCollection.set({ ... }).
Word.Interfaces.CustomPropertyData	Uma interface que descreve os dados devolvidos ao chamar customProperty.toJSON().
Word.Interfaces.CustomPropertyUpdateData	Uma interface para atualizar dados no CustomProperty objeto, para utilização no customProperty.set({ ... }).
Word.Interfaces.CustomXmlPartCollectionData	Uma interface que descreve os dados devolvidos ao chamar customXmlPartCollection.toJSON().
Word.Interfaces.CustomXmlPartCollectionUpdateData	Uma interface para atualizar dados no CustomXmlPartCollection objeto, para utilização no customXmlPartCollection.set({ ... }).
Word.Interfaces.CustomXmlPartData	Uma interface que descreve os dados devolvidos ao chamar customXmlPart.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionData	Uma interface que descreve os dados devolvidos ao chamar customXmlPartScopedCollection.toJSON().
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData	Uma interface para atualizar dados no CustomXmlPartScopedCollection objeto, para utilização no customXmlPartScopedCollection.set({ ... }).
Word.Interfaces.DocumentCreatedData	Uma interface que descreve os dados devolvidos ao chamar documentCreated.toJSON().
Word.Interfaces.DocumentCreatedUpdateData	Uma interface para atualizar dados no DocumentCreated objeto, para utilização no documentCreated.set({ ... }).
Word.Interfaces.DocumentData	Uma interface que descreve os dados devolvidos ao chamar 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 devolvidos ao chamar documentProperties.toJSON().
Word.Interfaces.DocumentPropertiesUpdateData	Uma interface para atualizar dados no DocumentProperties objeto, para utilização no documentProperties.set({ ... }).
Word.Interfaces.DocumentUpdateData	Uma interface para atualizar dados no Document objeto, para utilização no document.set({ ... }).
Word.Interfaces.FieldCollectionData	Uma interface que descreve os dados devolvidos ao chamar fieldCollection.toJSON().
Word.Interfaces.FieldCollectionUpdateData	Uma interface para atualizar dados no FieldCollection objeto, para utilização no fieldCollection.set({ ... }).
Word.Interfaces.FieldData	Uma interface que descreve os dados devolvidos ao chamar field.toJSON().
Word.Interfaces.FieldUpdateData	Uma interface para atualizar dados no Field objeto, para utilização no field.set({ ... }).
Word.Interfaces.FontData	Uma interface que descreve os dados devolvidos ao chamar font.toJSON().
Word.Interfaces.FontLoadOptions	Representa uma fonte.
Word.Interfaces.FontUpdateData	Uma interface para atualizar dados no Font objeto, para utilização no font.set({ ... }).
Word.Interfaces.InlinePictureCollectionData	Uma interface que descreve os dados devolvidos ao chamar inlinePictureCollection.toJSON().
Word.Interfaces.InlinePictureCollectionLoadOptions	Contém uma coleção de Word. Objetos InlinePicture.
Word.Interfaces.InlinePictureCollectionUpdateData	Uma interface para atualizar dados no InlinePictureCollection objeto, para utilização no inlinePictureCollection.set({ ... }).
Word.Interfaces.InlinePictureData	Uma interface que descreve os dados devolvidos ao chamar inlinePicture.toJSON().
Word.Interfaces.InlinePictureLoadOptions	Representa uma imagem embutida.
Word.Interfaces.InlinePictureUpdateData	Uma interface para atualizar dados no InlinePicture objeto, para utilização no inlinePicture.set({ ... }).
Word.Interfaces.ListCollectionData	Uma interface que descreve os dados devolvidos ao chamar listCollection.toJSON().
Word.Interfaces.ListCollectionUpdateData	Uma interface para atualizar dados no ListCollection objeto, para utilização no listCollection.set({ ... }).
Word.Interfaces.ListData	Uma interface que descreve os dados devolvidos ao chamar list.toJSON().
Word.Interfaces.ListItemData	Uma interface que descreve os dados devolvidos ao chamar listItem.toJSON().
Word.Interfaces.ListItemUpdateData	Uma interface para atualizar dados no ListItem objeto, para utilização no listItem.set({ ... }).
Word.Interfaces.ListLevelCollectionData	Uma interface que descreve os dados devolvidos ao chamar listLevelCollection.toJSON().
Word.Interfaces.ListLevelCollectionUpdateData	Uma interface para atualizar dados no ListLevelCollection objeto, para utilização no listLevelCollection.set({ ... }).
Word.Interfaces.ListLevelData	Uma interface que descreve os dados devolvidos ao chamar listLevel.toJSON().
Word.Interfaces.ListLevelUpdateData	Uma interface para atualizar dados no ListLevel objeto, para utilização no listLevel.set({ ... }).
Word.Interfaces.ListTemplateData	Uma interface que descreve os dados devolvidos ao chamar listTemplate.toJSON().
Word.Interfaces.ListTemplateUpdateData	Uma interface para atualizar dados no ListTemplate objeto, para utilização no listTemplate.set({ ... }).
Word.Interfaces.NoteItemCollectionData	Uma interface que descreve os dados devolvidos ao chamar noteItemCollection.toJSON().
Word.Interfaces.NoteItemCollectionUpdateData	Uma interface para atualizar dados no NoteItemCollection objeto, para utilização no noteItemCollection.set({ ... }).
Word.Interfaces.NoteItemData	Uma interface que descreve os dados devolvidos ao chamar noteItem.toJSON().
Word.Interfaces.NoteItemUpdateData	Uma interface para atualizar dados no NoteItem objeto, para utilização no noteItem.set({ ... }).
Word.Interfaces.ParagraphCollectionData	Uma interface que descreve os dados devolvidos ao chamar 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 ParagraphCollection objeto, para utilização no paragraphCollection.set({ ... }).
Word.Interfaces.ParagraphData	Uma interface que descreve os dados devolvidos ao chamar paragraph.toJSON().
Word.Interfaces.ParagraphFormatData	Uma interface que descreve os dados devolvidos ao chamar paragraphFormat.toJSON().
Word.Interfaces.ParagraphFormatUpdateData	Uma interface para atualizar dados no ParagraphFormat objeto, para utilização no 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 Paragraph objeto, para utilização no paragraph.set({ ... }).
Word.Interfaces.RangeCollectionData	Uma interface que descreve os dados devolvidos ao chamar rangeCollection.toJSON().
Word.Interfaces.RangeCollectionLoadOptions	Contém uma coleção de Word. Intervalo de objetos.
Word.Interfaces.RangeCollectionUpdateData	Uma interface para atualizar dados no RangeCollection objeto, para utilização no rangeCollection.set({ ... }).
Word.Interfaces.RangeData	Uma interface que descreve os dados devolvidos ao chamar range.toJSON().
Word.Interfaces.RangeLoadOptions	Representa uma área contígua em um documento.
Word.Interfaces.RangeUpdateData	Uma interface para atualizar dados no Range objeto, para utilização no range.set({ ... }).
Word.Interfaces.SearchOptionsData	Uma interface que descreve os dados devolvidos ao chamar searchOptions.toJSON().
Word.Interfaces.SearchOptionsLoadOptions	Especifica as opções a serem incluídas em uma operação de pesquisa. Para saber mais sobre como utilizar as opções de pesquisa nas APIs javaScript Word, leia Utilizar opções de pesquisa para localizar texto no seu suplemento Word.
Word.Interfaces.SearchOptionsUpdateData	Uma interface para atualizar dados no SearchOptions objeto, para utilização no searchOptions.set({ ... }).
Word.Interfaces.SectionCollectionData	Uma interface que descreve os dados devolvidos ao chamar sectionCollection.toJSON().
Word.Interfaces.SectionCollectionLoadOptions	Contém a coleção do Word do documento. Objetos de secção.
Word.Interfaces.SectionCollectionUpdateData	Uma interface para atualizar dados no SectionCollection objeto, para utilização no sectionCollection.set({ ... }).
Word.Interfaces.SectionData	Uma interface que descreve os dados devolvidos ao chamar section.toJSON().
Word.Interfaces.SectionLoadOptions	Representa uma seção em um documento do Word.
Word.Interfaces.SectionUpdateData	Uma interface para atualizar dados no Section objeto, para utilização no section.set({ ... }).
Word.Interfaces.SettingCollectionData	Uma interface que descreve os dados devolvidos ao chamar settingCollection.toJSON().
Word.Interfaces.SettingCollectionUpdateData	Uma interface para atualizar dados no SettingCollection objeto, para utilização no settingCollection.set({ ... }).
Word.Interfaces.SettingData	Uma interface que descreve os dados devolvidos ao chamar setting.toJSON().
Word.Interfaces.SettingUpdateData	Uma interface para atualizar dados no Setting objeto, para utilização no setting.set({ ... }).
Word.Interfaces.ShadingData	Uma interface que descreve os dados devolvidos ao chamar shading.toJSON().
Word.Interfaces.ShadingUpdateData	Uma interface para atualizar dados no Shading objeto, para utilização no shading.set({ ... }).
Word.Interfaces.StyleCollectionData	Uma interface que descreve os dados devolvidos ao chamar styleCollection.toJSON().
Word.Interfaces.StyleCollectionUpdateData	Uma interface para atualizar dados no StyleCollection objeto, para utilização no styleCollection.set({ ... }).
Word.Interfaces.StyleData	Uma interface que descreve os dados devolvidos ao chamar style.toJSON().
Word.Interfaces.StyleUpdateData	Uma interface para atualizar dados no Style objeto, para utilização no style.set({ ... }).
Word.Interfaces.TableBorderData	Uma interface que descreve os dados devolvidos ao chamar tableBorder.toJSON().
Word.Interfaces.TableBorderUpdateData	Uma interface para atualizar dados no TableBorder objeto, para utilização no tableBorder.set({ ... }).
Word.Interfaces.TableCellCollectionData	Uma interface que descreve os dados devolvidos ao chamar tableCellCollection.toJSON().
Word.Interfaces.TableCellCollectionUpdateData	Uma interface para atualizar dados no TableCellCollection objeto, para utilização no tableCellCollection.set({ ... }).
Word.Interfaces.TableCellData	Uma interface que descreve os dados devolvidos ao chamar tableCell.toJSON().
Word.Interfaces.TableCellUpdateData	Uma interface para atualizar dados no TableCell objeto, para utilização no tableCell.set({ ... }).
Word.Interfaces.TableCollectionData	Uma interface que descreve os dados devolvidos ao chamar tableCollection.toJSON().
Word.Interfaces.TableCollectionUpdateData	Uma interface para atualizar dados no TableCollection objeto, para utilização no tableCollection.set({ ... }).
Word.Interfaces.TableData	Uma interface que descreve os dados devolvidos ao chamar table.toJSON().
Word.Interfaces.TableRowCollectionData	Uma interface que descreve os dados devolvidos ao chamar tableRowCollection.toJSON().
Word.Interfaces.TableRowCollectionUpdateData	Uma interface para atualizar dados no TableRowCollection objeto, para utilização no tableRowCollection.set({ ... }).
Word.Interfaces.TableRowData	Uma interface que descreve os dados devolvidos ao chamar tableRow.toJSON().
Word.Interfaces.TableRowUpdateData	Uma interface para atualizar dados no TableRow objeto, para utilização no tableRow.set({ ... }).
Word.Interfaces.TableStyleData	Uma interface que descreve os dados devolvidos ao chamar tableStyle.toJSON().
Word.Interfaces.TableStyleUpdateData	Uma interface para atualizar dados no TableStyle objeto, para utilização no tableStyle.set({ ... }).
Word.Interfaces.TableUpdateData	Uma interface para atualizar dados no Table objeto, para utilização no table.set({ ... }).
Word.Interfaces.TrackedChangeCollectionData	Uma interface que descreve os dados devolvidos ao chamar trackedChangeCollection.toJSON().
Word.Interfaces.TrackedChangeCollectionUpdateData	Uma interface para atualizar dados no TrackedChangeCollection objeto, para utilização no trackedChangeCollection.set({ ... }).
Word.Interfaces.TrackedChangeData	Uma interface que descreve os dados devolvidos ao chamar trackedChange.toJSON().

Enumerações

Word.Alignment
Word.BreakType	Especifica a forma de uma quebra.
Word.ContentControlAppearance	ContentControl aspeto.
Word.ContentControlType	Especifica subtipos e tipos de controlo de conteúdo suportados.
Word.ErrorCodes
Word.HeaderFooterType
Word.InsertLocation	Os tipos de localização de inserção.
Word.SaveBehavior	Especifica o comportamento de guardar para Document.save.
Word.SelectionMode	Esta enumeração define onde o cursor (ponto de inserção) no documento se encontra após uma seleção.
Word.UnderlineType	Os estilos suportados para o formato de sublinhado.

Funções

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

Detalhes da função

Word.run(objects, batch)

Executa um script de lote que executa ações no modelo de objeto Word, com 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 partilham o mesmo contexto. O lote utilizará este RequestContext partilhado, o que significa que todas as alterações aplicadas a estes objetos serão recolhidas pelo context.sync().

batch

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

Uma função que recebe um RequestContext e devolve uma promessa (normalmente, apenas o resultado de context.sync()). O parâmetro de contexto facilita os pedidos para a aplicação Word. Uma vez que o suplemento do Office e a aplicação Word são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto Word a partir do suplemento.

Retornos

Promise<T>

Word.run(object, batch)

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

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 utilizará o mesmo RequestContext que o objeto transmitido, o que significa que todas as alterações aplicadas ao objeto serão recolhidas por context.sync().

batch

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

Uma função que recebe um RequestContext e devolve uma promessa (normalmente, apenas o resultado de context.sync()). O parâmetro de contexto facilita os pedidos para a aplicação Word. Uma vez que o suplemento do Office e a aplicação Word são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto Word a partir do suplemento.

Retornos

Promise<T>

Word.run(batch)

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

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 devolve uma promessa (normalmente, apenas o resultado de context.sync()). O parâmetro de contexto facilita os pedidos para a aplicação Word. Uma vez que o suplemento do Office e a aplicação Word são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto Word a partir do suplemento.

Retornos

Promise<T>