Share 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, há suporte apenas para controles de conteúdo de texto, texto sem formatação e caixa de seleção.

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

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.

checkboxContentControl

Especifica os dados relacionados à caixa de seleção se o tipo do controle de conteúdo for 'CheckBox'. Caso contrário, é nulo.

color

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

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.

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.

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.

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

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

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 ]

checkboxContentControl

Especifica os dados relacionados à caixa de seleção se o tipo do controle de conteúdo for 'CheckBox'. Caso contrário, é nulo.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.7 ]

color

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

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 ]

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. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.

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

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.

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

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.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

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

Valor da propriedade

boolean

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

Valor da propriedade

boolean

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

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

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 controle 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, 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 ]