Shell.UI.Navigation.js

 

Se aplica a: Windows Azure Pack

Proporciona funcionalidad de navegación.

Widgets

Ninguno.

Enumeraciones

Ninguno.

Propiedades

Nombre	Tipo	Descripción
Shell.UI.Navigation.WellKnownPropertyNames.alwaysVisibile	Boolean	Determina la visibilidad.
Shell.UI.Navigation.WellKnownPropertyNames.count	Object	Recuento.
Shell.UI.Navigation.WellKnownPropertyNames.displayError	String	Error de visualización.
Shell.UI.Navigation.WellKnownPropertyNames.displayName	String	El nombre para mostrar.
Shell.UI.Navigation.WellKnownPropertyNames.displayWarning	String	Advertencia de visualización.
Shell.UI.Navigation.WellKnownPropertyNames.icon	Object	El URI del icono.
Shell.UI.Navigation.WellKnownPropertyNames.collection	Object	Elementos de navegación.
Shell.UI.Navigation.WellKnownPropertyNames.name	String	Nombre.
Shell.UI.Navigation.WellKnownPropertyNames.showSpinner	Object	El spinner de la presentación.
Shell.UI.Navigation.WellKnownPropertyNames.tooltip	Object	Información sobre herramientas

Métodos

Nombre	Descripción	Devuelve	Parámetros
Shell.UI.Navigation.calculateNavigationPath	Calcula la ruta de navegación. El valor devuelto es la ruta de navegación calculada.	String	Opciones: la ruta de navegación que se va a calcular. Options es un objeto con las siguientes propiedades Extensión: la extensión. Tipo: el tipo. Nombre: el nombre. Vista: la vista dataContext: contexto de datos. expandPath: True para expandir la ruta de acceso; de lo contrario, False.
Shell.UI.Navigation.cdmNavigateTo	Vaya mediante programación a un área nueva de la aplicación.	Nada	hashPath (String): área a la que navegar.
Shell.UI.Navigation.crackNavigationPath	Obtiene la ruta de navegación descifrada que es un objeto con los valores siguientes. Hash: valor hash. Extensión: la extensión. Vista: la vista. viewName: el nombre de la vista. item: el elemento. itemName: el nombre del elemento. itemType: el tipo de elemento.	Object	Hash: hash usado para descifrar la ruta de navegación.
Shell.UI.Navigation.currentLocation	Obtiene la ubicación actual.	Object El objeto representa la ubicación actual y tiene las siguientes propiedades: extension: el nombre de la extensión. view: la vista. viewName: nombre de la vista. item: el elemento. itemName: nombre del elemento. itemType: el tipo de elemento.	None
Shell.UI.Navigation.expandDefaultHashPath	Expande la ruta de acceso hash predeterminada para una extensión. Devuelve la ruta de acceso hash expandida.	String	Extensión: la extensión hashPath: ruta de acceso hash.
Shell.UI.Navigation.getBasePath	Obtiene la ruta de acceso base.	String	None
Shell.UI.Navigation.getHashPathType	Toma una ruta hash (por ejemplo, de location.hash) y devuelve el componente "type" de que tiene si existe.	String	hashPath (String): una ruta hash de una dirección URL que está en formato de navegación.
Shell.UI.Navigation.getObservableExtensionBadge	Devuelve el distintivo de navegación de extensión.	String	Extensión: el nombre de la extensión.
Shell.UI.Navigation.initializeNav	Inicializa la navegación.	Nada	None
Shell.UI.Navigation.isNavigatedTo	Devuelve true si se navega por la extensión, la vista, el elemento y el tipo de elemento.	Boolean	extensionName: el nombre de la extensión. viewName: el nombre de la vista. itemName: nombre del elemento. itemType: el tipo de elemento.
Shell.UI.Navigation.navigate	Navega al destino proporcionado.	Nada	Destino: destino al que se va a navegar.
Shell.UI.Navigation.removeConfirmNavigateAway	Quita el mensaje de confirmación de desplazamiento.	Nada	Ninguno.
Shell.UI.Navigation.selectExtension	Selecciona una extensión.	Nada	Extensión: extensión que se va a seleccionar.
Shell.UI.Navigation.setConfirmNavigateAway	Establece el mensaje de desplazamiento de confirmación.	Nada	Mensaje: Mensaje de confirmación de desplazamiento.

Ejemplos

Cómo especificar la ubicación a la que apunta el botón Atrás?

En la función de datos, devuelve un objeto que tiene un objeto backNavigationProperty. Esta propiedad indica dónde debe llevar el botón Atrás. Esta propiedad usa Shell.UI.Navigation.calculateNavigationPath() en esta propiedad para determinar el hash.

function dataFunction(...) {
// Code to acquire the data used to populate he list of the second level of navigation
// ...
    return {
        data: [...], //
        label: "label of the back button",
            backNavigation: {
                type: "the type id you want the back button to point to",
                view: "the view id you want the back button to point to",
                name: "the id of the item you want to point to"
            }
    };
}

Cómo definir varios "niveles" de navegación?

Considere el siguiente escenario: Desea crear una extensión que muestre una cuadrícula de elementos de tipo "A" (quizás un SQL Server). Al hacer clic en uno de ellos, debe ir a una lista de elementos de tipo "B", dentro de esa instancia de A (quizás SQL bases de datos). A su vez, la cliquing en una instancia de "B" de la cuadrícula debe llevarle a una cuadrícula de elementos de tipo "C" (quizás tablas de la base de datos). Esto se hace a través de navigationDependencies.

_types = [
    {
        name: "A",
        displayName: "A - SQL Server",
        dataFunction: function() {}, // data function here
        tabs: [{
            id: "AllAs",
            displayName: "SQL servers",
            template: "a template name",
            activated: function() {}, // tab activated function here
        }]
    },
    {
        name: "B",
        displayName: "B - SQL Database",
        navigationDependencies: {
            A: "AId"
        },
        dataFunction: function() {}, // data function here
        tabs: [{
            id: "AllBs",
            displayName: "SQL Databases",
            template: "a template name",
            activated: function() {}, // tab activated function here
        }]
    },
    {
        name: "C",
        displayName: "B - SQL Table",
        navigationDependencies: {
            B: "BId"
        },
        dataFunction: function() {}, // data function here
        tabs: [{
            id: "AllCs",
            displayName: "SQL Tables",
            template: "a template name",
            activated: function() {}, // tab activated function here
        }]
    }
];

Consulte también

Referencia de la biblioteca de shell de extensión de paquete de Azure Windows