• Documentation
  InstallationUsing the Kentico interfaceDeveloping websitesConfiguring KenticoManaging usersSecuring websitesDeploying websitesManaging website contentMultilingual websitesMacro expressionsExternal utilitiesIntegrating 3rd party systemsCustom developmentE-commerce featuresOn-line marketing featuresIntranet featuresCommunity featuresRunning Kentico on Microsoft AzureUsing Amazon web services with KenticoCertified extensionsReferencesRelease notes - Kentico 9
• Tutorial
  Getting started with KenticoUsing the Kentico interfaceSite development overviewCreating a new websiteAdding styles to the websiteWorking with the Pages applicationCreating the master pageCreating website pagesCreating page templatesNext steps
• API Examples
  Content managementOn-line marketingE-commerceSocial and CommunityDevelopmentConfiguration

Example

The following example demonstrates how to create a substitution macro that displays the current time:

1. Open your project in Visual Studio.

2. Create a class in the App_Code folder (or CMSApp_AppCode -> Old_App_Code on web application projects).

3. Edit the class and add the following references:

   C#

   Copy

   using CMS.Base;
   using CMS.OutputFilter;

4. Extend the CMSModuleLoader partial class⁠ (opens in a new tab).

5. Create a new class inside CMSModuleLoader that inherits from CMSLoaderAttribute.

6. Add the attribute defined by the internal class before the definition of the CMSModuleLoader partial class.

7. Override the Init method inside the attribute class and assign a handler method to the ResponseOutputFilter.OnResolveSubstitution event.

   C#

   Copy

   [SubstitutionLoader]
   public partial class CMSModuleLoader
   {
       /// <summary>
       /// Attribute class that registers substitution handlers.
       /// </summary>
       private class SubstitutionLoader : CMSLoaderAttribute
       {
           /// <summary>
           /// Called automatically when the application starts.
           /// </summary>
           public override void Init()
           {
               // Assigns a handler method to the event that the system triggers when resolving substitution macros
               ResponseOutputFilter.OnResolveSubstitution += ResolveCustomOutputSubstitutions;
           }
   
           /// <summary>
           /// Resolves output substitutions.
           /// </summary>
           /// <param name="sender">Sender object</param>
           /// <param name="e">Event argument object representing the substitution expression that is being resolved</param>
           private void ResolveCustomOutputSubstitutions(object sender, SubstitutionEventArgs e)
           {
               // Checks that the substitution expression is not resolved yet
               if (!e.Match)
               {
                   // Branches according to the expression text of the substitution macro
                   // You can define any number of substitution macros by adding further cases
                   switch (e.Expression.ToLower())
                   {
                       // Handles the {~TimeStamp~} substitution macro
                       case "timestamp":
   
                           // Flags the substitution expression as resolved
                           e.Match = true;
   
                           // Returns the current time as the result of the substitution
                           e.Result = DateTime.Now.ToString();
                           break;
                   }
               }
           }
   
       }
   }

8. Save the class file. Build the solution on web application installations.

The system now recognizes the {TimeStamp} expression, and resolves it into the current time. You can place the expression directly into the text content of pages, or anywhere within the output code.