Word.Interfaces.ContentControlData interface

  • Referencia
Paquete:
word

Interfaz que describe los datos devueltos mediante una llamada a contentControl.toJSON().

Propiedades

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

Obtiene la colección de objetos de control de contenido que se encuentran en el control de contenido.
dropDownListContentControl

Especifica los datos relacionados con la lista desplegable si el tipo del control de contenido es "DropDownList". De lo contrario, es null.
fields

Obtiene la colección de objetos de campo en el control de contenido.
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.
inlinePictures

Obtiene la colección de objetos InlinePicture en el control de contenido. La colección no incluye imágenes flotantes.
lists

Obtiene la colección de objetos de lista en el control de contenido.
paragraphs

Obtiene la colección de objetos de párrafo en el control de contenido.
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.
tables

Obtiene la colección de objetos de tabla en el control de contenido.
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

appearance

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

appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

Valor de propiedad

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

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

Valor de propiedad

Word.Interfaces.CheckboxContentControlData

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

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.1 ]

contentControls

Obtiene la colección de objetos de control de contenido que se encuentran en el control de contenido.

contentControls?: Word.Interfaces.ContentControlData[];

Valor de propiedad

Word.Interfaces.ContentControlData[]

Comentarios

[ Conjunto de API: WordApi 1.1 ]

dropDownListContentControl

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;

Valor de propiedad

Word.Interfaces.DropDownListContentControlData

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

fields

Obtiene la colección de objetos de campo en el control de contenido.

fields?: Word.Interfaces.FieldData[];

Valor de propiedad

Word.Interfaces.FieldData[]

Comentarios

[ Conjunto de API: WordApi 1.4 ]

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

Valor de propiedad

Word.Interfaces.FontData

Comentarios

[ Conjunto de API: WordApi 1.1 ]

id

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

id?: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.1 ]

inlinePictures

Obtiene la colección de objetos InlinePicture en el control de contenido. La colección no incluye imágenes flotantes.

inlinePictures?: Word.Interfaces.InlinePictureData[];

Valor de propiedad

Word.Interfaces.InlinePictureData[]

Comentarios

[ Conjunto de API: WordApi 1.1 ]

lists

Obtiene la colección de objetos de lista en el control de contenido.

lists?: Word.Interfaces.ListData[];

Valor de propiedad

Word.Interfaces.ListData[]

Comentarios

[ Conjunto de API: WordApi 1.3 ]

paragraphs

Obtiene la colección de objetos de párrafo en el control de contenido.

paragraphs?: Word.Interfaces.ParagraphData[];

Valor de propiedad

Word.Interfaces.ParagraphData[]

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Importante: En el caso de los conjuntos de requisitos 1.1 y 1.2, no se devuelven los párrafos de las tablas totalmente contenidos dentro de este control de contenido. A partir del conjunto de requisitos 1.3, también se devuelven los párrafos de dichas tablas.

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

Valor de propiedad

string

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

Valor de propiedad

string

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?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valor de propiedad

Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"

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?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

Valor de propiedad

Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText"

Comentarios

[ Conjunto de API: WordApi 1.3 ]

tables

Obtiene la colección de objetos de tabla en el control de contenido.

tables?: Word.Interfaces.TableData[];

Valor de propiedad

Word.Interfaces.TableData[]

Comentarios

[ Conjunto de API: WordApi 1.3 ]

tag

Especifica una etiqueta para identificar un control de contenido.

tag?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.1 ]

text

Obtiene el texto del control de contenido.

text?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.1 ]

title

Especifica el título de un control de contenido.

title?: string;

Valor de propiedad

string

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?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

Valor de propiedad

Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText"

Comentarios

[ Conjunto de API: WordApi 1.1 ]