Anwendungsschnittstelle (OneNote)

Artikel
04/04/2023

Die Anwendungsschnittstelle umfasst Methoden, mit denen OneNote-Informationen und -Inhalte abgerufen, bearbeitet und aktualisiert werden können. Die Methoden sind in vier allgemeine Kategorien unterteilt:

Notebookstruktur : Methoden zum Arbeiten mit notebook-Struktur, einschließlich derer zum Ermitteln, Öffnen, Ändern, Schließen und Löschen von Notizbüchern, Abschnittsgruppen und Abschnitten.
Seiteninhalt : Methoden zum Arbeiten mit Seiten und Seiteninhalten, einschließlich solcher zum Ermitteln, Ändern, Speichern und Löschen von Seiteninhalten. Seiteninhalte umfassen binäre Objekte wie Freihand und Bilder sowie Textobjekte wie Gliederungen.
Navigation : Methoden zum Suchen, Verknüpfen und Navigieren zu Seiten und Objekten.
Funktional : Alle anderen Methoden, die bestimmte Aktionen ausführen oder Parameter in OneNote festlegen.

Außerdem umfasst die Anwendungsschnittstelle eine Reihe von Eigenschaften und Ereignissen.

Notizbuchstruktur-Methoden

Mit den in diesem Abschnitt beschriebenen Methoden können Sie OneNote-Notizbücher, Abschnittsgruppen und Abschnitte entdecken, öffnen, ändern, schließen und löschen.

GetHierarchy-Methode

Wert	Beschreibung
Beschreibung	Ruft die Hierarchiestruktur der Notizbuchknoten ab, beginnend mit dem von Ihnen angegebenen Knoten (alle Notizbücher oder ein einzelnes Notizbuch, eine Abschnittsgruppe oder ein Abschnitt) bis hinunter zu allen Nachfolgern auf der von Ihnen angegebenen Ebene.
Syntax	`HRESULT GetHierarchy(` `[in]BSTR bstrStartNodeID,` `[in]HierarchyScope hsScope,` `[out]BSTR * pbstrHierarchyXmlOut,` `[in,defaultvalue(xs2013)]XMLSchema xsSchema);`
Parameter	bstrStartNodeID : Der Knoten (Notebook, Abschnittsgruppe oder Abschnitt), dessen Nachfolger Sie benötigen. Wenn Sie eine NULL-Zeichenfolge ("") übergeben, ruft die Methode alle Knoten unterhalb des Stammknotens ab (d. h. alle Notizbücher, Abschnittsgruppen und Abschnitte). Wenn Sie ein Notizbuch, eine Abschnittsgruppe oder einen Abschnittsknoten angeben, ruft die Methode nur die Nachfolger dieses Knotens ab. hsScope : Die unterste untergeordnete Knotenebene, die Sie benötigen. Wenn Sie beispielsweise Seiten angeben, ruft die Methode alle Knoten bis nach unten zur Seitenebene ab. Wenn Sie Abschnitte angeben, ruft die Methode nur Abschnittsknoten unterhalb des Notizbuchs ab. Weitere Informationen finden Sie unter der Enumeration HierarchyScope im Thema Enumerations. pbstrHierarchyXmlOut – (Output-Parameter) Ein Zeiger auf die Zeichenfolge, in die OneNote die XML-Ausgabe schreiben soll. xsSchema – (Optional) Die Version des OneNote-XML-Schemas vom Typ XMLSchema, die ausgegeben werden soll. Sie können angeben, ob Sie die XML-Schemaversion 2013, 2010, 2007 oder die aktuelle Version wünschen. HINWEIS: Es wird empfohlen, eine Version von OneNote (z. B. xs2013) anzugeben, anstatt xsCurrent zu verwenden oder leer zu lassen, da Ihr Add-In auf diese Weise mit zukünftigen Versionen von OneNote verwendet werden kann.

Die GetHierarchy-Methode gibt standardmäßig eine Zeichenfolge im OneNote 2013-XML-Format zurück, oder Sie können die bevorzugte XML-Schemaversion mithilfe des optionalen xsSchema-Parameters festlegen.

Abhängig von den übergebenen Parametern kann die GetHierarchy-Methode verschiedene Listen zurückgeben (z. B. alle Notizbücher, alle Abschnitte in allen Notizbüchern, alle Seiten in einem bestimmten Abschnitt oder alle Seiten in einem bestimmten Notizbuch). Für jeden Knoten stellt die zurückgegebene XML-Zeichenfolge Eigenschaften bereit (z. B. den Abschnitts- oder Seitentitel, die ID und die Uhrzeit der letzten Änderung).

Nicht alle Kombinationen aus Startknoten und Bereich sind gültig. Wenn Sie z. B. den Startknoten eines Abschnitts und einen Notizbuchbereich angeben, gibt GetHierarchy ein Null-Ergebnis zurück, da ein Notizbuch höher in der Knotenhierarchie steht als ein Abschnitt.

Das folgende C#-Beispiel veranschaulicht, wie die GetHierarchy-Methode verwendet wird, um die gesamte OneNote-Hierarchie abzurufen, einschließlich aller Notizbücher bis auf Seitenebene. Die Ausgabezeichenfolge wird in die Zwischenablage kopiert, von wo aus Sie die Zeichenfolge zur Überprüfung in einen Texteditor einfügen können.

static void GetEntireHierarchy()
    {
        String strXML;
        OneNote.Application onApplication = new OneNote.Application();
        onApplication.GetHierarchy(null, 
            OneNote.HierarchyScope.hsPages, out strXML);
        Clipboard.SetText(strXML);
        MessageBox.Show("The XML has been copied to the clipboard");
    }

UpdateHierarchy-Methode

Wert	Beschreibung
Beschreibung	Ändert oder aktualisiert die Hierarchie der Notizbücher. Sie können z. B. Abschnitte oder Abschnittsgruppen in ein Notizbuch einfügen, ein neues Notizbuch hinzufügen, Abschnitte in einem Notizbuch verschieben, den Namen eines Abschnitts ändern, Seiten zu einem Abschnitt hinzufügen oder die Reihenfolge von Seiten in einem Abschnitt ändern.
Syntax	`HRESULT UpdateHierarchy(` `[in]BSTR bstrChangesXmlIn,` `[in,defaultvalue(xsCurrent)] XMLSchema xsSchema);`
Parameter	bstrChangesXmlIn : Eine Zeichenfolge, die OneNote-XML-Code enthält, der die vorzunehmenden Hierarchieänderungen angibt. Wenn Sie beispielsweise einen neuen Abschnitt einfügen möchten, können Sie ein Section-Element in die XML-Zeichenfolge einfügen, um anzugeben, wo der neue Abschnitt eingefügt werden soll. Wenn Sie den Namen eines vorhandenen Abschnitts ändern möchten, können Sie auch die gleiche Abschnitt-ID beibehalten und das name-Attribut im XML-Code ändern. xsSchema – (Optional) Die OneNote-Schemaversion der Zeichenfolge bstrChangesXmln. Dieser optionale Wert wird verwendet, um die Version des OneNote-XML-Schemas anzugeben, in dem sich die bstrChangesXmlIn-Zeichenfolge befindet. Wenn dieser Wert nicht angegeben wird, geht OneNote davon aus, dass sich der XML-Code in der Schemaversion xsCurrent befindet. HINWEIS: Es wird empfohlen, eine Version von OneNote (z. B. xs2013) anzugeben, anstatt xsCurrent zu verwenden oder leer zu lassen, da Ihr Add-In auf diese Weise mit zukünftigen Versionen von OneNote verwendet werden kann.

