OneNote.Notebook class

Stellt eine Seite in einem OneNote-Notizbuch dar. Notizbücher können Abschnittsgruppen und Abschnitte enthalten.

[API-Satz: OneNoteApi 1.1]

Extends

Eigenschaften

baseUrl

Die URL der Website, in der sich dieses Notizbuch befindet. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

clientUrl

Die Client-URL des Notizbuchs. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

context

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

id

Ruft die ID des Notizbuchs ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

isVirtual

True, wenn das Notizbuch nicht vom Benutzer erstellt wird (d. h. 'Falsch platzierte Abschnitte'). Schreibgeschützt

[API-Satz: OneNoteApi 1.2]

name

Ruft den Namen des Notizbuchs ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

sectionGroups

Die Abschnittsgruppen im Notizbuch. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

sections

Die Abschnitte des Notizbuchs. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

Methoden

addSection(name)

Fügt einen neuen Abschnitt am Ende des Notizbuchs hinzu.

[API-Satz: OneNoteApi 1.1]

addSectionGroup(name)

Fügt eine neue Abschnittsgruppe am Ende des Notizbuchs hinzu.

[API-Satz: OneNoteApi 1.1]

getRestApiId()

Ruft die REST-API-ID ab.

[API-Satz: OneNoteApi 1.1]

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.

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.Notebook-Objekt ein API-Objekt ist, gibt die Methode ein toJSON einfaches JavaScript-Objekt zurück (Typ: OneNote.Interfaces.NotebookData), die flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzschreibweise für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt übergreifend für ".sync"-Aufrufe und außerhalb der sequenziellen Ausführung eines ".run"-Stapels verwenden und beim Festlegen einer Eigenschaft oder Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler zurückgegeben wird, hätte das Objekt der nachverfolgten Objektsammlung hinzugefügt werden müssen, in der das Objekt ursprünglich erstellt wurde.

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf stellt eine Kurzschreibweise für context.trackedObjects.remove(thisObject) dar. Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen "context.sync()" aufrufen, damit die Freigabe des Arbeitsspeichers wirksam wird.

Details zur Eigenschaft

baseUrl

Die URL der Website, in der sich dieses Notizbuch befindet. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

readonly baseUrl: string;

Eigenschaftswert

string

clientUrl

Die Client-URL des Notizbuchs. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

readonly clientUrl: string;

Eigenschaftswert

string

context

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

context: RequestContext;

Eigenschaftswert

id

Ruft die ID des Notizbuchs ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

readonly id: string;

Eigenschaftswert

string

isVirtual

True, wenn das Notizbuch nicht vom Benutzer erstellt wird (d. h. 'Falsch platzierte Abschnitte'). Schreibgeschützt

[API-Satz: OneNoteApi 1.2]

readonly isVirtual: boolean;

Eigenschaftswert

boolean

name

Ruft den Namen des Notizbuchs ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

readonly name: string;

Eigenschaftswert

string

sectionGroups

Die Abschnittsgruppen im Notizbuch. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

readonly sectionGroups: OneNote.SectionGroupCollection;

Eigenschaftswert

sections

Die Abschnitte des Notizbuchs. Schreibgeschützt

[API-Satz: OneNoteApi 1.1]

readonly sections: OneNote.SectionCollection;

Eigenschaftswert

Details zur Methode

addSection(name)

Fügt einen neuen Abschnitt am Ende des Notizbuchs hinzu.

[API-Satz: OneNoteApi 1.1]

addSection(name: string): OneNote.Section;

Parameter

name

string

Der Name des neuen Abschnitts.

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // Gets the active notebook.
    var notebook = context.application.getActiveNotebook();

    // Queue a command to add a new section. 
    var section = notebook.addSection("Sample section");
    
    // Queue a command to load the new section. This example reads the name property later.
    section.load("name");

    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function() {
            console.log("New section name is " + section.name);
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
}); 

addSectionGroup(name)

Fügt eine neue Abschnittsgruppe am Ende des Notizbuchs hinzu.

[API-Satz: OneNoteApi 1.1]

addSectionGroup(name: string): OneNote.SectionGroup;

Parameter

name

string

Der Name des neuen Abschnitts.

Gibt zurück

Beispiele

