OneNote.Application class

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.

[API-Satz: OneNoteApi 1.1]

Extends

Eigenschaften

context

Der Dem Objekt zugeordnete Anforderungskontext. 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 im Web ist immer nur ein Notizbuch in der Anwendungsinstanz geöffnet. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

Methoden

getActiveNotebook()

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

[API-Satz: OneNoteApi 1.1]

getActiveNotebookOrNull()

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

[API-Satz: OneNoteApi 1.1]

getActiveOutline()

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

[API-Satz: OneNoteApi 1.1]

getActiveOutlineOrNull()

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

[API-Satz: OneNoteApi 1.1]

getActivePage()

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

[API-Satz: OneNoteApi 1.1]

getActivePageOrNull()

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

[API-Satz: OneNoteApi 1.1]

getActiveParagraph()

Ruft den aktiven Absatz ab, wenn einer vorhanden ist, Wenn kein Absatz aktiv ist, wird ItemNotFound ausgelöst.

[API-Satz: OneNoteApi 1.1]

getActiveParagraphOrNull()

Ruft den aktiven Absatz ab, falls vorhanden, andernfalls gibt null zurück.

[API-Satz: OneNoteApi 1.1]

getActiveSection()

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

[API-Satz: OneNoteApi 1.1]

getActiveSectionOrNull()

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

[API-Satz: OneNoteApi 1.1]

getWindowSize()
insertHtmlAtCurrentPosition(html)
isViewingDeletedNotes()
load(option)

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.

[API-Satz: OneNoteApi 1.1]

navigateToPageWithClientUrl(url)

Ruft die angegebene Seite ab und öffnet sie in der Anwendungsinstanz.

[API-Satz: OneNoteApi 1.1]

toJSON()

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

Details zur Eigenschaft

context

Der Dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

notebooks

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

[API-Satz: OneNoteApi 1.1]

readonly notebooks: OneNote.NotebookCollection;

Eigenschaftswert

Details zur Methode

getActiveNotebook()

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

[API-Satz: OneNoteApi 1.1]

getActiveNotebook(): OneNote.Notebook;

Gibt zurück

Beispiele

