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, há suporte apenas para controles de conteúdo de texto e texto simples.

Comentários

[ Conjunto de API: WordApi 1.1 ]

Propriedades

$all	Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).
appearance	Para CADA ITEM na coleção: especifica a aparência do controle 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 usuário pode excluir o controle de conteúdo. Mutuamente exclusivo com a propriedade removeWhenEdited.
cannotEdit	Para CADA ITEM na coleção: especifica um valor que indica se o usuário pode editar o conteúdo do controle de conteúdo.
color	Para CADA ITEM na coleção: especifica a cor do controle de conteúdo. A cor é especificada no formato "#RRGGBB" ou usando o nome de cor.
font	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: obtém um inteiro que representa o identificador de controle de conteúdo.
parentBody	Para CADA ITEM na coleção: obtém o corpo pai do controle de conteúdo.
parentContentControl	Para CADA ITEM na coleção: obtém o controle de conteúdo que contém o controle de conteúdo. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.
parentContentControlOrNullObject	Para CADA ITEM na coleção: obtém o controle de conteúdo que contém 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	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: especifica um valor que indica se o controle de conteúdo é removido após a edição. Mutuamente exclusivo com a propriedade cannotDelete.
style	Para CADA ITEM na coleção: especifica o nome de estilo para o 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	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: 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.
tag	Para CADA ITEM na coleção: especifica uma marca para identificar um controle de conteúdo.
text	Para CADA ITEM na coleção: obtém o texto do controle de conteúdo.
title	Para CADA ITEM na coleção: especifica o título de um controle de conteúdo.
type	Para CADA ITEM na coleção: 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.

Detalhes da propriedade

$all

Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

appearance

Para CADA ITEM na coleção: especifica a aparência do controle 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 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

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

Para CADA ITEM na coleção: especifica a cor do controle de conteúdo. A cor é especificada no formato "#RRGGBB" ou usando o nome de 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 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

Word.Interfaces.FontLoadOptions

Comentários

[ Conjunto de API: WordApi 1.1 ]

id

Para CADA ITEM na coleção: obtém um inteiro que representa o identificador de controle 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 pai do controle 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 controle de conteúdo que contém o controle de conteúdo. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.

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 controle de conteúdo que contém 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.

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 controle de conteúdo. Gerará um ItemNotFound erro se ele não estiver contido em uma 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 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.

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

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

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

Para CADA ITEM na coleção: especifica o nome de estilo para o 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?: 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 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?: 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 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.

subtype?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.3 ]

tag

Para CADA ITEM na coleção: especifica uma marca para identificar um controle 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 controle 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 controle 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 controle de conteúdo. Atualmente, há suporte apenas para controles de conteúdo de texto, texto simples e caixa de seleção.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]