word package
Classes
Word.Application |
Representa o objeto do aplicativo. |
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.CustomProperty |
Representa uma propriedade personalizada. |
Word.CustomPropertyCollection |
Contém a coleção de Word. Objetos CustomProperty. |
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.DocumentCreated |
O objeto DocumentCreated é o objeto de nível superior criado por Application.CreateDocument. Um objeto DocumentCreated é um objeto Document especial. |
Word.DocumentProperties |
Representa as propriedades 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.List |
Contém uma coleção de Word. Objetos de parágrafo. |
Word.ListCollection |
Contém uma coleção de Word. Listar objetos. |
Word.ListItem |
Representa o formato de item da lista de parágrafos. |
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. |
Word.Style |
Representa um estilo em um documento Word. |
Word.Table |
Representa uma tabela em um documento Word. |
Word.TableBorder |
Especifica o estilo de borda. |
Word.TableCell |
Representa uma célula de tabela em um documento Word. |
Word.TableCellCollection |
Contém a coleção dos objetos TableCell do documento. |
Word.TableCollection |
Contém a coleção dos objetos Table do documento. |
Word.TableRow |
Representa uma linha em um documento Word. |
Word.TableRowCollection |
Contém a coleção dos objetos TableRow do documento. |
Interfaces
Word.Interfaces.AnnotationCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.AnnotationCollectionUpdateData |
Uma interface para atualizar dados no objeto AnnotationCollection, para uso em |
Word.Interfaces.AnnotationData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.BodyData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.CheckboxContentControlData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CheckboxContentControlUpdateData |
Uma interface para atualizar dados no objeto CheckboxContentControl, para uso em |
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 |
Word.Interfaces.CommentCollectionUpdateData |
Uma interface para atualizar dados no objeto CommentCollection, para uso em |
Word.Interfaces.CommentContentRangeData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CommentContentRangeUpdateData |
Uma interface para atualizar dados no objeto CommentContentRange, para uso em |
Word.Interfaces.CommentData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CommentReplyCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CommentReplyCollectionUpdateData |
Uma interface para atualizar dados no objeto CommentReplyCollection, para uso em |
Word.Interfaces.CommentReplyData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CommentReplyUpdateData |
Uma interface para atualizar dados no objeto CommentReply, para uso em |
Word.Interfaces.CommentUpdateData |
Uma interface para atualizar dados no objeto Comment, para uso em |
Word.Interfaces.ContentControlCollectionData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.ContentControlData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.CritiqueAnnotationData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CustomPropertyCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CustomPropertyCollectionLoadOptions |
Contém a coleção de Word. Objetos CustomProperty. |
Word.Interfaces.CustomPropertyCollectionUpdateData |
Uma interface para atualizar dados no objeto CustomPropertyCollection, para uso em |
Word.Interfaces.CustomPropertyData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CustomPropertyLoadOptions |
Representa uma propriedade personalizada. |
Word.Interfaces.CustomPropertyUpdateData |
Uma interface para atualizar dados no objeto CustomProperty, para uso em |
Word.Interfaces.CustomXmlPartCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
Uma interface para atualizar dados no objeto CustomXmlPartCollection, para uso em |
Word.Interfaces.CustomXmlPartData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CustomXmlPartScopedCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
Uma interface para atualizar dados no objeto CustomXmlPartScopedCollection, para uso em |
Word.Interfaces.DocumentCreatedData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.DocumentCreatedLoadOptions |
O objeto DocumentCreated é o objeto de nível superior criado por Application.CreateDocument. Um objeto DocumentCreated é um objeto Document especial. |
Word.Interfaces.DocumentCreatedUpdateData |
Uma interface para atualizar dados no objeto DocumentCreated, para uso em |
Word.Interfaces.DocumentData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.DocumentPropertiesLoadOptions |
Representa as propriedades do documento. |
Word.Interfaces.DocumentPropertiesUpdateData |
Uma interface para atualizar dados no objeto DocumentProperties, para uso em |
Word.Interfaces.DocumentUpdateData |
Uma interface para atualizar dados no objeto Document, para uso em |
Word.Interfaces.FieldCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.FieldCollectionUpdateData |
Uma interface para atualizar dados no objeto FieldCollection, para uso em |
Word.Interfaces.FieldData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.FieldUpdateData |
Uma interface para atualizar dados no objeto Field, para uso em |
Word.Interfaces.FontData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.FontLoadOptions |
Representa uma fonte. |
Word.Interfaces.FontUpdateData |
Uma interface para atualizar dados no objeto Font, para uso em |
Word.Interfaces.InlinePictureCollectionData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.InlinePictureData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.InlinePictureLoadOptions |
Representa uma imagem embutida. |
Word.Interfaces.InlinePictureUpdateData |
Uma interface para atualizar dados no objeto InlinePicture, para uso em |
Word.Interfaces.ListCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.ListCollectionLoadOptions |
Contém uma coleção de Word. Listar objetos. |
Word.Interfaces.ListCollectionUpdateData |
Uma interface para atualizar dados no objeto ListCollection, para uso em |
Word.Interfaces.ListData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.ListItemData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.ListItemLoadOptions |
Representa o formato de item da lista de parágrafos. |
Word.Interfaces.ListItemUpdateData |
Uma interface para atualizar dados no objeto ListItem, para uso em |
Word.Interfaces.ListLoadOptions |
Contém uma coleção de Word. Objetos de parágrafo. |
Word.Interfaces.NoteItemCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.NoteItemCollectionUpdateData |
Uma interface para atualizar dados no objeto NoteItemCollection, para uso em |
Word.Interfaces.NoteItemData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.NoteItemUpdateData |
Uma interface para atualizar dados no objeto NoteItem, para uso em |
Word.Interfaces.ParagraphCollectionData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.ParagraphData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.ParagraphFormatData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.ParagraphFormatUpdateData |
Uma interface para atualizar dados no objeto ParagraphFormat, para uso em |
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 |
Word.Interfaces.RangeCollectionData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.RangeData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.SearchOptionsData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.SectionCollectionData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.SectionData |
Uma interface que descreve os dados retornados chamando |
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 |
Word.Interfaces.SettingCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.SettingCollectionUpdateData |
Uma interface para atualizar dados no objeto SettingCollection, para uso em |
Word.Interfaces.SettingData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.SettingUpdateData |
Uma interface para atualizar dados no objeto Configuração, para uso em |
Word.Interfaces.ShadingData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.ShadingUpdateData |
Uma interface para atualizar dados no objeto Sombreamento, para uso em |
Word.Interfaces.StyleCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.StyleCollectionUpdateData |
Uma interface para atualizar dados no objeto StyleCollection, para uso em |
Word.Interfaces.StyleData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.StyleLoadOptions |
Representa um estilo em um documento Word. |
Word.Interfaces.StyleUpdateData |
Uma interface para atualizar dados no objeto Style, para uso em |
Word.Interfaces.TableBorderData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableBorderLoadOptions |
Especifica o estilo de borda. |
Word.Interfaces.TableBorderUpdateData |
Uma interface para atualizar dados no objeto TableBorder, para uso em |
Word.Interfaces.TableCellCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableCellCollectionLoadOptions |
Contém a coleção dos objetos TableCell do documento. |
Word.Interfaces.TableCellCollectionUpdateData |
Uma interface para atualizar dados no objeto TableCellCollection, para uso em |
Word.Interfaces.TableCellData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableCellLoadOptions |
Representa uma célula de tabela em um documento Word. |
Word.Interfaces.TableCellUpdateData |
Uma interface para atualizar dados no objeto TableCell, para uso em |
Word.Interfaces.TableCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableCollectionLoadOptions |
Contém a coleção dos objetos Table do documento. |
Word.Interfaces.TableCollectionUpdateData |
Uma interface para atualizar dados no objeto TableCollection, para uso em |
Word.Interfaces.TableData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableLoadOptions |
Representa uma tabela em um documento Word. |
Word.Interfaces.TableRowCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableRowCollectionLoadOptions |
Contém a coleção dos objetos TableRow do documento. |
Word.Interfaces.TableRowCollectionUpdateData |
Uma interface para atualizar dados no objeto TableRowCollection, para uso em |
Word.Interfaces.TableRowData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableRowLoadOptions |
Representa uma linha em um documento Word. |
Word.Interfaces.TableRowUpdateData |
Uma interface para atualizar dados no objeto TableRow, para uso em |
Word.Interfaces.TableStyleData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TableStyleUpdateData |
Uma interface para atualizar dados no objeto TableStyle, para uso em |
Word.Interfaces.TableUpdateData |
Uma interface para atualizar dados no objeto Table, para uso em |
Word.Interfaces.TrackedChangeCollectionData |
Uma interface que descreve os dados retornados chamando |
Word.Interfaces.TrackedChangeCollectionUpdateData |
Uma interface para atualizar dados no objeto TrackedChangeCollection, para uso em |
Word.Interfaces.TrackedChangeData |
Uma interface que descreve os dados retornados chamando |
Enumerações
Word.Alignment | |
Word.BodyType | |
Word.BorderLocation | |
Word.BorderType | |
Word.BreakType |
Especifica a forma de uma quebra. |
Word.BuiltInStyleName |
Representa o estilo interno em um documento Word. |
Word.CellPaddingLocation | |
Word.ContentControlAppearance |
Aparência contentControl. |
Word.ContentControlType |
Especifica os tipos e subtipos de controle de conteúdo com suporte. |
Word.DocumentPropertyType | |
Word.ErrorCodes | |
Word.HeaderFooterType | |
Word.InsertLocation |
Os tipos de local de inserção. |
Word.ListBullet | |
Word.ListLevelType | |
Word.ListNumbering | |
Word.LocationRelation | |
Word.RangeLocation | |
Word.SaveBehavior |
Especifica o comportamento de salvamento para |
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. |
Word.VerticalAlignment |
Funções
Word. |
Executa um script em lote que executa ações no modelo de objeto Word, usando o RequestContext de objetos de API criados anteriormente. |
Word. |
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. |
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
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>
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de