View Source

Interface IBlockLayoutItem

Represents a layout item for a block editor.

Namespace: Umbraco.Cms.Core.Models.Blocks

Assembly: Umbraco.Core.dll

Syntax

public interface IBlockLayoutItem

Properties

ContentKey

Gets or sets the content key.

Declaration

Guid ContentKey { get; set; }

Property Value

Type	Description
Guid	The content key.

ContentUdi

Gets or sets the content UDI.

Declaration

[Obsolete("Use ContentKey instead. Scheduled for removal in Umbraco 18.")]
Udi? ContentUdi { get; set; }

Property Value

Type	Description
Udi	The content UDI.

SettingsKey

Gets or sets the settings key.

Declaration

Guid? SettingsKey { get; set; }

Property Value

Type	Description
Guid?	The settings key.

SettingsUdi

Gets or sets the settings UDI.

Declaration

[Obsolete("Use SettingsKey instead. Scheduled for removal in Umbraco 18.")]
Udi? SettingsUdi { get; set; }

Property Value

Type	Description
Udi	The settings UDI.

Methods

ReferencesContent(Guid)

Determines whether this layout item references the specified content key.

Declaration

bool ReferencesContent(Guid key)

Parameters

Type	Name	Description
Guid	key	The content key to check.

Returns

Type	Description
bool	true if this layout item references the specified content key; otherwise, false.

ReferencesSetting(Guid)

Determines whether this layout item references the specified settings key.

Declaration

bool ReferencesSetting(Guid key)

Parameters

Type	Name	Description
Guid	key	The settings key to check.

Returns

Type	Description
bool	true if this layout item references the specified settings key; otherwise, false.