Wenn Sie nur eine partielle OneNote-XML-Zeichenfolge für den bstrChangesXmlIn-Parameter übergeben, versucht OneNote, die gewünschten Änderungen abzuleiten. Wenn Sie z. B. ein Notizbuch-Element einschließen, das nur einen Abschnitt enthält, fügt OneNote den Abschnitt nach einem vorhandenen Abschnitt ein. Wenn der Vorgang, den Sie angeben, nicht eindeutig ist, kann das Ergebnis jedoch schwer zu ermitteln sein. Wenn ein vorhandenes Notizbuch z. B. vier Abschnitte enthält und die übergebene XML-Zeichenfolge das Notizbuch und nur den vierten und ersten Abschnitt enthält (in dieser Reihenfolge), platziert OneNote möglicherweise den zweiten und dritten Abschnitt vor dem vierten oder nach dem ersten Abschnitt.

Sie können nicht die UpdateHierarchy-Methode verwenden, um einen Teil eines Notizbuchs zu löschen. Dies bedeutet, dass bei der Übergabe einer XML-Zeichenfolge, die nur einen Teil einer vorhandenen Hierarchie enthält, keine Abschnitte gelöscht werden, die nicht in der Zeichenfolge enthalten sind. Verwenden Sie zum Löschen eines Teils einer Hierarchie die DeleteHierarchy-Methode.

Der folgende C#-Code zeigt eine Möglichkeit für die Verwendung der UpdateHierarchy-Methode, um die OneNote-Hierarchie zu ändern, indem Sie den Namen eines vorhandenen Abschnitts ändern. XML-Code wird aus einer Beispieldatei mit dem Namen ChangeSectionName.xml im Stammverzeichnis von Laufwerk C gelesen, der dann in ein XML-Dokument geladen wird. Die XML-Struktur dieses Dokuments wird dann an die Methode übergeben.

static void UpdateExistingHierarchy()
    {
        OneNote.Application onApplication = new OneNote.Application();
        
        // Get the XML from the file.
        XmlTextReader reader = new XmlTextReader("C:\\ChangeSectionName.xml");
        reader.WhitespaceHandling = WhitespaceHandling.None;
        XmlDocument xmlDocIn = new XmlDocument();
        xmlDocIn.Load(reader);
        
        // Update the hierarchy.
        onApplication.UpdateHierarchy(xmlDocIn.OuterXml,
        OneNote.XMLSchema.xs2007);   
    }

Der folgende XML-Code ist ein Auszug aus der ChangeSectionName.xml-Datei, die der vorherige C#-Code an die Methode übergibt. Wenn der XML-Code an die UpdateHierarchy-Methode weitergegeben wird, wird der Name einer der Abschnitte in der vorhandenen Hierarchie geändert (durch Ändern des Werts des name-Attributs in "Mein umbenannter Abschnitt"). Dann werden alle Abschnitte außer dem, dessen Name geändert wurde, entfernt. Darüber hinaus entfernt der Code nicht erforderliche Attribute aus dem Zielelement Abschnitt, einschließlich der Attribute lastModifiedTime, isCurrentlyViewed und color, wobei nur die Attribute name, ID und path erhalten bleiben.

<?xml version="1.0" ?> 
    <one:Notebooks xmlns:one="http://schemas.microsoft.com/office/onenote/12/2004/onenote"> 
        <one:Notebook name="My Notebook" nickname="My Notebook" ID="{0B8E7305-AC2C-4BCB-8651-1CDA55AAE14C}{1}{B0}"> 
            <one:Section name="My Renamed Section" ID="{5F4E2908-44BA-4C02-91FE-49FC665E9A33}{1}{B0}" path="C:\My Section.one" /> 
        </one:Notebook> 
    </one:Notebooks>

Der vorherige XML-Code wurde mit dem im Beispiel für die GetHierarchy-Methode verwendeten Code abgerufen, der wie folgt geändert wird, um den Bereich auf Abschnitte zu beschränken.

static void GetAllSections()
    {
        String strXML;
        OneNote.Application onApplication = new OneNote.Application();
        onApplication.GetHierarchy(System.String.Empty, 
            OneNote.HierarchyScope.hsSections, out strXML);
        Clipboard.SetText(strXML.ToString());
        MessageBox.Show("The XML has been copied to the Clipboard");
    }

Das folgende C#-Beispiel zeigt eine vollständige Konsolenanwendung, die nach einem Abschnitt mit dem Namen "Sample_Section" sucht, den Benutzer auffordert, einen neuen Namen für den Abschnitt einzugeben und dann die UpdateHierarchy-Methode verwendet, um den Abschnittsnamen in den vom Benutzer eingegebenen Namen zu ändern. Ändern Sie vor dem Ausführen des Codes "Sample_Section" in den Namen eines Abschnitts, der in Ihrer OneNote-Hierarchie vorhanden ist.

    static void Main(string[] args)
    {
        
        // OneNote 2013 Schema namespace.
        string strNamespace = "http://schemas.microsoft.com/office/onenote/2013/onenote";
        string outputXML;
        Application onApplication = new Application();
        onApplication.GetHierarchy(null, HierarchyScope.hsSections, out outputXML);
        // Load a new XmlDocument.
        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.LoadXml(outputXML);
        XmlNamespaceManager nsmgr = new XmlNamespaceManager(xmlDoc.NameTable);
            nsmgr.AddNamespace("one", strNamespace);
        // Search for the section named "Sample_Section".
        XmlNode xmlNode = xmlDoc.SelectSingleNode("//one:Section[@name='Sample_Section']", nsmgr);
        // Prompt for a new section title.
        System.Console.Write("Please enter a new title for the section: ");
        string input = System.Console.ReadLine();
        xmlNode.Attributes["name"].Value = input; 
        // Update the section with the new title.
        onApp.UpdateHierarchy(xmlNode.OuterXml);
        System.Console.Write("Done!\n");
    }

OpenHierarchy-Methode

