Interfaz de la aplicación (OneNote)

La interfaz de la aplicación incluye métodos que ayudan a recuperar, manipular y actualizar información y contenido de OneNote. Los métodos se encuentran en cuatro categorías generales:

• Estructura del cuaderno : métodos para trabajar con la estructura del cuaderno, incluidos los para detectar, abrir, modificar, cerrar y eliminar cuadernos, grupos de secciones y secciones.

• Contenido de página: métodos para trabajar con páginas y contenido de página, incluidos los para detectar, modificar, guardar y eliminar contenido de página. El contenido de la página incluye objetos binarios, como imágenes y escritura en lápiz y objetos de texto, como esquemas.

• Navegación : métodos para buscar, vincular y navegar a páginas y objetos.

• Funcional : todos los demás métodos que realizan ciertas acciones o establecen parámetros en OneNote.

Además, la interfaz de la Aplicación incluye una serie de propiedades y eventos.

Métodos de estructura del Bloc de notas

Los métodos descritos en esta sección te permiten descubrir, abrir, modificar, cerrar y eliminar blocs de notas, secciones y grupos de secciones de OneNote.

Método GetHierarchy

El método GetHierarchy devuelve una cadena en formato XML de OneNote 2013 de forma predeterminada o puede establecer la versión de esquema XML preferida mediante el parámetro xsSchema opcional.

Dependiendo de los parámetros que pases, el método GetHierarchy puede devolver varias listas (por ejemplo, todos los blocs de notas, todas las secciones en todos los blocs de notas, todas las páginas de una sección determinada o todas las páginas dentro de un bloc de notas determinado). Para cada nodo, la cadena XML devuelta proporciona propiedades (por ejemplo, el título de sección o página, la identificación y la última modificación).

No todas las combinaciones de nodo inicial y ámbito son válidas. Por ejemplo, si especificas un nodo inicial de sección y un ámbito de bloc de notas, GetHierarchy devuelve un resultado nulo porque un bloc de notas es superior en la jerarquía de nodos a una sección.

El siguiente ejemplo C# muestra cómo usar el método GetHierarchy para obtener toda la jerarquía de OneNote, incluidos todos los blocs de notas, hasta el nivel de la página. Copia la cadena de salida en el Portapapeles, desde donde puedes pegar la cadena en un editor de texto para revisarla.

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

Método UpdateHierarchy

Si solo pasa una cadena XML de OneNote parcial para el parámetro bstrChangesXmlIn , OneNote intenta deducir los cambios que desee. Por ejemplo, si incluyes un elemento Bloc de notas que contiene solo una sección, OneNote agrega la sección después de las secciones existentes. Sin embargo, si la operación que especificas es ambigua, puede ser difícil determinar el resultado. Por ejemplo, si un bloc de notas existente contiene cuatro secciones, y la cadena XML que pasas incluye el bloc de notas y solo las secciones cuarta y primera (en ese orden), OneNote puede colocar la segunda y tercera sección antes de la cuarta sección o después de la primera.

No puedes usar el método UpdateHierarchy para eliminar parte de un bloc de notas. Es decir, pasar una cadena XML que incluya solo una parte de una jerarquía existente no elimina secciones que no se incluyen en la cadena. Para eliminar parte de una jerarquía, usa el método DeleteHierarchy.

El siguiente código C# muestra una forma de usar el método UpdateHierarchy para cambiar la jerarquía de OneNote, mediante la modificación del nombre de una sección existente. Lee el código XML desde un archivo de ejemplo denominado ChangeSectionName.xml en la raíz de la unidad C, lo carga en un documento XML y luego pasa la estructura XML de ese documento al método.

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

El siguiente código XML es un fragmento del archivo ChangeSectionName.xml que el anterior código C# pasa al método. Cuando el archivo XML se pasa al método UpdateHierarchy, cambia el nombre de una de las secciones en la jerarquía existente (al cambiar el valor del atributo nombre a "Mi sección con nombre nuevo"). A continuación, quita todas las secciones excepto aquella cuyo nombre cambió. Además, el código quita atributos innecesarios del elemento de destino Sección, incluidos los atributos lastModifiedTime, isCurrentlyViewedy color, dejando solo los atributos nombre, ID y ruta intactos.

<?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>

