Word.ContentControl class

Referência

Pacote:: word

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.

Extends: OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;

    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'color,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');

        // Synchronize the document state by executing the queued commands,
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' +
            '   ----- appearance: ' + contentControls.items[0].appearance +
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

Propriedades

appearance	Especifica a aparência do controle de conteúdo. O valor pode ser 'BoundingBox', 'Tags' ou 'Hidden'.
cannotDelete	Especifica um valor que indica se o usuário pode excluir o controle de conteúdo. Mutuamente exclusivo com a propriedade removeWhenEdited.
cannotEdit	Especifica um valor que indica se o usuário pode editar o conteúdo do controle de conteúdo.
color	Especifica a cor do controle de conteúdo. A cor é especificada no formato "#RRGGBB" ou usando o nome de cor.
contentControls	Obtém a coleção de objetos de controle de conteúdo no controle de conteúdo.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
font	Obtém o formato de texto do controle de conteúdo. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.
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. A coleção não inclui imagens flutuantes.
lists	Obtém a coleção de listas de objetos no controle de conteúdo.
paragraphs	Obtém a coleção de objetos de parágrafo no controle de conteúdo.
parentBody	Obtém o corpo pai do controle de conteúdo.
parentContentControl	Obtém o controle de conteúdo que inclui o controle de conteúdo. Gerará um `ItemNotFound` erro se não houver um controle de conteúdo pai.
parentContentControlOrNullObject	Obtém o controle de conteúdo que inclui o controle de conteúdo. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
parentTable	Obtém a tabela que contém o controle de conteúdo. Gerará um `ItemNotFound` erro se ele não estiver contido em uma tabela.
parentTableCell	Obtém a célula de tabela que contém o controle de conteúdo. Gerará um `ItemNotFound` erro se ele não estiver contido em uma célula de tabela.
parentTableCellOrNullObject	Obtém a célula de tabela que contém o controle de conteúdo. Se ele não estiver contido em uma célula de tabela, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
parentTableOrNullObject	Obtém a tabela que contém o controle de conteúdo. Se ele não estiver contido em uma tabela, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
placeholderText	Especifica o texto de espaço reservado do controle de conteúdo. Quando o controle de conteúdo está vazio, o sistema exibe o texto esmaecido. Observação: a operação definida para essa propriedade não tem suporte em Word na Web.
removeWhenEdited	Especifica um valor que indica se o controle de conteúdo é removido após a edição. Mutuamente exclusivo com a propriedade cannotDelete.
style	Especifica o nome de estilo do controle de conteúdo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".
styleBuiltIn	Especifica o nome de estilo interno para o controle de conteúdo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".
subtype	Obtém o subtipo de controle de conteúdo. O subtipo pode ser 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' e 'RichTextTable' para controles de conteúdo de texto avançados ou 'PlainTextInline' e 'PlainTextParagraph' para controles de conteúdo de texto simples ou 'CheckBox' para controles de conteúdo de caixa de seleção.
tables	Obtém a coleção de objetos de tabela no controle de conteúdo.
tag	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. Atualmente, há suporte apenas para controles de conteúdo de texto, texto simples e caixa de seleção.

Métodos

