Oqtane Tutorials
Oqtane Tutorials

Razor Tutorial - Home (16.4.0)

Below you'll find a list of topics this tutorial covers. The easiest way to work with it is to look at an example, then look at the code shown below the examples.


Basic


Quick Reference for Razor APIs (WIP = Work in Progress)

Quick Summary of most APIs for reference. This is still WIP...

  1. Dynamic Razor Code - Quick Reference

    For Razor12 and Razor14

  2. Pro Razor Code - Quick Reference new v16

    For the new base class Custom.Hybrid.RazorPro

Razor Basics

Learn how to use variables and loops, encode HTML, use 🚀😁💪 Emojis.
Also advanced stuff like re-using code or setting page titles and SEO stuff.
  1. Variables

    Create variables and show using @variableName

  2. Conditions

    if/else and ternary operator (condition ? true : false)

  3. Loops

    Loops using for() and foreach()

  4. Work with HTML

    Learn the difference of showing variables with @variable and @Html.Raw(variable), and re-use very simple snippets

  5. Using Emojis / Emoticons 👍

    Show Emojis in your output or use them for showing true/false

Basics: Reuse Code and Templates Across Files

You can place common templates, hlp and functions into shared files - both .cshtml and .cs. And you can split Razor files into code and templates.You can place common templates, hlp and functions into shared files - both .cshtml and .cs. And you can split Razor files into code and templates.

  1. Introduction Reuse templates and code

    Explains the basics of re-using code across templates and code files. 

  2. Create functions in your Razor

    Normal C# functions are the basic block for reusing code. 

  3. Template-Delegate Helpers - Razor-Style Functions

    Shows how to create simple functions which use the classic Razor-style syntax.

  4. Razor Components with @Html.Partial and DynamicModel/MyModel

    Reuse Razor files by calling them using @Html.Partial and passing parameters in DynamicModel (or  MyModel).

  5. Reuse Razor Helpers (mini-templates) with CreateInstance

    Use a shared razor file to hold multiple functions / helpers, and call them one-by-one as needed. 

  6. Reuse a function library CreateInstance

    Reuse a .cs file with shared functions using CreateInstance

  7. Advanced code reuse with .cs files

    Advanced uses of CreateInstance to share code across Razor files and WebApi Controllers.

Basics: Link between Pages and Views

Learn how to use Link.To(...) to link to specific pages or to link to the same page with certain URL parameters. 

  1. URL Parameters (text)

    Working with text URL Parameters like ?sort=ascending

  2. URL Parameters (number)

    Working with number URL Parameters like ?id=27

  3. Preserve Parameters

    Learn how to create links using current URL parameters

  4. View Switch

    Learn how to switch between views using Link.To()

  5. Working with difficult URLs

    Working difficult URLs like images containing umlauts

Basics: Set Page Title, Keywords etc. and Headers

Use the IPageService to set page properties, base tags and headers - even JsonLD and OpenGraph.
  1. Page Title, Keyword, Description

    Get/Set Page Title, Keywords, Description and set meta-tags and more.

  2. Base tag in header

    Add a base tag to the header - which works correctly in DNN. Important for SPA JS applications.

  3. Page Icons for Favicon, Apple/Android

    Add various combinations of icons to the page header

  4. Meta and other Tags in header

    Add a base tag to the header - which works correctly in DNN. Important for SPA JS applications.

  5. JSON-LD Headers for SEO

    Add JSON-LD (Linked Data) headers for Google

  6. Open-Graph headers for Social Media

    Add Open-Graph data headers for Facebook, Twitter and other sharing-systems

Basics: Get Information about Site, Page, User, etc.

To enable Hybrid Razor which works on Dnn and Oqtane, we need standards so that our Dynamic Code can access information about the page, module etc. 

  1. CmsContext.Platform – Dnn/Oqtane, Version etc.
  2. CmsContext.Culture – Current Language etc.
  3. CmsContext.Site – Name, URL etc.
  4. CmsContext.Page – Id, Parameters, etc.
  5. CmsContext.Module – ID, etc.
  6. CmsContext.User – ID, Permissions, etc.
  7. CmsContext.View – ID, Identifier, Edition, Name, etc.

