Word.Interfaces.ContentControlData interface

Interface décrivant les données retournées en appelant contentControl.toJSON().

Propriétés

appearance

Spécifie l’apparence du contrôle de contenu. La valeur peut être « BoundingBox », « Tags » ou « Hidden ».

cannotDelete

Spécifie une valeur qui indique si l’utilisateur peut supprimer le contrôle de contenu. Non compatible avec removeWhenEdited.

cannotEdit

Spécifie une valeur qui indique si l’utilisateur peut modifier le contenu du contrôle de contenu.

checkboxContentControl

Obtient les données du contrôle de contenu lorsque son type est « CheckBox ». C’est null le contraire.

color

Spécifie la couleur du contrôle de contenu. La couleur est spécifiée au format « #RRGGBB » ou à l’aide du nom de la couleur.

comboBoxContentControl

Obtient les données du contrôle de contenu lorsque son type est « ComboBox ». C’est null le contraire.

contentControls

Obtient la collection d’objets de contrôle de contenu compris dans le contrôle de contenu.

dropDownListContentControl

Obtient les données du contrôle de contenu lorsque son type est « DropDownList ». C’est null le contraire.

fields

Obtient la collection d’objets de champ dans le contrôle de contenu.

font

Obtient le format de texte du contrôle de contenu. Utilisez cette propriété pour obtenir et définir le nom de la police, la taille, la couleur et d’autres propriétés.

id

Obtient un entier qui représente l’identificateur du contrôle de contenu.

inlinePictures

Obtient la collection d’objets InlinePicture dans le contrôle de contenu. La collection n’inclut pas d’images flottantes.

lists

Obtient la collection d’objets list du contrôle de contenu.

paragraphs

Obtient la collection d’objets de paragraphe dans le contrôle de contenu.

placeholderText

Spécifie le texte de l’espace réservé du contrôle de contenu. Ce texte apparaît de façon estompée lorsque le contrôle de contenu est vide.

removeWhenEdited

Spécifie une valeur qui indique si le contrôle de contenu est supprimé après sa modification. Non compatible avec cannotDelete.

style

Spécifie le nom du style pour le contrôle de contenu. Utilisez cette propriété pour les noms des styles personnalisés et localisés. Pour utiliser les styles prédéfinis qui sont portables entre différents paramètres régionaux, voir la propriété « styleBuiltIn ».

styleBuiltIn

Spécifie le nom de style intégré pour le contrôle de contenu. Utilisez cette propriété pour les styles intégrés qui sont portables entre les paramètres régionaux. Pour utiliser des styles personnalisés ou des noms de style localisés, consultez la propriété « style ».

subtype

Obtient le sous-type du contrôle de contenu. Le sous-type peut être « RichTextInline », « RichTextParagraphs », « RichTextTableCell », « RichTextTableRow » et « RichTextTable » pour les contrôles de contenu de texte enrichi, ou « PlainTextInline » et « PlainTextParagraph » pour les contrôles de contenu de texte brut, ou « CheckBox » pour les contrôles de contenu de case à cocher.

tables

Obtient la collection d’objets table du contrôle de contenu.

tag

Spécifie une balise pour identifier un contrôle de contenu.

text

Obtient le texte du contrôle de contenu.

title

Spécifie le titre d’un contrôle de contenu.

type

Obtient le type du contrôle de contenu. Seuls les contrôles de texte enrichi, de texte brut et de contenu de case à cocher sont actuellement pris en charge.

Détails de la propriété

appearance

Spécifie l’apparence du contrôle de contenu. La valeur peut être « BoundingBox », « Tags » ou « Hidden ».

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApi 1.1 ]

cannotDelete

Spécifie une valeur qui indique si l’utilisateur peut supprimer le contrôle de contenu. Non compatible avec removeWhenEdited.

cannotDelete?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.1 ]

cannotEdit

Spécifie une valeur qui indique si l’utilisateur peut modifier le contenu du contrôle de contenu.

cannotEdit?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.1 ]

