Struct UmbracoEntityReference

Used to track a reference to another entity in a property value.

Namespace: Umbraco.Cms.Core.Models.Editors

Assembly: Umbraco.Core.dll

Syntax

public struct UmbracoEntityReference

Constructors

View Source

UmbracoEntityReference(Udi)

Initializes a new instance of the UmbracoEntityReference struct for a document or media item.

Declaration

public UmbracoEntityReference(Udi udi)

Parameters

Type	Name	Description
Udi	udi	The UDI.

View Source

UmbracoEntityReference(Udi, string)

Initializes a new instance of the UmbracoEntityReference struct.

Declaration

public UmbracoEntityReference(Udi udi, string relationTypeAlias)

Parameters

Type	Name	Description
Udi	udi	The UDI.
string	relationTypeAlias	The relation type alias.

Properties

View Source

RelationTypeAlias

Gets the relation type alias.

Declaration

public readonly string RelationTypeAlias { get; }

Property Value

Type	Description
string	The relation type alias.

View Source

Udi

Gets the UDI.

Declaration

public readonly Udi Udi { get; }

Property Value

Type	Description
Udi	The UDI.

Methods

View Source

Empty()

Gets an empty reference.

Declaration

public static UmbracoEntityReference Empty()

Returns

Type	Description
UmbracoEntityReference	An empty reference.

View Source

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

View Source

Equals(UmbracoEntityReference)

Declaration

public bool Equals(UmbracoEntityReference other)

Parameters

Type	Name	Description
UmbracoEntityReference	other

Returns

Type	Description
bool

View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

View Source

IsEmpty(UmbracoEntityReference)

Determines whether the specified reference is empty.

Declaration

public static bool IsEmpty(UmbracoEntityReference reference)

Parameters

Type	Name	Description
UmbracoEntityReference	reference	The reference.

Returns

Type	Description
bool	`true` if the specified reference is empty; otherwise, `false`.

Operators

View Source

operator ==(UmbracoEntityReference, UmbracoEntityReference)

Declaration

public static bool operator ==(UmbracoEntityReference left, UmbracoEntityReference right)

Parameters

Type	Name	Description
UmbracoEntityReference	left
UmbracoEntityReference	right

Returns

Type	Description
bool

View Source

operator !=(UmbracoEntityReference, UmbracoEntityReference)

Declaration

public static bool operator !=(UmbracoEntityReference left, UmbracoEntityReference right)

Parameters

Type	Name	Description
UmbracoEntityReference	left
UmbracoEntityReference	right

Returns

Type	Description
bool