Oqtane Tutorials
Oqtane Tutorials

Context Tutorials

Tutorial Home › Context
Set Open-Graph headers for Social Media using the  IPageService
#1 Work with the Context (Page, Site, etc.)
Working with Entity (Item) Values
The samples can differ based on your Razor base class or if you're running an old version.
Switch to Typed (2sxc 16+) Switch to Dynamic (Razor14 or below)
Requirements
Resources
Related

Work with the Context (Page, Site, etc.)

Whenever you need to know about the current environment, you need Context information. These are the contexts you should know about:

  1. Platform
  2. Site
  3. Page
  4. Module
  5. View
  6. User

With the ICmsContext object you can get general information about the current platform.

⬇️ Result | Source ➡️

  1. .Name Current platform name is: Oqtane
  2. .Type Current platform type is: Oqtane
  3. .Version Current platform version is: 5.1.2 
@inherits Custom.Hybrid.RazorTyped

<ol>
  <li>
    <code>.Name</code> Current platform name is: 
    <strong>@MyContext.Platform.Name</strong>
  </li>
  <li>
    <code>.Type</code> Current platform type is: 
    <strong>@MyContext.Platform.Type</strong>
  </li>
  <li>
    <code>.Version</code> Current platform version is: 
    <strong>@MyContext.Platform.Version</strong>
  </li>
</ol>

With this object you can get general information about the culture.

⬇️ Result | Source ➡️

  1. .CurrentCode Current code culture is: en-us
  2. .DefaultCode en-us 
@inherits Custom.Hybrid.RazorTyped
@using ToSic.Razor.Blade

<ol>
  <li>
    <code>.CurrentCode</code> Current code culture is:
    <strong>@MyContext.Culture.CurrentCode</strong>
  </li>
  <li>
    <code>.DefaultCode</code>
    @if (Text.Has(MyContext.Culture.DefaultCode)) {
      <strong>@MyContext.Culture.DefaultCode</strong>
    } else {
      <p>
        The system is single language and the response is an empty string.
      </p>
    }
  </li>
</ol>

With this object you can get general informtion about the current site.

⬇️ Result | Source ➡️

  1. .Id of the current site (same as PortalId in DNN): 2
  2. .Url The site url with protocol: https://blazor-cms.org/oqtane-tutorials
  3. .UrlRoot The site url without a protocol: blazor-cms.org/oqtane-tutorials 
@inherits Custom.Hybrid.RazorTyped
@using ToSic.Razor.Blade

<ol>
  <li>
    <code>.Id</code> of the current site 
    (same as <code>PortalId</code> in DNN):
    <strong>@MyContext.Site.Id</strong>
  </li>
  <li>
    <code>.Url</code> The site url with protocol: 
    <strong>@MyContext.Site.Url</strong>
  </li>
  <li>
    <code>.UrlRoot</code> The site url without a protocol: 
    <strong>@MyContext.Site.UrlRoot</strong>
  </li>
</ol>

Get information about the page which is the contxt for the currently running code.

⬇️ Result | Source ➡️

  1. .Id of the current page: 37 (TabId in DNN or Page.PageId in oqtane.)
  2. .Url the page url with protocol: https://blazor-cms.org/oqtane-tutorials
  3. .Parameters all the url parameters of the page blade=page&tut=code-context&variant=strong
  4. .Parameters[name] Access a specific parameter (in this case the parameter c140 from the url) 
@inherits Custom.Hybrid.RazorTyped
@using ToSic.Razor.Blade

<ol>
  <li>
    <code>.Id</code> of the current page: 
    <strong>@MyPage.Id</strong>
    (<code>TabId</code> in DNN or 
    <code>Page.PageId</code> in oqtane.)
  </li>
  <li>
    <code>.Url</code> the page url with protocol: 
    <strong>@MyPage.Url</strong>
  </li>
  <li>
    <code>.Parameters</code> all the url parameters of the page 
    <code>@MyPage.Parameters</code>
  </li>
  <li>
    <code>.Parameters[name]</code> Access a specific parameter 
    (in this case the parameter <code>c140</code> from the url)
    <strong>
      @MyPage.Parameters["c140"]
    </strong>
  </li>