checkboxContentControl

Obtient les données du contrôle de contenu lorsque son type est « CheckBox ». C’est null le contraire.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.7 ]

color

Spécifie la couleur du contrôle de contenu. La couleur est spécifiée au format « #RRGGBB » ou à l’aide du nom de la couleur.

color?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

comboBoxContentControl

Obtient les données du contrôle de contenu lorsque son type est « ComboBox ». C’est null le contraire.

comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.9 ]

contentControls

Obtient la collection d’objets de contrôle de contenu compris dans le contrôle de contenu.

contentControls?: Word.Interfaces.ContentControlData[];

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

dropDownListContentControl

Obtient les données du contrôle de contenu lorsque son type est « DropDownList ». C’est null le contraire.

dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.9 ]

fields

Obtient la collection d’objets de champ dans le contrôle de contenu.

fields?: Word.Interfaces.FieldData[];

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.4 ]

font

Obtient le format de texte du contrôle de contenu. Utilisez cette propriété pour obtenir et définir le nom de la police, la taille, la couleur et d’autres propriétés.

font?: Word.Interfaces.FontData;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

id

Obtient un entier qui représente l’identificateur du contrôle de contenu.

id?: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

inlinePictures

Obtient la collection d’objets InlinePicture dans le contrôle de contenu. La collection n’inclut pas d’images flottantes.

inlinePictures?: Word.Interfaces.InlinePictureData[];

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

lists

Obtient la collection d’objets list du contrôle de contenu.

lists?: Word.Interfaces.ListData[];

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

paragraphs

Obtient la collection d’objets de paragraphe dans le contrôle de contenu.

paragraphs?: Word.Interfaces.ParagraphData[];

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Important : Pour les ensembles de conditions requises 1.1 et 1.2, les paragraphes des tables entièrement contenus dans ce contrôle de contenu ne sont pas retournés. À partir de l’ensemble de conditions requises 1.3, les paragraphes de ces tableaux sont également retournés.

placeholderText

Spécifie le texte de l’espace réservé du contrôle de contenu. Ce texte apparaît de façon estompée lorsque le contrôle de contenu est vide.

placeholderText?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

removeWhenEdited

Spécifie une valeur qui indique si le contrôle de contenu est supprimé après sa modification. Non compatible avec cannotDelete.

removeWhenEdited?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.1 ]

style

Spécifie le nom du style pour le contrôle de contenu. Utilisez cette propriété pour les noms des styles personnalisés et localisés. Pour utiliser les styles prédéfinis qui sont portables entre différents paramètres régionaux, voir la propriété « styleBuiltIn ».

style?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

styleBuiltIn

Spécifie le nom de style intégré pour le contrôle de contenu. Utilisez cette propriété pour les styles intégrés qui sont portables entre les paramètres régionaux. Pour utiliser des styles personnalisés ou des noms de style localisés, consultez la propriété « 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";

Valeur de propriété

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"

Remarques

[ Ensemble d’API : WordApi 1.3 ]

subtype

Obtient le sous-type du contrôle de contenu. Le sous-type peut être « RichTextInline », « RichTextParagraphs », « RichTextTableCell », « RichTextTableRow » et « RichTextTable » pour les contrôles de contenu de texte enrichi, ou « PlainTextInline » et « PlainTextParagraph » pour les contrôles de contenu de texte brut, ou « CheckBox » pour les contrôles de contenu de case à cocher.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApi 1.3 ]

tables

Obtient la collection d’objets table du contrôle de contenu.

tables?: Word.Interfaces.TableData[];

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.3 ]

tag

Spécifie une balise pour identifier un contrôle de contenu.

tag?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

text

Obtient le texte du contrôle de contenu.

text?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

title

Spécifie le titre d’un contrôle de contenu.

title?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

type

Obtient le type du contrôle de contenu. Seuls les contrôles de texte enrichi, de texte brut et de contenu de case à cocher sont actuellement pris en charge.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApi 1.1 ]