Word.BuildingBlockGalleryContentControl class

Spécifie l’apparence du contrôle de contenu.

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

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la catégorie pour le contrôle de contenu de bloc de construction.

buildingBlockCategory: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie une BuildingBlockType valeur qui représente le type de bloc de construction pour le contrôle de contenu du bloc de construction.

buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Obtient l’identification du contrôle de contenu.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient 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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie 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

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient si le texte de l’espace réservé pour le contrôle de contenu est affiché.

readonly showingPlaceholderText: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

tag: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le titre du contrôle de contenu.

title: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

[ Ensemble d’API : WordApiDesktop 1.3 ]

Copie le contrôle de contenu du document actif dans le Presse-papiers.

copy(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Supprime le contrôle de contenu du document actif et le place dans le Presse-papiers.

cut(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Supprime le contrôle de contenu et éventuellement son contenu.

delete(deleteContents?: boolean): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl;

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

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.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.BuildingBlockGalleryContentControl): void;

Paramètres

Retours

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

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.BuildingBlockGalleryContentControl est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.BuildingBlockGalleryContentControlDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData;

Retours

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

Retours

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

Retours