OneNote.run(function (context) {

    // Gets the active notebook.
    var notebook = context.application.getActiveNotebook();

    // Queue a command to add a new section group.
    var sectionGroup = notebook.addSectionGroup("Sample section group");

    // Queue a command to load the new section group.
    sectionGroup.load();

    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function() {
            console.log("New section group name is " + sectionGroup.name);
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
}); 

getRestApiId()

Ruft die REST-API-ID ab.

[API-Satz: OneNoteApi 1.1]

getRestApiId(): OfficeExtension.ClientResult<string>;

Gibt zurück

Beispiele

OneNote.run(function(ctx){
    // Get the current notebook.         
    var notebook = ctx.application.getActiveNotebook();
    var restApiId = notebook.getRestApiId();

    return ctx.sync().
        then(function(){
            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://blogs.msdn.microsoft.com/onenotedev/2015/06/11/and-sharepoint-makes-three/
        });
});

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.NotebookLoadOptions): OneNote.Notebook;

Parameter

Gibt zurück

Hinweise

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

load(option?: string | string[]): OneNote.Notebook - 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.Notebook - 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.Notebook - 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.Notebook;

Parameter

propertyNames

string | string[]

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

Gibt zurück

Beispiele

OneNote.run(function (context) {
        
    // Get the current notebook.
    var notebook = context.application.getActiveNotebook();
            
    // Queue a command to load the notebook. 
    // For best performance, request specific properties.           
    notebook.load('baseUrl');
            
    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function () {
            console.log("Base url: " + notebook.baseUrl);
            // This is only required for SharePoint notebooks, and will be null for OneDrive notebooks.
            // This baseUrl should be used to talk to OneNote REST APIs according to the OneNote Development Blog.
            // https://blogs.msdn.microsoft.com/onenotedev/2015/06/11/and-sharepoint-makes-three/
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
OneNote.run(function (context) {
        
    // Get the current notebook.
    var notebook = context.application.getActiveNotebook();
            
    // Queue a command to load the notebook. 
    // For best performance, request specific properties.           
    notebook.load('id');
            
    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function () {
            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));
    }
});
OneNote.run(function (context) {
        
    // Get the current notebook.
    var notebook = context.application.getActiveNotebook();
            
    // Queue a command to load the notebook. 
    // For best performance, request specific properties.           
    notebook.load('name');
            
    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function () {
            console.log("Notebook name: " + notebook.name);
            
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
OneNote.run(function (context) {

    // Get the section groups in the notebook. 
    var sectionGroups = context.application.getActiveNotebook().sectionGroups;

    // Queue a command to load the sectionGroups. 
    sectionGroups.load("name");

    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function() {
            $.each(sectionGroups.items, function(index, sectionGroup) {
                console.log("Section group name: " + sectionGroup.name);
            });
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
OneNote.run(function (context) {

    // Gets the active notebook.
    var notebook = context.application.getActiveNotebook();
    
    // Queue a command to get immediate child sections of the notebook. 
    var childSections = notebook.sections;

    // Queue a command to load the childSections. 
    context.load(childSections);

    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function() {
            $.each(childSections.items, function(index, childSection) {
                console.log("Immediate child section name: " + childSection.name);
            });            
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});   

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.Notebook;

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

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.Notebook-Objekt ein API-Objekt ist, gibt die Methode ein toJSON einfaches JavaScript-Objekt zurück (Typ: OneNote.Interfaces.NotebookData), die flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): OneNote.Interfaces.NotebookData;

Gibt zurück

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzschreibweise für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt übergreifend für ".sync"-Aufrufe und außerhalb der sequenziellen Ausführung eines ".run"-Stapels verwenden und beim Festlegen einer Eigenschaft oder Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler zurückgegeben wird, hätte das Objekt der nachverfolgten Objektsammlung hinzugefügt werden müssen, in der das Objekt ursprünglich erstellt wurde.

track(): OneNote.Notebook;

Gibt zurück

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf stellt eine Kurzschreibweise für context.trackedObjects.remove(thisObject) dar. Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen "context.sync()" aufrufen, damit die Freigabe des Arbeitsspeichers wirksam wird.

untrack(): OneNote.Notebook;

Gibt zurück