Wert	Beschreibung
Beschreibung	Öffnet eine Abschnittsgruppe oder einen Abschnitt, den Sie angeben.
Syntax	`HRESULT OpenHierarchy(` `[in]BSTR bstrPath,` `[in]BSTR bstrRelativeToObjectID,` `[out]BSTR * pbstrObjectID,` `[in,defaultvalue(cftNone)]CreateFileType cftIfNotExist);`
Parameter	bstrPath : Der Pfad, den Sie öffnen möchten. Für ein Notizbuch oder eine Abschnittsgruppe in einem Notizbuch kann bstrPath ein Ordnerpfad oder der Pfad zu einer ONE-Abschnittsdatei sein. Wenn Sie den Pfad zu einer ONE-Abschnittsdatei angeben, müssen Sie die ONE-Erweiterung in die Dateipfad-Zeichenfolge einschließen. bstrRelativeToObjectID : Die OneNote-ID des übergeordneten Objekts (Notizbuch oder Abschnittsgruppe), unter dem das neue Objekt geöffnet werden soll. Wenn der bstrPath-Parameter ein absoluter Pfad ist, können Sie für bstrRelativeToObjectID eine leere Zeichenfolge übergeben (""). Alternativ können Sie auch die Objekt-ID des Notizbuchs oder der Abschnittsgruppe weitergeben, die das Objekt enthalten sollte (Abschnitt oder Abschnittsgruppe), das Sie erstellen möchten. Geben Sie dann den Dateinamen (z. B. section1.one) des Objekts an, das Sie unter dem übergeordneten Objekt erstellen möchten. pbstrObjectID – (Ausgabeparameter) Die Objekt-ID, die OneNote für das Notizbuch, die Abschnittsgruppe oder den Abschnitt zurückgibt, das von der OpenHierarchy-Methode geöffnet wird. Dieser Parameter ist ein Verweis auf die Zeichenfolge, in die die Methode die ID schreiben soll. cftlfNotExist – (Optional) Ein aufgezählter Wert aus der CreateFileType-Enumeration . Wenn Sie einen Wert für cftIfNotExist übergeben, erstellt die OpenHierarchy-Methode die Abschnittsgruppe oder Die Abschnittsdatei nur dann am angegebenen Pfad, wenn die Datei noch nicht vorhanden ist.

Wenn Sie eine Abschnittsgruppe angeben, die sich nicht in einem offenen Notizbuch befindet, öffnet die OpenHierarchy-Methode die Abschnittsgruppe als Notizbuch. Wenn Sie einen Abschnitt angeben, der sich nicht in einem offenen Notizbuch befindet, öffnet die OpenHierarchy-Methode den Abschnitt in der Abschnittsgruppe "Zuletzt geöffnete Abschnitte". Wenn Sie eine Abschnittsgruppe oder einen Abschnitt angeben, die bzw. der sich bereits in einem geöffneten Notizbuch befindet, geschieht nichts, da die Abschnittsgruppe oder der Abschnitt ebenfalls bereits geöffnet ist. Auf jeden Fall gibt OpenHierarchy die Objekt-ID für die Abschnittsgruppe, das Notizbuch oder den Abschnitt zurück, die/das/den Sie angeben haben, sodass Sie sie in anderen Vorgängen verwenden können.

Sie können auch die OpenHierarchy-Methode verwenden, um neue Abschnitte zu erstellen, anstatt XML zu importieren.

Der folgende Code veranschaulicht, wie Sie die OpenHierarchy-Methode zum Öffnen des Abschnitts "Besprechungen" im Arbeitsnotizbuch öffnen und die ID für den Abschnitt abrufen. Wenn der Abschnitt nicht bereits vorhanden ist, erstellt OneNote ihn am von Ihnen angegebenen Speicherort.

static void OpenSection()
    {
        String strID;
        OneNote.Application onApplication = new OneNote.Application();
        onApplication.OpenHierarchy("C:\\Documents and Settings\\user\\My Documents\\OneNote Notebooks\\Work\\Meetings.one", 
        System.String.Empty, out strID, OneNote.CreateFileType.cftSection);
    }

DeleteHierarchy-Methode

Wert	Beschreibung
Beschreibung	Löscht alle Hierarchie-Objekte (eine Abschnittsgruppe, einen Abschnitt oder eine Seite) aus der Hierarchie des OneNote-Notizbuchs.
Syntax	`HRESULT DeleteHierarchy(` `[in]BSTR bstrObjectID,` `[in,defaultvalue(0)]DATE dateExpectedLastModified,` `[in,defaultvalue(false)]VARIANT_BOOL deletePermanently);`
Parameter	bstrObjectID : Die OneNote-ID des Objekts, das Sie löschen möchten. Das Objekt kann eine Abschnittsgruppe, ein Abschnitt oder eine Seite sein. dateExpectedLastModified – (Optional) Das Datum und die Uhrzeit, von denen Sie glauben, dass das Objekt, das Sie löschen möchten, zuletzt geändert wurde. Wenn Sie einen Wert ungleich NULL für diesen Parameter übergeben, fährt OneNote nur mit dem Update fort, wenn der Wert, den Sie übergeben, dem tatsächlichen Datum und der Zeit entspricht, zu der das Objekt zuletzt geändert wurde. Die Übergabe eines Werts für diesen Parameter verhindert, dass versehentlich Änderungen überschrieben werden, die Benutzer seit der letzten Änderung des Objekts vorgenommen haben. deletePermanently – (Optional) true , um den Inhalt endgültig zu löschen; false , um den Inhalt in den OneNote-Papierkorb für das entsprechende Notizbuch (Standard) zu verschieben. Wenn das Notizbuch im OneNote 2007-Format vorliegt, ist kein Papierkorb vorhanden, sodass der Inhalt dauerhaft gelöscht wird.

CreateNewPage-Methode

Wert	Beschreibung
Beschreibung	Fügt eine neue Seite am Ende des von Ihnen angegebenen Abschnitts hinzu. Die neue Seite wird als letzte Seite des Abschnitts hinzugefügt.
Syntax	`HRESULT CreateNewPage(` `[in]BSTR bstrSectionID,` `[out]BSTR * pbstrPageID);` `[in,defaultvalue(npsDefault)]NewPageStyle npsNewPageStyle);`
Parameter	bstrSectionID : Eine Zeichenfolge, die die OneNote-ID des Abschnitts enthält, in dem Sie die neue Seite erstellen möchten. pbstrPageID – (Ausgabeparameter) Ein Zeiger auf die Zeichenfolge, in die die Methode die OneNote-ID für die neu erstellte Seite schreibt. npsNewPageStyle : Ein Wert aus der NewPageStyle-Enumeration , der den Stil der zu erstellenden Seite angibt.

Die OneNote-API umfasst die CreateNewPage-Methode als Serviceleistung. Sie können dasselbe Ergebnis mit einer höheren Kontrolle darüber, wie die neue Seite in der Hierarchie positioniert wird, erzielen, indem Sie die UpdateHierarchy-Methode aufrufen. Mit der UpdateHierarchy-Methode können Sie beim Erstellen der neuen Seite auch Unterseiten erstellen.

CloseNotebook-Methode

Wert	Beschreibung
Beschreibung	Schließt das angegebene Notizbuch.
Syntax	`HRESULT CloseNotebook(` `[in]BSTR bstrNotebookID,` `[in,defaultvalue(false)]VARIANT_BOOL force);`
Parameter	bstrNotebookID : Die OneNote-ID des Notizbuchs, das Sie schließen möchten. force – (Optional) true , um das Notizbuch zu schließen, auch wenn Änderungen im Notizbuch vorhanden sind, die OneNote vor dem Schließen nicht synchronisieren kann; andernfalls false (Standard).

