Interfaces de cuadro de diálogo de archivo rápido (OneNote)

En este tema se describen las interfaces que puede usar para personalizar mediante programación el cuadro de diálogo Archivo rápido en OneNote 2013.

Cuadro de diálogo Archivo rápido

El cuadro de diálogo Archivo rápido de OneNote 2013 es un cuadro de diálogo personalizable que permite a los usuarios seleccionar una ubicación dentro de la estructura de jerarquía de OneNote. Las ubicaciones seleccionables incluyen cuadernos, grupos de secciones, secciones, páginas y subpáginas. El cuadro de diálogo se usa tanto en la aplicación OneNote como en aplicaciones externas a través de la API de OneNote 2013. La figura 1 muestra el cuadro de diálogo Archivo rápido en su estado predeterminado.

Figura 1. Cuadro de diálogo de relleno rápido sin personalizaciones

En el cuadro de diálogo, los usuarios pueden navegar por la jerarquía Todos los cuadernos para buscar ubicaciones específicas o buscar en la estructura de árbol de OneNote escribiendo en el cuadro de texto. Entre los aspectos del cuadro de diálogo que se pueden personalizar se incluyen el título, la descripción, la lista de resultados recientes, el texto y el estado de la casilla, la profundidad del árbol, los botones y los tipos de ubicación seleccionables.

Puede acceder a la funcionalidad del cuadro de diálogo Archivo rápido a través de dos interfaces de OneNote 2013. La interfaz IQuickFilingDialog permite a los usuarios crear instancias, configurar y ejecutar el cuadro de diálogo. Se llama a la interfaz IQuickFilingDialogCallback después de cerrar el cuadro de diálogo. El cuadro de diálogo se ejecuta en el proceso de OneNote, por lo que se necesita un mecanismo para mantener el subproceso del cuadro de diálogo en ejecución y, a continuación, para capturar la selección del usuario y el estado del cuadro de diálogo cuando se cierra.

IQuickFilingDialog (interfaz)

Esta interfaz permite al usuario personalizar y ejecutar el cuadro de diálogo. El usuario puede crear una instancia de un cuadro de diálogo a través de la clase Application mediante el método Application.QuickFilingDialog . El método devuelve una instancia del cuadro de diálogo. Una vez establecidas las propiedades del cuadro de diálogo, se usa el método IQuickFilingDialog.Run para ejecutar el cuadro de diálogo. Este método ejecuta el cuadro de diálogo en un subproceso nuevo.

Propiedades

Métodos

SetRecentResults

En el ejemplo siguiente se usa el método SetRecentResults para mostrar la sección actual, la página actual y la sección Notas sin archivo de la lista de resultados reciente.

        static void Main(string[] args)
        {
            Microsoft.Office.Interop.OneNote.Application app = 
                new Microsoft.Office.Interop.OneNote.Application();
            ... 
            // RECENT RESULTS
            qfDialog.SetRecentResults(RecentResultType.rrtFiling,
                /*Current Section*/ true,
                /*Current Page*/ true,
                /*Unfiled Notes*/ true);
            ...
        }

AddButton

En el ejemplo siguiente se agregan tres botones al cuadro de diálogo Archivo rápido. Todos los elementos del árbol de jerarquía de OneNote pueden seleccionar el primero, Todos. Los demás, Cuadernos y Páginas, solo se pueden seleccionar si se seleccionan sus elementos correspondientes, Cuadernos y Páginas.

        static void Main(string[] args)
        {
            Microsoft.Office.Interop.OneNote.Application app = 
                new Microsoft.Office.Interop.OneNote.Application();
            ... 
            
            // BUTTONS
            HierarchyElement heAll = (HierarchyElement) 
                ((uint)HierarchyElement.heNotebooks | 
                (uint)HierarchyElement.heSectionGroups | 
                (uint)HierarchyElement.heSections |  
                (uint)HierarchyElement.hePages);
            
            qfDialog.AddButton("All", heAll, heAll, true);
            qfDialog.AddButton("Notebooks", HierarchyElement.heNotebooks, 
                HierarchyElement.heNotebooks, false);
            qfDialog.AddButton("Pages", HierarchyElement.hePages, 
                HierarchyElement.hePages, false);
            ... 
        }

Run

En el ejemplo siguiente se usa el método Run para mostrar el cuadro de diálogo Archivo rápido de un nuevo subproceso.

    class OpenQuickFilingDialog
    {
            ... 
        static void Main(string[] args)
        {
            Microsoft.Office.Interop.OneNote.Application app = 
                new Microsoft.Office.Interop.OneNote.Application();
            ... 
            // Display Quick Filing UI
            qfDialog.Run(new Callback());
            ... 
        }
    }