Se obtuvo el código XML anterior mediante el código que se muestra en el ejemplo del método GetHierarchy, que se modifica, como se indica a continuación, para limitar el ámbito de las secciones.

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

En el siguiente ejemplo de C# se muestra una aplicación de consola completa que busca una sección denominada "Sample_Section", solicita al usuario que escriba un nuevo nombre para la sección y, a continuación, usa el método UpdateHierarchy para cambiar el nombre de la sección por el nombre que escribió el usuario. Antes de ejecutar el código, cambie "Sample_Section" por el nombre de una sección que existe en la jerarquía de OneNote.

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

Método OpenHierarchy

Si especificas un grupo de secciones que no está en un bloc de notas abierto, el método OpenHierarchy abre el grupo de secciones como un bloc de notas. Si especificas un grupo de secciones que no está en un bloc de notas abierto, el método OpenHierarchy abre la sección en el grupo de sección Secciones Abiertas Recientemente. Si especificas un grupo de secciones o sección que ya está en un bloc de notas abierto, no sucede nada porque la sección o grupo de secciones ya están abiertos también. En cualquier caso, OpenHierarchy devuelve la id. de objeto del grupo de sección, bloc de notas o sección que especifiques, para que puedes usarlos en otras operaciones.

También puedes usar el método OpenHierarchy para crear secciones nuevas, en lugar de hacerlo mediante la importación de XML.

El código siguiente muestra cómo usar el método OpenHierarchy para abrir la sección de Reuniones en el bloc de notas de trabajo y obtener la id. de la sección. Si todavía no existe la sección, OneNote la crea en la ubicación que especifiques.

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

Método DeleteHierarchy

Método CreateNewPage

La API de OneNote incluye el método CreateNewPage como comodidad. Puedes lograr el mismo resultado, con mayor control sobre el lugar que ocupa la página nueva en la jerarquía, mediante una llamada al método UpdateHierarchy. El método UpdateHierarchy también te permite crear subpáginas al mismo tiempo que creas una nueva página.

Método CloseNotebook

Puedes usar el método CloseNotebook para cerrar el bloc de notas que especifiques. Cuando llamas a este método, OneNote sincroniza los archivos sin conexión con el contenido del bloc de notas actual, si es necesario y, a continuación, cierra el bloc de notas especificado. Cuando regresa el método, el bloc de notas ya no aparece en la lista de blocs de notas abiertos en la interfaz de usuario (IU) de OneNote.

Método GetHierarchyParent

Si el objeto de OneNote no tiene ningún objeto primario (por ejemplo, cuando un usuario desea obtener el elemento primario de un bloc de notas), se produce una excepción.

Método GetSpecialLocation

Puedes usar este método para determinar la ubicación en disco de la carpeta Notas sin archivar. Es la carpeta en la que OneNote almacena las notas que se crean al arrastrar un elemento en OneNote, así como las notas que se incluyen directamente desde otras aplicaciones (como las que se generan al hacer clic en Enviar a OneNote en Microsoft Outlook o Microsoft Internet Explorer).

Métodos de contenido de página

Los métodos descritos en esta sección te permiten descubrir, actualizar y eliminar el contenido en las páginas de los blocs de notas de OneNote, así como publicar contenido en OneNote.

Método GetPageContent

De forma predeterminada, para evitar el exceso de longitud de la cadena XML que devuelve, OneNote no inserta contenido binario en el código XML. Por el mismo motivo, no marca la selección actual con los atributos de la selección. Los objetos binarios incluyen una id. de OneNote en sus etiquetas. Para obtener un objeto binario, llamas al método GetBinaryPageContent y pasas la id. de OneNote que obtienes del método GetPageContent. Usas el método GetPageContent cuando no necesitas los datos binarios inmediatamente.

Método UpdatePageContent

Puedes usar este método para modificar la página de varias formas. Por ejemplo, puedes usar el método UpdatePageContent para agregar un esquema a una página, cambiar el contenido de un esquema, agregar imágenes, agregar entradas de lápiz, mover contenido o modificar texto en contornos.

Como un ejemplo más específico, puedes usar el método GetPageContent para exportar una página existente, realizar algunos cambios en el código XML de la página y, después, usar el método UpdatePageContent para importar toda la página nuevamente. O bien, puedes usar este método para agregar nuevos objetos de página, como imágenes, en la parte inferior de una página existente.

