Class DTSupplementalPropertyInfo

Class DTSupplementalPropertyInfo provides information about a property that can be applied to a DTDL element that has a supplemental type.

Inheritance

object

DTSupplementalPropertyInfo

Implements

IEquatable<DTSupplementalPropertyInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DTDLParser.Models

Assembly: DTDLParser.dll

Syntax

public class DTSupplementalPropertyInfo : IEquatable<DTSupplementalPropertyInfo>

Properties

ChildOf

Gets the identifier of a parent element in which the value of this property must be defined.

Declaration

public Dtmi ChildOf { get; }

Property Value

Type	Description
Dtmi

DefaultLanguage

Gets the default language code for a language-tagged string literal property.

Declaration

public string DefaultLanguage { get; }

Property Value

Type	Description
string	The default language code for a language-tagged string.

DictionaryKey

Gets a value indicating the name of the nested property that determines the dictionary key.

Declaration

public string DictionaryKey { get; }

Property Value

Type	Description
string	The name of the nested property used as a dictionary key.

Remarks

This property has a non-null value only when a plural property is exposed as a >Dictionary instead of a List. If the property is singular or not a dictionary, the DictionaryKey property will be null.

DtmiSegment

Gets a DTMI segment identifier, used for auto ID generation.

Declaration

public string DtmiSegment { get; }

Property Value

Type	Description
string	The segment identifier used for DTMI generation.

IdRequired

Gets a value indicating whether an @id must be present.

Declaration

public bool IdRequired { get; }

Property Value

Type	Description
bool	True if the model requieres an identifier for the element.

IsOptional

Gets a value indicating whether the property is optional or mandatory.

Declaration

public bool IsOptional { get; }

Property Value

Type	Description
bool	True if the property is optional.

IsPlural

Gets a value indicating whether the property is a singular value or a collection of values.

Declaration

public bool IsPlural { get; }

Property Value

Type	Description
bool	True if the property is a collection of values.

Type

Gets a Uri that indicates the type of the property.

Declaration

public Uri Type { get; }

Property Value

Type	Description
Uri	The type of the property.

Remarks

The type of the Type property is a Uri instead of a Dtmi because when a property has a literal value in DTDL documents, its types is given by an XSD type. When the type of a property is a DTDL type, its Uri will be a Dtmi.

TypeRequired

Gets a value indicating whether a @type must be present.

Declaration

public bool TypeRequired { get; }

Property Value

Type	Description
bool	True if the model requieres the type of the element to be specified.

Methods

Equals(DTSupplementalPropertyInfo)

Determines whether the specified DTSupplementalPropertyInfo is equal to the current object.

Declaration

public bool Equals(DTSupplementalPropertyInfo other)

Parameters

Type	Name	Description
DTSupplementalPropertyInfo	other	The other DTSupplementalPropertyInfo to compare against.

Returns

Type	Description
bool	True if the specified object is equal to the current object; otherwise, false.

Operators

operator ==(DTSupplementalPropertyInfo, DTSupplementalPropertyInfo)

Determines whether two DTSupplementalPropertyInfo objects are equal.

Declaration

public static bool operator ==(DTSupplementalPropertyInfo x, DTSupplementalPropertyInfo y)

Parameters

Type	Name	Description
DTSupplementalPropertyInfo	x	One DTSupplementalPropertyInfo object to compare.
DTSupplementalPropertyInfo	y	Another DTSupplementalPropertyInfo object to compare to the first.

Returns

Type	Description
bool	True if equal.

operator !=(DTSupplementalPropertyInfo, DTSupplementalPropertyInfo)

Determines whether two DTSupplementalPropertyInfo objects are not equal.

Declaration

public static bool operator !=(DTSupplementalPropertyInfo x, DTSupplementalPropertyInfo y)

Parameters

Type	Name	Description
DTSupplementalPropertyInfo	x	One DTSupplementalPropertyInfo object to compare.
DTSupplementalPropertyInfo	y	Another DTSupplementalPropertyInfo object to compare to the first.

Returns

Type	Description
bool	True if not equal.

Implements

IEquatable<T>