Class DTSchemaFieldInfo

Class DTSchemaFieldInfo corresponds to an element of type SchemaField in a DTDL model.

Inheritance

object

DTEntityInfo

DTNamedEntityInfo

DTSchemaFieldInfo

DTCommandPayloadInfo

DTFieldInfo

DTMapValueInfo

Implements

IEquatable<DTEntityInfo>

IEquatable<DTNamedEntityInfo>

IEquatable<DTSchemaFieldInfo>

Inherited Members

DTNamedEntityInfo.Name

DTEntityInfo.EntityKind

DTEntityInfo.ChildOf

DTEntityInfo.DefinedIn

DTEntityInfo.Id

DTEntityInfo.UndefinedProperties

DTEntityInfo.LanguageMajorVersion

DTEntityInfo.UndefinedTypes

DTEntityInfo.Description

DTEntityInfo.DisplayName

DTEntityInfo.Comment

DTEntityInfo.ValidateInstance(JsonElement)

DTEntityInfo.ValidateInstance(string)

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 abstract class DTSchemaFieldInfo : DTNamedEntityInfo, IEquatable<DTEntityInfo>, IEquatable<DTNamedEntityInfo>, IEquatable<DTSchemaFieldInfo>

Properties

ClassId

Get the DTMI that identifies type SchemaField in the version of DTDL used to define this element.

Declaration

public override Dtmi ClassId { get; }

Property Value

Type	Description
Dtmi	The DTMI for the DTDL type SchemaField.

Overrides

DTNamedEntityInfo.ClassId

Schema

Gets the value of the 'schema' property of the DTDL element that corresponds to this object.

Declaration

public DTSchemaInfo Schema { get; }

Property Value

Type	Description
DTSchemaInfo	The 'schema' property of the DTDL element.

SupplementalProperties

Gets the supplemantal properties of the DTDL element that corresponds to this object.

Declaration

public override IDictionary<string, object> SupplementalProperties { get; }

Property Value

Type	Description
IDictionary<string, object>	A dictionary that maps each string-valued property name to an object that holds the value of the property with the given name.

Overrides

DTNamedEntityInfo.SupplementalProperties

Remarks

If the property is a literal in the DTDL model, the object holds a literal value. If the property is another DTDL element in the model, the object is the C# object that corresponds to this element.

SupplementalTypes

Gets a collection of identifiers, each of which is a Dtmi that indicates a supplemental type that applies to the DTDL element that corresponds to this object.

Declaration

public override IReadOnlyCollection<Dtmi> SupplementalTypes { get; }

Property Value

Type	Description
IReadOnlyCollection<Dtmi>	A collection of DTMIs indicating the supplemental types that apply to the DTDL element.

Overrides

DTNamedEntityInfo.SupplementalTypes

Methods

DeepEquals(DTEntityInfo)

Compares to another DTEntityInfo object, recursing through the entire subtree of object properties.

Declaration

public override bool DeepEquals(DTEntityInfo other)

Parameters

Type	Name	Description
DTEntityInfo	other	The other DTEntityInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Overrides

DTNamedEntityInfo.DeepEquals(DTEntityInfo)

DeepEquals(DTNamedEntityInfo)

Compares to another DTNamedEntityInfo object, recursing through the entire subtree of object properties.

Declaration

public override bool DeepEquals(DTNamedEntityInfo other)

Parameters

Type	Name	Description
DTNamedEntityInfo	other	The other DTNamedEntityInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Overrides

DTNamedEntityInfo.DeepEquals(DTNamedEntityInfo)

DeepEquals(DTSchemaFieldInfo)

Compares to another DTSchemaFieldInfo object, recursing through the entire subtree of object properties.

Declaration

public virtual bool DeepEquals(DTSchemaFieldInfo other)

Parameters

Type	Name	Description
DTSchemaFieldInfo	other	The other DTSchemaFieldInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Equals(DTEntityInfo)

Compares to another DTEntityInfo object.

Declaration

public override bool Equals(DTEntityInfo other)

Parameters

Type	Name	Description
DTEntityInfo	other	The other DTEntityInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Overrides

DTNamedEntityInfo.Equals(DTEntityInfo)

Equals(DTNamedEntityInfo)

Compares to another DTNamedEntityInfo object.

Declaration

public override bool Equals(DTNamedEntityInfo other)

Parameters

Type	Name	Description
DTNamedEntityInfo	other	The other DTNamedEntityInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Overrides

DTNamedEntityInfo.Equals(DTNamedEntityInfo)

Equals(DTSchemaFieldInfo)

Compares to another DTSchemaFieldInfo object.

Declaration

public virtual bool Equals(DTSchemaFieldInfo other)

Parameters

Type	Name	Description
DTSchemaFieldInfo	other	The other DTSchemaFieldInfo object to compare to.

Returns

Type	Description
bool	True if equal.

Operators

operator ==(DTSchemaFieldInfo, DTSchemaFieldInfo)

Determines whether two DTSchemaFieldInfo objects are equal.

Declaration

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

Parameters

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

Returns

Type	Description
bool	True if equal.

operator !=(DTSchemaFieldInfo, DTSchemaFieldInfo)

Determines whether two DTSchemaFieldInfo objects are not equal.

Declaration

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

Parameters

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

Returns

Type	Description
bool	True if not equal.

Implements

IEquatable<T>

IEquatable<T>

IEquatable<T>