Sie können die CloseNotebook-Methode verwenden, um das angegebene Notizbuch zu schließen. Wenn Sie diese Methode aufrufen, synchronisiert OneNote bei Bedarf alle Offline-Dateien mit aktuellem Notizbuchinhalt und schließt dann das angegebene Notizbuch. Nachdem die Methode zurückgegeben wurde, wird das Notizbuch nicht mehr in der Liste der geöffneten Notizbücher der OneNote-Benutzeroberfläche (UI) angezeigt.

GetHierarchyParent-Methode

Wert	Beschreibung
Beschreibung	Ruft die OneNote-ID des übergeordneten Objekts eines OneNote-Objekts ab.
Syntax	`HRESULT GetHierarchyParent (` `[in]BSTR bstrObjectID,` `[out]BSTR * pbstrParentID);`
Parameter	bstrObjectID : Eine Zeichenfolge, die die OneNote-ID des Objekts enthält, dessen übergeordnetes Objekt Sie suchen möchten. pbstrParentID – (Ausgabeparameter) Ein Zeiger auf die Zeichenfolge, in die die Methode die OneNote-ID des übergeordneten Objekts schreibt.

Wenn das OneNote-Objekt kein übergeordnetes Objekt besitzt (wenn z. B. ein Benutzer das übergeordnete Element eines Notizbuchs abrufen möchte), wird eine Ausnahme ausgelöst.

GetSpecialLocation-Methode

Wert	Beschreibung
Beschreibung	Ruft den Pfad zu dem Speicherort ab, an dem OneNote bestimmte Sonderelemente, wie z. B. Sicherungen, nicht abgelegte Notizen und das Standardnotizbuch, speichert.
Syntax	`HRESULT GetSpecialLocation(` `[in]SpecialLocation slToGet,` `[out]BSTR * pbstrSpecialLocationPath);`
Parameter	slToGet : Einer der SpecialLocation-Enumerationswerte , der den abzurufenden speicherort des speziellen Ordners angibt. pbstrSpecialLocationPath – (Ausgabeparameter) Ein Zeiger auf die Zeichenfolge, in die OneNote den Pfad des speziellen Ordners schreiben soll.

Sie können diese Methode verwenden, um den Speicherort des Ordners "Nicht abgelegte Notizen" auf dem Datenträger zu ermitteln. Dies ist der Ordner, in dem OneNote Notizen speichert, die erstellt werden, wenn Sie ein Element in OneNote ziehen, sowie Notizen, die direkt aus anderen Anwendungen stammen (z. B. solche, die abgerufen werden, wenn Sie auf An OneNote senden in Microsoft Outlook oder Microsoft Internet Explorer klicken).

Seiteninhalt-Methoden

Mit den in diesem Abschnitt beschriebenen Methoden können Sie Inhalte von Seiten in OneNote-Notizbüchern entdecken, aktualisieren und löschen sowie OneNote-Inhalte veröffentlichen.

GetPageContent-Methode

Wert	Beschreibung
Beschreibung	Ruft alle Inhalte (im OneNote XML-Format) der angegebenen Seite ab.
Syntax	`HRESULT GetPageContent(` `[in]BSTR bstrPageID,` `[out]BSTR * pbstrPageXmlOut,` `[in,defaultvalue(piBasic)]PageInfo pageInfoToExport,` `[in,defaultvalue(xsCurrent)]XMLSchema xsSchema);`
Parameter	bstrPageId : Die OneNote-ID der Seite, deren Inhalt Sie abrufen möchten. pbstrPageXmlOut – (Ausgabeparameter) Ein Zeiger auf die Zeichenfolge, in die OneNote die XML-Ausgabe schreiben soll. pageInfoToExport – (Optional) Gibt an, ob die GetPageContent-Methode binären Inhalt zurückgibt, eingebettet in den XML-Code und base-64-codiert. Binäre Inhalte können beispielsweise Bilder und Freihanddaten enthalten. Der pageInfoToExport-Parameter gibt auch an, ob die Auswahl im XML-Code, den die GetPageContent-Methode zurückgibt, gekennzeichnet werden soll. Es wird ein Enumerationswert aus der PageInfo-Enumeration verwendet. xsSchema – (Optional) Die Version des OneNote-XML-Schemas vom Typ XMLSchema, die ausgegeben werden soll. Sie können angeben, ob Sie die XML-Schemaversion 2013, 2010, 2007 oder die aktuelle Version wünschen. HINWEIS: Es wird empfohlen, eine Version von OneNote (z. B. xs2013) anzugeben, anstatt xsCurrent zu verwenden oder leer zu lassen, da Ihr Add-In auf diese Weise mit zukünftigen Versionen von OneNote verwendet werden kann.

Standardmäßig bettet OneNote keine binären Inhalte in den XML-Code ein, um übermäßige Längen in der zurückgegebenen Zeichenfolge zu vermeiden. Aus demselben Grund wird die aktuelle Auswahl nicht mit Auswahlattributen gekennzeichnet. Binäre Objekte enthalten eine OneNote-ID in Ihren eigenen Tags. Um ein binäres Objekt abzurufen, rufen Sie die GetBinaryPageContent-Methode auf und übergeben die OneNote-ID, die Sie von der GetPageContent-Methode erhalten haben. Verwenden Sie die GetPageContent-Methode, wenn Sie die binären Daten nicht sofort benötigen.

UpdatePageContent-Methode

Wert	Beschreibung
Beschreibung	Aktualisiert oder ändert den Inhalt auf der Seite.
Syntax	`HRESULT UpdatePageContent(` `[in]BSTR bstrPageChangesXmlIn,` `[in,defaultvalue(0)]DATE dateExpectedLastModified,` `[in,defaultvalue(xsCurrent)]XMLSchema xsSchema,` `[in,defaultvalue(false)]VARIANT_BOOL force);`
Parameter	bstrPageChangesXmlIn : Eine Zeichenfolge, die OneNote-XML-Code enthält, der die Änderungen enthält, die Sie an der Seite vornehmen möchten. dateExpectedLastModified – (Optional) Das Datum und die Uhrzeit, zu der Sie der Meinung sind, dass die Seite, die Sie aktualisieren möchten, zuletzt geändert wurde. Wenn Sie einen Wert ungleich NULL für diesen Parameter übergeben, fährt OneNote nur mit dem Update fort, wenn der Wert, den Sie übergeben, dem tatsächlichen Datum und der Zeit entspricht, zu der die Seite zuletzt geändert wurde. Die Übergabe eines Werts für diesen Parameter verhindert, dass versehentlich Änderungen überschrieben werden, die Benutzer seit der letzten Änderung der Seite vorgenommen haben. xsSchema – (Optional) Die Version des OneNote-XML-Schemas vom Typ XMLSchema, die ausgegeben werden soll. Sie können angeben, ob Sie die XML-Schemaversion 2013, 2010, 2007 oder die aktuelle Version wünschen. HINWEIS: Es wird empfohlen, eine Version von OneNote (z. B. xs2013) anzugeben, anstatt xsCurrent zu verwenden oder leer zu lassen, da Ihr Add-In auf diese Weise mit zukünftigen Versionen von OneNote verwendet werden kann. force(Optional) true, um den Inhalt der Seite zu aktualisieren, auch wenn auf der Seite unbekannte Daten von einer zukünftigen OneNote-Version vorhanden sind; andernfalls false (Standard).

