Word.Interfaces.ContentControlCollectionLoadOptions interface

Pacote:

word

Contém uma coleção de Word. Objetos ContentControl. Os controles de conteúdo são regiões associadas e potencialmente rotuladas em um documento que servem como contêineres para tipos específicos de conteúdo. Os controles de conteúdo individuais podem incluir conteúdo, como imagens, tabelas ou parágrafos de texto formatado. Atualmente, apenas são suportados controlos de conteúdo de texto formatado e texto simples.

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	Para CADA ITEM na coleção: especifica o aspeto do controlo de conteúdo. O valor pode ser "BoundingBox", "Tags" ou "Hidden".
cannotDelete	Para CADA ITEM na coleção: especifica um valor que indica se o utilizador pode eliminar o controlo de conteúdo. Mutuamente exclusivo com a propriedade removeWhenEdited.
cannotEdit	Para CADA ITEM na coleção: especifica um valor que indica se o utilizador pode editar os conteúdos do controlo de conteúdo.
checkboxContentControl	Para CADA ITEM na coleção: obtém os dados do controlo de conteúdo quando o respetivo tipo é "Caixa de Verificação". De null outra forma.
color	Para CADA ITEM na coleção: especifica a cor do controlo de conteúdo. A cor é especificada no formato "#RRGGBB" ou utilizando o nome da cor.
font	Para CADA ITEM na coleção: obtém o formato de texto do controlo de conteúdo. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.
id	Para CADA ITEM na coleção: obtém um número inteiro que representa o identificador de controlo de conteúdo.
parentBody	Para CADA ITEM na coleção: obtém o corpo principal do controlo de conteúdo.
parentContentControl	Para CADA ITEM na coleção: obtém o controlo de conteúdo que contém o controlo de conteúdo. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.
parentContentControlOrNullObject	Para CADA ITEM na coleção: obtém o controlo de conteúdo que contém o controlo 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	Para CADA ITEM na coleção: obtém a tabela que contém o controlo de conteúdo. Gera um ItemNotFound erro se não estiver contido numa tabela.
parentTableCell	Para CADA ITEM na coleção: obtém a célula da tabela que contém o controlo de conteúdo. Gera um ItemNotFound erro se não estiver contido numa célula de tabela.
parentTableCellOrNullObject	Para CADA ITEM na coleção: obtém a célula da tabela que contém o controlo 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	Para CADA ITEM na coleção: obtém a tabela que contém o controlo 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).
placeholderText	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: especifica um valor que indica se o controlo de conteúdo é removido depois de ser editado. Mutuamente exclusivo com a propriedade cannotDelete.
style	Para CADA ITEM na coleção: especifica o nome do estilo para o controlo 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	Para CADA ITEM na coleção: 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 usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".
subtype	Para CADA ITEM na coleção: obtém o subtipo de controlo de conteúdo. O subtipo pode ser "RichTextInline", "RichTextParagraphs", "RichTextTableCell", "RichTextTableRow" e "RichTextTable" para controlos de conteúdo de texto formatado ou "PlainTextInline" e "PlainTextParagraph" para controlos de conteúdo de texto simples ou "Caixa de Verificação" para controlos de conteúdo da caixa de verificação.
tag	Para CADA ITEM na coleção: especifica uma etiqueta para identificar um controlo de conteúdo.
text	Para CADA ITEM na coleção: obtém o texto do controlo de conteúdo.
title	Para CADA ITEM na coleção: especifica o título de um controlo de conteúdo.
type	Para CADA ITEM na coleção: obtém o tipo de controlo de conteúdo. Atualmente, só são suportados controlos de conteúdo de rich text, texto simples e caixa de verificação.

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

Para CADA ITEM na coleção: especifica o aspeto do controlo de conteúdo. O valor pode ser "BoundingBox", "Tags" ou "Hidden".

appearance?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

cannotDelete

Para CADA ITEM na coleção: especifica um valor que indica se o utilizador pode eliminar o controlo de conteúdo. Mutuamente exclusivo com a propriedade removeWhenEdited.

cannotDelete?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

cannotEdit

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém os dados do controlo de conteúdo quando o respetivo tipo é "Caixa de Verificação". De null outra forma.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;

Valor da propriedade

Word.Interfaces.CheckboxContentControlLoadOptions

Comentários

[ Conjunto de API: WordApi 1.7 ]

color

Para CADA ITEM na coleção: 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 ]

font

Para CADA ITEM na coleção: obtém o formato de texto do controlo 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

Word.Interfaces.FontLoadOptions

Comentários

[ Conjunto de API: WordApi 1.1 ]

id

Para CADA ITEM na coleção: obtém um número inteiro que representa o identificador de controlo de conteúdo.

id?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

parentBody

Para CADA ITEM na coleção: obtém o corpo principal do controlo de conteúdo.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Word.Interfaces.BodyLoadOptions

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentContentControl

Para CADA ITEM na coleção: obtém o controlo de conteúdo que contém o controlo de conteúdo. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Valor da propriedade

Word.Interfaces.ContentControlLoadOptions

Comentários

[ Conjunto de API: WordApi 1.1 ]

parentContentControlOrNullObject

Para CADA ITEM na coleção: obtém o controlo de conteúdo que contém o controlo 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

Word.Interfaces.ContentControlLoadOptions

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTable

Para CADA ITEM na coleção: obtém a tabela que contém o controlo de conteúdo. Gera um ItemNotFound erro se não estiver contido numa tabela.

parentTable?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

Word.Interfaces.TableLoadOptions

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableCell

Para CADA ITEM na coleção: obtém a célula da tabela que contém o controlo de conteúdo. Gera um ItemNotFound erro se não estiver contido numa célula de tabela.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Valor da propriedade

Word.Interfaces.TableCellLoadOptions

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableCellOrNullObject

Para CADA ITEM na coleção: obtém a célula da tabela que contém o controlo 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

Word.Interfaces.TableCellLoadOptions

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTableOrNullObject

Para CADA ITEM na coleção: obtém a tabela que contém o controlo 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

Word.Interfaces.TableLoadOptions

Comentários

[ Conjunto de API: WordApi 1.3 ]

placeholderText

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: especifica um valor que indica se o controlo de conteúdo é removido depois de ser editado. Mutuamente exclusivo com a propriedade cannotDelete.

removeWhenEdited?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

style

Para CADA ITEM na coleção: especifica o nome do estilo para o controlo 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?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

styleBuiltIn

Para CADA ITEM na coleção: 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 usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".

styleBuiltIn?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.3 ]

subtype

Para CADA ITEM na coleção: obtém o subtipo de controlo de conteúdo. O subtipo pode ser "RichTextInline", "RichTextParagraphs", "RichTextTableCell", "RichTextTableRow" e "RichTextTable" para controlos de conteúdo de texto formatado ou "PlainTextInline" e "PlainTextParagraph" para controlos de conteúdo de texto simples ou "Caixa de Verificação" para controlos de conteúdo da caixa de verificação.

subtype?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.3 ]

tag

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém o texto do controlo de conteúdo.

text?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

title

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém o tipo de controlo de conteúdo. Atualmente, só são suportados controlos de conteúdo de rich text, texto simples e caixa de verificação.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]