View Source

Class BlockGridTemplateExtensions

Inheritance

object

Namespace: Umbraco.Extensions

Assembly: Umbraco.Web.Common.dll

Syntax

public static class BlockGridTemplateExtensions

Fields

DefaultFolder

Declaration

public const string DefaultFolder = "blockgrid/"

Field Value

Type	Description
string

DefaultItemAreaTemplate

Declaration

public const string DefaultItemAreaTemplate = "area"

Field Value

Type	Description
string

DefaultItemAreasTemplate

Declaration

public const string DefaultItemAreasTemplate = "areas"

Field Value

Type	Description
string

DefaultItemsTemplate

Declaration

public const string DefaultItemsTemplate = "items"

Field Value

Type	Description
string

DefaultTemplate

Declaration

public const string DefaultTemplate = "default"

Field Value

Type	Description
string

Methods

GetBlockGridHtml(IHtmlHelper, BlockGridModel?, string)

Renders a block grid model into a grid layout

Declaration

public static IHtmlContent GetBlockGridHtml(this IHtmlHelper html, BlockGridModel? model, string template = "default")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridModel	model
string	template

Returns

Type	Description
IHtmlContent

Remarks

By default this method uses a set of built-in partial views for rendering the blocks and areas in the grid model. These partial views are embedded in the static assets (Umbraco.Cms.StaticAssets), so they won't show up in the Views folder on your local disk.

If you need to tweak the grid rendering output, you can copy the partial views from GitHub to your local disk. The partial views are found in "/src/Umbraco.Cms.StaticAssets/Views/Partials/blockgrid/" on GitHub and should be copied to "Views/Partials/BlockGrid/" on your local disk.

GetBlockGridHtml(IHtmlHelper, IPublishedContent, string)

Renders a block grid model into a grid layout

Declaration

public static IHtmlContent GetBlockGridHtml(this IHtmlHelper html, IPublishedContent contentItem, string propertyAlias)

Parameters

Type	Name	Description
IHtmlHelper	html
IPublishedContent	contentItem
string	propertyAlias

Returns

Type	Description
IHtmlContent

Remarks

By default this method uses a set of built-in partial views for rendering the blocks and areas in the grid model. These partial views are embedded in the static assets (Umbraco.Cms.StaticAssets), so they won't show up in the Views folder on your local disk.

If you need to tweak the grid rendering output, you can copy the partial views from GitHub to your local disk. The partial views are found in "/src/Umbraco.Cms.StaticAssets/Views/Partials/blockgrid/" on GitHub and should be copied to "Views/Partials/BlockGrid/" on your local disk.

GetBlockGridHtml(IHtmlHelper, IPublishedContent, string, string)

Declaration

public static IHtmlContent GetBlockGridHtml(this IHtmlHelper html, IPublishedContent contentItem, string propertyAlias, string template)

Parameters

Type	Name	Description
IHtmlHelper	html
IPublishedContent	contentItem
string	propertyAlias
string	template

Returns

Type	Description
IHtmlContent

GetBlockGridHtml(IHtmlHelper, IPublishedProperty, string)

Renders a block grid model into a grid layout

Declaration

public static IHtmlContent GetBlockGridHtml(this IHtmlHelper html, IPublishedProperty property, string template = "default")

Parameters

Type	Name	Description
IHtmlHelper	html
IPublishedProperty	property
string	template

Returns

Type	Description
IHtmlContent

Remarks

By default this method uses a set of built-in partial views for rendering the blocks and areas in the grid model. These partial views are embedded in the static assets (Umbraco.Cms.StaticAssets), so they won't show up in the Views folder on your local disk.

If you need to tweak the grid rendering output, you can copy the partial views from GitHub to your local disk. The partial views are found in "/src/Umbraco.Cms.StaticAssets/Views/Partials/blockgrid/" on GitHub and should be copied to "Views/Partials/BlockGrid/" on your local disk.

GetBlockGridHtmlAsync(IHtmlHelper, BlockGridModel?, string)

Renders a block grid model into a grid layout

Declaration

public static Task<IHtmlContent> GetBlockGridHtmlAsync(this IHtmlHelper html, BlockGridModel? model, string template = "default")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridModel	model
string	template

Returns

Type	Description
Task<IHtmlContent>

Remarks

By default this method uses a set of built-in partial views for rendering the blocks and areas in the grid model. These partial views are embedded in the static assets (Umbraco.Cms.StaticAssets), so they won't show up in the Views folder on your local disk.

If you need to tweak the grid rendering output, you can copy the partial views from GitHub to your local disk. The partial views are found in "/src/Umbraco.Cms.StaticAssets/Views/Partials/blockgrid/" on GitHub and should be copied to "Views/Partials/BlockGrid/" on your local disk.

GetBlockGridHtmlAsync(IHtmlHelper, IPublishedContent, string)

Renders a block grid model into a grid layout

Declaration

public static Task<IHtmlContent> GetBlockGridHtmlAsync(this IHtmlHelper html, IPublishedContent contentItem, string propertyAlias)

Parameters