Content and Images


Show Content and Data Entities on a Page

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 lets editors work with content - and your template only needs to visualize it.
  1. Working with Entity (Item) Values

    Every thing is an Entity. Here some basic examples how to show values like Name, Birthday etc. of such an Entity.

  2. Show current Content in the Output

    Show content which was entered for this module

Images, Automatic Resizing and Responsive Pictures

Learn the basics of Images, Image Resizing and Pictures.

  1. Introduction to the <img> Tag and Image formats

    Basics of showing images in HTML and understand JPG vs. PNG vs. WebP.

  2. Resize and Crop Images on the Server

    Learn to use the built-in Image-Resizer to create perfect images no matter what the editor adds in the CMS.

  3. Resize using Resize-Settings

    Store all the resize-parameters in a variable for re-use.

  4. Resize and Crop using Global Presets

    Site-wide and App-Wide Presets help to resize with the same settings everywhere.

  5. Resize combining Presets with Custom Resize-Settings

    Merge presets with custom settings.

  6. Responsive Server-Side Images (img) for real pros!

    Professional sites give each screen the best possible picture using srcset and <img>

  7. Responsive and optimal Server-Side Images (picture) for real pros!

    Give each screen the best possible picture based on resolution and format using srcset and <picture>

  8. Leverage the picture tag to the fullest

    Learn the newest best practices using the image service

Multi-Language Content and Resources (i18n) 🌐

2sxc is super-powerful with multiple languages. It's actually one of the best multi-language solutions in all known CMS solutions out there.
  1. Using multiple languages
    Everything in 2sxc can be multi-language. Discover how!

Data and DataSources


Data

Access App-Data directly or from an App-Query. Learn to query the data in C# using LINQ and work with SQL and JSON

  1. Introduction to Data

    Overview about all the basics like Data vs. App.Data, Query etc.

  2. Data from the App using App.Data

    Get any kind of data from the current App.

Data: List-Details Samples

Show data from DNN, the current App, DataSources or SQL, CSV etc. Also includes list/details (parent/child) examples.

  1. List-Details with one template and code-only
  2. List-Details with three templates and code-only
  3. List-Details with two templates, automatic view-switching
  4. List-Details with two templates, automatic view-switching and query
  5. Look into a Content-Type

Data: Work with Data from Queries - Entities, SQL, CSV and more

Show data from DNN, the current App, DataSources or SQL, CSV etc. Also includes list/details (parent/child) examples.

  1. Use a Query with App Data

    Get data from a prepared query on the App.

  2. Use Query to get CSV Data

    See an example how to use a Query to get Data from a CSV file as data source.

  3. Use Query to get CSV Data from a File Configured in Settings

    Get gata from a CSV file - which is configurable.

  4. Use App Query to get SQL Data
  5. SQL data from a Query with Params
  6. Query with Params - Run multiple times

Data: LINQ (Language Integrated Query)

The following examples show how to use LINQ (Language INtegrated Query) to sort, filter and group data. This is for quick work in your views - for more extensive querying, we recommend the Visual Query Designer.

  1. Introduction to LINQ
  2. Basic looking for something with Where(...) and Any(...)
  3. Get First() / Last() item in a list
  4. Take() / Skip() items in a list
  5. Count() items in a list
  6. Basic sorting of lists
  7. Get Authors of Books (sub-items) to show and for sorting
  8. Group books by authors in 3 ways
  9. Access a list in list in list
  10. Go backwards - find Books pointing to Authors with Parents(...)

Data: JSON

Easily work with JSON data.

  1. Introduction to JSON

DataSources: Use in C# Code

DataSources will usually be used in a VisualQuery, but you can also use them in C# for advanced scenarios. Learn about the Kit.Data API

  1. Get DataSources in Code - Introduction new v16

    Overview about using DataSources directly in your code.

  2. Get DataSources in Code - Basics new v16

    Use Kit.Data.GetSource() and more to get DataSource objects and work with them.

  3. Use DataSources in Code - Attach/Connect Multiple Sources new v16

    We can use one or more DataSources as In data for another DataSource.

  4. Use DataSource in Code - GetQuery new v16

    Queries are also just another DataSource. Discover how to use GetQuery()

