Resources in Dynamic Code ✨ new!
The Resources object consolidates resources for the current scenario. It merges resources configured in the View and App and gives View-Resources the preference.
Discover More in the Razor Tutorials
We have an rich series of Razor tutorials. You should really check them out 👍.Example
Let's assume you have these View-Resources in EN & DE
| Source | Property | Value EN | Value DE |
|---|---|---|---|
| View | ColHeadId |
Id |
(not defined) |
| View | ColHeadName |
Name |
(not defined) |
| View | ColHeadDesc |
Description |
Beschreibung |
| View | HelpLink |
/help |
/hilfe |
| App | OrderLabel |
Order Now |
Jetzt Bestellen |
| App | OrderHint |
Click to Order |
Klick um zu Bestellen |
| App | HelpLink |
www.2sxc.org |
(not defined) |
Then you could get these values from the Resources object
| Object | Value if on an EN page | Value if on a DE page |
|---|---|---|
@Resources.ColHeadId |
Id |
Id (auto-fallback) |
@Resources.ColHeadName |
Name |
Name (auto-fallback) |
@Resources.ColHeadDesc |
Description |
Beschreibung |
@Resources.HelpLink |
/help |
/hilfe |
@Resources.OrderLabel |
Order Now |
Jetzt Bestellen |
@Resources.OrderHint |
Click to Order |
Klick um zu Bestellen |
Tip
Remember that Settings are meant for configuration and Resources should be used for multi-language output. You could do it differently, but that would be bad practice.
How it Works
The Resources is a dynamic object.
Internally the Settings use the new IDynamicStack object to stack entities like sources on each other, and take the first best match.
The sources are:
- ViewCustom with View-level resources
- AppCustom/AppSystem with App-level resources
- SiteCustom/SiteSystem with Site-level resources
- GlobalCustom/GlobalSystem with System-level resources
- PresetSystem with pre-defined resources from the installation
Tip
Read more about this stack and what's in it here Resources Stack in 2sxc ✨ new!. This also includes the full list of sources and their exact names.
The order of the sources is important, as the first match will be returned. The View has priority over the App. This setup allows Views to override App-Defaults.
Accessing Resources from One Source
In rare cases you may want to access settings from a specific source - maybe to detect if it has been changed or because your template explicitly wants the App settings.
For this you can use the GetSource(name) method like this:
@Resources.HelpLinkwould return/help@Resources.GetSource("ViewCustom").HelpLinkwould return/help@Resources.GetSource("AppCustom").HelpLinkwould returnwww.2sxc.org
History
- You could use
App.Resourcessince ca. 2sxc 6 Resourcesobject Introduced in 2sxc 12.02 to consolidate View and App ResourcesResourcesobject was expanded in 12.04 to also cover global, portal and site level resources - see settings docs