Type	Name	Description
IHtmlHelper	html
IPublishedContent	contentItem
string	propertyAlias

Returns

Type	Description
Task<IHtmlContent>

Remarks

By default this method uses a set of built-in partial views for rendering the blocks and areas in the grid model. These partial views are embedded in the static assets (Umbraco.Cms.StaticAssets), so they won't show up in the Views folder on your local disk.

If you need to tweak the grid rendering output, you can copy the partial views from GitHub to your local disk. The partial views are found in "/src/Umbraco.Cms.StaticAssets/Views/Partials/blockgrid/" on GitHub and should be copied to "Views/Partials/BlockGrid/" on your local disk.

GetBlockGridHtmlAsync(IHtmlHelper, IPublishedContent, string, string)

Declaration

public static Task<IHtmlContent> GetBlockGridHtmlAsync(this IHtmlHelper html, IPublishedContent contentItem, string propertyAlias, string template)

Parameters

Type	Name	Description
IHtmlHelper	html
IPublishedContent	contentItem
string	propertyAlias
string	template

Returns

Type	Description
Task<IHtmlContent>

GetBlockGridHtmlAsync(IHtmlHelper, IPublishedProperty, string)

Renders a block grid model into a grid layout

Declaration

public static Task<IHtmlContent> GetBlockGridHtmlAsync(this IHtmlHelper html, IPublishedProperty property, string template = "default")

Parameters

Type	Name	Description
IHtmlHelper	html
IPublishedProperty	property
string	template

Returns

Type	Description
Task<IHtmlContent>

Remarks

By default this method uses a set of built-in partial views for rendering the blocks and areas in the grid model. These partial views are embedded in the static assets (Umbraco.Cms.StaticAssets), so they won't show up in the Views folder on your local disk.

If you need to tweak the grid rendering output, you can copy the partial views from GitHub to your local disk. The partial views are found in "/src/Umbraco.Cms.StaticAssets/Views/Partials/blockgrid/" on GitHub and should be copied to "Views/Partials/BlockGrid/" on your local disk.

GetBlockGridItemAreaHtml(IHtmlHelper, BlockGridArea, string)

Declaration

public static IHtmlContent GetBlockGridItemAreaHtml(this IHtmlHelper html, BlockGridArea area, string template = "area")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridArea	area
string	template

Returns

Type	Description
IHtmlContent

GetBlockGridItemAreaHtml(IHtmlHelper, BlockGridItem, string, string)

Declaration

public static IHtmlContent GetBlockGridItemAreaHtml(this IHtmlHelper html, BlockGridItem item, string areaAlias, string template = "area")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridItem	item
string	areaAlias
string	template

Returns

Type	Description
IHtmlContent

GetBlockGridItemAreaHtmlAsync(IHtmlHelper, BlockGridArea, string)

Declaration

public static Task<IHtmlContent> GetBlockGridItemAreaHtmlAsync(this IHtmlHelper html, BlockGridArea area, string template = "area")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridArea	area
string	template

Returns

Type	Description
Task<IHtmlContent>

GetBlockGridItemAreaHtmlAsync(IHtmlHelper, BlockGridItem, string, string)

Declaration

public static Task<IHtmlContent> GetBlockGridItemAreaHtmlAsync(this IHtmlHelper html, BlockGridItem item, string areaAlias, string template = "area")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridItem	item
string	areaAlias
string	template

Returns

Type	Description
Task<IHtmlContent>

GetBlockGridItemAreasHtml(IHtmlHelper, BlockGridItem, string)

Declaration

public static IHtmlContent GetBlockGridItemAreasHtml(this IHtmlHelper html, BlockGridItem item, string template = "areas")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridItem	item
string	template

Returns

Type	Description
IHtmlContent

GetBlockGridItemAreasHtmlAsync(IHtmlHelper, BlockGridItem, string)

Declaration

public static Task<IHtmlContent> GetBlockGridItemAreasHtmlAsync(this IHtmlHelper html, BlockGridItem item, string template = "areas")

Parameters

Type	Name	Description
IHtmlHelper	html
BlockGridItem	item
string	template

Returns

Type	Description
Task<IHtmlContent>

GetBlockGridItemsHtml(IHtmlHelper, IEnumerable<BlockGridItem>, string)

Declaration

public static IHtmlContent GetBlockGridItemsHtml(this IHtmlHelper html, IEnumerable<BlockGridItem> items, string template = "items")

Parameters

Type	Name	Description
IHtmlHelper	html
IEnumerable<BlockGridItem>	items
string	template

Returns

Type	Description
IHtmlContent

GetBlockGridItemsHtmlAsync(IHtmlHelper, IEnumerable<BlockGridItem>, string)

Declaration

public static Task<IHtmlContent> GetBlockGridItemsHtmlAsync(this IHtmlHelper html, IEnumerable<BlockGridItem> items, string template = "items")

Parameters

Type	Name	Description
IHtmlHelper	html
IEnumerable<BlockGridItem>	items
string	template

Returns

Type	Description
Task<IHtmlContent>