Shell.UI.Navigation.js

Artikel
08/24/2015

Van toepassing op: Windows Azure Pack

Biedt navigatiefunctionaliteit.

Widgets

Geen.

Enums

Geen.

Eigenschappen

Naam	Type	Description
Shell.UI.Navigation.WellKnownPropertyNames.alwaysVisibile	Booleaans	Bepaalt de zichtbaarheid.
Shell.UI.Navigation.WellKnownPropertyNames.count	Object	Het aantal.
Shell.UI.Navigation.WellKnownPropertyNames.displayError	Tekenreeks	De weergavefout.
Shell.UI.Navigation.WellKnownPropertyNames.displayName	Tekenreeks	De weergavenaam.
Shell.UI.Navigation.WellKnownPropertyNames.displayWarning	Tekenreeks	De weergavewaarschuwing.
Shell.UI.Navigation.WellKnownPropertyNames.icon	Object	De pictogram-URI.
Shell.UI.Navigation.WellKnownPropertyNames.collection	Object	De navigatie-items.
Shell.UI.Navigation.WellKnownPropertyNames.name	Tekenreeks	De naam.
Shell.UI.Navigation.WellKnownPropertyNames.showSpinner	Object	De show spinner.
Shell.UI.Navigation.WellKnownPropertyNames.tooltip	Object	De knopinfo

Methoden

Naam	Beschrijving	Retouren	Parameters
Shell.UI.Navigation.calculateNavigationPath	Berekent het navigatiepad. Retourwaarde is het berekende navigatiepad.	Tekenreeks	Opties: het navigatiepad dat moet worden berekend. Opties is een object met de volgende eigenschappen Extensie: De extensie. Type: Het type. Naam: de naam. Weergave: De weergave dataContext: de gegevenscontext. expandPath: Waar om het pad uit te vouwen, anders onwaar.
Shell.UI.Navigation.cdmNavigateTo	Programmatisch navigeren naar een nieuw gebied van de toepassing	Niets	hashPath (tekenreeks ): gebied om naar te navigeren.
Shell.UI.Navigation.crackNavigationPath	Hiermee haalt u het gebarsten navigatiepad op dat een object is met de volgende waarden. Hash: de hash-waarde. Extensie: De extensie. Weergave: De weergave. viewName: de weergavenaam. item: Het item. itemName: de itemnaam. itemType: het itemtype.	Object	Hash: De hash die wordt gebruikt om het navigatiepad te kraken.
Shell.UI.Navigation.currentLocation	Hiermee haalt u de huidige locatie op	Object Het object vertegenwoordigt de huidige locatie en heeft de volgende eigenschappen: extensie: de extensienaam. weergave: De weergave. viewName: De weergavenaam. item: Het item. itemName: de itemnaam. itemType: het itemtype.	Geen
Shell.UI.Navigation.expandDefaultHashPath	Hiermee wordt het standaard-hashpad voor een extensie uitgebreid. Retourneert het uitgevouwen hashpad.	Tekenreeks	Extensie: de extensie hashPath: het hash-pad.
Shell.UI.Navigation.getBasePath	Hiermee haalt u het basispad op.	Tekenreeks	Geen
Shell.UI.Navigation.getHashPathType	Neemt een hashpad (bijvoorbeeld van location.hash) en retourneert het onderdeel 'type' van dat onderdeel als deze bestaat.	Tekenreeks	hashPath (tekenreeks ): een hashpath van een URL die de navigatie-indeling heeft.
Shell.UI.Navigation.getObservableExtensionBadge	Retourneert de uitbreidingsnavigatiebadge.	Tekenreeks	Extensie: de extensienaam.
Shell.UI.Navigation.initializeNav	Initialiseert navigatie.	Niets	Geen
Shell.UI.Navigation.isNavigatedTo	Retourneert true als de extensie, weergave, item en itemtype worden genavigeerd.	Booleaans	extensionName: de extensienaam. viewName: de weergavenaam. itemName: de itemnaam. itemType: het itemtype.
Shell.UI.Navigation.navigate	Hiermee gaat u naar de opgegeven bestemming.	Niets	Bestemming: de bestemming waar u naartoe wilt navigeren.
Shell.UI.Navigation.removeConfirmNavigateAway	Hiermee verwijdert u het bericht bevestigen dat u weg navigeert.	Niets	Geen.
Shell.UI.Navigation.selectExtension	Selecteert een extensie.	Niets	Extensie: De extensie die u wilt selecteren.
Shell.UI.Navigation.setConfirmNavigateAway	Hiermee stelt u het bericht om te bevestigen dat u weg navigeert.	Niets	Bericht: Het bericht bevestigen navigeert weg.

Voorbeelden

Hoe kan ik de locatie opgeven waar de knop Terug naar wijst?

Retourneer vanuit de gegevensfunctie een object met een backNavigationProperty. Met deze eigenschap wordt aangegeven waar de knop Terug naartoe moet gaan. Deze eigenschap maakt gebruik van Shell.UI.Navigation.calculateNavigationPath() op deze eigenschap om de hash te bepalen.

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

Hoe kan ik meerdere niveaus van navigatie definiëren?

Denkt u zich het volgende scenario eens in. U wilt een extensie maken die een raster met items van het type A weergeeft (misschien een SQL Server). Als u op een van deze items klikt, gaat u naar een lijst met items van het type 'B', binnen dat exemplaar van A (mogelijk SQL Databases). Als u op zijn beurt een exemplaar van 'B' in het raster opneemt, gaat u naar een raster met items van het type C (misschien tabellen in de database). Dit gebeurt via 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
        }]
    }
];

Zie ook

Naslaginformatie Windows Azure Pack Extension Shell Library

Delen via