Class Renderer
- Namespace
- Dynamicweb.Content.Items.Rendering
- Assembly
- Dynamicweb.dll
Provides methods and properties for rendering items in the frontend.
public class Renderer
- Inheritance
-
Renderer
- Inherited Members
Constructors
Renderer()
Initializes a new instance of an object.
public Renderer()
Renderer(string)
Initializes a new instance of an object.
public Renderer(string tagNamespace)
Parameters
tagNamespace
string- Tag namespace.
Properties
DetailsPageId
Gets or sets the page Id for details.
public int DetailsPageId { get; set; }
Property Value
DetailsParagraphId
Gets or sets the paragraph Id for details.
public int DetailsParagraphId { get; set; }
Property Value
NestingLevel
Gets or sets current nesting level of rendering(increased by link to item, item list).
public int NestingLevel { get; set; }
Property Value
PageId
Gets or sets the page Id.
public int PageId { get; set; }
Property Value
PagingPosition
Gets number of current page according to paging position
public int PagingPosition { get; }
Property Value
ParagraphId
Gets or sets the paragraph Id.
public int ParagraphId { get; set; }
Property Value
TagNamespace
Gets or sets the tag namespace for all tags.
public string TagNamespace { get; set; }
Property Value
ValueConverter
Gets or sets the value converter.
protected ValueConverter ValueConverter { get; set; }
Property Value
Methods
NormalizeTagPrefix(string)
Normalizes tag prefix by removing reduntnat "." and ":" and cleaning leading and trailing whitespaces.
protected virtual string NormalizeTagPrefix(string prefix)
Parameters
prefix
string- Tag prefix to normalize.
Returns
- string
- Normalized tag prefix.
RenderAreaItem(ItemEntry, Template)
Renders the given item.
public void RenderAreaItem(ItemEntry item, Template template)
Parameters
RenderEditForm(ItemEntry, ItemEditSettings)
Renders item edit form.
[Obsolete("Do not use")]
public void RenderEditForm(ItemEntry item, ItemEditSettings settings)
Parameters
item
ItemEntry- Item.
settings
ItemEditSettings- Item settings.
RenderEditFormBegin(StringWriter, ItemEditSettings)
Renders the begin of edit form.
[Obsolete("Do not use")]
protected virtual void RenderEditFormBegin(StringWriter output, ItemEditSettings settings)
Parameters
output
StringWritersettings
ItemEditSettings
RenderEditFormContent(StringWriter, ItemEntry, ItemEditSettings)
Renders the content of edit form.
[Obsolete("Do not use")]
protected virtual void RenderEditFormContent(StringWriter output, ItemEntry item, ItemEditSettings settings)
Parameters
output
StringWriteritem
ItemEntrysettings
ItemEditSettings
RenderEditFormEnd(StringWriter, ItemEditSettings)
Renders the end of edit form.
[Obsolete("Do not use")]
protected virtual void RenderEditFormEnd(StringWriter output, ItemEditSettings settings)
Parameters
output
StringWritersettings
ItemEditSettings
RenderGlobalTags(Template)
Renders global tags.
protected virtual void RenderGlobalTags(Template template)
Parameters
template
Template- Template.
RenderItem(ItemEntry, ItemSettings)
Renders the given item.
public virtual void RenderItem(ItemEntry item, ItemSettings settings)
Parameters
item
ItemEntry- Item.
settings
ItemSettings- Item settings.
RenderItem(ItemEntry, Template)
Renders the given item.
public void RenderItem(ItemEntry item, Template template)
Parameters
RenderItems(IEnumerable<ItemEntry>, ItemListSettings)
Renders items list.
public virtual void RenderItems(IEnumerable<ItemEntry> items, ItemListSettings settings)
Parameters
items
IEnumerable<ItemEntry>- Items to render.
settings
ItemListSettings- List settings.
RenderItems(IEnumerable<ItemEntry>, Template)
Renders items list.
public virtual void RenderItems(IEnumerable<ItemEntry> items, Template template)
Parameters
items
IEnumerable<ItemEntry>- Items to render.
template
Template- Template.
RenderItemType(ItemType, ItemTypeSettings)
Renders item type details.
public virtual void RenderItemType(ItemType itemType, ItemTypeSettings settings)
Parameters
itemType
ItemType- Item type.
settings
ItemTypeSettings- Settings.
RenderItemType(ItemType, Template)
Renders item type details.
public virtual void RenderItemType(ItemType itemType, Template template)
Parameters
RenderLink(string, Template, string)
Renders action link.
protected virtual void RenderLink(string query, Template template, string tagName)
Parameters
RenderPagePropertyItem(ItemEntry, Template)
Renders the given item.
public void RenderPagePropertyItem(ItemEntry item, Template template)
Parameters
RenderPaging(PagingSettings)
Renders paging tags.
public virtual void RenderPaging(PagingSettings settings)
Parameters
settings
PagingSettings- Paging settings.
RenderPagingLoop(Template, int, int, int, int, string, Func<int, string>)
[Obsolete("Use RenderPagingSequence instead.")]
protected virtual void RenderPagingLoop(Template l, int startPage, int endPage, int currentPage, int totalPages, string tagPrefix, Func<int, string> linkGenerator)
Parameters
l
TemplatestartPage
intendPage
intcurrentPage
inttotalPages
inttagPrefix
stringlinkGenerator
Func<int, string>
RenderPagingSequence(Template, int, int, int, int, string, Func<int, string>)
Render paging loop.
protected virtual void RenderPagingSequence(Template template, int startPage, int endPage, int currentPage, int totalPages, string tagPrefix, Func<int, string> linkGenerator)
Parameters
template
Template- Loop.
startPage
int- Start page.
endPage
int- End page.
currentPage
int- Current page.
totalPages
int- Total pages.
tagPrefix
string- Tag prefix.
linkGenerator
Func<int, string>- Page URL generator.
RenderPropertyItem(ItemEntry, Template, string)
Renders the given item.
public void RenderPropertyItem(ItemEntry item, Template template, string tagPrefix)
Parameters
RenderValidationError(Template, List<Tuple<string, string, string>>)
Renders validation error.
public virtual void RenderValidationError(Template template, List<Tuple<string, string, string>> errorMessages)
Parameters
RenderValue(object, Type, Template, string)
Renders the value.
public virtual void RenderValue(object value, Type valueType, Template template, string tagName)