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(Guid, IPublishedElement, Nullable<Guid>, IPublishedElement)

Declaration

public BlockGridItem(Guid contentKey, IPublishedElement content, Guid? settingsKey, IPublishedElement settings)

Parameters

Type	Name	Description
Guid	contentKey
IPublishedElement	content
System.Nullable<Guid>	settingsKey
IPublishedElement	settings

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.

Properties

View Source

AreaGridColumns

The number of columns available for the areas to span

Declaration

public int? AreaGridColumns { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

View Source

Areas

The grid areas within this item

Declaration

public IEnumerable<BlockGridArea> Areas { get; set; }

Property Value

Type	Description
IEnumerable<BlockGridArea>

View Source

ColumnSpan

The number of columns this item should span

Declaration

public int ColumnSpan { get; set; }

Property Value

Type	Description
System.Int32

View Source

Content

Gets the content.

Declaration

public IPublishedElement Content { get; }

Property Value

Type	Description
IPublishedElement	The content.

View Source

ContentKey

Gets the content key.

Declaration

public Guid ContentKey { get; set; }

Property Value

Type	Description
Guid

View Source

ContentUdi

Gets the content UDI.

Declaration

public Udi ContentUdi { get; }

Property Value

Type	Description
Udi	The content UDI.

View Source

GridColumns

The number of columns in the root grid

Declaration

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

public int RowSpan { get; set; }

Property Value

Type	Description
System.Int32

View Source

Settings

Gets the settings.

Declaration

public IPublishedElement Settings { get; }

Property Value

Type	Description
IPublishedElement	The settings.

View Source

SettingsKey

Gets the settings key.

Declaration

public Guid? SettingsKey { get; set; }

Property Value

Type	Description
System.Nullable<Guid>

View Source

SettingsUdi

Gets the settings UDI.

Declaration

public Udi SettingsUdi { get; }

Property Value

Type	Description
Udi	The settings UDI.