Novidades no Word API JavaScript 1.1
O WordApi 1.1 é o primeiro conjunto de requisitos da Word API JavaScript. É o único conjunto de requisitos de API Word com suporte por Word 2016.
Lista de API
A tabela a seguir lista as APIs no Word o conjunto de requisitos da API JavaScript 1.1. Para exibir a documentação de referência da API para todas as APIs com suporte Word o conjunto de requisitos da API JavaScript 1.1, consulte Word APIs no conjunto de requisitos 1.1.
| Classe | Campos | Descrição |
|---|---|---|
| Body | clear() | Limpa o conteúdo do objeto Body. |
| Contentcontrols | Obtém a coleção de objetos de controle de conteúdo de texto avançados no corpo. | |
| font | Obtém o formato de texto do corpo. | |
| getHtml() | Obtém uma representação HTML do objeto body. | |
| getOoxml() | Obtém a representação OOXML (Office Open XML) do objeto Body. | |
| inlinePictures | Obtém a coleção de objetos InlinePicture no corpo. | |
| insertBreak(breakType: Word. BreakType | "Página" | "Próximo" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End") | Insere uma quebra no local especificado no documento principal. | |
| insertContentControl() | Encapsula o objeto Body com um controle de conteúdo rich text. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere um documento no corpo, no local especificado. | |
| insertHtml(html: cadeia de caracteres, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere HTML no local especificado. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere um formato OOXML no local especificado. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End") | Insere um parágrafo no local especificado. | |
| insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere texto no corpo, no local especificado. | |
| paragraphs | Obtém a coleção de objetos de parágrafo no corpo. | |
| Parentcontentcontrol | Obtém o controle de conteúdo que inclui o corpo. | |
| search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) | Executa uma pesquisa com as SearchOptions especificadas no escopo do objeto body. | |
| select(selectionMode?: Word. SelectionMode) | Seleciona o corpo e navega na interface do usuário do Word até ele. | |
| style | Especifica o nome de estilo do corpo. | |
| text | Obtém o texto do corpo. | |
| ContentControl | Aparência | Especifica a aparência do controle de conteúdo. |
| canDelete | Especifica um valor que indica se o usuário pode excluir o controle de conteúdo. | |
| canEdit | Especifica um valor que indica se o usuário pode editar o conteúdo do controle de conteúdo. | |
| clear() | Limpa o conteúdo do controle de conteúdo. | |
| color | Especifica a cor do controle de conteúdo. | |
| Contentcontrols | Obtém a coleção de objetos de controle de conteúdo no controle de conteúdo. | |
| delete(keepContent: booleano) | Exclui o controle de conteúdo e o respectivo conteúdo. | |
| font | Obtém o formato de texto do controle de conteúdo. | |
| getHtml() | Obtém uma representação HTML do objeto de controle de conteúdo. | |
| getOoxml() | Obtém a representação OOXML (Office Open XML) do objeto do controle de conteúdo. | |
| id | Obtém um número inteiro que representa o identificador do controle de conteúdo. | |
| inlinePictures | Obtém a coleção de objetos InlinePicture no controle de conteúdo. | |
| insertBreak(breakType: Word. BreakType | "Página" | "Próximo" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Iniciar" | "End" | "Antes" | "After") | Insere uma quebra no local especificado no documento principal. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere um documento no controle de conteúdo no local especificado. | |
| insertHtml(html: cadeia de caracteres, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere HTML no local especificado dentro do controle de conteúdo. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere OOXML no controle de conteúdo no local especificado. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Iniciar" | "End" | "Antes" | "After") | Insere um parágrafo no local especificado. | |
| insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere texto no local especificado dentro do controle de conteúdo. | |
| paragraphs | Obtém a coleção de objetos de parágrafo no controle de conteúdo. | |
| Parentcontentcontrol | Obtém o controle de conteúdo que inclui o controle de conteúdo. | |
| Placeholdertext | Especifica o texto de espaço reservado do controle de conteúdo. | |
| removeWhenEdited | Especifica um valor que indica se o controle de conteúdo é removido após a edição. | |
| search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) | Executa uma pesquisa com as SearchOptions especificadas no escopo do objeto de controle de conteúdo. | |
| select(selectionMode?: Word. SelectionMode) | Seleciona o controle de conteúdo. | |
| style | Especifica o nome de estilo do controle de conteúdo. | |
| marcar | Especifica uma marca para identificar um controle de conteúdo. | |
| text | Obtém o texto do controle de conteúdo. | |
| title | Especifica o título de um controle de conteúdo. | |
| type | Obtém o tipo de controle de conteúdo. | |
| ContentControlCollection | getById(id: number) | Obtém um controle de conteúdo pelo respectivo identificador. |
| getByTag(tag: string) | Obtém os controles de conteúdo com a marca especificada. | |
| getByTitle(title: string) | Obtém os controles de conteúdo com o título especificado. | |
| getItem(id: number) | Obtém um controle de conteúdo por sua ID. | |
| items | Obtém os itens filhos carregados nesta coleção. | |
| Document | body | Obtém o objeto body do documento main. |
| Contentcontrols | Obtém a coleção de objetos de controle de conteúdo no documento. | |
| getSelection() | Obtém a seleção atual do documento. | |
| save() | Salva o documento. | |
| Salvou | Indica se as alterações do documento foram salvas. | |
| sections | Obtém a coleção de objetos de seção no documento. | |
| Font | bold | Especifica um valor que indica se a fonte é em negrito. |
| color | Especifica a cor da fonte especificada. | |
| doubleStrikeThrough | Especifica um valor que indica se a fonte tem um strikethrough duplo. | |
| Highlightcolor | Especifica a cor de destaque. | |
| italic | Especifica um valor que indica se a fonte está itállica. | |
| name | Especifica um valor que representa o nome da fonte. | |
| size | Especifica um valor que representa o tamanho da fonte em pontos. | |
| Tachado | Especifica um valor que indica se a fonte tem um strikethrough. | |
| subscript | Especifica um valor que indica se a fonte é um subscript. | |
| superscript | Especifica um valor que indica se a fonte é um superscript. | |
| underline | Especifica um valor que indica o tipo de sublinhado da fonte. | |
| InlinePicture | altTextDescription | Especifica uma cadeia de caracteres que representa o texto alternativo associado à imagem embutida. |
| altTextTitle | Especifica uma cadeia de caracteres que contém o título da imagem embutida. | |
| getBase64ImageSrc() | Obtém a representação de cadeia de caracteres codificada base64 da imagem embutida. | |
| height | Especifica um número que descreve a altura da imagem embutida. | |
| hiperlink | Especifica um hiperlink na imagem. | |
| insertContentControl() | Quebra a imagem embutida com um controle de conteúdo de rich text. | |
| lockAspectRatio | Especifica um valor que indica se a imagem embutida mantém suas proporções originais quando você a redimensiona. | |
| Parentcontentcontrol | Obtém o controle de conteúdo que inclui a imagem embutida. | |
| width | Especifica um número que descreve a largura da imagem embutida. | |
| InlinePictureCollection | items | Obtém os itens filhos carregados nesta coleção. |
| Paragraph | Alinhamento | Especifica o alinhamento de um parágrafo. |
| clear() | Limpa o conteúdo do objeto Paragraph. | |
| Contentcontrols | Obtém a coleção de objetos de controle de conteúdo no parágrafo. | |
| delete() | Exclui o parágrafo e o respectivo conteúdo do documento. | |
| firstLineIndent | Especifica o valor, em pontos, para um recuo de primeira linha ou de suspensão. | |
| font | Obtém o formato de texto do parágrafo. | |
| getHtml() | Obtém uma representação HTML do objeto parágrafo. | |
| getOoxml() | Obtém a representação OOXML (Office Open XML) do objeto Paragraph. | |
| inlinePictures | Obtém a coleção de objetos InlinePicture no parágrafo. | |
| insertBreak(breakType: Word. BreakType | "Página" | "Próximo" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "After") | Insere uma quebra no local especificado no documento principal. | |
| insertContentControl() | Encapsula o objeto Parágrafo com um controle de conteúdo de texto avançado. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere um documento no parágrafo no local especificado. | |
| insertHtml(html: cadeia de caracteres, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere HTML no local especificado dentro do parágrafo. | |
| insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere uma imagem no local especificado dentro do parágrafo. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere OOXML no parágrafo no local especificado. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "After") | Insere um parágrafo no local especificado. | |
| insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End") | Insere texto no local especificado dentro do parágrafo. | |
| leftIndent | Especifica o valor de recuo esquerdo, em pontos, para o parágrafo. | |
| lineSpacing | Especifica o espaçamento de linha, em pontos, para o parágrafo especificado. | |
| lineUnitAfter | Especifica a quantidade de espaçamento, em linhas de grade, após o parágrafo. | |
| lineUnitBefore | Especifica a quantidade de espaçamento, em linhas de grade, antes do parágrafo. | |
| outlineLevel | Especifica o nível de contorno do parágrafo. | |
| Parentcontentcontrol | Obtém o controle de conteúdo que inclui o parágrafo. | |
| rightIndent | Especifica o valor de recuo direito, em pontos, para o parágrafo. | |
| search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) | Executa uma pesquisa com as SearchOptions especificadas no escopo do objeto parágrafo. | |
| select(selectionMode?: Word. SelectionMode) | Seleciona e navega na interface do usuário do Word até o parágrafo. | |
| spaceAfter | Especifica o espaçamento, em pontos, após o parágrafo. | |
| spaceBefore | Especifica o espaçamento, em pontos, antes do parágrafo. | |
| style | Especifica o nome de estilo do parágrafo. | |
| text | Obtém o texto do parágrafo. | |
| ParagraphCollection | items | Obtém os itens filhos carregados nesta coleção. |
| Range | clear() | Limpa o conteúdo do objeto Range. |
| Contentcontrols | Obtém a coleção de objetos de controle de conteúdo no intervalo. | |
| delete() | Exclui o intervalo e o respectivo conteúdo do documento. | |
| font | Obtém o formato de texto do intervalo. | |
| getHtml() | Obtém uma representação HTML do objeto range. | |
| getOoxml() | Obtém a representação OOXML do objeto Range. | |
| insertBreak(breakType: Word. BreakType | "Página" | "Próximo" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "After") | Insere uma quebra no local especificado no documento principal. | |
| insertContentControl() | Encapsula o objeto Range com um controle de conteúdo de texto avançado. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "End" | "Antes" | "After") | Insere um documento no local especificado. | |
| insertHtml(html: cadeia de caracteres, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "End" | "Antes" | "After") | Insere HTML no local especificado. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "End" | "Antes" | "After") | Insere um formato OOXML no local especificado. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "After") | Insere um parágrafo no local especificado. | |
| insertText(text: string, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "End" | "Antes" | "After") | Insere um texto no local especificado. | |
| paragraphs | Obtém a coleção de objetos de parágrafo no intervalo. | |
| Parentcontentcontrol | Obtém o controle de conteúdo que inclui o intervalo. | |
| search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) | Executa uma pesquisa com as SearchOptions especificadas no escopo do objeto range. | |
| select(selectionMode?: Word. SelectionMode) | Seleciona e navega na interface do usuário do Word até o intervalo. | |
| style | Especifica o nome de estilo para o intervalo. | |
| text | Obtém o texto do intervalo. | |
| RangeCollection | items | Obtém os itens filhos carregados nesta coleção. |
| SearchOptions | ignorePunct | Especifica um valor que indica se deve ignorar todos os caracteres de pontuação entre palavras. |
| ignoreSpace | Especifica um valor que indica se deve ignorar todo o whitespace entre palavras. | |
| matchCase | Especifica um valor que indica se deve executar uma pesquisa confidencial de caso. | |
| matchPrefix | Especifica um valor que indica se deve corresponder às palavras que começam com a cadeia de caracteres de pesquisa. | |
| matchSuffix | Especifica um valor que indica se deve corresponder palavras que terminam com a cadeia de caracteres de pesquisa. | |
| matchWholeWord | Especifica um valor que indica se deve encontrar a operação apenas palavras inteiras, não texto que faz parte de uma palavra maior. | |
| matchWildcards | Especifica um valor que indica se a pesquisa será executada usando operadores de pesquisa especiais. | |
| Section | body | Obtém o objeto body da seção. |
| getFooter(type: Word. HeaderFooterType) | Obtém um dos rodapés da seção. | |
| getHeader(tipo: Word. HeaderFooterType) | Obtém um dos cabeçalhos da seção. | |
| SectionCollection | items | Obtém os itens filhos carregados nesta coleção. |
Confira também
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.