Sie können diese Methode verwenden, um die Seite auf verschiedene Arten zu ändern. Beispielsweise können Sie die UpdatePageContent-Methode verwenden, um eine Gliederung zu einer Seite hinzuzufügen, den Inhalt einer Gliederung zu ändern, Bilder hinzuzufügen, Freihandobjekte hinzuzufügen, Inhalte zu verschieben oder Text in Gliederungen zu ändern.

Ein spezifischeres Beispiel wäre die Verwendung der GetPageContent-Methode, um eine vorhandene Seite zu exportieren, Änderungen am XML-Code für die Seite vorzunehmen und dann die UpdatePageContent-Methode zu verwenden, um die gesamte Seite erneut zu importieren. Oder Sie können diese Methode verwenden, um neue Seitenobjekte, wie z. B. Bilder, an das Ende einer vorhandenen Seite hinzuzufügen.

Die einzigen Objekte, die Sie zu dem XML-Code hinzufügen müssen, den Sie an die UpdatePageContent-Methode übergeben, sind Seitenebene-Objekte (z. B. Gliederungen, Bilder auf der Seite oder Freihandobjekte auf der Seite), die nie geändert wurden. Diese Methode ändert oder entfernt keine Objekte auf Seitenebene, die Sie nicht im bstrPageChangesXmlIn-Parameter angegeben. Diese Methode ersetzt vollständig Objekte auf Seitenebene, wie z. B. Gliederungen, deren IDs mit denen der übergebenen Objekte übereinstimmen. Aus diesem Grund müssen Sie alle Objekte auf Seitenebene vollständig in Ihrem Code angeben, einschließlich der vorhandenen Inhalte und Änderungen, die Sie daran vornehmen möchten.

Wenn Ihre Seite z. B. eine Gliederung und ein Hintergrundbild für die Seite enthält, können Sie die Gliederung ersetzen und das Bild unverändert lassen, indem Sie die Gliederung komplett im XML-Code angeben, die ID der vorhandenen Gliederung verwenden und das Bild nicht in den Code einschließlichen. Da die überarbeitete Gliederung, die Sie in den Code einschließen, die vorhandene Gliederung vollständig ersetzt, müssen Sie alle Inhalte der Gliederung einschließen.

Darüber hinaus ändert die UpdatePageContent-Methode nur Elementeigenschaften, die Sie im bstrPageChangesXmlIn-Parameter angeben. Wenn Sie z. B. einige, aber nicht alle Eigenschaften des PageSettings-Elements angeben, bleiben die Eigenschaften, die Sie nicht angeben, unverändert.

Das folgende Beispiel zeigt, wie Sie mithilfe der UpdatePageContent-Methode den Titel einer Seite ändern und Beispieltext zur Seite hinzufügen. Ersetzen Sie vor dem Ausführen des Codes eine gültige Seiten-ID durch die im Code angezeigte Seiten-ID, damit der Code auf Ihrem Computer funktioniert. Sie können die Seiten-ID für eine Seite abrufen, indem Sie die GetHierarchy-Methode verwenden und die Ausgabe untersuchen.

static void UpdatePageContent()
    {
        OneNote.Application onApplication = new OneNote.Application();
        String strImportXML;
        strImportXML = "<?xml version=\"1.0\"?>" +
            "<one:Page xmlns:one=\"http://schemas.microsoft.com/office/onenote/12/2004/onenote\" 
            ID=\"{3428B7BB-EF39-4B9C-A167-3FAE20630C37}{1}{B0}\">" +
            "    <one:PageSettings RTL=\"false\" color=\"automatic\">" +
            "        <one:PageSize>" +
            "            <one:Automatic/>" +
            "        </one:PageSize>" +
            "        <one:RuleLines visible=\"false\"/>" +
            "    </one:PageSettings>" +
            "    <one:Title style=\"font-family:Calibri;
                 font-size:17.0pt\" lang=\"en-US\">" +
            "        <one:OE alignment=\"left\">" +
            "            <one:T>" +
            "                <![CDATA[My Sample Page]]>" +
            "            </one:T>" +
            "        </one:OE>" +
            "    </one:Title>" +
            "    <one:Outline >" +
            "        <one:Position x=\"120\" y=\"160\"/>" +
            "        <one:Size width=\"120\" height=\"15\"/>" +
            "        <one:OEChildren>" +
            "            <one:OE alignment=\"left\">" +
            "                <one:T>" +
            "                    <![CDATA[Sample Text]]>" +
            "                </one:T>" +
            "            </one:OE>" +
            "        </one:OEChildren>" +
            "    </one:Outline>" +
            "</one:Page>";
        // Update the page content.
        onApplication.UpdatePageContent(strImportXML, System.DateTime.MinValue);
    }

GetBinaryPageContent-Methode

Wert	Beschreibung
Beschreibung	Gibt ein binäres Objekt, wie z. B. Freihand oder Bilder, auf einer OneNote-Seite als Base-64-codierte Zeichenfolge zurück.
Syntax	`HRESULT GetBinaryPageContent(` `[in]BSTR bstrPageID,` `[in]BSTR bstrCallbackID,` `[out]BSTR * pbstrBinaryObjectB64Out);`
Parameter	bstrPageID : Die OneNote-ID der Seite, die das abzurufende binäre Objekt enthält. bstrCallBackID : Die OneNote-ID des binären Objekts, das Sie abrufen möchten. Diese ID, die als callbackID bezeichnet wird, ist der OneNote XML-Code für eine von der GetPageContent-Methode zurückgegebene Seite. pbstrBinaryObectB64Out – (Ausgabeparameter) Ein Zeiger auf eine Zeichenfolge, in die OneNote das binäre Objekt als Base64-codierte Zeichenfolge schreibt.

DeletePageContent-Methode

Wert	Beschreibung
Beschreibung	Löscht ein Objekt , z. B. ein Outline-, Freihand- oder Image-Objekt von einer Seite.
Syntax	`HRESULT DeletePageContent(` `[in]BSTR bstrPageID,` `[in]BSTR bstrObjectID,` `[in,defaultvalue(0)]DATE dateExpectedLastModified,` `[in,defaultvalue(#)]VARIANT_BOOL force);`
Parameter	bstrPageID : Die OneNote-ID der Seite, die das zu löschende Objekt enthält. bstrObjectID : Die OneNote-ID des Objekts, das Sie löschen möchten. dateExpectedLastModified – (Optional) Das Datum und die Uhrzeit, zu denen Sie der Meinung sind, dass die Seite, die inhalte enthält, die Sie löschen möchten, zuletzt geändert wurde. Wenn Sie einen Wert ungleich NULL für diesen Parameter übergeben, fährt OneNote nur mit dem Löschen fort, wenn der Wert, den Sie übergeben, dem tatsächlichen Datum und der Zeit entspricht, zu der die Seite zuletzt geändert wurde. Die Übergabe eines Werts für diesen Parameter verhindert, dass versehentlich Änderungen überschrieben werden, die Benutzer seit der letzten Änderung der Seite vorgenommen haben. force – (Optional) true , um den Seiteninhalt zu aktualisieren, auch wenn auf der Seite unbekannte Daten aus einer zukünftigen Version von OneNote vorhanden sind; andernfalls false (Standard).

