Word.DocumentCreated class
L’objet DocumentCreated est l’objet de niveau supérieur créé par Application.CreateDocument. Un objet DocumentCreated est un objet Document spécial.
- Extends
Remarques
[ Ensemble d’API : WordApi 1.3 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml
// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
// Use the Base64-encoded string representation of the selected .docx file.
const externalDoc: Word.DocumentCreated = context.application.createDocument(externalDocument);
await context.sync();
if (!Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.3")) {
console.warn("The WordApiHiddenDocument 1.3 requirement set isn't supported on this client so can't proceed. Try this action on a platform that supports this requirement set.");
return;
}
const externalDocBody: Word.Body = externalDoc.body;
externalDocBody.load("text");
await context.sync();
// Insert the external document's text at the beginning of the current document's body.
const externalDocBodyText = externalDocBody.text;
const currentDocBody: Word.Body = context.document.body;
currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
await context.sync();
});
Propriétés
| body | Obtient l’objet body du document. Le corps est le texte qui exclut les en-têtes, les pieds de page, les notes de bas de page, les zones de texte, etc. |
| content |
Obtient la collection d’objets de contrôle de contenu dans le document. Cela inclut les contrôles de contenu dans le corps du document, les en-têtes, les pieds de page, les zones de texte, etc. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| custom |
Obtient les parties XML personnalisées dans le document. |
| properties | Obtient les propriétés du document. |
| saved | Indique si les modifications apportées au document ont été enregistrées. La valeur true indique que le document n’a pas été modifié depuis son enregistrement. |
| sections | Obtient la collection d’objets de section dans le document. |
| settings | Obtient les paramètres du complément dans le document. |
Méthodes
| add |
Ajoute un style dans le document par nom et par type. |
| add |
Ajoute un style dans le document par nom et par type. |
| delete |
Supprime un signet, s’il existe, du document. |
| get |
Obtient la plage d’un signet. Génère une |
| get |
Obtient la plage d’un signet. Si le signet n’existe pas, cette méthode retourne un objet avec sa |
| get |
Obtient les contrôles de contenu actuellement pris en charge dans le document. |
| get |
Obtient un objet StyleCollection qui représente l’ensemble du jeu de styles du document. |
| insert |
Insère un document dans le document cible à un emplacement spécifique avec des propriétés supplémentaires. Les en-têtes, pieds de page, filigranes et autres propriétés de section sont copiés par défaut. |
| 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 |
| open() | Ouvre le document. |
| save(save |
Enregistre le document. |
| save(save |
Enregistre le document. |
| 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. |
| 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é
body
Obtient l’objet body du document. Le corps est le texte qui exclut les en-têtes, les pieds de page, les notes de bas de page, les zones de texte, etc.
readonly body: Word.Body;Valeur de propriété
Remarques
contentControls
Obtient la collection d’objets de contrôle de contenu dans le document. Cela inclut les contrôles de contenu dans le corps du document, les en-têtes, les pieds de page, les zones de texte, etc.
readonly contentControls: Word.ContentControlCollection;Valeur de propriété
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é
customXmlParts
Obtient les parties XML personnalisées dans le document.
readonly customXmlParts: Word.CustomXmlPartCollection;Valeur de propriété
Remarques
properties
Obtient les propriétés du document.
readonly properties: Word.DocumentProperties;Valeur de propriété
Remarques
saved
Indique si les modifications apportées au document ont été enregistrées. La valeur true indique que le document n’a pas été modifié depuis son enregistrement.
readonly saved: boolean;Valeur de propriété
boolean
Remarques
sections
Obtient la collection d’objets de section dans le document.
readonly sections: Word.SectionCollection;Valeur de propriété
Remarques
settings
Obtient les paramètres du complément dans le document.
readonly settings: Word.SettingCollection;Valeur de propriété
Remarques
Détails de la méthode
addStyle(name, type)
Ajoute un style dans le document par nom et par type.
addStyle(name: string, type: Word.StyleType): Word.Style;Paramètres
- name
-
string
Obligatoire. Chaîne représentant le nom du style.
- type
- Word.StyleType
Obligatoire. Type de style, y compris caractère, liste, paragraphe ou tableau.
Retours
Remarques
addStyle(name, typeString)
Ajoute un style dans le document par nom et par type.
addStyle(name: string, typeString: "Character" | "List" | "Paragraph" | "Table"): Word.Style;Paramètres
- name
-
string
Obligatoire. Chaîne représentant le nom du style.
- typeString
-
"Character" | "List" | "Paragraph" | "Table"
Obligatoire. Type de style, y compris caractère, liste, paragraphe ou tableau.
Retours
Remarques
deleteBookmark(name)
Supprime un signet, s’il existe, du document.
deleteBookmark(name: string): void;Paramètres
- name
-
string
Obligatoire. Nom de signet qui ne respecte pas la casse.
Retours
void
Remarques
getBookmarkRange(name)
Obtient la plage d’un signet. Génère une ItemNotFound erreur si le signet n’existe pas.
getBookmarkRange(name: string): Word.Range;Paramètres
- name
-
string
Obligatoire. Nom de signet qui ne respecte pas la casse.
Retours
Remarques
getBookmarkRangeOrNullObject(name)
Obtient la plage d’un signet. Si le signet n’existe pas, 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.
getBookmarkRangeOrNullObject(name: string): Word.Range;Paramètres
- name
-
string
Obligatoire. Nom de signet qui ne respecte pas la casse. Seuls les caractères alphanumériques et de soulignement sont pris en charge. Il doit commencer par une lettre, mais si vous souhaitez étiqueter le signet comme masqué, commencez le nom par un trait de soulignement. Les noms ne peuvent pas comporter plus de 40 caractères.
Retours
Remarques
getContentControls(options)
Obtient les contrôles de contenu actuellement pris en charge dans le document.
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;Paramètres
- options
- Word.ContentControlOptions
Optional. Options qui définissent les contrôles de contenu qui sont retournés.
Retours
Remarques
[ Ensemble d’API : WordApiHiddenDocument 1.5 ]
Important : si des types spécifiques sont fournis dans le paramètre options, seuls les contrôles de contenu des types pris en charge sont retournés. N’oubliez pas qu’une exception sera levée à l’aide de méthodes d’un Word générique. ContentControl qui ne sont pas pertinents pour le type spécifique. Avec le temps, d’autres types de contrôles de contenu peuvent être pris en charge. Par conséquent, votre complément doit demander et gérer des types spécifiques de contrôles de contenu.
getStyles()
Obtient un objet StyleCollection qui représente l’ensemble du jeu de styles du document.
getStyles(): Word.StyleCollection;Retours
Remarques
insertFileFromBase64(base64File, insertLocation, insertFileOptions)
Insère un document dans le document cible à un emplacement spécifique avec des propriétés supplémentaires. Les en-têtes, pieds de page, filigranes et autres propriétés de section sont copiés par défaut.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;Paramètres
- base64File
-
string
Obligatoire. Contenu encodé en Base64 d’un fichier .docx.
Obligatoire. La valeur doit être « Replace », « Start » ou « End ».
- insertFileOptions
- Word.InsertFileOptions
Optional. Propriétés supplémentaires qui doivent être importées dans le document de destination.
Retours
Remarques
[ Ensemble d’API : WordApiHiddenDocument 1.5 ]
Remarque : l’insertion n’est pas prise en charge si le document inséré contient un contrôle ActiveX (probablement dans un champ de formulaire). Envisagez de remplacer un tel champ de formulaire par un contrôle de contenu ou une autre option appropriée pour votre scénario.
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.DocumentCreatedLoadOptions): Word.DocumentCreated;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.DocumentCreated;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.DocumentCreated;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
open()
Ouvre le document.
open(): void;Retours
void
Remarques
[ Ensemble d’API : WordApi 1.3 ]
Exemples
// Create and open a new document in a new tab or window.
await Word.run(async (context) => {
const externalDoc = context.application.createDocument();
await context.sync();
externalDoc.open();
await context.sync();
});
save(saveBehavior, fileName)
Enregistre le document.
save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;Paramètres
- saveBehavior
- Word.SaveBehavior
Optional. DocumentCreated prend uniquement en charge « Enregistrer ».
- fileName
-
string
Optional. Nom de fichier (exclure l’extension de fichier). Prend effet uniquement pour un nouveau document.
Retours
void
Remarques
[ Ensemble d’API : WordApiHiddenDocument 1.3 ]
Remarque : Les saveBehavior paramètres et fileName ont été introduits dans WordApiHiddenDocument 1.5.
save(saveBehaviorString, fileName)
Enregistre le document.
save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;Paramètres
- saveBehaviorString
-
"Save" | "Prompt"
Optional. DocumentCreated prend uniquement en charge « Enregistrer ».
- fileName
-
string
Optional. Nom de fichier (exclure l’extension de fichier). Prend effet uniquement pour un nouveau document.
Retours
void
Remarques
[ Ensemble d’API : WordApiHiddenDocument 1.3 ]
Remarque : Les saveBehavior paramètres et fileName ont été introduits dans WordApiHiddenDocument 1.5.
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.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Word.Interfaces.DocumentCreatedUpdateData
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.DocumentCreated): void;Paramètres
- properties
- Word.DocumentCreated
Retours
void
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.DocumentCreated est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.DocumentCreatedDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Word.Interfaces.DocumentCreatedData;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.DocumentCreated;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.DocumentCreated;