Partager via


Word.Coauthoring class

Représente l’objet Coauthoring . Cette opération effectue le suivi des mises à jour, modifications, conflits et autres interactions dans le document effectuées par le biais de la co-création.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Propriétés

authors

Obtient un CoauthorCollection objet qui représente tous les co-auteurs qui modifient actuellement le document.

canCoauthor

Obtient si ce document peut être co-auteur.

canMerge

Obtient si le document peut être fusionné automatiquement.

conflicts

Obtient un ConflictCollection objet qui représente tous les conflits dans le document.

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

locks

Obtient un CoauthoringLockCollection objet qui représente les verrous dans le document.

me

Obtient un Coauthor objet qui représente l’utilisateur actuel.

pendingUpdates

Obtient si le document a des mises à jour en attente qui n’ont pas été acceptées.

updates

Obtient un CoauthoringUpdateCollection objet qui représente les mises à jour les plus récentes qui ont été fusionnées dans le document.

Méthodes

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

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

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.

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.

Détails de la propriété

authors

Obtient un CoauthorCollection objet qui représente tous les co-auteurs qui modifient actuellement le document.

readonly authors: Word.CoauthorCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

canCoauthor

Obtient si ce document peut être co-auteur.

readonly canCoauthor: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

canMerge

Obtient si le document peut être fusionné automatiquement.

readonly canMerge: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

conflicts

Obtient un ConflictCollection objet qui représente tous les conflits dans le document.

readonly conflicts: Word.ConflictCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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é

locks

Obtient un CoauthoringLockCollection objet qui représente les verrous dans le document.

readonly locks: Word.CoauthoringLockCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

me

Obtient un Coauthor objet qui représente l’utilisateur actuel.

readonly me: Word.Coauthor;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

pendingUpdates

Obtient si le document a des mises à jour en attente qui n’ont pas été acceptées.

readonly pendingUpdates: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

updates

Obtient un CoauthoringUpdateCollection objet qui représente les mises à jour les plus récentes qui ont été fusionnées dans le document.

readonly updates: Word.CoauthoringUpdateCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Détails de la méthode

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.CoauthoringLoadOptions): Word.Coauthoring;

Paramètres

options
Word.Interfaces.CoauthoringLoadOptions

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

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

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

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

toJSON(): Word.Interfaces.CoauthoringData;

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

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

Retours