OneNote.run(function (context) {
        
    // Get the active notebook.
    var 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.
    return context.sync()
        .then(function () {
                    
            // Show some properties.
            console.log("Notebook name: " + notebook.name);
            console.log("Notebook ID: " + notebook.id);
            
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getActiveNotebookOrNull()

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

[API-Satz: OneNoteApi 1.1]

getActiveNotebookOrNull(): OneNote.Notebook;

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // Get the active notebook.
    var 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.
    return context.sync()
        .then(function () {

            // check if active notebook is set.
            if (!notebook.isNull) {
                console.log("Notebook name: " + notebook.name);
                console.log("Notebook ID: " + notebook.id);
            }
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getActiveOutline()

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

[API-Satz: OneNoteApi 1.1]

getActiveOutline(): OneNote.Outline;

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // get active outline.
    var 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.
    return context.sync()
        .then(function () {

            // Show some properties.
            console.log("outline id: " + outline.id);
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getActiveOutlineOrNull()

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

[API-Satz: OneNoteApi 1.1]

getActiveOutlineOrNull(): OneNote.Outline;

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // get active outline.
    var 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.
    return context.sync()
        .then(function () {

            if (!outline.isNull) {
                console.log("outline id: " + outline.id);
            }
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getActivePage()

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

[API-Satz: OneNoteApi 1.1]

getActivePage(): OneNote.Page;

Gibt zurück

Beispiele

OneNote.run(function (context) {
        
    // Get the active page.
    var 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.
    return context.sync()
        .then(function () {
                    
            // Show some properties.
            console.log("Page title: " + page.title);
            console.log("Page ID: " + page.id);
            
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getActivePageOrNull()

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

[API-Satz: OneNoteApi 1.1]

getActivePageOrNull(): OneNote.Page;

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // Get the active page.
    var 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.
    return context.sync()
        .then(function () {
            
            if (!page.isNull) {
                // Show some properties.
                console.log("Page title: " + page.title);
                console.log("Page ID: " + page.id);
            }
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getActiveParagraph()

Ruft den aktiven Absatz ab, wenn einer vorhanden ist, Wenn kein Absatz aktiv ist, wird ItemNotFound ausgelöst.

[API-Satz: OneNoteApi 1.1]

getActiveParagraph(): OneNote.Paragraph;

Gibt zurück

getActiveParagraphOrNull()

Ruft den aktiven Absatz ab, falls vorhanden, andernfalls gibt null zurück.

[API-Satz: OneNoteApi 1.1]

getActiveParagraphOrNull(): OneNote.Paragraph;

Gibt zurück

getActiveSection()

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

[API-Satz: OneNoteApi 1.1]

getActiveSection(): OneNote.Section;

Gibt zurück

Beispiele

OneNote.run(function (context) {
        
    // Get the active section.
    var 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.
    return context.sync()
        .then(function () {
                    
            // Show some properties.
            console.log("Section name: " + section.name);
            console.log("Section ID: " + section.id);
            
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getActiveSectionOrNull()

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

[API-Satz: OneNoteApi 1.1]

getActiveSectionOrNull(): OneNote.Section;

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // Get the active section.
    var 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.
    return context.sync()
        .then(function () {
            if (!section.isNull) {
                // Show some properties.
                console.log("Section name: " + section.name);
                console.log("Section ID: " + section.id);
            }
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getWindowSize()

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

Gibt zurück

insertHtmlAtCurrentPosition(html)

insertHtmlAtCurrentPosition(html: string): void;

Parameter

html

string

Gibt zurück

void

isViewingDeletedNotes()

isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

load(option)

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(option?: OneNote.Interfaces.ApplicationLoadOptions): OneNote.Application;

Parameter

Gibt zurück

Hinweise

Zusätzlich zu dieser Signatur verfügt diese Methode über die folgenden Signaturen:

load(option?: string | string[]): OneNote.Application - Bei der Option handelt es sich um eine durch Kommas getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

load(option?: { select?: string; expand?: string; }): OneNote.Application - Dabei ist option.select eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und options.expand ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): OneNote.Application - Nur für Auflistungstypen verfügbar. Sie ähnelt der vorherigen Signatur. Option.top gibt die maximale Anzahl von Auflistungselementen an, die in das Ergebnis eingeschlossen werden können. Option.skip gibt die Anzahl der Elemente an, die übersprungen und nicht in das Ergebnis einbezogen werden sollen. Wenn option.top angegeben wird, wird das Ergebnisset gestartet, nachdem die angegebene Anzahl von Elementen übersprungen wurde.

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

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; }

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

Gibt zurück

Öffnet die angegebene Seite in der Anwendungsinstanz.

[API-Satz: OneNoteApi 1.1]

navigateToPage(page: OneNote.Page): void;

Parameter

page
OneNote.Page

Die zu öffnende Seite.

Gibt zurück

void

Beispiele

OneNote.run(function (context) {
        
    // Get the pages in the current section.
    var 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.
    return context.sync()
        .then(function () {
                    
            // This example loads the first page in the section.
            var page = pages.items[0];
                        
            // Open the page in the application.                    
            context.application.navigateToPage(page);
                    
            // Run the queued command.
            return context.sync();
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Ruft die angegebene Seite ab und öffnet sie in der Anwendungsinstanz.

[API-Satz: OneNoteApi 1.1]

navigateToPageWithClientUrl(url: string): OneNote.Page;

Parameter

url

string

Die Client-URL der zu öffnenden Seite.

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // Get the pages in the current section.
    var 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.
    return context.sync()
        .then(function () {

            // This example loads the first page in the section.
            var page = pages.items[0];

            // Open the page in the application.                    
            context.application.navigateToPageWithClientUrl(page.clientUrl);

            // Run the queued command.
            return context.sync();
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

toJSON()

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

toJSON(): OneNote.Interfaces.ApplicationData;

Gibt zurück