View Source

Class UdiRange

Represents a Udi range.

Inheritance
object
Namespace: Umbraco.Cms.Core
Assembly: Umbraco.Core.dll
Syntax
public class UdiRange
Remarks
A Udi range is composed of a Udi which represents the base of the range, plus a selector that can be "." (the Udi), ".*" (the Udi and its children), ".**" (the udi and its descendants, "*" (the children of the Udi), and "**" (the descendants of the Udi). The Udi here can be a closed entity, or an open entity.

Constructors

View Source

UdiRange(Udi, string)

Initializes a new instance of the UdiRange class with a Udi and an optional selector.

Declaration
public UdiRange(Udi udi, string selector = "this")
Parameters
Type Name Description
Udi udi

A Udi.
string selector

An optional selector.

Properties

View Source

EntityType

Gets the entity type of the Udi for this range.

Declaration
public string EntityType { get; }
Property Value
Type Description
string
View Source

Selector

Gets or sets the selector for this range.

Declaration
public string Selector { get; }
Property Value
Type Description
string
View Source

Udi

Gets the Udi for this range.

Declaration
public Udi Udi { get; }
Property Value
Type Description
Udi

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
View Source

Parse(string)

Parses a string representation of a UDI range.

Declaration
public static UdiRange Parse(string value)
Parameters
Type Name Description
string value

The string to parse.
Returns
Type Description
UdiRange

A UdiRange instance.
Exceptions
Type Condition
FormatException

Thrown when the string is not a valid UDI range.
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string

Operators

View Source

operator ==(UdiRange?, UdiRange?)

Determines whether two UdiRange instances are equal.

Declaration
public static bool operator ==(UdiRange? range1, UdiRange? range2)
Parameters
Type Name Description
UdiRange range1

The first range to compare.
UdiRange range2

The second range to compare.
Returns
Type Description
bool

true if the ranges are equal; otherwise, false.
View Source

operator !=(UdiRange, UdiRange)

Determines whether two UdiRange instances are not equal.

Declaration
public static bool operator !=(UdiRange range1, UdiRange range2)
Parameters
Type Name Description
UdiRange range1

The first range to compare.
UdiRange range2

The second range to compare.
Returns
Type Description
bool

true if the ranges are not equal; otherwise, false.