Compartilhar via


Word.Interfaces.ContentControlData interface

Uma interface que descreve os dados devolvidos ao chamar contentControl.toJSON().

Propriedades

appearance

Especifica o aspeto do controlo de conteúdo. O valor pode ser boundingBox, tagsou hidden.

buildingBlockGalleryContentControl

Obtém os dados relacionados com a galeria de blocos modulares se o controlo de conteúdo Word. ContentControlType é buildingBlockGallery. De null outra forma.

cannotDelete

Especifica um valor que indica se o utilizador pode eliminar o controlo de conteúdo. Mutuamente exclusivo com removeWhenEdited.

cannotEdit

Especifica um valor que indica se o utilizador pode editar os conteúdos do controlo de conteúdo.

checkboxContentControl

Obtém os dados do controlo de conteúdo quando o respetivo tipo é checkBox. De null outra forma.

color

Especifica a cor do controlo de conteúdo. A cor é especificada no formato "#RRGGBB" ou utilizando o nome da cor.

comboBoxContentControl

Obtém os dados do controlo de conteúdo quando o respetivo tipo é comboBox. De null outra forma.

contentControls

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

datePickerContentControl

Obtém os dados relacionados com o seletor de datas se o controlo de conteúdo Word. ContentControlType é datePicker. De null outra forma.

dropDownListContentControl

Obtém os dados do controlo de conteúdo quando o respetivo tipo é dropDownList. De null outra forma.

fields

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

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.

groupContentControl

Obtém os dados relacionados com o grupo se o controlo de conteúdo Word. ContentControlType é group. De null outra forma.

id

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

inlinePictures

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

lists

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

paragraphs

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

pictureContentControl

Obtém os dados relacionados com a imagem se o controlo de conteúdo Word. ContentControlType é picture. De null outra forma.

placeholderText

Especifica o texto do marcador de posição do controlo de conteúdo. Quando o controle de conteúdo está vazio, o sistema exibe o texto esmaecido.

removeWhenEdited

Especifica um valor que indica se o controlo de conteúdo é removido depois de ser editado. Mutuamente exclusivo com cannotDelete.

repeatingSectionContentControl

Obtém os dados relacionados com a secção de repetição se o controlo de conteúdo for Word. ContentControlType é repeatingSection. De null outra forma.

style

Especifica o nome do estilo para o controlo de conteúdo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para utilizar os estilos incorporados que são portáteis entre regiões, consulte a styleBuiltIn propriedade .

styleBuiltIn

Especifica o nome de estilo incorporado para o controlo de conteúdo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para utilizar estilos personalizados ou nomes de estilos localizados, consulte a style propriedade .

subtype

Obtém o subtipo de controle de conteúdo. O subtipo pode ser richTextInline, richTextParagraphs, richTextTableCellrichTextTableRow e richTextTable para controlos plainTextInline de conteúdo de texto formatado, e plainTextParagraph para controlos de conteúdo de texto simples, checkBox para controlos de conteúdo de caixa de verificação, dropDownList para controlos de conteúdo de lista pendente, comboBox para controlos de conteúdo de caixa de combinação, buildingBlockGallery para controlos de conteúdo da galeria de blocos modulares, datePicker para controlos de conteúdo do seletor de datas, repeatingSection para a repetição de controlos de conteúdo de secção, picture para controlos de conteúdo de imagem e group para controlos de conteúdo de grupo.

tables

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

tag

Especifica uma etiqueta para identificar um controlo de conteúdo.

text

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

title

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

type

Obtém o tipo de controle de conteúdo. Atualmente, só são suportados controlos de texto formatado, texto simples, caixa de marcar, lista pendente, caixa de combinação, galeria de blocos modulares, seletor de datas, secção de repetição, imagem e conteúdo de grupo.

xmlMapping

Devolve um XmlMapping objeto que representa o mapeamento do controlo de conteúdo para dados XML no arquivo de dados do documento.

Detalhes da propriedade

appearance

Especifica o aspeto do controlo de conteúdo. O valor pode ser boundingBox, tagsou hidden.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApi 1.1 ]

buildingBlockGalleryContentControl

Obtém os dados relacionados com a galeria de blocos modulares se o controlo de conteúdo Word. ContentControlType é buildingBlockGallery. De null outra forma.

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

cannotDelete

Especifica um valor que indica se o utilizador pode eliminar o controlo de conteúdo. Mutuamente exclusivo com removeWhenEdited.

cannotDelete?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

cannotEdit

