Shell.UI.Navigation.js

Artigo
08/24/2015

Aplica-se a: Windows Azure Pack

Fornece funcionalidade de navegação.

Widgets

Nenhum.

Enumerações

Nenhum.

Propriedades

Nome	Tipo	Description
Shell.UI.Navigation.WellKnownPropertyNames.alwaysVisibile	Booleano	Determina a visibilidade.
Shell.UI.Navigation.WellKnownPropertyNames.count	Objeto	A contagem.
Shell.UI.Navigation.WellKnownPropertyNames.displayError	String	Erro de visualização.
Shell.UI.Navigation.WellKnownPropertyNames.displayName	String	O nome do visor.
Shell.UI.Navigation.WellKnownPropertyNames.displayWarning	String	O aviso de exibição.
Shell.UI.Navigation.WellKnownPropertyNames.icon	Objeto	O ícone URI.
Shell.UI.Navigation.WellKnownPropertyNames.collection	Objeto	Os itens de navegação.
Shell.UI.Navigation.WellKnownPropertyNames.name	String	O nome.
Shell.UI.Navigation.WellKnownPropertyNames.showSpinner	Objeto	O espetáculo spinner.
Shell.UI.Navigation.WellKnownPropertyNames.tooltip	Objeto	A ponta da ferramenta

Métodos

Nome	Descrição	Devoluções	Parâmetros
Shell.UI.Navigation.calcularNavigationPath	Calcula o caminho de navegação. O valor de retorno é a trajetória de navegação calculada.	String	Opções: o caminho de navegação para calcular. Opções é um objeto com as seguintes propriedades Extensão: A extensão. Tipo: O tipo. Nome: O nome. Vista: A vista dataContexto: O contexto dos dados. expandPath: Verdadeiro para expandir o caminho, caso contrário Falso.
Shell.UI.Navigation.cdmNavigateTo	Navegue programáticamente para uma nova área da aplicação	Nenhumas	hashPath (String): Área para navegar.
Shell.UI.Navigation.crackNavigationPath	Obtém o caminho de navegação rachado que é um objeto com os seguintes valores. O valor do haxixe. Extensão: A extensão. Vista: A vista. verName: o nome da vista. item: O item. itemName: o nome do item. itemType: O tipo de item.	Objeto	O haxixe usado para quebrar o caminho de navegação.
Shell.UI.Navigation.currentLocation	Obtém a localização atual	Objeto O objeto representa a localização atual e tem as seguintes propriedades: extensão: O nome da extensão. vista: A vista. verName: O nome da vista. item: O item. item Nome: O nome do item. itemType: O tipo de item.	Nenhuma
Shell.UI.Navigation.expandDefaultHashPath	Expande o caminho de haxixe padrão para uma extensão. Devolve o caminho do haxixe expandido.	String	Extensão: a extensão hashPath: O caminho do haxixe.
Shell.UI.Navigation.getBasePath	Fica com o caminho da base.	String	Nenhuma
Shell.uI.Navigation.getHashPathType	Toma um hashpath (por exemplo, a partir do local.hash) e devolve o componente "tipo" que tem se existir.	String	hashPath (String): Um hashpath de um url que está em formato de navegação.
Shell.UI.Navigation.getObservableExtensionBadge	Devolve o crachá de navegação de extensão.	String	Extensão: O nome da extensão.
Shell.UI.Navigation.initializeNav	Inicializa a navegação.	Nenhumas	Nenhuma
Shell.UI.Navigation.isNavigatedTo	Devoluções verdadeiras se a extensão, visualização, item e tipo de item estiverem navegados.	Booleano	extensão Nome: O nome da extensão. verName: o nome da vista. item Nome: O nome do item. itemType: O tipo de item.
Shell.UI.Navigation.navigate	Navega para o destino fornecido.	Nenhumas	Destino: O destino para navegar.
Shell.UI.Navigation.removeConfirmNavigateAway	Remove a mensagem de navegação de confirmação.	Nenhumas	Nenhum.
Shell.UI.Navigation.selectExtension	Seleciona uma extensão.	Nenhumas	Extensão: A extensão para selecionar.
Shell.UI.Navigation.setConfirmNavigateAway	Define a mensagem de navegação de confirmação.	Nenhumas	Mensagem: O confirma a mensagem de navegação.

Exemplos

Como devo proceder para especificar o local para onde o botão traseiro aponta?

A partir da função de dados, devolva um objeto que tenha uma navegação traseiraProperty. Esta propriedade indica para onde o botão de trás deve levá-lo. Esta propriedade utiliza Shell.UI.Navigation.calculNavigationPath() nesta propriedade para determinar o haxixe.

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

Como devo proceder para definir vários "níveis" de navegação?

Considere o seguinte cenário. Deseja construir uma extensão que apresente uma grelha de itens do tipo "A" (talvez um SQL Server). Clicar num desses deve levá-lo a uma lista de itens do tipo "B", nesse caso de A (talvez SQL Bases de Dados). Por sua vez, a cliquamento de um caso de "B" na grelha deve levá-lo a uma grelha de itens do tipo "C" (talvez tabelas na base de dados). Isto é feito através da navegação Dependências.

_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 também

Windows referência da biblioteca da extensão do pacote Azure

Partilhar via