Publish-Methode

Wert	Beschreibung
Beschreibung	Exportiert die Seite, die Sie angeben haben, in eine Datei in einem beliebigen Format, das OneNote unterstützt.
Syntax	`HRESULT Publish(` `[in]BSTR bstrHierarchyID,` `[in]BSTR bstrTargetFilePath,` `[in,defaultvalue(pfOneNote)]PublishFormat pfPublishFormat,` `[in,defaultvalue(0)]BSTR bstrCLSIDofExporter);`
Parameter	bstrHierarchyID : Die OneNote-ID der Hierarchie, die Sie exportieren möchten. bstrTargetFilePath : Der absolute Pfad zu dem Speicherort, an dem Sie die resultierende Ausgabedatei speichern möchten. Die Datei, die Sie angeben, darf noch nicht an diesem Speicherort vorhanden sein. pfPublishFormat : Einer der PublishFormat-Enumerationswerte , der das Format angibt, in dem die veröffentlichte Seite sein soll (z. B. MTHML, PDF usw.). bstrCLSIDofExporter : Die Klassen-ID (CLSID) einer registrierten COM-Anwendung, die erweiterte Metadateien von Microsoft Windows (.emf) exportieren kann. Die COM-Anwendung muss die IMsoDocExporter-Oberfläche implementieren. Dieser Parameter wird angegeben, um zu verhindern, dass Entwickler dritter Parteien ihren eigenen Code schreiben, um OneNote-Inhalte in einem benutzerdefinierten Format zu veröffentlichen. Weitere Informationen zur IMsoDocExporter-Schnittstelle finden Sie unter Erweitern Sie das Office 2007-Format Export Feature.

OneNote unterstützt derzeit die folgenden Dateiformate:

MHTML-Dateien (MHT)
Adobe Acrobat-PDF-Dateien (PDF)
XML Paper Specification-Dateien (XPS)
OneNote 2013-, 2010- oder 2007-Dateien (ONE)
OneNote-Paketdateien (ONEPKG)
Microsoft Word-Dokumente (DOC oder DOCX)
Microsoft Windows Enhanced Metafiles (EMF)
HTML-Dateien (HTML)

Diese Methode erzeugt genau die gleichen Ergebnisse, die Sie auch durch Klicken auf Publish in der Benutzeroberfläche und Angabe des Formats erhalten würden.

Mit den in diesem Abschnitt beschriebenen Methoden können Sie OneNote-Notizbücher, Abschnittsgruppen, Abschnitte, Seiten und Seitenobjekte finden, zu diesen navigieren und diese verlinken.

NavigateTo-Methode

Wert	Beschreibung
Beschreibung	Navigiert zu dem angegebenen Objekt (z. B. Abschnitte, Seiten und Outline-Elemente innerhalb der Seite).
Syntax	`HRESULT NavigateTo(` `[in]BSTR bstrHierarchyObjectID,` `[in,defaultvalue(#)]BSTR bstrObjectID,` `[in,defaultvalue(0)]VARIANT_BOOL fNewWindow);`
Parameter	bstrHierarchyObjectID : Die OneNote-ID des Objekts, zu dem Sie in der OneNote-Hierarchie navigieren möchten. bstrObjectID : Die OneNote-ID des Objekts, zu dem Sie auf der OneNote-Seite navigieren möchten. fNewWindow – (Optional) true , um das angegebene Objekt in einem neuen OneNote-Fenster zu öffnen. false öffnet kein neues OneNote-Fenster, wenn eins geöffnet ist.

NavigateToUrl-Methode

Wert	Beschreibung
Beschreibung	Wenn einen Link OneNote übergeben (Onenote: / /), wird das OneNote-Fenster auf den entsprechenden Speicherort in OneNote geöffnet. Wenn sich der Link außerhalb von OneNote befindet (z. B. "https://" oder "file://"), wird ein Sicherheitsdialogfeld angezeigt. Bei Ablehnung versucht OneNote, den Link zu öffnen, und ein HResult.hrObjectDoesNotExist-Fehler wird zurückgegeben.
Syntax	`HRESULT NavigateTo(` `[in]BSTR bstrUrl,` `[in,defaultvalue(0)]VARIANT_BOOL fNewWindow);`
Parameter	bstrUrl : Eine Zeichenfolge, die angibt, wohin navigiert werden soll. Dies kann ein OneNote-Link oder eine beliebige andere URL sein, wie z. B. ein Weblink oder eine Netzwerkadresse. fNewWindow – (Optional) true , um die angegebene URL in einem neuen OneNote-Fenster zu öffnen. false öffnet kein neues OneNote-Fenster, wenn eins geöffnet ist.

GetHyperLinkToObject-Methode

Wert	Beschreibung
Beschreibung	Ruft einen OneNote-Hyperlink zum angegebenen Notizbuch, zur angegebenen Abschnittsgruppe, zum angegebenen Abschnitt, zur angegebenen Seite oder zum angegebenen Seitenobjekt ab.
Syntax	`HRESULT GetHyperlinkToObject(` `[in] BSTR bstrHierarchyID,` `[in] BSTR bstrPageContentObjectID,` `[out] BSTR * pbstrHyperlinkOut);`
Parameter	bstrHierarchyID : Die OneNote-ID für das Notizbuch, die Abschnittsgruppe, den Abschnitt oder die Seite, für die Sie einen Link erstellen möchten. bstrPageContentObjectID – (Optional) Die OneNote-ID für das Objekt innerhalb der Seite, für die Sie einen Link erstellen möchten. Das Objekt kann z. B. eine Gliederung oder ein outline-Element sein. Wenn Sie eine leere Zeichenfolge übergeben (""), verweist der zurückgegebene Link auf das Notizbuch, die Abschnittsgruppe, den Abschnitt oder die Seite, das/die/der im bstrHierarchyID-Parameter angegeben wurde. Wenn Sie eine nicht leere Zeichenfolge für den bstrPageContentObjectID-Parameter übergeben, muss der _bstrHierarchyID-Parameterein Verweis auf die Seite sein, die das angegebene Objekt enthält. pbstrHyperlinkOut – (Ausgabeparameter) Ein Zeiger auf eine Zeichenfolge, in die die GetHyperlinkToObject-Methode den Ausgabelinktext schreibt.

Wenn Sie versuchen, zum resultierenden Link zu navigieren, öffnet OneNote das angegebene Objekt im Browser.

GetWebHyperlinktoObject-Methode

