Word.Interfaces.ContentControlLoadOptions interface

Paquete:

word

Representa un control de contenido. Los controles de contenido son regiones delimitadas y posiblemente con etiquetas de un documento que funcionan como contenedores para tipos de contenido específicos. Los controles de contenido individuales pueden incluir contenido como imágenes, tablas o párrafos de texto con formato. Actualmente, solo se admiten los controles de contenido de texto enriquecido, texto sin formato y casilla.

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Propiedades

$all	Si se $all especifica para LoadOptions, se cargan todas las propiedades escalares (por ejemplo, Range.address) pero no las propiedades de navegación (por ejemplo, Range.format.fill.color).
appearance	Especifica la apariencia del control de contenido. El valor puede ser "BoundingBox", "Tags" o "Hidden".
cannotDelete	Especifica un valor que indica si el usuario puede eliminar el control de contenido. Esta propiedad y removeWhenEdited son mutuamente excluyentes.
cannotEdit	Especifica un valor que indica si el usuario puede editar el contenido del control de contenido.
checkboxContentControl	Especifica los datos relacionados con la casilla si el tipo del control de contenido es "CheckBox". De lo contrario, es null.
color	Especifica el color del control de contenido. El color se especifica en formato "#RRGGBB" o mediante el nombre del color.
font	Obtiene el formato de texto del control de contenido. Úselo para obtener y establecer el nombre de la fuente, el tamaño, el color y otras propiedades.
id	Obtiene un entero que representa el identificador del control de contenido.
parentBody	Obtiene el cuerpo primario del control de contenido.
parentContentControl	Obtiene el control de contenido que contiene el control de contenido. Produce un ItemNotFound error si no hay un control de contenido primario.
parentContentControlOrNullObject	Obtiene el control de contenido que contiene el control de contenido. Si no hay un control de contenido primario, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
parentTable	Obtiene la tabla que contiene el control de contenido. Produce un ItemNotFound error si no está incluido en una tabla.
parentTableCell	Obtiene la celda de tabla que contiene el control de contenido. Produce un ItemNotFound error si no está contenido en una celda de tabla.
parentTableCellOrNullObject	Obtiene la celda de tabla que contiene el control de contenido. Si no está contenido en una celda de tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
parentTableOrNullObject	Obtiene la tabla que contiene el control de contenido. Si no está contenido en una tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
placeholderText	Especifica el texto del marcador de posición del control de contenido. Se mostrará texto atenuado cuando el control de contenido esté vacío. Nota: La operación set para esta propiedad no se admite en Word en la web.
removeWhenEdited	Especifica un valor que indica si el control de contenido se quita después de editarlo. Esta propiedad y cannotDelete son mutuamente excluyentes.
style	Especifica el nombre de estilo del control de contenido. Use esta propiedad para los estilos personalizados y los nombres de estilo localizados. Para usar los estilos integrados portátiles entre configuraciones regionales, consulte la propiedad "styleBuiltIn".
styleBuiltIn	Especifica el nombre de estilo integrado para el control de contenido. Use esta propiedad para los estilos integrados que son portátiles entre configuraciones regionales. Para usar estilos personalizados o nombres de estilo localizados, consulte la propiedad "style".
subtype	Obtiene el subtipo de control de contenido. El subtipo puede ser "RichTextInline", "RichTextParagraphs", "RichTextTableCell", "RichTextTableRow" y "RichTextTable" para controles de contenido de texto enriquecido, o "PlainTextInline" y "PlainTextParagraph" para controles de contenido de texto sin formato, o "CheckBox" para los controles de contenido de casilla.
tag	Especifica una etiqueta para identificar un control de contenido.
text	Obtiene el texto del control de contenido.
title	Especifica el título de un control de contenido.
type	Obtiene el tipo de control de contenido. Actualmente solo se admiten controles de texto enriquecido, texto sin formato y contenido de casilla.

Detalles de las propiedades

$all

Si se $all especifica para LoadOptions, se cargan todas las propiedades escalares (por ejemplo, Range.address) pero no las propiedades de navegación (por ejemplo, Range.format.fill.color).

$all?: boolean;

Valor de propiedad

