View Source

Class BlockLayoutItemBase

Base class for block layout items.

Inheritance

object

Namespace: Umbraco.Cms.Core.Models.Blocks

Assembly: Umbraco.Core.dll

Syntax

public abstract class BlockLayoutItemBase : IBlockLayoutItem

Constructors

BlockLayoutItemBase()

Initializes a new instance of the BlockLayoutItemBase class.

Declaration

protected BlockLayoutItemBase()

BlockLayoutItemBase(Guid)

Initializes a new instance of the BlockLayoutItemBase class.

Declaration

protected BlockLayoutItemBase(Guid contentKey)

Parameters

Type	Name	Description
Guid	contentKey	The content key.

BlockLayoutItemBase(Guid, Guid)

Initializes a new instance of the BlockLayoutItemBase class.

Declaration

protected BlockLayoutItemBase(Guid contentKey, Guid settingsKey)

Parameters

Type	Name	Description
Guid	contentKey	The content key.
Guid	settingsKey	The settings key.

Properties

ContentKey

Gets or sets the content key.

Declaration

public Guid ContentKey { get; set; }

Property Value

Type	Description
Guid	The content key.

SettingsKey

Gets or sets the settings key.

Declaration

public Guid? SettingsKey { get; set; }

Property Value

Type	Description
Guid?	The settings key.

Methods

ReferencesContent(Guid)

Determines whether this layout item references the specified content key.

Declaration

public virtual 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

public virtual 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.