Wert	Beschreibung
Beschreibung	Gibt einen Hyperlink zu einem Objekt zurück, das im OneNote-Webclient geöffnet wird.
Syntax	`HRESULT GetWebHyperlinkToObject (` `[in] BSTR bstrHierarchyID,` `[in] BSTR bstrPageContentObjectID,` `[out] BSTR * pbstrHyperlinkOut);`
Parameter	bstrHierarchyID : Die OneNote-ID für das Notizbuch, die Abschnittsgruppe, den Abschnitt oder die Seite, für die sie einen Weblink verwenden möchten. bstrPageContentObjectID – (Optional) Die OneNote-ID für das Objekt innerhalb der Seite, für die Sie einen Link erstellen möchten. Das Objekt kann z. B. eine Gliederung oder ein outline-Element sein. Wenn Sie eine leere Zeichenfolge übergeben (""), verweist der zurückgegebene Link auf das Notizbuch, die Abschnittsgruppe, den Abschnitt oder die Seite, das/die/der im bstrHierarchyID-Parameter angegeben wurde. Wenn Sie eine nicht leere Zeichenfolge für den bstrPageContentObjectID-Parameter übergeben, muss der _bstrHierarchyID-Parameterein Verweis auf die Seite sein, die das angegebene Objekt enthält. pbstrHyperlinkOut – (Ausgabeparameter) Ein Zeiger auf eine Zeichenfolge, in die die GetWebHyperlinkToObject-Methode den Ausgabelinktext schreibt. Wenn kein Webhyperlink für das Notizbuch erstellt werden kann, wird ein Null-Wert zurückgegeben.

FindPages-Methode

Wert	Beschreibung
Beschreibung	Gibt eine Liste der Seiten zurück, die dem angegebenen Abfragebegriff entsprechen.
Syntax	`HRESULT FindPages(` `[in]BSTR bstrStartNodeID,` `[in]BSTR bstrSearchBSTR,` `[out]BSTR * pbstrHierarchyXmlOut,` `[in,defaultvalue(#)]VARIANT_BOOL fIncludeUnindexedPages,` `[in,defaultvalue(0)]VARIANT_BOOL fDisplay,` `[in,defaultvalue(#)]XMLSchema xsSchema);`
Parameter	bstrStartNodeID : Der Knoten (Stamm, Notebook, Abschnittsgruppe oder Abschnitt), unter dem nach Inhalt gesucht werden soll. Dieser Parameter legt den Bereich für die Suche fest. bstrSearchString : Die Suchzeichenfolge. Geben Sie genau die gleiche Zeichenfolge weiter, die Sie in das Suchfeld der OneNote-UI eingeben würden. Sie können bitweise Operatoren verwenden, wie z. B. UND und ODER, die komplett in Großbuchstaben angegeben werden müssen. pbstrHierarchyXmlOut – (Ausgabeparameter) Ein Zeiger auf eine Zeichenfolge, in die OneNote die XML-Ausgabezeichenfolge schreiben soll. Die resultierende XML-Zeichenfolge enthält die Notizbuchhierarchie vom Stamm bis hinunter zu den und einschließlich aller Seiten, die der Suchzeichenfolge entsprechen. Die FindPages-Methode listet z. B. keine Abschnitte auf, die nicht über Seitenübereinstimmungen in der Hierarchie verfügen. Wenn nur eine Seite in einem einzigen Abschnitt mit der Zeichenfolge übereinstimmt, enthält die zurückgegebene Hierarchie den Pfad zu dem Abschnitt und der Seite, aber keine anderen Bestandteile der Hierarchie des Notizbuchs. fIncludeUnindexedPages – (Optional) true für Suchseiten, die nicht von Windows Search indiziert wurden; andernfalls false. fDisplay – (optional) true , um die Suche auch in der Benutzeroberfläche für den Benutzer auszuführen, so als hätte der Benutzer sie selbst eingegeben. false, um die Abfrage ohne Änderung an der Benutzeroberfläche auszuführen (Standard). xsSchema – (Optional) Die OneNote-Schemaversion der Zeichenfolge pbstrHierarchyXmlOut. Dieser optionale Wert wird verwendet, um die Version des OneNote-XML-Schemas anzugeben, im dem sich die pbstrHierarchyXmlOut-Zeichenfolge befindet. Wenn dieser Wert nicht angegeben wird, geht OneNote davon aus, dass sich der XML-Code in der Schemaversion xsCurrent befindet. HINWEIS: Es wird empfohlen, eine Version von OneNote (z. B. xs2013) anzugeben, anstatt xsCurrent zu verwenden oder leer zu lassen, da Ihr Add-In auf diese Weise mit zukünftigen Versionen von OneNote verwendet werden kann.

FindPages funktioniert nur, wenn Sie Microsoft Search 3.0 oder 4.0 auf Ihrem Computer installiert haben. Windows Vista und Windows 7 enthalten diese Komponente. Wenn Sie eine frühere Version von Windows ausführen, müssen Sie Windows Search installieren, damit FindPages funktioniert.

FindMeta-Methode

Wert	Beschreibung
Beschreibung	Gibt eine Liste von OneNote-Objekten zurück, die Metadaten enthalten, die dem angegebenen Abfragebegriff entsprechen.
Syntax	`HRESULT FindMeta (` `[in]BSTR bstrStartNodeID,` `[in]BSTR bstrSearchBSTRName,` `[out]BSTR * pbstrHierarchyXmlOut,` `[in,defaultvalue(#)]VARIANT_BOOL fIncludeUnindexedPages,` `[in,defaultvalue(#)]XMLSchema xsSchema);`
Parameter	bstrStartNodeID : Der Knoten (Stamm, Notebook, Abschnittsgruppe oder Abschnitt), unter dem nach Inhalt gesucht werden soll. Dieser Parameter legt den Bereich für die Suche fest. bstrSearchStringName : Die Suchzeichenfolge. In einem beliebigen Teil des Namens der Metadaten übergeben. Wenn Sie eine leere Zeichenfolge oder einen Null-Wert übergeben, entsprechen alle Objekte, die Metadaten enthalten, der Abfrage. pbstrHierarchyXmlOut – (Ausgabeparameter) Ein Zeiger auf eine Zeichenfolge, in die OneNote die XML-Ausgabezeichenfolge schreiben soll. Die resultierende XML-Zeichenfolge enthält die Notizbuchhierarchie vom Stamm bis hinunter zu den und einschließlich aller Seiten, die der Suchzeichenfolge entsprechen. Die FindPages-Methode listet z. B. keine Abschnitte auf, die nicht über Seitenübereinstimmungen in der Hierarchie verfügen. Wenn nur eine Seite in einem einzigen Abschnitt mit der Zeichenfolge übereinstimmt, enthält die zurückgegebene Hierarchie den Pfad zu dem Abschnitt und der Seite, aber keine anderen Bestandteile der Hierarchie des Notizbuchs. fIncludeUnindexedPages – (Optional) true für Suchseiten, die nicht von Windows Search indiziert wurden; andernfalls false. xsSchema – (Optional) Die OneNote-Schemaversion der Zeichenfolge pbstrHierarchyXmlOut. Dieser optionale Wert wird verwendet, um die Version des OneNote-XML-Schemas anzugeben, im dem sich die pbstrHierarchyXmlOut-Zeichenfolge befindet. Wenn dieser Wert nicht angegeben wird, geht OneNote davon aus, dass sich der XML-Code in der Schemaversion xsCurrent befindet. HINWEIS: Es wird empfohlen, eine Version von OneNote (z. B. xs2013) anzugeben, anstatt xsCurrent zu verwenden oder leer zu lassen, da Ihr Add-In auf diese Weise mit zukünftigen Versionen von OneNote verwendet werden kann.

