Template

    Represents a Template file.

    • Namespace: Umbraco.Cms.Core.Models
    • Assembly: Umbraco.Core.dll

    All samples in this document will require references to the following dll:

    • Umbraco.Core.dll

    All samples in this document will require the following using statements:

    using Umbraco.Cms.Core.Models;
    

    Constructors

    new Template(IShortStringHelper shortStringHelper, string name, string alias)

    Constructor for creating a new Template object where the necessary parameters are a short String Helper as a IShortStringHelper, the name of the Template as a string and the alias as a string for the Template being created.

    Properties

    .Alias

    Gets the Alias of the File, which is the name without the extension.

    var template = new Template(shortStringHelper, "Page", "page");
    return template.Alias;
    

    .IsMasterTemplate

    Returns true if the template is used as a layout for other templates (i.e. it has 'children')

    var template = new Template(shortStringHelper,"Page", "page");
    return template.IsMasterTemplate;
    

    .MasterTemplateAlias

    Returns the alias of the master template if one is set.

    var template = new Template(shortStringHelper, "Page", "page");
    return template.MasterTemplateAlias;
    

    .MasterTemplateId

    Returns the id of the master template if one is set.

    var template = new Template(shortStringHelper, "Page", "page");
    return template.MasterTemplateId;
    

    .Name

    Gets the Name of the File including extension.

    var template = new Template(shortStringHelper, "Page", "page");
    return template.Name;
    

    Methods

    .SetMasterTemplate(ITemplate masterTemplate)

    Sets the master template of the template.

    // Create a new template
    var template = new Template(shortStringHelper, "Page", "page");
    // Get a master template 
    var masterTemplate = fileService.GetTemplate(1234);
    // Set the master template to new created template
    template.SetMasterTemplate(masterTemplate);
    // Save the new template
    fileService.SaveTemplate(template);