Especifica um valor que indica se o utilizador pode editar os conteúdos do controlo de conteúdo.

cannotEdit?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

checkboxContentControl

Obtém os dados do controlo de conteúdo quando o respetivo tipo é checkBox. De null outra forma.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.7 ]

color

Especifica a cor do controlo de conteúdo. A cor é especificada no formato "#RRGGBB" ou utilizando o nome da cor.

color?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

comboBoxContentControl

Obtém os dados do controlo de conteúdo quando o respetivo tipo é comboBox. De null outra forma.

comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.9 ]

contentControls

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

contentControls?: Word.Interfaces.ContentControlData[];

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

datePickerContentControl

Obtém os dados relacionados com o seletor de datas se o controlo de conteúdo Word. ContentControlType é datePicker. De null outra forma.

datePickerContentControl?: Word.Interfaces.DatePickerContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

dropDownListContentControl

Obtém os dados do controlo de conteúdo quando o respetivo tipo é dropDownList. De null outra forma.

dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.9 ]

fields

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

fields?: Word.Interfaces.FieldData[];

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

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.

font?: Word.Interfaces.FontData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

groupContentControl

Obtém os dados relacionados com o grupo se o controlo de conteúdo Word. ContentControlType é group. De null outra forma.

groupContentControl?: Word.Interfaces.GroupContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

id

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

id?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.1 ]

inlinePictures

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

inlinePictures?: Word.Interfaces.InlinePictureData[];

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

lists

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

lists?: Word.Interfaces.ListData[];

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

paragraphs

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

paragraphs?: Word.Interfaces.ParagraphData[];

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Importante: para os conjuntos de requisitos 1.1 e 1.2, os parágrafos em tabelas totalmente contidas neste controlo de conteúdo não são devolvidos. A partir do conjunto de requisitos 1.3, os parágrafos nessas tabelas também são devolvidos.

pictureContentControl

Obtém os dados relacionados com a imagem se o controlo de conteúdo Word. ContentControlType é picture. De null outra forma.

pictureContentControl?: Word.Interfaces.PictureContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

placeholderText

Especifica o texto do marcador de posição do controlo de conteúdo. Quando o controle de conteúdo está vazio, o sistema exibe o texto esmaecido.

placeholderText?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

removeWhenEdited

Especifica um valor que indica se o controlo de conteúdo é removido depois de ser editado. Mutuamente exclusivo com cannotDelete.

removeWhenEdited?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

repeatingSectionContentControl

Obtém os dados relacionados com a secção de repetição se o controlo de conteúdo for Word. ContentControlType é repeatingSection. De null outra forma.

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

style

Especifica o nome do estilo para o controlo de conteúdo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para utilizar os estilos incorporados que são portáteis entre regiões, consulte a styleBuiltIn propriedade .

style?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

styleBuiltIn

Especifica o nome de estilo incorporado para o controlo de conteúdo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para utilizar estilos personalizados ou nomes de estilos localizados, consulte a style propriedade .

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

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"

Comentários

[ Conjunto de API: WordApi 1.3 ]

subtype

Obtém o subtipo de controle de conteúdo. O subtipo pode ser richTextInline, richTextParagraphs, richTextTableCellrichTextTableRow e richTextTable para controlos plainTextInline de conteúdo de texto formatado, e plainTextParagraph para controlos de conteúdo de texto simples, checkBox para controlos de conteúdo de caixa de verificação, dropDownList para controlos de conteúdo de lista pendente, comboBox para controlos de conteúdo de caixa de combinação, buildingBlockGallery para controlos de conteúdo da galeria de blocos modulares, datePicker para controlos de conteúdo do seletor de datas, repeatingSection para a repetição de controlos de conteúdo de secção, picture para controlos de conteúdo de imagem e group para controlos de conteúdo de grupo.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApi 1.3 ]

tables

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

tables?: Word.Interfaces.TableData[];

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

tag

Especifica uma etiqueta para identificar um controlo de conteúdo.

tag?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

text

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

text?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.1 ]

title

Especifica o título de um controlo 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, só são suportados controlos de texto formatado, texto simples, caixa de marcar, lista pendente, caixa de combinação, galeria de blocos modulares, seletor de datas, secção de repetição, imagem e conteúdo de grupo.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApi 1.1 ]

xmlMapping

Devolve um XmlMapping objeto que representa o mapeamento do controlo de conteúdo para dados XML no arquivo de dados do documento.

xmlMapping?: Word.Interfaces.XmlMappingData;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]