Compartilhar via


Word.Interfaces.ContentControlLoadOptions interface

Representa um controle de conteúdo. Controles de conteúdo são regiões limitadas e possivelmente rotuladas de um documento, que servem como contêineres para tipos específicos de conteúdo. Os controles de conteúdo individuais podem incluir conteúdo, como imagens, tabelas ou parágrafos de texto formatado. Atualmente, apenas são suportados controlos de texto formatado, texto simples, caixa de verificação, lista pendente e conteúdo de caixa de combinação.

Comentários

[ Conjunto de API: WordApi 1.1 ]

Propriedades

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

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.

datePickerContentControl

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

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.

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. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.

parentContentControlOrNullObject

Obtém o controle de conteúdo que inclui o controle de conteúdo. Se não existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentTable

Obtém a tabela que contém o controle de conteúdo. Gera um ItemNotFound erro se não estiver contido numa tabela.

parentTableCell

Obtém a célula de tabela que contém o controle de conteúdo. Gera um ItemNotFound erro se não estiver contido numa célula de tabela.

parentTableCellOrNullObject

Obtém a célula de tabela que contém o controle de conteúdo. Se não estiver contido numa célula de tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentTableOrNullObject

Obtém a tabela que contém o controle de conteúdo. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

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.

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

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

appearance

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

appearance?: boolean;

Valor da propriedade

boolean

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.BuildingBlockGalleryContentControlLoadOptions;

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.CheckboxContentControlLoadOptions;

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?: boolean;

Valor da propriedade

boolean

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.DatePickerContentControlLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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.FontLoadOptions;

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.GroupContentControlLoadOptions;

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?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

parentBody

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

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentContentControl

Obtém o controle de conteúdo que inclui o controle de conteúdo. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Valor da propriedade

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 existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTable

Obtém a tabela que contém o controle de conteúdo. Gera um ItemNotFound erro se não estiver contido numa tabela.

parentTable?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableCell

Obtém a célula de tabela que contém o controle de conteúdo. Gera um ItemNotFound erro se não estiver contido numa célula de tabela.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Valor da propriedade

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 não estiver contido numa célula de tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableOrNullObject

Obtém a tabela que contém o controle de conteúdo. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

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.PictureContentControlLoadOptions;

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?: boolean;

Valor da propriedade

boolean

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.RepeatingSectionContentControlLoadOptions;

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?: boolean;

Valor da propriedade

boolean

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?: boolean;

Valor da propriedade

boolean

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?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.3 ]

tag

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

tag?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

text

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

text?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

title

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

title?: boolean;

Valor da propriedade

boolean

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?: boolean;

Valor da propriedade

boolean

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.XmlMappingLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]