In most cases a template will run in a context - so something prepared data for the template, which should now be visualized. These examples assume you're working with 2sxc, which let's editors work with content - and your template only needs to visualize it. The current content item (if it's just one) is always available on the variable called Content. It's a dynamic object, so you can just type things like @Content.FirstName to access the properties.
Content
dynamic
@Content.FirstName
Showing values from Data (aka. Entities) is very easy. Normally they are accessed through Item (new Razor) or DynamicEntity (older Razor) objects.
@inherits Custom.Hybrid.RazorTyped @MyItem.Img("Mugshot", settings: "Square", width: 100, imgClass: "rounded-circle") <ul> <li> Name: @MyItem.String("FirstName") @MyItem.String("LastName") </li> <li> Birthday: @MyItem.DateTime("Birthday").ToString("d") </li> <li> Award: @MyItem.Child("Awards").String("Name") </li> </ul>
This is how this view would be configured for this sample.
Note that Awards refers to other Entities of the type PersonAwards and has properties like Name. The above example showed the award Name using @Content.Awards.Name - which makes sense when you only expect one award. In other tutorials you'll see how to work with such related Entities if there are more than one.
Awards
PersonAwards
Name
@Content.Awards.Name
MyItem
MyItem is the object which contains the first thing added by the editor on the current block.
Every view/template receives prepared data, usually on the MyItem object.
Id, Guid and Title are built-in properties
Use Get(…) if you don't care about the var type...
Get(…)
... or Get<T>(…) which will try to treat as the expected type.
Get<T>(…)
Use typed methods such as .String(…) if you care about the variable type.
.String(…)
Use fallback: … to handle empty values or conversion problems.
fallback: …
Use .Attribute(…) to safely encode properties. Mouse over this to see the effect.
.Attribute(…)
@inherits Custom.Hybrid.RazorTyped <h4>Douglas Adams on <code>MyItem</code></h4> <p> Id, Guid and Title are built-in properties </p> <ol> <li>Id: @MyItem.Id</li> <li>Guid: @MyItem.Guid</li> <li>Title: @MyItem.Title</li> </ol> <p>Use <code>Get(…)</code> if you don't care about the var type...</p> <ol> <li>Name: @MyItem.Get("FirstName")</li> <li>Birthday: @MyItem.Get("Birthday")</li> </ol> <p>... or <code>Get<T>(…)</code> which will try to treat as the expected type.</p> <ol> <li>Birthday Get<string> @(MyItem.Get<string>("Birthday"))</li> <li>Birthday Get<DateTime> @(MyItem.Get<DateTime>("Birthday"))</li> <li>Birthday Get<bool> @(MyItem.Get<bool>("Birthday"))</li> <li>Birthday Get<int> @(MyItem.Get<int>("Birthday"))</li> </ol> <p>Use typed methods such as <code>.String(…)</code> if you care about the variable type.</p> <ol> @* use .String(…), .DateTime(…), .Int(…) to make it typed *@ <li>Name (strings): @MyItem.String("FirstName") @MyItem.String("LastName")</li> <li>Birthday: @MyItem.DateTime("Birthday").ToString("d")</li> <li>Is Alive: @MyItem.Bool("IsAlive")</li> @* use .Int(…), .Long(…), .Float(…) etc. for numbers *@ <li>Fav Num. Int: @MyItem.Int("FavoriteNumber")</li> <li>Fav Num. Float: @MyItem.Float("FavoriteNumber")</li> </ol> <p>Use <code>fallback: …</code> to handle empty values or conversion problems.</p> <ol> @* this has no effect, as the value works *@ <li>Name (strings): @MyItem.String("FirstName", fallback: "unknown") <li>Name (int): @MyItem.Int("FirstName", fallback: 12345) </ol> <p title='@MyItem.Attribute("FirstName")'> Use <code>.Attribute(…)</code> to safely encode properties. Mouse over this to see the effect. </p>
Every thing is an Entity. Here some basic examples how to show values like Name, Birthday etc. of such an Entity.
Show content which was entered for this module
MyItems
Every view/template receives prepared data, either entered by the user on this page, or provided through a query. It can contain many items - so to get the list, use MyItems
@inherits Custom.Hybrid.RazorTyped <h4>Loop persons which were added to this view</h4> <ul> @foreach (var person in MyItems) { <li> @person.Picture("Mugshot", settings: "Square", width: 50, imgClass: "rounded-circle") @person.String("FirstName") @person.String("LastName") </li> } </ul>
We are one!
Two be or !2B
Three's the charm
@inherits Custom.Hybrid.RazorTyped <ul> @foreach (var item in MyItems) { var pres = item.Presentation; var hType = pres.String("HeadingType"); var title = item.Title + (pres.Bool("Highlight") ? " 🌟" : ""); <li> @* Create a heading tag the size specified in Presentation *@ @if (pres.IsNotEmpty("HeadingType")) { @Kit.HtmlTags.Custom(hType).Wrap(title) } else { @title } <br> <em>FYI: Heading @(pres.IsEmpty("HeadingType") ? "none" : pres.String("HeadingType"))</em> <div style='color: @pres.Attribute("Color")'> @item.Html("Contents") </div> </li> } </ul>
@inherits Custom.Hybrid.RazorTyped <h3>@MyHeader.Title</h3> <ul> @foreach (var item in MyItems) { <li> @item.Title </li> } </ul>
This example builds on the last one, and additionally shows awards these authors have won, which is on the Awards property.
@inherits Custom.Hybrid.RazorTyped <ul> @foreach (var person in MyItems) { <li> @person.Picture("Mugshot", settings: "Square", width: 50, imgClass: "rounded-circle") @person.String("FirstName") @person.String("LastName") @if (person.Children("Awards").Any()) { // we just want the award names // to understand this, look at the LINQ tutorial var awardNames = person.Children("Awards").Select(a => a.String("Name")); <span> (awards: @string.Join(",", awardNames)) </span> } </li> } </ul>