Word.Interfaces.ContentControlLoadOptions interface
Représente un contrôle de contenu. Les contrôles de contenu sont des zones d’un document délimitées par des bordures et pouvant porter une étiquette qui servent à contenir certains types de contenu. Les contrôles de contenu individuels peuvent contenir des images, des tableaux ou des paragraphes de texte mis en forme. Actuellement, seuls les contrôles de texte enrichi, de texte brut et de contenu de case à cocher sont pris en charge.
Remarques
[ Ensemble d’API : WordApi 1.1 ]
Propriétés
$all | La spécification des options de |
appearance | Spécifie l’apparence du contrôle de contenu. La valeur peut être « BoundingBox », « Tags » ou « Hidden ». |
cannot |
Spécifie une valeur qui indique si l’utilisateur peut supprimer le contrôle de contenu. Non compatible avec removeWhenEdited. |
cannot |
Spécifie une valeur qui indique si l’utilisateur peut modifier le contenu du contrôle de contenu. |
checkbox |
Obtient les données du contrôle de contenu lorsque son type est « CheckBox ». C’est |
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. |
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. |
parent |
Obtient le corps parent du contrôle de contenu. |
parent |
Obtient le contrôle de contenu qui contient le contrôle de contenu spécifié. Génère une |
parent |
Obtient le contrôle de contenu qui contient le contrôle de contenu spécifié. S’il n’existe pas de contrôle de contenu parent, cette méthode retourne un objet avec sa |
parent |
Obtient le tableau qui contient le contrôle de contenu. Génère une |
parent |
Obtient la cellule de tableau qui contient le contrôle de contenu. Génère une |
parent |
Obtient la cellule de tableau qui contient le contrôle de contenu. Si elle n’est pas contenue dans une cellule de tableau, cette méthode renvoie un objet avec sa |
parent |
Obtient le tableau qui contient le contrôle de contenu. Si elle n’est pas contenue dans une table, cette méthode retourne un objet avec sa |
placeholder |
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. |
remove |
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 ». |
style |
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. |
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é
$all
La spécification des options de $all
chargement charge toutes les propriétés scalaires (telles que Range.address
) mais pas les propriétés de navigation (telles que Range.format.fill.color
).
$all?: boolean;
Valeur de propriété
boolean
appearance
Spécifie l’apparence du contrôle de contenu. La valeur peut être « BoundingBox », « Tags » ou « Hidden ».
appearance?: boolean;
Valeur de propriété
boolean
Remarques
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
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
checkboxContentControl
Obtient les données du contrôle de contenu lorsque son type est « CheckBox ». C’est null
le contraire.
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
Valeur de propriété
Remarques
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?: boolean;
Valeur de propriété
boolean
Remarques
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.FontLoadOptions;
Valeur de propriété
Remarques
id
Obtient un entier qui représente l’identificateur du contrôle de contenu.
id?: boolean;
Valeur de propriété
boolean
Remarques
parentBody
Obtient le corps parent du contrôle de contenu.
parentBody?: Word.Interfaces.BodyLoadOptions;
Valeur de propriété
Remarques
parentContentControl
Obtient le contrôle de contenu qui contient le contrôle de contenu spécifié. Génère une ItemNotFound
erreur s’il n’existe pas de contrôle de contenu parent.
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
Valeur de propriété
Remarques
parentContentControlOrNullObject
Obtient le contrôle de contenu qui contient le contrôle de contenu spécifié. S’il n’existe pas de contrôle de contenu parent, cette méthode retourne un objet avec sa isNullObject
propriété définie sur true
. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
Valeur de propriété
Remarques
parentTable
Obtient le tableau qui contient le contrôle de contenu. Génère une ItemNotFound
erreur si elle n’est pas contenue dans une table.
parentTable?: Word.Interfaces.TableLoadOptions;
Valeur de propriété
Remarques
parentTableCell
Obtient la cellule de tableau qui contient le contrôle de contenu. Génère une ItemNotFound
erreur si elle n’est pas contenue dans une cellule de tableau.
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
Valeur de propriété
Remarques
parentTableCellOrNullObject
Obtient la cellule de tableau qui contient le contrôle de contenu. Si elle n’est pas contenue dans une cellule de tableau, cette méthode renvoie un objet avec sa isNullObject
propriété définie sur true
. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
Valeur de propriété
Remarques
parentTableOrNullObject
Obtient le tableau qui contient le contrôle de contenu. Si elle n’est pas contenue dans une table, cette méthode retourne un objet avec sa isNullObject
propriété définie sur true
. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
Valeur de propriété
Remarques
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?: boolean;
Valeur de propriété
boolean
Remarques
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
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?: boolean;
Valeur de propriété
boolean
Remarques
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?: boolean;
Valeur de propriété
boolean
Remarques
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?: boolean;
Valeur de propriété
boolean
Remarques
tag
Spécifie une balise pour identifier un contrôle de contenu.
tag?: boolean;
Valeur de propriété
boolean
Remarques
text
Obtient le texte du contrôle de contenu.
text?: boolean;
Valeur de propriété
boolean
Remarques
title
Spécifie le titre d’un contrôle de contenu.
title?: boolean;
Valeur de propriété
boolean
Remarques
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?: boolean;
Valeur de propriété
boolean