clear()	Limpa o conteúdo do controle de conteúdo. O usuário pode executar a operação de desfazer no conteúdo limpo.
delete(keepContent)	Exclui o controle de conteúdo e o respectivo conteúdo. Se `keepContent` for definido como true, o conteúdo não será excluído.
getHtml()	Obtém uma representação HTML do objeto de controle de conteúdo. Quando renderizada em uma página da Web ou visualizador HTML, a formatação será uma correspondência próxima, mas não exata, para a formatação do documento. Esse método não retorna exatamente o mesmo HTML para o mesmo documento em plataformas diferentes (Windows, Mac, Word na Web, etc.). Se você precisar de fidelidade exata ou consistência entre plataformas, use `ContentControl.getOoxml()` e converta o XML retornado em HTML.
getOoxml()	Obtém a representação OOXML (Office Open XML) do objeto do controle de conteúdo.
getRange(rangeLocation)	Obtém o controle de todo o conteúdo, ou então, os pontos inicial ou final do controle de conteúdo, como um intervalo.
getTextRanges(endingMarks, trimSpacing)	Obtém os intervalos de texto no controle de conteúdo usando marcas de pontuação e/ou outras marcas finais.
insertBreak(breakType, insertLocation)	Insere uma quebra no local especificado no documento principal. Esse método não pode ser usado com controles de conteúdo 'RichTextTTable', 'RichTextTableRow' e 'RichTextTableCell'.
insertFileFromBase64(base64File, insertLocation)	Insere um documento no controle de conteúdo no local especificado.
insertHtml(html, insertLocation)	Insere HTML no local especificado dentro do controle de conteúdo.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Insere uma imagem embutida no local especificado dentro do controle de conteúdo.
insertOoxml(ooxml, insertLocation)	Insere OOXML no controle de conteúdo no local especificado.
insertParagraph(paragraphText, insertLocation)	Insere um parágrafo no local especificado.
insertTable(rowCount, columnCount, insertLocation, values)	Insere uma tabela com a quantidade especificada de linhas e colunas dentro ou próxima do controle de conteúdo.
insertText(text, insertLocation)	Insere texto no local especificado dentro do controle de conteúdo.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
search(searchText, searchOptions)	Executa uma pesquisa com as SearchOptions especificadas no escopo do objeto de controle de conteúdo. Os resultados da pesquisa são uma coleção de objetos Range.
select(selectionMode)	Seleciona o controle de conteúdo. Isso faz com que o Word role até a seleção.
select(selectionModeString)	Seleciona o controle de conteúdo. Isso faz com que o Word role até a seleção.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)	Divide o controle de conteúdo em intervalos filho usando delimitadores.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o Word original. O objeto ContentControl é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Word.Interfaces.ContentControlData`) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará chamar `context.sync()` antes que a versão da memória entre em vigor.

Detalhes da propriedade

appearance

Especifica a aparência do controle de conteúdo. O valor pode ser 'BoundingBox', 'Tags' ou 'Hidden'.

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

Valor da propriedade

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

Comentários

[ Conjunto de API: WordApi 1.1 ]

cannotDelete

Especifica um valor que indica se o usuário pode excluir o controle de conteúdo. Mutuamente exclusivo com a propriedade removeWhenEdited.

cannotDelete: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

cannotEdit

Especifica um valor que indica se o usuário pode editar o conteúdo do controle de conteúdo.

cannotEdit: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

color

Especifica a cor do controle de conteúdo. A cor é especificada no formato "#RRGGBB" ou usando o nome de cor.

color: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

contentControls

Obtém a coleção de objetos de controle de conteúdo no controle de conteúdo.

readonly contentControls: Word.ContentControlCollection;

Valor da propriedade

Word.ContentControlCollection

Comentários

[ Conjunto de API: WordApi 1.1 ]

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

font

Obtém o formato de texto do controle de conteúdo. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.

readonly font: Word.Font;

Valor da propriedade

Word.Font

Comentários

[ Conjunto de API: WordApi 1.1 ]

id

Obtém um número inteiro que representa o identificador do controle de conteúdo.

readonly id: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.1 ]

inlinePictures

Obtém a coleção de objetos InlinePicture no controle de conteúdo. A coleção não inclui imagens flutuantes.

readonly inlinePictures: Word.InlinePictureCollection;

Valor da propriedade

Word.InlinePictureCollection

Comentários

[ Conjunto de API: WordApi 1.1 ]

lists

Obtém a coleção de listas de objetos no controle de conteúdo.

readonly lists: Word.ListCollection;

Valor da propriedade

Word.ListCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

paragraphs

Obtém a coleção de objetos de parágrafo no controle de conteúdo.

readonly paragraphs: Word.ParagraphCollection;

Valor da propriedade

Word.ParagraphCollection

Comentários

[ Conjunto de API: WordApi 1.1 ]

Importante: para os conjuntos de requisitos 1.1 e 1.2, parágrafos em tabelas totalmente contidas nesse controle de conteúdo não são retornados. Do conjunto de requisitos 1.3, parágrafos nessas tabelas também são retornados.

parentBody

Obtém o corpo pai do controle de conteúdo.

readonly parentBody: Word.Body;

Valor da propriedade

Word.Body

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentContentControl

Obtém o controle de conteúdo que inclui o controle de conteúdo. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.

readonly parentContentControl: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

[ Conjunto de API: WordApi 1.1 ]

parentContentControlOrNullObject

Obtém o controle de conteúdo que inclui o controle de conteúdo. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTable

Obtém a tabela que contém o controle de conteúdo. Gerará um ItemNotFound erro se ele não estiver contido em uma tabela.

readonly parentTable: Word.Table;

Valor da propriedade

Word.Table

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableCell

Obtém a célula de tabela que contém o controle de conteúdo. Gerará um ItemNotFound erro se ele não estiver contido em uma célula de tabela.

readonly parentTableCell: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableCellOrNullObject

Obtém a célula de tabela que contém o controle de conteúdo. Se ele não estiver contido em uma célula de tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableOrNullObject

Obtém a tabela que contém o controle de conteúdo. Se ele não estiver contido em uma tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentTableOrNullObject: Word.Table;

Valor da propriedade

Word.Table

Comentários

[ Conjunto de API: WordApi 1.3 ]

placeholderText

Especifica o texto de espaço reservado do controle de conteúdo. Quando o controle de conteúdo está vazio, o sistema exibe o texto esmaecido.

Observação: a operação definida para essa propriedade não tem suporte em Word na Web.

placeholderText: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

removeWhenEdited

Especifica um valor que indica se o controle de conteúdo é removido após a edição. Mutuamente exclusivo com a propriedade cannotDelete.

removeWhenEdited: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

style

Especifica o nome de estilo do controle de conteúdo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".

style: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

styleBuiltIn

Especifica o nome de estilo interno para o controle de conteúdo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

subtype

Obtém o subtipo de controle de conteúdo. O subtipo pode ser 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' e 'RichTextTable' para controles de conteúdo de texto avançados ou 'PlainTextInline' e 'PlainTextParagraph' para controles de conteúdo de texto simples ou 'CheckBox' para controles de conteúdo de caixa de seleção.

readonly subtype: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

tables

Obtém a coleção de objetos de tabela no controle de conteúdo.

readonly tables: Word.TableCollection;

Valor da propriedade

Word.TableCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

tag

Especifica uma marca para identificar um controle de conteúdo.

tag: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml

// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
  let paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.

  await context.sync();

  for (let i = 0; i < paragraphs.items.length; i++) {
    let contentControl = paragraphs.items[i].insertContentControl();
    // For even, tag "even".
    if (i % 2 === 0) {
      contentControl.tag = "even";
    } else {
      contentControl.tag = "odd";
    }
  }
  console.log("Content controls inserted: " + paragraphs.items.length);

  await context.sync();
});

text

Obtém o texto do controle de conteúdo.

readonly text: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

title

Especifica o título de um controle de conteúdo.

title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

type

Obtém o tipo de controle de conteúdo. Atualmente, há suporte apenas para controles de conteúdo de texto, texto simples e caixa de seleção.

readonly type: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Detalhes do método

clear()

Limpa o conteúdo do controle de conteúdo. O usuário pode executar a operação de desfazer no conteúdo limpo.

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (contentControls.items.length === 0) {
        console.log("There isn't a content control in this document.");
    } else {
        // Queue a command to clear the contents of the first content control.
        contentControls.items[0].clear();

        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control cleared of contents.');
    }
});

delete(keepContent)

Exclui o controle de conteúdo e o respectivo conteúdo. Se keepContent for definido como true, o conteúdo não será excluído.

delete(keepContent: boolean): void;

Parâmetros

keepContent: boolean

Obrigatório. Indica se o conteúdo deve ser excluído com o controle de conteúdo. Se keepContent for definido como true, o conteúdo não será excluído.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (contentControls.items.length === 0) {
        console.log("There isn't a content control in this document.");
    } else {            
        // Queue a command to delete the first content control. 
        // The contents will remain in the document.
        contentControls.items[0].delete(true);

        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control cleared of contents.'); 
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/content-control-ondeleted-event.yaml

await Word.run(async (context) => {
  const contentControls = context.document.contentControls.getByTag("forTesting");
  contentControls.load("items");
  await context.sync();

  if (contentControls.items.length === 0) {
    console.log("There are no content controls in this document.");
  } else {
    console.log("Control to be deleted:", contentControls.items[0]);
    contentControls.items[0].delete(false);
    await context.sync();
  }
});

getHtml()

Obtém uma representação HTML do objeto de controle de conteúdo. Quando renderizada em uma página da Web ou visualizador HTML, a formatação será uma correspondência próxima, mas não exata, para a formatação do documento. Esse método não retorna exatamente o mesmo HTML para o mesmo documento em plataformas diferentes (Windows, Mac, Word na Web, etc.). Se você precisar de fidelidade exata ou consistência entre plataformas, use ContentControl.getOoxml() e converta o XML retornado em HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Retornos

OfficeExtension.ClientResult<string>

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection that contains a specific tag.
    const contentControlsWithTag = context.document.contentControls.getByTag('Customer-Address');
    
    // Queue a command to load the tag property for all of content controls.
    contentControlsWithTag.load('tag');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControlsWithTag.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the HTML contents of the first content control.
        const html = contentControlsWithTag.items[0].getHtml();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control HTML: ' + html.value);
    }
});

getOoxml()

Obtém a representação OOXML (Office Open XML) do objeto do controle de conteúdo.

getOoxml(): OfficeExtension.ClientResult<string>;

Retornos

OfficeExtension.ClientResult<string>

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the OOXML contents of the first content control.
        const ooxml = contentControls.items[0].getOoxml();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control OOXML: ' + ooxml.value);
    }
});

getRange(rangeLocation)

Obtém o controle de todo o conteúdo, ou então, os pontos inicial ou final do controle de conteúdo, como um intervalo.

getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;

Parâmetros

rangeLocation: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"

Opcional. O local de intervalo deve ser 'Whole', 'Start', 'End', 'Before', 'After' ou 'Content'.

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi 1.3 ]

getTextRanges(endingMarks, trimSpacing)

Obtém os intervalos de texto no controle de conteúdo usando marcas de pontuação e/ou outras marcas finais.

getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;

Parâmetros

endingMarks: string[]

Obrigatório. As marcas de pontuação e/ou outras marcas finais como uma matriz de cadeias de caracteres.

trimSpacing: boolean

Opcional. Indica se é necessário cortar caracteres de espaçamento (espaços, guias, quebras de coluna e marcas de extremidade do parágrafo) desde o início e o final dos intervalos retornados na coleção de intervalos. O padrão é falso, o que indica que caracteres de espaçamento no início e no final dos intervalos são incluídos na coleção de intervalos.

Retornos

Word.RangeCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

insertBreak(breakType, insertLocation)

Insere uma quebra no local especificado no documento principal. Esse método não pode ser usado com controles de conteúdo 'RichTextTTable', 'RichTextTableRow' e 'RichTextTableCell'.

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void;

Parâmetros

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Obrigatório. Tipo de interrupção.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Start', 'End', 'Before' ou 'After'.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of content controls.
    contentControls.load('id');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    // We now will have access to the content control collection.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a page break after the first content control.
        contentControls.items[0].insertBreak(Word.BreakType.page, Word.InsertLocation.after);
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted a page break after the first content control.');    
    }
});

insertFileFromBase64(base64File, insertLocation)

Insere um documento no controle de conteúdo no local especificado.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

base64File: string

Obrigatório. O conteúdo codificado em Base64 de um arquivo .docx.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obrigatório. O valor deve ser 'Replace', 'Start' ou 'End'. Não é possível usar 'Replace' com controles de conteúdo 'RichTextTable' e 'RichTextTableRow'.

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi 1.1 ]

Observação: não há suporte para inserção se o documento inserido contiver um controle ActiveX (provavelmente em um campo de formulário). Considere substituir esse campo de formulário por um controle de conteúdo ou outra opção apropriada para seu cenário.

insertHtml(html, insertLocation)

Insere HTML no local especificado dentro do controle de conteúdo.

insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

html: string

Obrigatório. O HTML a inserir no controle de conteúdo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obrigatório. O valor deve ser 'Replace', 'Start' ou 'End'. Não é possível usar 'Replace' com controles de conteúdo 'RichTextTable' e 'RichTextTableRow'.

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put HTML into the contents of the first content control.
        contentControls.items[0].insertHtml(
            '<strong>HTML content inserted into the content control.</strong>',
            'Start');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted HTML in the first content control.');
    }
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Insere uma imagem embutida no local especificado dentro do controle de conteúdo.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;

Parâmetros

base64EncodedImage: string

Obrigatório. A imagem codificada base64 a ser inserida no controle de conteúdo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obrigatório. O valor deve ser 'Replace', 'Start' ou 'End'. Não é possível usar 'Replace' com controles de conteúdo 'RichTextTable' e 'RichTextTableRow'.

Retornos

Word.InlinePicture

Comentários

[ Conjunto de API: WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

Insere OOXML no controle de conteúdo no local especificado.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

ooxml: string

Obrigatório. O OOXML a ser inserido no controle de conteúdo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obrigatório. O valor deve ser 'Replace', 'Start' ou 'End'. Não é possível usar 'Replace' com controles de conteúdo 'RichTextTable' e 'RichTextTableRow'.

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put OOXML into the contents of the first content control.
        contentControls.items[0].insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", "End");
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted OOXML in the first content control.');
    }
});  

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

insertParagraph(paragraphText, insertLocation)

Insere um parágrafo no local especificado.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;

Parâmetros

paragraphText: string

Obrigatório. O texto do parágrafo a ser inserido.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Start', 'End', 'Before' ou 'After'. 'Before' e 'After' não podem ser usados com controles de conteúdo 'RichTextTTableRow', 'RichTextTableRow' e 'RichTextTableCell'.

Retornos

Word.Paragraph

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a paragraph after the first content control.
        contentControls.items[0].insertParagraph('Text of the inserted paragraph.', 'After');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted a paragraph after the first content control.');
    }
});

insertTable(rowCount, columnCount, insertLocation, values)

Insere uma tabela com a quantidade especificada de linhas e colunas dentro ou próxima do controle de conteúdo.

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table;

Parâmetros

rowCount: number

Obrigatório. A quantidade de linhas na tabela.

columnCount: number

Obrigatório. A quantidade de colunas na tabela.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Start', 'End', 'Before' ou 'After'. 'Before' e 'After' não podem ser usados com controles de conteúdo 'RichTextTTableRow', 'RichTextTableRow' e 'RichTextTableCell'.

values: string[][]

Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.

Retornos

Word.Table

Comentários

[ Conjunto de API: WordApi 1.3 ]

insertText(text, insertLocation)

Insere texto no local especificado dentro do controle de conteúdo.

insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

text: string

Obrigatório. O texto a inserir no controle de conteúdo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Obrigatório. O valor deve ser 'Replace', 'Start' ou 'End'. Não é possível usar 'Replace' com controles de conteúdo 'RichTextTable' e 'RichTextTableRow'.

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to replace text in the first content control.
        contentControls.items[0].insertText('Replaced text in the first content control.', 'Replace');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Replaced text in the first content control.');
    }
});  

// The Silly stories add-in sample shows how to use the insertText method.
// https://aka.ms/sillystorywordaddin

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.ContentControlLoadOptions): Word.ContentControl;

Parâmetros

options: Word.Interfaces.ContentControlLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.ContentControl

Exemplos

// Load all of the content control properties
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    } else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');             
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' + 
            '   ----- appearance: ' + contentControls.items[0].appearance + 
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.ContentControl;

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Word.ContentControl

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ContentControl;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.ContentControl

search(searchText, searchOptions)

Executa uma pesquisa com as SearchOptions especificadas no escopo do objeto de controle de conteúdo. Os resultados da pesquisa são uma coleção de objetos Range.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parâmetros

searchText: string

Obrigatório. O texto da pesquisa.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Opcional. Opções da pesquisa.

Retornos

Word.RangeCollection

Comentários

[ Conjunto de API: WordApi 1.1 ]

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to select the first content control.
        contentControls.items[0].select();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Selected the first content control.');
    }
});

select(selectionMode)

Seleciona o controle de conteúdo. Isso faz com que o Word role até a seleção.

select(selectionMode?: Word.SelectionMode): void;

Parâmetros

selectionMode: Word.SelectionMode

Opcional. O modo de seleção deve ser 'Select', 'Start' ou 'End'. 'Select' é o padrão.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.1 ]

select(selectionModeString)

Seleciona o controle de conteúdo. Isso faz com que o Word role até a seleção.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Parâmetros

selectionModeString: "Select" | "Start" | "End"

Opcional. O modo de seleção deve ser 'Select', 'Start' ou 'End'. 'Select' é o padrão.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.1 ]

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Word.Interfaces.ContentControlUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml

// Adds title and colors to odd and even content controls and changes their appearance.
await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  let evenContentControls = context.document.contentControls.getByTag("even");
  let oddContentControls = context.document.contentControls.getByTag("odd");
  evenContentControls.load("length");
  oddContentControls.load("length");

  await context.sync();

  for (let i = 0; i < evenContentControls.items.length; i++) {
    // Change a few properties and append a paragraph.
    evenContentControls.items[i].set({
      color: "red",
      title: "Odd ContentControl #" + (i + 1),
      appearance: Word.ContentControlAppearance.tags
    });
    evenContentControls.items[i].insertParagraph("This is an odd content control", "End");
  }

  for (let j = 0; j < oddContentControls.items.length; j++) {
    // Change a few properties and append a paragraph.
    oddContentControls.items[j].set({
      color: "green",
      title: "Even ContentControl #" + (j + 1),
      appearance: "Tags"
    });
    oddContentControls.items[j].insertHtml("This is an <b>even</b> content control", "End");
  }

  await context.sync();
});

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.ContentControl): void;

Parâmetros

properties: Word.ContentControl

Retornos

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

Divide o controle de conteúdo em intervalos filho usando delimitadores.

split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;

Parâmetros

delimiters: string[]

Obrigatório. Os delimitadores como uma matriz de cadeias de caracteres.

multiParagraphs: boolean

Opcional. Indica se um intervalo filho retornado pode cobrir vários parágrafos. O padrão é falso, o que indica que os limites do parágrafo também são usados como delimitadores.

trimDelimiters: boolean

Opcional. Indica se é necessário cortar delimitadores dos intervalos na coleção de intervalos. O padrão é falso, o que indica que os delimitadores estão incluídos nos intervalos retornados na coleção de intervalos.

trimSpacing: boolean

Retornos

Word.RangeCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto ContentControl é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ContentControlData) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.ContentControlData;

Retornos

Word.Interfaces.ContentControlData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.ContentControl;

Retornos

Word.ContentControl

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.ContentControl;

Retornos

Word.ContentControl

Share via

Word.ContentControl class

Comentários

Exemplos

Propriedades

Métodos

Detalhes da propriedade

appearance

Valor da propriedade

Comentários

cannotDelete

Valor da propriedade

Comentários

cannotEdit

Valor da propriedade

Comentários

color

Valor da propriedade

Comentários

contentControls

Valor da propriedade

Comentários

context

Valor da propriedade

font

Valor da propriedade

Comentários

id

Valor da propriedade

Comentários

inlinePictures

Valor da propriedade

Comentários

lists

Valor da propriedade

Comentários

paragraphs

Valor da propriedade

Comentários

parentBody

Valor da propriedade

Comentários

parentContentControl

Valor da propriedade

Comentários

parentContentControlOrNullObject

Valor da propriedade

Comentários

parentTable

Valor da propriedade

Comentários

parentTableCell

Valor da propriedade

Comentários

parentTableCellOrNullObject

Valor da propriedade

Comentários

parentTableOrNullObject

Valor da propriedade

Comentários

placeholderText

Valor da propriedade

Comentários

removeWhenEdited

Valor da propriedade

Comentários

style

Valor da propriedade

Comentários

styleBuiltIn

Valor da propriedade

Comentários

subtype

Valor da propriedade

Comentários

tables

Valor da propriedade

Comentários

tag

Valor da propriedade