boolean

appearance

Especifica la apariencia del control de contenido. El valor puede ser "BoundingBox", "Tags" o "Hidden".

appearance?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

cannotDelete

Especifica un valor que indica si el usuario puede eliminar el control de contenido. Esta propiedad y removeWhenEdited son mutuamente excluyentes.

cannotDelete?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

cannotEdit

Especifica un valor que indica si el usuario puede editar el contenido del control de contenido.

cannotEdit?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

checkboxContentControl

Especifica los datos relacionados con la casilla si el tipo del control de contenido es "CheckBox". De lo contrario, es null.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;

Valor de propiedad

Word.Interfaces.CheckboxContentControlLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.7 ]

color

Especifica el color del control de contenido. El color se especifica en formato "#RRGGBB" o mediante el nombre del color.

color?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

font

Obtiene el formato de texto del control de contenido. Úselo para obtener y establecer el nombre de la fuente, el tamaño, el color y otras propiedades.

font?: Word.Interfaces.FontLoadOptions;

Valor de propiedad

Word.Interfaces.FontLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.1 ]

id

Obtiene un entero que representa el identificador del control de contenido.

id?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

parentBody

Obtiene el cuerpo primario del control de contenido.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor de propiedad

Word.Interfaces.BodyLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentContentControl

Obtiene el control de contenido que contiene el control de contenido. Produce un ItemNotFound error si no hay un control de contenido primario.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Valor de propiedad

Word.Interfaces.ContentControlLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.1 ]

parentContentControlOrNullObject

Obtiene el control de contenido que contiene el control de contenido. Si no hay un control de contenido primario, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Valor de propiedad

Word.Interfaces.ContentControlLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTable

Obtiene la tabla que contiene el control de contenido. Produce un ItemNotFound error si no está incluido en una tabla.

parentTable?: Word.Interfaces.TableLoadOptions;

Valor de propiedad

Word.Interfaces.TableLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTableCell

Obtiene la celda de tabla que contiene el control de contenido. Produce un ItemNotFound error si no está contenido en una celda de tabla.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Valor de propiedad

Word.Interfaces.TableCellLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTableCellOrNullObject

Obtiene la celda de tabla que contiene el control de contenido. Si no está contenido en una celda de tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Valor de propiedad

Word.Interfaces.TableCellLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTableOrNullObject

Obtiene la tabla que contiene el control de contenido. Si no está contenido en una tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valor de propiedad

Word.Interfaces.TableLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.3 ]

placeholderText

Especifica el texto del marcador de posición del control de contenido. Se mostrará texto atenuado cuando el control de contenido esté vacío.

Nota: La operación set para esta propiedad no se admite en Word en la web.

placeholderText?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

removeWhenEdited

Especifica un valor que indica si el control de contenido se quita después de editarlo. Esta propiedad y cannotDelete son mutuamente excluyentes.

removeWhenEdited?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

style

Especifica el nombre de estilo del control de contenido. Use esta propiedad para los estilos personalizados y los nombres de estilo localizados. Para usar los estilos integrados portátiles entre configuraciones regionales, consulte la propiedad "styleBuiltIn".

style?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

styleBuiltIn

Especifica el nombre de estilo integrado para el control de contenido. Use esta propiedad para los estilos integrados que son portátiles entre configuraciones regionales. Para usar estilos personalizados o nombres de estilo localizados, consulte la propiedad "style".

styleBuiltIn?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

subtype

Obtiene el subtipo de control de contenido. El subtipo puede ser "RichTextInline", "RichTextParagraphs", "RichTextTableCell", "RichTextTableRow" y "RichTextTable" para controles de contenido de texto enriquecido, o "PlainTextInline" y "PlainTextParagraph" para controles de contenido de texto sin formato, o "CheckBox" para los controles de contenido de casilla.

subtype?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

tag

Especifica una etiqueta para identificar un control de contenido.

tag?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

text

Obtiene el texto del control de contenido.

text?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

title

Especifica el título de un control de contenido.

title?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

type

Obtiene el tipo de control de contenido. Actualmente solo se admiten controles de texto enriquecido, texto sin formato y contenido de casilla.

type?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]