Class BlockGridItem

Represents a layout item for the Block Grid editor.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Models.Blocks

Assembly: Umbraco.Core.dll

Syntax

[DataContract(Name = "block", Namespace = "")]
public class BlockGridItem : IBlockReference<IPublishedElement, IPublishedElement>, IBlockReference<IPublishedElement>, IBlockReference

Constructors

View Source

BlockGridItem(Udi, IPublishedElement, Udi, IPublishedElement)

Initializes a new instance of the BlockGridItem class.

Declaration

public BlockGridItem(Udi contentUdi, IPublishedElement content, Udi settingsUdi, IPublishedElement settings)

Parameters

Type	Name	Description
Udi	contentUdi	The content UDI.
IPublishedElement	content	The content.
Udi	settingsUdi	The settings UDI.
IPublishedElement	settings	The settings.

Exceptions

Type	Condition
System.ArgumentNullException	contentUdi or content

Properties

View Source

AreaGridColumns

The number of columns available for the areas to span

Declaration

[DataMember(Name = "areaGridColumns")]
public int? AreaGridColumns { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

View Source

Areas

The grid areas within this item

Declaration

[DataMember(Name = "areas")]
public IEnumerable<BlockGridArea> Areas { get; set; }

Property Value

Type	Description
IEnumerable<BlockGridArea>

View Source

ColumnSpan

The number of columns this item should span

Declaration

[DataMember(Name = "columnSpan")]
public int ColumnSpan { get; set; }

Property Value

Type	Description
System.Int32

View Source

Content

Gets the content.

Declaration

[DataMember(Name = "content")]
public IPublishedElement Content { get; }

Property Value

Type	Description
IPublishedElement	The content.

View Source

ContentUdi

Gets the content UDI.

Declaration

[DataMember(Name = "contentUdi")]
public Udi ContentUdi { get; }

Property Value

Type	Description
Udi	The content UDI.

View Source

GridColumns

The number of columns in the root grid

Declaration

[DataMember(Name = "gridColumns")]
public int? GridColumns { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

View Source

RowSpan

The number of rows this item should span

Declaration

[DataMember(Name = "rowSpan")]
public int RowSpan { get; set; }

Property Value

Type	Description
System.Int32

View Source

Settings

Gets the settings.

Declaration

[DataMember(Name = "settings")]
public IPublishedElement Settings { get; }

Property Value

Type	Description
IPublishedElement	The settings.

View Source

SettingsUdi

Gets the settings UDI.

Declaration

[DataMember(Name = "settingsUdi")]
public Udi SettingsUdi { get; }

Property Value

Type	Description
Udi	The settings UDI.