DataSources: Create Custom Dynamic DataSources

Create custom DataSources directly in the App DataSources folder.

  1. Dynamic DataSources Overview new v16

    Learn about DataSources in general, before we start using or even creating them.

  2. Dynamic DataSources - Basics new v16

    Create custom, dynamic data sources directly in the App folder, without compiling to a DLL.

  3. Return Lists of Items new v16

    This sample is more realistic, returning many items.

  4. Configuration of DataSources new v16

    Learn how to create DataSources which can be configured.

  5. Process In (attached) Data new v16

    Create DataSources which receive data and filter them before providing them on Out.

  6. Provide Multiple Lists/Streams new v16

    Create DataSources which have multiple Out-Streams.

  7. Use Data from other DataSources new v16

    Your DataSource can also create other DataSources internally to get data.

  8. Use in Visual Query new v16

    Dynamic DataSources can also be used in VisualQuery.

  9. Relationships between Data Items new 16.01

    Create Data with Relationships to other Data - such as parent/child or tree / folder structures

  10. Conversion Factory Options new v16

    Customize how the Data in a Dynamic DataSource is Converted.

Data: External Data using .net APIs

Show data using .net APIs or DNN APIs

  1. SQL data from a SQL query and DataTable
  2. SQL data from a SQL query and DataReader
  3. DNN data (pages/tabs) from the DNN TabController

Advanced Settings and Automation

  1. Read Global/Site/App/View Settings using the Settings object 🆕 new in v12
  2. Deep dive into the Settings stack 🆕 new in v12
  3. Use PageService.Activate to enable features, Css and Js 🆕 new in v12

    Imagine controlling web resources/features in central management. No duplicate loading, full control!


RazorBlade and Koi


RazorBlade Tutorials

These examples help you quickly do hard stuff, once you've mastered the basics above

  1. RazorBlade Introduction - Making real tasks easier

    Properly create preview-texts, strip HTML, pick the right variables, set page titles and way more. 

RazorBlade Examples for Text Manipulations

Helpers to get the non-empty string, get parts of a specific string, trim-to-ellipsis and more.

  1. RazorBlade - Text.Crop() and Text.Ellipsis()

    Correctly crop text without splitting words or html-characters like &

  2. RazorBlade - Text.Has() tells you if something really has content

    Check if strings really have something correctly, incl. spaces or even   whitespaces.

  3. RazorBlade - Text.First() lets you pick a value from many variables RB 3.00

    Often you have to check many variables to find the first one to use.

  4. RazorBlade - Text.Zip() lets you shrink all spaces, tabs, enters together

    Very often you need to clean up some text before working with it.

  5. Razorblade - Text.After(), Text.AfterLast(), Text.Before(), Text.BeforeLast(), Text.Between() RB 3.09 / 2sxc 13.02

    Choose where to split text and retrieve the optimal form

RazorBlade for Manipulating Html Strings

Clean out tags, remove specific attributes, replace <br> with new-lines etc.

  1. Convert <br> tags to new-lines or just spaces - and also the other way around RB 1.00

    A common challenge is showing text as HTML or the other way around

  2. Use Scrub to Remove All or Specific HTML Tags RB 3.09 / 2sxc 13.02

    Remove html from a string - important for teaser texts and protecting against cross-site-scripting attacks.

  3. Use Scrub to remove Tag-Attributes, Classes, Styles or whatever you need RB 3.09 / 2sxc 13.02

    Clean out all kinds of HTML attributes

RazorBlade Examples for Modifying DNN Page Headers

2sxc 12 introduces the new PageService which also works in Oqtane 💧. We suggest you use that instead. 👉 See Razor Page Service

  1. Page Title, Keyword, Description v1.01

    Get/Set Page Title, Keywords, Description and set meta-tags and more.

  2. Base tag in header v3.00

    Add a base tag to the header - which works correctly in DNN. Important for SPA JS applications.

  3. JSON-LD Headers for SEO v1.01

    Add JSON-LD (Linked Data) headers for Google

  4. Open-Graph headers for Social Media  v1.01

    Add Open-Graph data headers for Facebook, Twitter and other sharing-systems

  5. Page Icons for Favicon, Apple/Android v2.01

    Add various combinations of icons to the page header

