OneNote.Application class
Représente l’objet de niveau supérieur qui contient tous les objets OneNote globalement adressables tels que les blocs-notes, le bloc-note actif et la section active.
- Extends
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| notebooks | Obtient la collection de blocs-notes ouverts dans l’instance de l’application OneNote. Dans OneNote Online, un seul bloc-notes est ouvert à la fois dans l’instance de l’application. En lecture seule. |
Méthodes
| get |
Obtient le bloc-notes actif s’il existe. Si aucun bloc-notes n’est actif, génère ItemNotFound. |
| get |
Obtient le bloc-notes actif s’il existe. Si aucun bloc-notes n’est actif, renvoie la valeur Null. |
| get |
Obtient le plan actif s’il existe. Si aucun plan n’est actif, génère ItemNotFound. |
| get |
Obtient le plan actif s’il existe. Sinon, renvoie la valeur Null. |
| get |
Obtient la page active si elle existe. Si aucune page n’est active, génère ItemNotFound. |
| get |
Obtient la page active si elle existe. Si aucune page n’est active, renvoie la valeur Null. |
| get |
Obtient le paragraphe actif s’il en existe un, Si aucun paragraphe n’est actif, lève ItemNotFound. |
| get |
Obtient le paragraphe actif s’il en existe un, sinon retourne null. |
| get |
Obtient la section active si elle existe. Si aucune section n’est active, génère ItemNotFound. |
| get |
Obtient la section active si elle existe. Si aucune section n’est active, renvoie la valeur Null. |
| get |
Obtient les traits d’encre actuellement sélectionnés. |
| get |
|
| insert |
|
| is |
|
| 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 |
| navigate |
Ouvre la page spécifiée dans l’instance de l’application. |
| navigate |
Obtient la page spécifiée et ouvre celle-ci dans l’instance de l’application. La navigation peut toujours ne pas être effectuée en l’absence d’échec. L’appelant doit valider la page retournée s’il le souhaite. |
| 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 |
Détails de la propriété
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é
notebooks
Obtient la collection de blocs-notes ouverts dans l’instance de l’application OneNote. Dans OneNote Online, un seul bloc-notes est ouvert à la fois dans l’instance de l’application. En lecture seule.
readonly notebooks: OneNote.NotebookCollection;Valeur de propriété
Remarques
Détails de la méthode
getActiveNotebook()
Obtient le bloc-notes actif s’il existe. Si aucun bloc-notes n’est actif, génère ItemNotFound.
getActiveNotebook(): OneNote.Notebook;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to load the notebook.
// For best performance, request specific properties.
notebook.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("Notebook name: " + notebook.name);
console.log("Notebook ID: " + notebook.id);
});
getActiveNotebookOrNull()
Obtient le bloc-notes actif s’il existe. Si aucun bloc-notes n’est actif, renvoie la valeur Null.
getActiveNotebookOrNull(): OneNote.Notebook;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the active notebook.
const notebook = context.application.getActiveNotebookOrNull();
// Queue a command to load the notebook.
// For best performance, request specific properties.
notebook.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Check if active notebook is set.
if (!notebook.isNullObject) {
console.log("Notebook name: " + notebook.name);
console.log("Notebook ID: " + notebook.id);
}
});
getActiveOutline()
Obtient le plan actif s’il existe. Si aucun plan n’est actif, génère ItemNotFound.
getActiveOutline(): OneNote.Outline;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// get active outline.
const outline = context.application.getActiveOutline();
// Queue a command to load the id of the outline.
outline.load('id');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("outline id: " + outline.id);
});
getActiveOutlineOrNull()
Obtient le plan actif s’il existe. Sinon, renvoie la valeur Null.
getActiveOutlineOrNull(): OneNote.Outline;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// get active outline.
const outline = context.application.getActiveOutlineOrNull();
// Queue a command to load the id of the outline.
outline.load('id');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (!outline.isNullObject) {
console.log("outline id: " + outline.id);
}
});
getActivePage()
Obtient la page active si elle existe. Si aucune page n’est active, génère ItemNotFound.
getActivePage(): OneNote.Page;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the active page.
const page = context.application.getActivePage();
// Queue a command to load the page.
// For best performance, request specific properties.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("Page title: " + page.title);
console.log("Page ID: " + page.id);
});
getActivePageOrNull()
Obtient la page active si elle existe. Si aucune page n’est active, renvoie la valeur Null.
getActivePageOrNull(): OneNote.Page;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the active page.
const page = context.application.getActivePageOrNull();
// Queue a command to load the page.
// For best performance, request specific properties.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (!page.isNullObject) {
// Show some properties.
console.log("Page title: " + page.title);
console.log("Page ID: " + page.id);
}
});
getActiveParagraph()
Obtient le paragraphe actif s’il en existe un, Si aucun paragraphe n’est actif, lève ItemNotFound.
getActiveParagraph(): OneNote.Paragraph;Retours
Remarques
getActiveParagraphOrNull()
Obtient le paragraphe actif s’il en existe un, sinon retourne null.
getActiveParagraphOrNull(): OneNote.Paragraph;Retours
Remarques
getActiveSection()
Obtient la section active si elle existe. Si aucune section n’est active, génère ItemNotFound.
getActiveSection(): OneNote.Section;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the active section.
const section = context.application.getActiveSection();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
});
getActiveSectionOrNull()
Obtient la section active si elle existe. Si aucune section n’est active, renvoie la valeur Null.
getActiveSectionOrNull(): OneNote.Section;Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the active section.
const section = context.application.getActiveSectionOrNull();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (!section.isNullObject) {
// Show some properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
}
});
getSelectedInkStrokes()
Obtient les traits d’encre actuellement sélectionnés.
getSelectedInkStrokes(): OneNote.InkStrokeCollection;Retours
Remarques
getWindowSize()
getWindowSize(): OfficeExtension.ClientResult<number[]>;Retours
OfficeExtension.ClientResult<number[]>
insertHtmlAtCurrentPosition(html)
insertHtmlAtCurrentPosition(html: string): void;Paramètres
- html
-
string
Retours
void
isViewingDeletedNotes()
isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;Retours
OfficeExtension.ClientResult<boolean>
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.ApplicationLoadOptions): OneNote.Application;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.Application;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;
}): OneNote.Application;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
navigateToPage(page)
Ouvre la page spécifiée dans l’instance de l’application.
navigateToPage(page: OneNote.Page): void;Paramètres
- page
- OneNote.Page
Page à ouvrir.
Retours
void
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the pages in the current section.
const pages = context.application.getActiveSection().pages;
// Queue a command to load the pages.
// For best performance, request specific properties.
pages.load('id');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync()
// This example loads the first page in the section.
const page = pages.items[0];
// Open the page in the application.
context.application.navigateToPage(page);
// Run the queued command.
await context.sync();
});
navigateToPageWithClientUrl(url)
Obtient la page spécifiée et ouvre celle-ci dans l’instance de l’application. La navigation peut toujours ne pas être effectuée en l’absence d’échec. L’appelant doit valider la page retournée s’il le souhaite.
navigateToPageWithClientUrl(url: string): OneNote.Page;Paramètres
- url
-
string
URL du client de la page à ouvrir.
Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
await OneNote.run(async (context) => {
// Get the pages in the current section.
const pages = context.application.getActiveSection().pages;
// Queue a command to load the pages.
// For best performance, request specific properties.
pages.load('clientUrl');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync()
// This example loads the first page in the section.
const page = pages.items[0];
// Open the page in the application.
context.application.navigateToPageWithClientUrl(page.clientUrl);
// Run the queued command.
await context.sync();
});
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.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- OneNote.Interfaces.ApplicationUpdateData
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: OneNote.Application): void;Paramètres
- properties
- OneNote.Application
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet OneNote.Application d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.ApplicationDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): OneNote.Interfaces.ApplicationData;