71 lines
3.0 KiB
C#
71 lines
3.0 KiB
C#
using System.Collections.Generic;
|
|
using System.Web;
|
|
using Umbraco.Core.Models;
|
|
|
|
namespace Umbraco.Web
|
|
{
|
|
/// <summary>
|
|
/// Methods used to render umbraco components as HTML in templates
|
|
/// </summary>
|
|
public interface IUmbracoComponentRenderer
|
|
{
|
|
/// <summary>
|
|
/// Renders the template for the specified pageId and an optional altTemplateId
|
|
/// </summary>
|
|
/// <param name="pageId"></param>
|
|
/// <param name="altTemplateId">If not specified, will use the template assigned to the node</param>
|
|
/// <returns></returns>
|
|
IHtmlString RenderTemplate(int pageId, int? altTemplateId = null);
|
|
|
|
/// <summary>
|
|
/// Renders the macro with the specified alias.
|
|
/// </summary>
|
|
/// <param name="alias">The alias.</param>
|
|
/// <returns></returns>
|
|
IHtmlString RenderMacro(string alias);
|
|
|
|
/// <summary>
|
|
/// Renders the macro with the specified alias, passing in the specified parameters.
|
|
/// </summary>
|
|
/// <param name="alias">The alias.</param>
|
|
/// <param name="parameters">The parameters.</param>
|
|
/// <returns></returns>
|
|
IHtmlString RenderMacro(string alias, object parameters);
|
|
|
|
/// <summary>
|
|
/// Renders the macro with the specified alias, passing in the specified parameters.
|
|
/// </summary>
|
|
/// <param name="alias">The alias.</param>
|
|
/// <param name="parameters">The parameters.</param>
|
|
/// <returns></returns>
|
|
IHtmlString RenderMacro(string alias, IDictionary<string, object> parameters);
|
|
|
|
/// <summary>
|
|
/// Renders an field to the template
|
|
/// </summary>
|
|
/// <param name="currentPage"></param>
|
|
/// <param name="fieldAlias"></param>
|
|
/// <param name="altFieldAlias"></param>
|
|
/// <param name="altText"></param>
|
|
/// <param name="insertBefore"></param>
|
|
/// <param name="insertAfter"></param>
|
|
/// <param name="recursive"></param>
|
|
/// <param name="convertLineBreaks"></param>
|
|
/// <param name="removeParagraphTags"></param>
|
|
/// <param name="casing"></param>
|
|
/// <param name="encoding"></param>
|
|
/// <param name="formatAsDate"></param>
|
|
/// <param name="formatAsDateWithTime"></param>
|
|
/// <param name="formatAsDateWithTimeSeparator"></param>
|
|
//// <param name="formatString"></param>
|
|
/// <returns></returns>
|
|
IHtmlString Field(IPublishedContent currentPage, string fieldAlias,
|
|
string altFieldAlias = "", string altText = "", string insertBefore = "", string insertAfter = "",
|
|
bool recursive = false, bool convertLineBreaks = false, bool removeParagraphTags = false,
|
|
RenderFieldCaseType casing = RenderFieldCaseType.Unchanged,
|
|
RenderFieldEncodingType encoding = RenderFieldEncodingType.Unchanged,
|
|
bool formatAsDate = false,
|
|
bool formatAsDateWithTime = false,
|
|
string formatAsDateWithTimeSeparator = "");
|
|
}
|
|
} |