</ol>

Get information about the module context the code is running in.

⬇️ Result | Source ➡️

  1. .Id of the current module: 103
  2. .Id of the current block: 0
    .Guid of the current block:
    00000000-0000-0000-0000-000000000000
  3. .Id of the module-block: 0
    .Guid of the current module-block:
    00000000-0000-0000-0000-000000000000

Note: in most cases the Block.Id and Module.Block.Id are the same, but in some cases they are different. For example when using inner-content (blocks in blocks). 

@inherits Custom.Hybrid.RazorTyped
@using ToSic.Razor.Blade

<ol>
  <li>
    <code>.Id</code> of the current module: 
    <strong>@MyContext.Module.Id</strong>
  </li>
  <li>
    <code>.Id</code> of the current block: 
    <strong>@MyContext.Block.Id</strong>
    <br>
    <code>.Guid</code> of the current block: <br>
    <strong>@MyContext.Block.Guid</strong>
  </li>
  <li>
    <code>.Id</code> of the module-block: 
    <strong>@MyContext.Module.Block.Id</strong>
    <br>
    <code>.Guid</code> of the current module-block: <br>
    <strong>@MyContext.Module.Block.Guid</strong>
  </li>
</ol>

<p>
  Note: in most cases the Block.Id and Module.Block.Id are the same, but in some cases they are different.
  For example when using inner-content (blocks in blocks).
</p>

Get information about the user which is currently used by the code.

⬇️ Result | Source ➡️

  1. .Id of the current user: -1
  2. .IsSiteAdmin False (check if the current user is a site admin)
  3. .IsContentAdmin False (check if the current user can edit content)
  4. .IsSystemAdmin False (check if the current user is a super-user) 
@inherits Custom.Hybrid.RazorTyped
@using ToSic.Razor.Blade

<ol>
  <li>
    <code>.Id</code> of the current user: 
    <strong>@MyUser.Id</strong>
  </li>
  <li>
    <code>.IsSiteAdmin</code> 
    <strong>@MyUser.IsSiteAdmin</strong> 
    (check if the current user is a site admin) 
  </li>
  <li>
    <code>.IsContentAdmin</code> 
    <strong>@MyUser.IsContentAdmin</strong> 
    (check if the current user can edit content) 
  </li>
  <li>
    <code>.IsSystemAdmin</code> 
    <strong>@MyUser.IsSystemAdmin</strong> 
    (check if the current user is a super-user) 
  </li>
</ol>

Get information about the view context.

⬇️ Result | Source ➡️

  1. .Id of the current view: 6437
  2. .Edition of the current view: (Get information about the edition used or return an empty string)
  3. .Identifier of the view:
    An optional identifier which the View configuration can provide. Use this when you want to use the same template but make minor changes based on the View selected (like change the number of columns). Usually you will use either this OR the Settings:
  4. .Name of the view Default Tutorial Page (new v16)
    Name of the view as configured - note that because of i18n it could be different depending on the language. To clearly identify a view, use the Identifier or use Settings: 
@inherits Custom.Hybrid.RazorTyped
@using ToSic.Razor.Blade

<ol>
  <li>
    <code>.Id</code> of the current view:
    <strong>@MyView.Id</strong>
  </li>
  <li>
    <code>.Edition</code> of the current view: 
    <strong>@MyView.Edition</strong>
    (Get information about the edition used or return an empty string)
  </li>
  <li>
    <code>.Identifier</code> of the view: 
    <strong>@MyView.Identifier</strong>
    <br>
    An optional identifier which the View configuration can provide. 
    Use this when you want to use the same template but make minor
     changes based on the View selected (like change the number of columns). 
    Usually you will use either this OR the Settings: 
  </li>
  <li>
    <code>.Name</code> of the view <code>@MyView.Name</code>
    <br>
    Name of the view as configured - note that because of i18n 
    it could be different depending on the language. 
    To clearly identify a view, use the Identifier or use Settings: 
  </li>
</ol>

 

Set Open-Graph headers for Social Media using the  IPageService
#1 Work with the Context (Page, Site, etc.)
Working with Entity (Item) Values