RazorBlade Fluent Html5 API

RazorBlade 3 contains over 130 objects with hundreds of properties so you can quickly generate Html5 tags correctly and safely.
  1. RazorBlade - using the Html5 Tag API
    The basics of creating html directly from code - new in 2.0 and enhanced in 2.1
  2. Introduction to the Fluid Html5 API with 130+ objects like Img, Table etc.  new! v3.00

    The basics of creating html directly from code

  3. Common Attributes (Id, Title, Class, Style) with SmartJoin new! v3.00

    Some attributes can be added, others replace the previous content. The attributes are super smart 💡

  4. Images with Unsafe URLs (Umlauts etc.) new! v3.00

    The API automatically fixes unsafe URLs like Umlauts, japanese characters etc. - SuperSmart 😎

  5. Picture Tags for various sizes / resolutions  new! v3.00

    Here's an example how to easily generate picture tags, which are the future of Images

  6. Start and End Tags new! v3.00

    In some cases you may want to just get the start or end-tag.

  7. Create custom (non Html5) tags or Tags whose name stems from a variable new! v3.00

    Working with tags in your code to stay error-free and do amazing stuff

RazorBlade Basic API to Generate Safe Attributes

  1. Safe Html5 Attributes from code  new! v3.00

    Working with attributes in your code to stay error-free

  2. Json Html5 Attributes from code  new! v3.00

    Working with attributes in your code to stay error-free

Koi Tutorials

These examples help you do cool stuff, once you've mastered the basics above
  1. Introduction - Koi - Cool things with CSS-Frameworks and Classes enhanced for v12
    Automatically include missing frameworks, conditionally modify the HTML or CSS-Classes and more, depending on what CSS-framework is used by the theme of this page.
  2. Koi - Auto-Add Bootstrap5 if missing

    Automatically add the Bootstrap5 CSS package from a CDN, if the current theme does not include Bootstrap5 already, but skip it if it's already included.

  3. Koi - Auto-Add Bootstrap5 but inform Admin

    Automatically add the Bootstrap5 CSS package from a CDN (same as above), but also show a warning to admins that this happened.

  4. Koi - Switch between template files new!

    Automatically switch between Bootstrap3 and Bootstrap4 templates.


JavaScript, turnOn, WebAPIs / REST


JavaScript

2sxc offers powerful helpers to just get things done - or to do things your way.
  1. Get Data from the Backend using JS
    Use the 2sxc data API and get data of a specific Content-Type
  2. Get a Query from the Backend using JS
    Use the 2sxc data API and get data from a Query
  3. Add Parameters to Query from the Backend using JS
    Use the 2sxc data API and get data from a Query using Parameters
  4. Create data, update and delete using JS APIs
    Use the 2sxc data API and create, update, delete data
  5. Create Metadata using JS APIs
    Use the 2sxc data API and create new metadata

turnOn

Use the turnOn feature to execute Javascript functions from Razor files
  1. Execute JavaScript with turnOn new in v12
    Use the turnOn feature to execute Javascript functions from Razor files
  2. Basic turnOn usage and activation

    Activate turn-on and execute local JavaScript functions

  3. Passing parameters with turnOn

    Pass parameters to JavaScript functions with turnOn

  4. Passing module parameters with turnOn

    Pass module parameters to JavaScript functions with turnOn

  5. Passing anonymous objects as parameters with turnOn

    Pass anonymous object to JavaScript functions with turnOn

  6. Wait for multiple scripts

    Await a library before executing JavaScript functions

  7. Await custom conditions through functions

    Await custom conditions before executing JavaScript functions

  8. Await system scripts

    Await a system script before executing JavaScript functions

WebApi / JSON Endpoints Examples