Los únicos objetos que debes incluir en el código XML que pasas al método UpdatePageContent son objetos de nivel de página (por ejemplo, esquemas, imágenes en la página o entrada de lápiz en la página) que cambiaron. Este método no modifica ni quita los objetos de nivel de página que no se especifican en el parámetro bstrPageChangesXmlIn. El método reemplaza por completo los objetos de nivel de página, como esquemas cuyas id. coinciden con las de los objetos que pasas. Por lo tanto, debes especificar completamente todos los objetos de nivel de página en tu código, incluidos los contenidos existentes y los cambios que deseas hacerles.

Por ejemplo, si tu página contiene un esquema y una imagen de fondo de página, puedes reemplazar el esquema y dejar la imagen sin modificar al especificar el esquema en el código XML, usando la id. del esquema existente y no incluyendo la imagen en el código. Como el esquema revisado que incluyes en el código reemplaza completamente el esquema existente, debes incluir todo el contenido del esquema.

Además, el métodoUpdatePageContent modifica solo propiedades de elemento especificados en el parámetro bstrPageChangesXmlIn. Por ejemplo, si especificas algunas (pero no todas) las propiedades del elemento PageSettings, las propiedades que no se especifican permanecen sin cambios.

El ejemplo siguiente muestra cómo usar el método UpdatePageContent para cambiar el título de una página y agregar texto de ejemplo a la página. Antes de ejecutar el código, sustituye una id. de página válida para la id. de la página que se muestra en el código, para que el código funcione en tu equipo. Para obtener la id. de la página, usa el método GetHierarchy y examina los resultados.

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

Método GetBinaryPageContent

Método DeletePageContent

Método Publish

Actualmente, OneNote admite los siguientes formatos de archivo:

• Archivos MHTML (.mht)
• Archivos PDF de Adobe Acrobat (.pdf)
• Archivos XML Paper Specification (XPS) (.xps)
• Archivos OneNote 2013, 2010 o 2007 (.one)
• Archivos OneNote Package (onepkg)
• Documentos de Microsoft Word (.doc o .docx)
• Metarchivos Microsoft Windows mejorados (.emf)
• Archivos HTML (.html)

Este método produce los mismos resultados que obtendrías al hacer clic en Publicar en la IU y especificar el formato.

Métodos de navegación

Los métodos descritos en esta sección te permiten buscar, desplazarte y vincularte a los blocs de notas, grupos de secciones, secciones, páginas y objetos de la página de OneNote.

Método NavigateTo

Método NavigateToUrl

Método GetHyperLinkToObject

Cuando intentas ir al vínculo resultante, OneNote se abre y muestra el objeto especificado en el navegador.

Método GetWebHyperlinktoObject

Método FindPages

FindPages funciona únicamente si tienes Búsqueda de Microsoft 3.0 o 4.0 instalado en tu equipo. Windows Vista y Windows 7 incluyen este componente. Sin embargo, si estás ejecutando una versión anterior de Windows, tendrás que instalar Windows Search para FindPages para trabajar.

Método FindMeta

FindMeta funciona únicamente si tienes Microsoft Windows Search 3.0 o 4.0 instalado en tu equipo. Windows Vista y Windows 7 incluyen este componente. Sin embargo, si estás ejecutando una versión anterior de Windows, tendrás que instalar Windows Search para FindMeta para trabajar.

Métodos de funciones

Los métodos descritos en esta sección te permiten realizar ciertas acciones o establecer parámetros dentro de la aplicación de OneNote.

Método MergeFiles

El método MergeFiles se diseñó para escenarios móviles en los que pueden existir varias versiones de un archivo OneNote.

Método MergeSections

Este método realiza la misma operación que la característica Combinar en otra secciónque está visible cuando haces clic con el botón derecho en una sección.

Método QuickFiling

Método SyncHierarchy

Método SetFilingLocation

Los tipos de contenido que se puede archivar incluyen los elementos de Outlook y notas web de Internet Explorer que se importan a OneNote a través del comando Enviar a OneNote en cada aplicación. Con este método, también se puede establecer la ubicación de archivado de elementos que se imprimen en OneNote.

Propiedades

Esta sección describe las propiedades de la interfaz de la Aplicación.

Eventos

Esta sección describe los eventos de la interfaz de la Aplicación.

Evento OnNavigate

Método OnHierarchyChange

Ver también

• Referencia para desarrolladores de OneNote