OneNote.Section class
Représente une section OneNote. Les sections peuvent contenir des pages.
- Extends
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Propriétés
| client |
URL du client de la section. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| id | Obtient l’ID de la section. |
| is |
True si cette section est chiffrée avec un mot de passe. |
| is |
True si cette section est verrouillée. |
| name | Obtient le nom de la section. |
| notebook | Obtient le bloc-notes qui contient la section. |
| pages | Collection de pages dans la section. |
| parent |
Obtient le groupe de sections qui contient la section. Génère ItemNotFound si la section est un enfant direct du bloc-notes. |
| parent |
Obtient le groupe de sections qui contient la section. Renvoie la valeur Null si la section est un enfant direct du bloc-notes. En lecture seule. |
| web |
URL web de la page. |
Méthodes
| add |
Ajoute une nouvelle page à la fin de la section. |
| copy |
Copie cette section dans le bloc-notes spécifié. |
| copy |
Copie cette section dans le groupe de sections spécifié. |
| get |
Obtient l’ID d’API REST. |
| insert |
Insère une nouvelle section avant ou après la section active. |
| insert |
Insère une nouvelle section avant ou après la section active. |
| 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 |
| 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é
clientUrl
URL du client de la section.
readonly clientUrl: 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
Obtient l’ID de la section.
readonly id: string;Valeur de propriété
string
Remarques
isEncrypted
True si cette section est chiffrée avec un mot de passe.
readonly isEncrypted: boolean;Valeur de propriété
boolean
Remarques
isLocked
True si cette section est verrouillée.
readonly isLocked: boolean;Valeur de propriété
boolean
Remarques
name
Obtient le nom de la section.
readonly name: string;Valeur de propriété
string
Remarques
notebook
Obtient le bloc-notes qui contient la section.
readonly notebook: OneNote.Notebook;Valeur de propriété
Remarques
pages
Collection de pages dans la section.
readonly pages: OneNote.PageCollection;Valeur de propriété
Remarques
parentSectionGroup
Obtient le groupe de sections qui contient la section. Génère ItemNotFound si la section est un enfant direct du bloc-notes.
readonly parentSectionGroup: OneNote.SectionGroup;Valeur de propriété
Remarques
parentSectionGroupOrNull
Obtient le groupe de sections qui contient la section. Renvoie la valeur Null si la section est un enfant direct du bloc-notes. En lecture seule.
readonly parentSectionGroupOrNull: OneNote.SectionGroup;Valeur de propriété
Remarques
webUrl
URL web de la page.
readonly webUrl: string;Valeur de propriété
string
Remarques
Détails de la méthode
addPage(title)
Ajoute une nouvelle page à la fin de la section.
addPage(title: string): OneNote.Page;Paramètres
- title
-
string
Titre de la nouvelle page.
Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Queue a command to add a page to the current section.
const page = context.application.getActiveSection().addPage("Wish list");
// Queue a command to load the id and title of the new page.
// This example loads the new page so it can read its properties later.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Page name: " + page.title);
console.log("Page ID: " + page.id);
});
copyToNotebook(destinationNotebook)
Copie cette section dans le bloc-notes spécifié.
copyToNotebook(destinationNotebook: OneNote.Notebook): OneNote.Section;Paramètres
- destinationNotebook
- OneNote.Notebook
Bloc-notes dans lequel cette section doit être copiée.
Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
const app = context.application;
// Gets the active Notebook.
const notebook = app.getActiveNotebook();
// Gets the active Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
newSection = section.copyToNotebook(notebook);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
copyToSectionGroup(destinationSectionGroup)
Copie cette section dans le groupe de sections spécifié.
copyToSectionGroup(destinationSectionGroup: OneNote.SectionGroup): OneNote.Section;Paramètres
- destinationSectionGroup
- OneNote.SectionGroup
Groupe de sections dans lequel cette section doit être copiée.
Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
const app = context.application;
// Gets the active Notebook.
const notebook = app.getActiveNotebook();
// Gets the active Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
const firstSectionGroup = notebook.sectionGroups.items[0];
newSection = section.copyToSectionGroup(firstSectionGroup);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
getRestApiId()
Obtient l’ID d’API REST.
getRestApiId(): OfficeExtension.ClientResult<string>;Retours
OfficeExtension.ClientResult<string>
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the current section.
const section = context.application.getActiveSection();
const restApiId = section.getRestApiId();
await context.sync();
console.log("The REST API ID is " + restApiId.value);
// Note that the REST API ID isn't all you need to interact with the OneNote REST API.
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the
// OneNote REST API according to the OneNote Development Blog.
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});
insertSectionAsSibling(location, title)
Insère une nouvelle section avant ou après la section active.
insertSectionAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Section;Paramètres
- location
- OneNote.InsertLocation
Emplacement de la nouvelle section par rapport à la section active.
- title
-
string
Nom de la nouvelle section.
Retours
Remarques
insertSectionAsSibling(locationString, title)
Insère une nouvelle section avant ou après la section active.
insertSectionAsSibling(locationString: "Before" | "After", title: string): OneNote.Section;Paramètres
- locationString
-
"Before" | "After"
Emplacement de la nouvelle section par rapport à la section active.
- title
-
string
Nom de la nouvelle section.
Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Queue a command to insert a section after the current section.
const section = context.application.getActiveSection().insertSectionAsSibling("After", "New section");
// Queue a command to load the id and name of the new section.
// This example loads the new section so it can read its properties later.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
});
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?: OneNote.Interfaces.SectionLoadOptions): OneNote.Section;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[]): OneNote.Section;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
Exemples
await OneNote.run(async (context) => {
// Get the current section.
const section = context.application.getActiveSection();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load("id");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("Section ID: " + section.id);
});
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;
}): OneNote.Section;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 OneNote.Section est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.SectionDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): OneNote.Interfaces.SectionData;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.
track(): OneNote.Section;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(): OneNote.Section;