OneNote.Application class

Referenz

Paket:: onenote

Stellt das Objekt der obersten Ebene dar, das alle global adressierbaren OneNote-Objekte enthält, z. B. Notizbücher, das aktive Notizbuch und den aktiven Abschnitt.

Extends: OfficeExtension.ClientObject

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
notebooks	Ruft die Auflistung von Notizbüchern ab, die in der OneNote-Anwendungsinstanz geöffnet sind. In OneNote Online ist immer nur ein Notizbuch in der Anwendungsinstanz geöffnet. Schreibgeschützt.

Methoden

getActiveNotebook()	Ruft das aktive Notizbuch ab, falls vorhanden. Wenn kein Notizbuch aktiv ist, wird ItemNotFound ausgelöst.
getActiveNotebookOrNull()	Ruft das aktive Notizbuch ab, falls vorhanden. Wenn kein Notizbuch aktiv ist, wird null zurückgegeben.
getActiveOutline()	Ruft die aktive Gliederung ab, falls vorhanden. Wenn keine Gliederung aktiv ist, wird ItemNotFound ausgelöst.
getActiveOutlineOrNull()	Ruft die aktive Gliederung ab, falls vorhanden, andernfalls wird null zurückgegeben.
getActivePage()	Ruft die aktive Seite ab, falls vorhanden. Wenn keine Seite aktiv ist, wird ItemNotFound ausgelöst.
getActivePageOrNull()	Ruft die aktive Seite ab, falls vorhanden. Wenn keine Seite aktiv ist, wird null zurückgegeben.
getActiveParagraph()	Ruft den aktiven Absatz ab, sofern vorhanden. Wenn kein Absatz aktiv ist, löst ItemNotFound aus.
getActiveParagraphOrNull()	Ruft den aktiven Absatz ab, sofern vorhanden, andernfalls wird NULL zurückgegeben.
getActiveSection()	Ruft den aktiven Abschnitt ab, falls vorhanden. Wenn kein Abschnitt aktiv ist, wird ItemNotFound ausgelöst.
getActiveSectionOrNull()	Ruft den aktiven Abschnitt ab, falls vorhanden. Wenn kein Abschnitt aktiv ist, wird null zurückgegeben.
getSelectedInkStrokes()	Ruft die derzeit ausgewählten Freihandstriche ab.
getWindowSize()
insertHtmlAtCurrentPosition(html)
isViewingDeletedNotes()
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
navigateToPage(page)	Öffnet die angegebene Seite in der Anwendungsinstanz.
navigateToPageWithClientUrl(url)	Ruft die angegebene Seite ab und öffnet sie in der Anwendungsinstanz. Die Navigation kann immer noch nicht ausgeführt werden, wenn kein Fehler auftritt. Der Aufrufer sollte die zurückgegebene Seite überprüfen, wenn dies gewünscht ist.
set(properties, options)	Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)	Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche OneNote.Application-Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `OneNote.Interfaces.ApplicationData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

OneNote.RequestContext

notebooks

Ruft die Auflistung von Notizbüchern ab, die in der OneNote-Anwendungsinstanz geöffnet sind. In OneNote Online ist immer nur ein Notizbuch in der Anwendungsinstanz geöffnet. Schreibgeschützt.

readonly notebooks: OneNote.NotebookCollection;

Eigenschaftswert

OneNote.NotebookCollection

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Details zur Methode

getActiveNotebook()

Ruft das aktive Notizbuch ab, falls vorhanden. Wenn kein Notizbuch aktiv ist, wird ItemNotFound ausgelöst.

getActiveNotebook(): OneNote.Notebook;

Gibt zurück

OneNote.Notebook

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft das aktive Notizbuch ab, falls vorhanden. Wenn kein Notizbuch aktiv ist, wird null zurückgegeben.

getActiveNotebookOrNull(): OneNote.Notebook;

Gibt zurück

OneNote.Notebook

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft die aktive Gliederung ab, falls vorhanden. Wenn keine Gliederung aktiv ist, wird ItemNotFound ausgelöst.

getActiveOutline(): OneNote.Outline;

Gibt zurück

OneNote.Outline

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft die aktive Gliederung ab, falls vorhanden, andernfalls wird null zurückgegeben.

getActiveOutlineOrNull(): OneNote.Outline;

Gibt zurück

OneNote.Outline

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft die aktive Seite ab, falls vorhanden. Wenn keine Seite aktiv ist, wird ItemNotFound ausgelöst.

getActivePage(): OneNote.Page;

Gibt zurück

OneNote.Page

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft die aktive Seite ab, falls vorhanden. Wenn keine Seite aktiv ist, wird null zurückgegeben.

getActivePageOrNull(): OneNote.Page;

Gibt zurück

OneNote.Page

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft den aktiven Absatz ab, sofern vorhanden. Wenn kein Absatz aktiv ist, löst ItemNotFound aus.

getActiveParagraph(): OneNote.Paragraph;

Gibt zurück

OneNote.Paragraph

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

getActiveParagraphOrNull()

Ruft den aktiven Absatz ab, sofern vorhanden, andernfalls wird NULL zurückgegeben.

getActiveParagraphOrNull(): OneNote.Paragraph;

Gibt zurück

OneNote.Paragraph

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

getActiveSection()

Ruft den aktiven Abschnitt ab, falls vorhanden. Wenn kein Abschnitt aktiv ist, wird ItemNotFound ausgelöst.

getActiveSection(): OneNote.Section;

Gibt zurück

OneNote.Section

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft den aktiven Abschnitt ab, falls vorhanden. Wenn kein Abschnitt aktiv ist, wird null zurückgegeben.

getActiveSectionOrNull(): OneNote.Section;

Gibt zurück

OneNote.Section

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

Ruft die derzeit ausgewählten Freihandstriche ab.

getSelectedInkStrokes(): OneNote.InkStrokeCollection;

Gibt zurück

OneNote.InkStrokeCollection

Hinweise

[ API-Satz: OneNoteApi 1.9 ]

getWindowSize()

getWindowSize(): OfficeExtension.ClientResult<number[]>;

Gibt zurück

OfficeExtension.ClientResult<number[]>

insertHtmlAtCurrentPosition(html)

insertHtmlAtCurrentPosition(html: string): void;

Parameter

html: string

Gibt zurück

void

isViewingDeletedNotes()

isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

OfficeExtension.ClientResult<boolean>

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: OneNote.Interfaces.ApplicationLoadOptions): OneNote.Application;

Parameter

options: OneNote.Interfaces.ApplicationLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

OneNote.Application

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): OneNote.Application;

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

OneNote.Application

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.Application;

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

OneNote.Application

navigateToPage(page)

Öffnet die angegebene Seite in der Anwendungsinstanz.

navigateToPage(page: OneNote.Page): void;

Parameter

page: OneNote.Page

Die zu öffnende Seite.

Gibt zurück

void

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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)

Ruft die angegebene Seite ab und öffnet sie in der Anwendungsinstanz. Die Navigation kann immer noch nicht ausgeführt werden, wenn kein Fehler auftritt. Der Aufrufer sollte die zurückgegebene Seite überprüfen, wenn dies gewünscht ist.

navigateToPageWithClientUrl(url: string): OneNote.Page;

Parameter

url: string

Die Client-URL der zu öffnenden Seite.

Gibt zurück

OneNote.Page

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: OneNote.Interfaces.ApplicationUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: OneNote.Application): void;

Parameter

properties: OneNote.Application

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche OneNote.Application-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.ApplicationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): OneNote.Interfaces.ApplicationData;

Gibt zurück

OneNote.Interfaces.ApplicationData