Word.Interfaces.ContentControlData interface

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

Remarques

Utilisateur

Propriétés

appearance

Indique l’apparence du contrôle de contenu. La valeur peut être boundingBox, tags, ou hidden.

buildingBlockGalleryContentControl

Obtient les données relatives à la galerie de blocs de construction si le contrôle de contenu est Word. ContentControlType est buildingBlockGallery. C’est null autrement.

cannotDelete

Indique si l’utilisateur peut supprimer le contrôle de contenu. Mutuellement exclusif avec removeWhenEdited.

cannotEdit

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

color

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

comboBoxContentControl

Obtient les données du contrôle de contenu lorsque son type est comboBox. C’est null autrement.

contentControls

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

datePickerContentControl

Obtient les données liées au sélecteur de dates si le contrôle de contenu est Word. ContentControlType est datePicker. C’est null autrement.

dropDownListContentControl

Obtient les données du contrôle de contenu lorsque son type est dropDownList. C’est null autrement.

fields

Obtient la collection d’objets dans le contrôle de Field 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.

groupContentControl

Obtient les données relatives au groupe si le contrôle de contenu est Word. ContentControlType est group. C’est null autrement.

id

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

inlinePictures

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

lists

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

paragraphs

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

pictureContentControl

Obtient les données relatives à l’image si le contrôle de contenu est Word. ContentControlType est picture. C’est null autrement.

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

Indique si le contrôle de contenu est supprimé après avoir été modifié. Mutuellement exclusif avec cannotDelete.

repeatingSectionContentControl

Obtient les données liées à la section répétitive si le contrôle de contenu est Word. ContentControlType est repeatingSection. C’est null autrement.

style

Spécifie le nom de style du 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 transférables entre les paramètres régionaux, voir la styleBuiltIn propriété.

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 styles localisés, voir la style propriété.

subtype

Obtient le sous-type du contrôle de contenu. Le sous-type peut être richTextInline, richTextTableCellrichTextParagraphsrichTextTableRow, et richTextTable pour les contrôles de contenu de texte enrichi, plainTextInline et plainTextParagraph pour les contrôles de contenu de texte brut, checkBox pour les contrôles de contenu de case à cocher, dropDownList pour les contrôles de contenu de liste déroulante, comboBox pour les contrôles de contenu de zone de liste déroulante, buildingBlockGallery pour les contrôles de contenu de galerie de blocs de construction, datePicker pour les contrôles de contenu de sélecteur de date, repeatingSection pour les contrôles de contenu de section répétitive, picture pour les contrôles de contenu d’image et group pour les contrôles de contenu de groupe.

tables

Obtient la collection d’objets dans le contrôle de Table 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, de case activée, de liste déroulante, de zone de liste modifiable, de galerie de blocs de construction, de sélecteur de date, de section répétée, d’image et de contenu de groupe sont actuellement pris en charge.

xmlMapping

Renvoie un XmlMapping objet qui représente le mappage du contrôle de contenu aux données XML du magasin de données du document.

Détails de la propriété

appearance

Indique 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

Jeu d’API : WordApi 1.1

buildingBlockGalleryContentControl

Obtient les données relatives à la galerie de blocs de construction si le contrôle de contenu est Word. ContentControlType est buildingBlockGallery. C’est null autrement.

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

cannotDelete

Indique si l’utilisateur peut supprimer le contrôle de contenu. Mutuellement exclusif avec removeWhenEdited.

cannotDelete?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.1

cannotEdit

Indique si l’utilisateur peut modifier le contenu du contrôle de contenu.

cannotEdit?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.1

checkboxContentControl

Obtient les données du contrôle de contenu lorsque son type est checkBox. C’est null autrement.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;

Valeur de propriété

Remarques

Jeu 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 en utilisant le nom de la couleur.

color?: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.1

comboBoxContentControl

Obtient les données du contrôle de contenu lorsque son type est comboBox. C’est null autrement.

comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.9

contentControls

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

contentControls?: Word.Interfaces.ContentControlData[];

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

datePickerContentControl

Obtient les données liées au sélecteur de dates si le contrôle de contenu est Word. ContentControlType est datePicker. C’est null autrement.

datePickerContentControl?: Word.Interfaces.DatePickerContentControlData;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

dropDownListContentControl

Obtient les données du contrôle de contenu lorsque son type est dropDownList. C’est null autrement.

dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.9

fields

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

fields?: Word.Interfaces.FieldData[];

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApi 1.1

groupContentControl

Obtient les données relatives au groupe si le contrôle de contenu est Word. ContentControlType est group. C’est null autrement.

groupContentControl?: Word.Interfaces.GroupContentControlData;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

id

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

id?: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApi 1.1

inlinePictures

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

inlinePictures?: Word.Interfaces.InlinePictureData[];

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

lists

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

lists?: Word.Interfaces.ListData[];

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.3

paragraphs

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

paragraphs?: Word.Interfaces.ParagraphData[];

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

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

pictureContentControl

Obtient les données relatives à l’image si le contrôle de contenu est Word. ContentControlType est picture. C’est null autrement.

pictureContentControl?: Word.Interfaces.PictureContentControlData;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

Jeu d’API : WordApi 1.1

removeWhenEdited

Indique si le contrôle de contenu est supprimé après avoir été modifié. Mutuellement exclusif avec cannotDelete.

removeWhenEdited?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.1

repeatingSectionContentControl

Obtient les données liées à la section répétitive si le contrôle de contenu est Word. ContentControlType est repeatingSection. C’est null autrement.

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

style

Spécifie le nom de style du 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 transférables entre les paramètres régionaux, voir la styleBuiltIn propriété.

style?: string;

Valeur de propriété

string

Remarques

Jeu 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 styles localisés, voir la style propriété.

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

Jeu d’API : WordApi 1.3

subtype

Obtient le sous-type du contrôle de contenu. Le sous-type peut être richTextInline, richTextTableCellrichTextParagraphsrichTextTableRow, et richTextTable pour les contrôles de contenu de texte enrichi, plainTextInline et plainTextParagraph pour les contrôles de contenu de texte brut, checkBox pour les contrôles de contenu de case à cocher, dropDownList pour les contrôles de contenu de liste déroulante, comboBox pour les contrôles de contenu de zone de liste déroulante, buildingBlockGallery pour les contrôles de contenu de galerie de blocs de construction, datePicker pour les contrôles de contenu de sélecteur de date, repeatingSection pour les contrôles de contenu de section répétitive, picture pour les contrôles de contenu d’image et group pour les contrôles de contenu de groupe.

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

Valeur de propriété

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

Remarques

Jeu d’API : WordApi 1.3

tables

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

tables?: Word.Interfaces.TableData[];

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApi 1.1

text

Obtient le texte du contrôle de contenu.

text?: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.1

title

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

title?: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.1

type

Obtient le type du contrôle de contenu. Seuls les contrôles de texte enrichi, de texte brut, de case activée, de liste déroulante, de zone de liste modifiable, de galerie de blocs de construction, de sélecteur de date, de section répétée, d’image et de contenu de groupe 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" | "Group";

Valeur de propriété

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

Remarques

Jeu d’API : WordApi 1.1

xmlMapping

Renvoie un XmlMapping objet qui représente le mappage du contrôle de contenu aux données XML du magasin de données du document.

xmlMapping?: Word.Interfaces.XmlMappingData;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3