Word.RepeatingSectionContentControl class
Représente l’objet RepeatingSectionContentControl .
- Extends
Remarques
Propriétés
| allow |
Spécifie si les utilisateurs peuvent ajouter ou supprimer des sections de ce contrôle de contenu de section répétitif à l’aide de l’interface utilisateur. |
| appearance | Spécifie l’apparence du contrôle de contenu. |
| color | Spécifie la valeur rouge-vert-bleu (RVB) de la couleur du contrôle de contenu. Vous pouvez fournir la valeur au format « #RRGGBB ». |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| id | Retourne l’identification du contrôle de contenu. |
| is |
Spécifie s’il faut supprimer le contrôle de contenu du document actif lorsque l’utilisateur modifie le contenu du contrôle. |
| level | Retourne le niveau du contrôle de contenu, que le contrôle de contenu entoure du texte, des paragraphes, des cellules de tableau ou des lignes de tableau ; ou s’il est inline. |
| lock |
Spécifie si le contrôle de contenu est verrouillé (ne peut pas être supprimé).
|
| lock |
Spécifie si le contenu du contrôle de contenu est verrouillé (non modifiable).
|
| placeholder |
Renvoie un |
| range | Obtient un |
| repeating |
Retourne la collection d’éléments de section répétitifs dans ce contrôle de contenu de section répétée. |
| repeating |
Spécifie le nom des éléments de section répétitifs utilisés dans le menu contextuel associé à ce contrôle de contenu de section répétée. |
| showing |
Renvoie une valeur indiquant si le texte de l’espace réservé pour le contrôle de contenu est affiché. |
| tag | Spécifie une balise pour identifier le contrôle de contenu. |
| title | Spécifie le titre du contrôle de contenu. |
| xml |
Renvoie un |
Méthodes
| copy() | Copie le contrôle de contenu du document actif dans le Presse-papiers. |
| cut() | Supprime le contrôle de contenu du document actif et le place dans le Presse-papiers. |
| delete(delete |
Supprime le contrôle de contenu et le contenu du contrôle de contenu. |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| set |
Définit le texte de l'espace réservé qui s'affiche dans le contrôle de contenu jusqu'à ce qu'un utilisateur entre son propre texte. |
| toJSON() | Remplace la méthode JavaScript |
| track() | Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des |
| untrack() | Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler |
Détails de la propriété
allowInsertDeleteSection
Spécifie si les utilisateurs peuvent ajouter ou supprimer des sections de ce contrôle de contenu de section répétitif à l’aide de l’interface utilisateur.
allowInsertDeleteSection: boolean;
Valeur de propriété
boolean
Remarques
appearance
Spécifie l’apparence du contrôle de contenu.
appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";
Valeur de propriété
Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"
Remarques
color
Spécifie la valeur rouge-vert-bleu (RVB) de la couleur du contrôle de contenu. Vous pouvez fournir la valeur au format « #RRGGBB ».
color: string;
Valeur de propriété
string
Remarques
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;
Valeur de propriété
id
Retourne l’identification du contrôle de contenu.
readonly id: string;
Valeur de propriété
string
Remarques
isTemporary
Spécifie s’il faut supprimer le contrôle de contenu du document actif lorsque l’utilisateur modifie le contenu du contrôle.
isTemporary: boolean;
Valeur de propriété
boolean
Remarques
level
Retourne le niveau du contrôle de contenu, que le contrôle de contenu entoure du texte, des paragraphes, des cellules de tableau ou des lignes de tableau ; ou s’il est inline.
readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";
Valeur de propriété
Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"
Remarques
lockContentControl
Spécifie si le contrôle de contenu est verrouillé (ne peut pas être supprimé).
true signifie que l’utilisateur ne peut pas le supprimer du document actif, false signifie qu’il peut être supprimé.
lockContentControl: boolean;
Valeur de propriété
boolean
Remarques
lockContents
Spécifie si le contenu du contrôle de contenu est verrouillé (non modifiable).
true signifie que l’utilisateur ne peut pas modifier le contenu, false signifie que le contenu est modifiable.
lockContents: boolean;
Valeur de propriété
boolean
Remarques
placeholderText
Renvoie un BuildingBlock objet qui représente le texte de l’espace réservé pour le contrôle de contenu.
readonly placeholderText: Word.BuildingBlock;
Valeur de propriété
Remarques
range
Obtient un Range objet qui représente le contenu du contrôle de contenu dans le document actif.
readonly range: Word.Range;
Valeur de propriété
Remarques
repeatingSectionItems
Retourne la collection d’éléments de section répétitifs dans ce contrôle de contenu de section répétée.
readonly repeatingSectionItems: Word.RepeatingSectionItemCollection;
Valeur de propriété
Remarques
repeatingSectionItemTitle
Spécifie le nom des éléments de section répétitifs utilisés dans le menu contextuel associé à ce contrôle de contenu de section répétée.
repeatingSectionItemTitle: string;
Valeur de propriété
string
Remarques
showingPlaceholderText
Renvoie une valeur indiquant si le texte de l’espace réservé pour le contrôle de contenu est affiché.
readonly showingPlaceholderText: boolean;
Valeur de propriété
boolean
Remarques
tag
Spécifie une balise pour identifier le contrôle de contenu.
tag: string;
Valeur de propriété
string
Remarques
title
Spécifie le titre du contrôle de contenu.
title: string;
Valeur de propriété
string
Remarques
xmlMapping
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Renvoie un XmlMapping objet qui représente le mappage du contrôle de contenu aux données XML dans le magasin de données du document.
readonly xmlMapping: Word.XmlMapping;
Valeur de propriété
Remarques
Détails de la méthode
copy()
Copie le contrôle de contenu du document actif dans le Presse-papiers.
copy(): void;
Retours
void
Remarques
cut()
Supprime le contrôle de contenu du document actif et le place dans le Presse-papiers.
cut(): void;
Retours
void
Remarques
delete(deleteContents)
Supprime le contrôle de contenu et le contenu du contrôle de contenu.
delete(deleteContents?: boolean): void;
Paramètres
- deleteContents
-
boolean
Facultatif. Indique s’il faut supprimer le contenu à l’intérieur du contrôle.
Retours
void
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl;
Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Word.RepeatingSectionContentControl;
Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.RepeatingSectionContentControl;
Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Word.RepeatingSectionContentControl): void;
Paramètres
- properties
- Word.RepeatingSectionContentControl
Retours
void
setPlaceholderText(options)
Définit le texte de l'espace réservé qui s'affiche dans le contrôle de contenu jusqu'à ce qu'un utilisateur entre son propre texte.
setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;
Paramètres
Facultatif. Options de configuration du texte d’espace réservé du contrôle de contenu.
Retours
void
Remarques
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.RepeatingSectionContentControl est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.RepeatingSectionContentControlDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Word.Interfaces.RepeatingSectionContentControlData;
Retours
track()
Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
track(): Word.RepeatingSectionContentControl;
Retours
untrack()
Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.
untrack(): Word.RepeatingSectionContentControl;