View Source

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

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.

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.
System.String	relationTypeAlias	The relation type alias.

Properties

RelationTypeAlias

Gets the relation type alias.

Declaration

public readonly string RelationTypeAlias { get; }

Property Value

Type	Description
System.String	The relation type alias.

Udi

Gets the UDI.

Declaration

public readonly Udi Udi { get; }

Property Value

Type	Description
Udi	The UDI.

Methods

Empty()

Gets an empty reference.

Declaration

public static UmbracoEntityReference Empty()

Returns

Type	Description
UmbracoEntityReference	An empty reference.

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Equals(UmbracoEntityReference)

Declaration

public bool Equals(UmbracoEntityReference other)

Parameters

Type	Name	Description
UmbracoEntityReference	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

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
System.Boolean	true if the specified reference is empty; otherwise, false.

Operators

Equality(UmbracoEntityReference, UmbracoEntityReference)

Declaration

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

Parameters

Type	Name	Description
UmbracoEntityReference	left
UmbracoEntityReference	right

Returns

Type	Description
System.Boolean

Inequality(UmbracoEntityReference, UmbracoEntityReference)

Declaration

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

Parameters

Type	Name	Description
UmbracoEntityReference	left
UmbracoEntityReference	right

Returns

Type	Description
System.Boolean