FindMeta funktioniert nur, wenn Sie Microsoft Windows Search 3.0 oder 4.0 auf Ihrem Computer installiert haben. Windows Vista und Windows 7 enthalten diese Komponente. Wenn Sie eine frühere Version von Windows ausführen, müssen Sie Windows Search installieren, damit FindMeta funktioniert.

Funktionale Methoden

Mit den in diesem Abschnitt beschriebenen Methoden können Sie bestimmte Aktionen ausführen oder Parameter innerhalb der OneNote-Anwendung festlegen.

MergeFiles-Methode

Wert	Beschreibung
Beschreibung	Ermöglicht es Benutzern, Änderungen an derselben Datei in einer Datei zusammenführen. Damit die Dateien als gleich angesehen werden, müssen Sie die gleiche OneNote-ID besitzen.
Syntax	`HRESULT MergeFiles (` `[in]BSTR bstrBaseFile,` `[in]BSTR bstrClientFile,` `[in]BSTR bstrServerFile,` `[in]BSTR bstrTargetFile);`
Parameter	bstrBaseFile : Die Pfadzeichenfolge zum Speicherort der ONE-Datei des Anfangszustands der Datei. bstrClientFile : Die Pfadzeichenfolge zum SPEICHERORT der ONE-Datei des zweiten Satzes von Änderungen, die mit der Basisdatei zusammengeführt werden sollen, nachdem die Änderungen der Serverdatei mit der Basis zusammengeführt wurden. bstrServerFile : Die Pfadzeichenfolge zum SPEICHERORT der ERSTEN ÄNDERUNGEN, die mit der Basisdatei zusammengeführt werden sollen. bstrTargetFile : Die Pfadzeichenfolge zum SPEICHERORT der ONE-Datei der Datei mit den zusammengeführten Änderungen.

Die MergeFiles-Methode wurde für mobile Szenarien entwickelt, bei denen mehrere Versionen einer OneNote-Datei vorhanden sein können.

MergeSections-Methode

Wert	Beschreibung
Beschreibung	Führt die Inhalte von einem Abschnitt mit einem anderen Abschnitt in OneNote zusammen.
Syntax	`HRESULT MergeSections (` `[in]BSTR bstrSectionSourceId,` `[in]BSTR bstrSectionDestinationId);`
Parameter	bstrSectionSourceId : Die OneNote-ID des abschnitts, der zusammengeführt werden soll. bstrSectionDestinationId : Die OneNote-ID des Abschnitts, in den zusammengeführt werden soll. Der Quellabschnitt wird in diesen Zielabschnitt integriert.

Diese Methode führt denselben Vorgang wie das Feature In einen anderen Abschnitt einfügen aus, das angezeigt wird, wenn Sie mit der rechten Maustaste auf einen Abschnitt klicken.

QuickFiling-Methode

Wert	Beschreibung
Beschreibung	Gibt eine Instanz des IQuickFilingDialog-Dialogfelds zurück, die verwendet werden kann, um einen Speicherort in der OneNote-Hierarchiestruktur auszuwählen.
Syntax	`HRESULT QuickFiling (` `);`

SyncHierarchy-Methode

Wert	Beschreibung
Beschreibung	Zwingt OneNote, das angegebene Objekt mit der Quelldatei auf dem Datenträger zu synchronisieren.
Syntax	`HRESULT SyncHierarchy (` `[in]BSTR bstrHierarchyID);`
Parameter	bstrHierarchyID : Die OneNote-ID des zu synchronisierenden Objekts.

SetFilingLocation-Methode

Wert	Beschreibung
Beschreibung	Ermöglicht es Benutzern, anzugeben, wo und wie bestimmte Arten von Inhalten in OneNote abgelegt werden sollen.
Syntax	`HRESULT SetFilingLocation (` `[in]FilingLocation flToSet,` `[in]FilingLocationType fltToSet,` `[in]BSTR bstrFilingSectionID);`
Parameter	flToSet : Der Objekttyp des festzulegenden Speicherorts. fltToSet : Der Speicherort, an dem der Typ gespeichert werden soll. bstrFilingSectionID : Die OneNote-ID des Abschnitts oder der Seite, an dem Sie festlegen möchten. Wenn dies nicht zutrifft, kann der Benutzer einen Null-Wert oder eine leere Zeichenfolge übergeben.

Die Arten von Inhalten, die abgelegt werden können, umfassen Outlook-Elemente und Webnotizen von Internet Explorer, die in OneNote über den Befehl An OneNote senden importiert werden. Der Ablageort von Elementen, die in OneNote gedruckt werden, kann ebenfalls mit dieser Methode festgelegt werden.

Eigenschaften

In diesem Abschnitt werden die Eigenschaften der Application-Oberfläche beschrieben.

Eigenschaft	Beschreibung
Windows	Bietet Benutzern Zugriff auf geöffnete OneNote-Fenster. Diese Eigenschaft ermöglicht es Benutzern, die OneNote-Fenster aufzulisten und bestimmte Fenstereigenschaften zu ändern. Weitere Informationen finden Sie unter Windows-Schnittstellen.
COMAddIns	Gibt die COMAddIns-Sammlung für OneNote zurück. Diese Sammlung enthält alle COM-Add-Ins, die für OneNote verfügbar sind. Die Count-Eigenschaft der COMAddins-Sammlung gibt die Anzahl der verfügbaren COM-Add-Ins zurück. Weitere Informationen finden Sie unter COMAddIns-Objekt.
LanguageSettings	Ermöglicht den Zugriff auf einige APIs, um die gängigen Spracheinstellungen von OneNote zu ändern.

Ereignisse

In diesem Abschnitt werden die Ereignisse der Anwendungsoberfläche beschrieben.

Achtung

Ereignisse können derzeit nicht zu verwaltetem Code hinzugefügt werden.

OnNavigate-Ereignis

Wert	Beschreibung
Beschreibung	Ermöglicht es einem Benutzer, eine Funktion zuzuweisen, die aufgerufen wird, wenn die OneNote-Oberfläche von der aktuellen OneNote-Position navigiert wird.
Syntax	`Event OnNavigate (` `);`

OnHierarchyChange-Methode

Wert	Beschreibung
Beschreibung	Ermöglicht es einem Benutzer, eine Funktion zuzuweisen, die immer dann aufgerufen wird, wenn die OneNote-Hierarchie sich ändert (z. B. Hinzufügen oder Löschen von Seiten oder Verschieben von Abschnitten). Hierarchie-Änderungen werden gestapelt, wenn also mehrere Änderungen zur gleichen Zeit oder etwa zur gleichen Zeit eintreten, löst OneNote das Ereignis einmal aus.
Syntax	`Event OnHierarchyChange (` `BSTR bstrActivePageID);`
Parameter	bstrActivePageID : Übergibt die OneNote-ID der aktiven Seite.

Siehe auch

OneNote-Entwicklerreferenz

Share via