Simon Miller Team : Web Development Tags : Umbraco

Umbraco reserved properties and their usage

Simon Miller Team : Web Development Tags : Umbraco

One of the lesser documented features of Umbraco is its built in properties; that is, creating a property in your document with a name from a list of reserved keywords. When you create a property with one of these keywords it has a special action associated with it. Some of these are incredibly useful:

umbracoRedirect

Creating a property alias with this name and using a Content Picker let’s you create a 302 temporary redirect. This in effect means that when a user navigates to this node, they will be redirected away from it.

umbracoInternalRedirectId

Add this property alias to your document type with a content picker, and Umbraco will load the selected page’s content transparently without performing any URL redirection.

umbracoUrlName

This alias, when created as a text string, lets you provide a different URL name to what is created by default by the name of the node.

umbracoUrlAlias

This incredibly useful alias, when entered as a text string property, lets you provide a comma separated list of alternate full URL paths for the node. For example, if your URL was /some-category/some-page/content-node, by adding an umbracoUrlAlias of “flowers”, a user can navigate to the node by simply going to /flowers. The URL alias remains in the browser address bar as a ‘mask’ over the real URL. You can also specify paths like “flowers/roses/red”.

umbracoNaviHide

This  alias is more a convention rather than a special use, but by being a convention, third party plugins have adopted it as well. If you add a True/False checkbox with this alias to your document it is implied that the node will not display on your website. This isn’t automatic but as mentioned, many plugins (RSS publishers for example) look for this property and will exclude nodes that have it set to true.