These examples show how to create and use WebApi. This isn't Razor, but also uses C#. You'll often need this when creating JavaScript and SPA apps.
  1. Introduction to WebApi
    Provide data to SPAs and do things like sending mails, changing data and more.
  2. WebApi - Very basic examples

    Creating the simplest possible hello WebApi and a Square(number) Api.

  3. WebApi - Basic example with CSRF protection

    This is almost the same as the simplest WebApi, but with additional Cross-Site-Request protection.

  4. WebApi - Basic example using all HTTP methods

    This is almost the same as the simplest WebApi, but with more methods.

  5. WebApi - Bare Metal for custom requests

    Advanced use cases where you need the url/headers but will do the request yourself.

  6. WebApi Polymorph - basic examples

    Basic example showing the same API in a live and staging editior, so you can develop while the users still use the sable one.

  7. WebApi App.Data - basic examples

    Basic example reading App Data.

  8. WebApi Query - basic examples

    Basic example reading App Query.

  9. Basic Hybrid WebApi

    Basic example reading App Data.


Edit UI and Formulas


Customize Edit UI / UX - Toolbars

Sometimes you want to customize what the editor will experience - using special toolbars or custom input fields. Note that this only applies to 2sxc.
  1. Introduction Toolbars
    Customize the editor experience by providing great toolbars or custom input fields
  2. Customize Toolbars
  3. Customize Toolbars Workflows (new ⭐)
  4. Call Toolbars Commands from JavaScript (new ⭐)

Customize Edit UI - Fields

Create custom input fields and customize WYSIWYG to your needs. 

  1. Basic HelloWorld Input Field (new)
  2. Custom Color Picker using Pickr (new)
  3. Configurable Color Picker (new)
  4. Custom lightweight WYSIWYG (4 buttons)  (new)
  5. Custom WYSIWYG with 1 additional button, multi-language (new)

Customize Edit-UI - Formulas (new!)

Add custom UI logic to your edit forms with formulas.

  1. Getting Started with Formulas

    Create Your First Formula

  2. Value Formulas

    Formulas affecting the Value of a Field

  3. Formulas for DropDowns

    Change what options are available in a DropDown

  4. Formulas for Field-Settings

    Formulas affecting Settings such as Required, Collapsed, Disabled, etc.

  5. Formulas for Field-Groups

    Modify Groups - auto-collapse based on rules, change help texts etc. 

  6. Formulas with parameters or App Settings new v16

    Create formulas which modify the form using parameters or App Settings (new v16)

  7. Formulas using REST or WebApi Calls new!

    Collection of previous samples, just all these using REST or WebApi.

  8. Advanced Formula API new v16

    Do advanced things such as checking features or the current user.


Advanced / Other


Advanced Scenarios for Hybrid (Dnn / Oqtane) Razor

Most Razor is identical for DNN and Oqtane, but in some cases you wish to access platform specific objects or use certain features which require different code in Dnn and Oqtane. Here's how to switch between such code. 

  1. Detect the current platform using CmsContext.Platform
  2. Place platform specific code in different child Razor files
  3. Platform-Specific Razor with Preprocessor Directives like #if

Crazy 2sxc Advanced Examples

These are really advanced examples and meant more to give guidance for specific questions. Don't worry if you don't understand these
  1. 2sxc-Advanced - Query the Content Block new!

Next Tutorials (Work-In-Progress)

We'll create some more tutorials in 2022, incl. the following
  1. Typed.IsEmpty / IsNotEmpty
  2. Typed.ContainsKey / Typed.Keys()
  3. Typed.Mock
  4. ---
  5. UI Formulas
  6. Linking around in dnn
  7. Using js/css and image resources in the app folder
  8. Using app settings and resources
  9. Navigation links
  10. Leveraging Connect.Koi
  11. Permission examples
  12. In-Page Editing experience
  13. Customizing Search Results
  14. Work with icon-fonts, font-awesome etc.
  15. More data examples, working with users, SQL-write, PetaPoco etc.
  16. Working with DataSources in all kinds of ways
  17. Using data from other apps
  18. Customizing search from data
  19. Custom dynamic WebApi
An error has occurred. This application may no longer respond until reloaded. Reload 🗙