TreeCollapsedState

NotebookFilterOut

ShowCreateNewNotebook

AddInitialEditor

ClearInitialEditors

ShowSharingHyperlink

IQuickFilingDialogCallback (interfaz)

Esta interfaz permite al usuario acceder a las propiedades del cuadro de diálogo después de que se cierre el cuadro de diálogo. Una vez que se cierra el cuadro de diálogo, OneNote 2013 llama al método IQuickFilingDialogCallback.OnDialogClose en esta interfaz.

Debe definirse una clase que herede esta interfaz.

Métodos

En la sección siguiente se describen los métodos asociados a las interfaces detalladas anteriormente.

OnDialogClosed

El ejemplo siguiente es una interfaz IQuickFilingDialogCallback de ejemplo. El método OnDialogClose imprime la selección del usuario del cuadro de diálogo Archivo rápido en la consola.

    class Callback : IQuickFilingDialogCallback
    {
        public Callback(){}
        public void OnDialogClosed(IQuickFilingDialog qfDialog)
        {
            Console.WriteLine(qfDialog.SelectedItem);
            Console.WriteLine(qfDialog.PressedButton);
            Console.WriteLine(qfDialog.CheckboxState);
        }
    }

Ejemplo

En el ejemplo de código siguiente se abre un cuadro de diálogo De archivo rápido que tiene un título, una descripción, una lista de resultados recientes, una profundidad de árbol, una casilla de verificación y botones personalizados. El elemento seleccionado del usuario, el botón presionado y el estado de la casilla se mostrarán en una ventana de consola cuando se cierre el cuadro de diálogo. Para ver el botón de página habilitado, el usuario tendrá que buscar una página y seleccionarla, ya que la profundidad del árbol se establece en secciones. El cuadro de diálogo no es un elemento secundario de ninguna ventana.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using Microsoft.Office.Interop.OneNote;
namespace SampleQFD
{
    class OpenQuickFilingDialog
    {
        private static EventWaitHandle wh = new AutoResetEvent(false);
        private static IQuickFilingDialog qfDialog;
        private static String strTitle = "Sample Title";
        private static String strDescription = "Sample Description";
        private static String strCheckboxText = "Sample Checkbox";
        static void Main(string[] args)
        {
            Microsoft.Office.Interop.OneNote.Application app = 
                new Microsoft.Office.Interop.OneNote.Application();
            // Instantiate Quick Filing UI
            qfDialog = app.QuickFiling();
            #region//SET API PARAMETERS
            // TITLE
            qfDialog.Title = strTitle;
            // DESCRIPTION
            qfDialog.Description = strDescription;
            // RECENT RESULTS
            qfDialog.SetRecentResults(RecentResultType.rrtFiling,
                /*Current Section*/ true,
                /*Current Page*/ true,
                /*Unfiled Notes*/ true);
            // TREE DEPTH
            qfDialog.TreeDepth = HierarchyElement.heSections;
            // CHECKBOX
            qfDialog.CheckboxText = strCheckboxText;
            qfDialog.CheckboxState = false;
            // BUTTONS
            HierarchyElement heAll = (HierarchyElement) 
                ((uint)HierarchyElement.heNotebooks | 
                (uint)HierarchyElement.heSectionGroups | 
                (uint)HierarchyElement.heSections |  
                (uint)HierarchyElement.hePages);
            
            qfDialog.AddButton("All", heAll, heAll, true);
            qfDialog.AddButton("Notebooks", HierarchyElement.heNotebooks, 
                HierarchyElement.heNotebooks, false);
            qfDialog.AddButton("Pages", HierarchyElement.hePages, 
                HierarchyElement.hePages, false);
            // PARENTWINDOW
            #endregion
            // Display Quick Filing UI
            qfDialog.Run(new Callback());
            // Clean up and Wait so console window does not close
            qfDialog = null;
            wh.WaitOne();
        }
    }
    class Callback : IQuickFilingDialogCallback
    {
        public Callback(){}
        public void OnDialogClosed(IQuickFilingDialog qfDialog)
        {
            Console.WriteLine(qfDialog.SelectedItem);
            Console.WriteLine(qfDialog.PressedButton);
            Console.WriteLine(qfDialog.CheckboxState);
        }
    }
}

Ver también

• Referencia para desarrolladores de OneNote