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 conteúdo de rich text, texto simples e caixa de verificaçã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", "Tags" ou "Hidden".

cannotDelete

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

cannotEdit

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

color

Especifica a cor do controlo de conteúdo. A cor é especificada no formato "#RRGGBB" ou utilizando o nome da 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.

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.

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.

Nota: a operação de conjunto para esta propriedade não é suportada no Word na Web.

removeWhenEdited

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

style

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

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

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

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

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 ]

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 ]

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 ]

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 ]

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.

Nota: a operação de conjunto para esta propriedade não é suportada no 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 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

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 ]

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