KXB.Umbraco.UmbracoDictionaryExtension 1.1.1

dotnet add package KXB.Umbraco.UmbracoDictionaryExtension --version 1.1.1
NuGet\Install-Package KXB.Umbraco.UmbracoDictionaryExtension -Version 1.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="KXB.Umbraco.UmbracoDictionaryExtension" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add KXB.Umbraco.UmbracoDictionaryExtension --version 1.1.1
#r "nuget: KXB.Umbraco.UmbracoDictionaryExtension, 1.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install KXB.Umbraco.UmbracoDictionaryExtension as a Cake Addin
#addin nuget:?package=KXB.Umbraco.UmbracoDictionaryExtension&version=1.1.1

// Install KXB.Umbraco.UmbracoDictionaryExtension as a Cake Tool
#tool nuget:?package=KXB.Umbraco.UmbracoDictionaryExtension&version=1.1.1

Umbraco Dictionary Extension

An extension to the UmbracoHelper with several ease of life improvements

Using the new method Umbraco.GetDictionaryValueAndCreateDictionaryItem(string key, string fallback="") you can create dictionary items code first by simply requesting them in your code. It's no longer necessary to manually create the dictionary items under Umbraco → Settings.

"Folders" in the dictionary is created based on the name of the key, example:

The key "Foo.Bar.Key" will be placed in Dictionary → "Foo" → "Bar"

The method has 3 "creation modes":

  • "key": This will initialize the dictionary item with the dictionary key stored in the dictionary (This is the default mode)
  • "fallback": This will initialize the dictionary item with the fallback value stored in the dictionary
  • "empty": This will initialize the dictionary item without a value

The creation mode can be set by modifying the app.config key: "KXB.Umbraco.UmbracoDictionaryExtension.CreationMode"

Using Umbraco.GetDictionaryItemsForPrefix(string prefix) or GetDictionaryValuesForPrefix(string prefix) you can retrieve dictionary values for a given prefix.

Example: Umbraco.GetDictionaryItemsForPrefix("Foo.") could return dictionary items with the following keys:

  • "Foo.Bar"
  • "Foo.Foo"
  • "Foo.Foo.Bar"


App config keys and their usage: XB.Umbraco.UmbracoDictionaryExtension.CreationMode" determines what values is stored in newly created keys. Valid options are "key" (default), "fallback", "empty" "KXB.Umbraco.UmbracoDictionaryExtension.SeparationSymbol" determines which symbol is used to separate "folders" in the names of dictionary keys. Default value is "."

Product Compatible and additional computed target framework versions.
.NET Framework net452 is compatible.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.1 11,743 10/17/2017
1.1.0 1,671 3/31/2017
1.0.9 922 3/31/2017
1.0.8 911 3/31/2017
1.0.7 1,267 3/17/2017
1.0.6 901 3/17/2017
1.0.5 878 3/17/2017
1.0.4 856 3/17/2017
1.0.3 873 3/17/2017
1.0.2 1,076 3/17/2017

Changed default value of "KXB.Umbraco.UmbracoDictionaryExtension.SeparationSymbol" to "." (period).