Oqtane Tutorials
Oqtane Tutorials

Entity (Item) Tutorials

Tutorial Home › Entity
CmsContext.View – ID, Identifier, Edition, Name, etc.
#1 Working with Entity (Item) Values
Show current Content in the Output

Working with Entity (Item) Values

Requirements
Resources

Every item a.k.a. object is called an Entity. Entities will have properties like Name, ProductNumber or Birthday, depending on the Content-Type they represent.

How your Razor Code receives Entities

When things are configured correctly, the right entities are given to your Razor-template so you can just show them or perform calculations as you need them. These are the common ways for the entities to be provided to your template:

  1. On simple templates, the UI allows users to add/edit content of a specific type (configured in the View). This content Entity is always available in your code in the variable called MyItem or Content on older Razors.
  2. On templates which expect many items of the same type, MyItem/Content contains the first item only. To access all (for iterating and showing each one) the Entities are in a variable called MyItems (Data on older Razors).
  3. If your code needs to find other data in the App, it can access it through App.Data.
  4. If your code want to get Entities which have been pre-selected/filtered etc. through a query, it will get them from Query

In this example the template is configured to contain an Entity of the type Person and has these fields:

  • FirstName: a string (text)
  • LastName: a string
  • Birthday: a date
  • Mugshot: a link to an image file
  • Awards: a reference to one or more other Entities which describe awards

So the following examples will show how to put the values in these fields into the HTML.

In the new typed RazorPro the current item is on a variable called MyItem. It's a typed object, so to read properties you need to specify what you want it, eg. @MyItem.String("FirstName").
This sample also uses the @MyItem.Picture(...) to automatically show a responsive image on the page.

In the dynamic Razor base classes lke Razor14 the current item 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.
This sample also uses the @Kit.Image.Img(...) to automatically show a responsive image on the page.

Show Entity Values

Output

  • Name: Douglas Adams
  • Birthday: 3/11/1952
  • Award: Hugo Award
@MyItem.Picture("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>
@Kit.Image.Img(Content.Field("Mugshot"), settings: "Square", width: 100, imgClass: "rounded-circle")
<ul>
  <li>Name: @Content.FirstName @Content.LastName</li>
  <li>Birthday: @Content.Birthday.ToString("d")</li>
  <li>Award: @Content.Awards.Name</li>
</ul>

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.

CmsContext.View – ID, Identifier, Edition, Name, etc.
#1 Working with Entity (Item) Values
Show current Content in the Output

Source Code of this file

Below you'll see the source code of the file. Note that we're just showing the main part, and hiding some parts of the file which are not relevant for understanding the essentials. Click to expand the code

@inherits Custom.Hybrid.RazorTyped
@using ToSic.Razor.Blade;
@using System.Linq;
<!-- unimportant stuff, hidden -->


<h2>Working with Entity (Item) Values</h2>
<div @Sys.PageParts.InfoWrapper()>
  @Html.Partial("../shared/DefaultInfoSection.cshtml")
  <div @Sys.PageParts.InfoIntro()>
      <p>
        Every <em>item</em> a.k.a. <em>object</em> is called an <a href="https://docs.2sxc.org/specs/data/entities.html" target="_blank"><strong>Entity</strong></a>. 
        Entities will have properties like <code>Name</code>, <code>ProductNumber</code> or <code>Birthday</code>, depending on the <a href="https://docs.2sxc.org/specs/data/content-types.html" target="_blank"><strong>Content-Type</strong></a> they represent. 
      </p>
      <h3>How your Razor Code receives Entities</h3>
      <p>
        When things are configured correctly, the right entities are given to your Razor-template so you can just show them or perform calculations as you need them. These are the common ways for the entities to be provided to your template:
      </p>
      <ol>
        <li>
          On simple templates, the UI allows users to add/edit content of a specific type (configured in the View). This content Entity is always available in your code in the variable called 
          <code>MyItem</code> or <code>Content</code> on older Razors.
        </li>
        <li>
          On templates which expect many items of the same type, <code>MyItem</code>/<code>Content</code> contains the first item only. 
          To access all (for iterating and showing each one) the Entities are in a variable called <code>MyItems</code> (<code>Data</code> on older Razors).
        </li>
        <li>
          If your code needs to find other data in the App, it can access it through <code>App.Data</code>.
        </li>
        <li>
          If your code want to get Entities which have been pre-selected/filtered etc. through a query, it will get them from <code>Query</code>
        </li>
      </ol>
      <p>
        In this example the template is configured to contain an Entity of the type <code>Person</code> and has these fields:
      </p>
      <ul>
        <li>FirstName: a string (text)</li>
        <li>LastName: a string</li>
        <li>Birthday: a date</li>
        <li>Mugshot: a link to an image file</li>
        <li>Awards: a reference to one or more other Entities which describe awards</li>
      </ul>
      <p>
        So the following examples will show how to put the values in these fields into the HTML.
      </p>
      <p>
        In the new typed <code>RazorPro</code> the current item is on a variable called <code>MyItem</code>.
        It's a typed object, so to read properties you need to specify what you want it, eg. <code>@@MyItem.String("FirstName")</code>.
        <br>
        This sample also uses the <code>@@MyItem.Picture(...)</code> to automatically show a responsive image on the page.
      </p>
      <p>
        In the dynamic Razor base classes lke <code>Razor14</code> the current item is always available on the variable called <code>Content</code>.
        It's a <code>dynamic</code> object, so you can just type things like <code>@@Content.FirstName</code> to access the properties. 
        <br>
        This sample also uses the <code>@@Kit.Image.Img(...)</code> to automatically show a responsive image on the page.
      </p>
    </div>
  </div>


<h3>Show Entity Values</h3>
<!-- unimportant stuff, hidden -->

  @MyItem.Picture("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>


@* Snippet for the old v14 code, which shouldn't run but should be shown. This is a bit of a hack, but it works

  @Kit.Image.Img(Content.Field("Mugshot"), settings: "Square", width: 100, imgClass: "rounded-circle")
  <ul>
    <li>Name: @Content.FirstName @Content.LastName</li>
    <li>Birthday: @Content.Birthday.ToString("d")</li>
    <li>Award: @Content.Awards.Name</li>
  </ul>

*@

Note that Awards refers to other... <!-- unimportant stuff, hidden -->

@* Footer *@
@Html.Partial("../Shared/Layout/FooterWithSource.cshtml", new { Sys = Sys })
An error has occurred. This application may no longer respond until reloaded. Reload 🗙