Show / Hide Table of Contents

Class DTStringInfo

Class DTStringInfo corresponds to an element of type String in a DTDL model.

Inheritance
object
DTEntityInfo
DTSchemaInfo
DTPrimitiveSchemaInfo
DTStringInfo
Implements
IEquatable<DTEntityInfo>
IEquatable<DTSchemaInfo>
IEquatable<DTPrimitiveSchemaInfo>
IEquatable<DTStringInfo>
Inherited Members
DTEntityInfo.EntityKind
DTEntityInfo.ChildOf
DTEntityInfo.DefinedIn
DTEntityInfo.Id
DTEntityInfo.UndefinedProperties
DTEntityInfo.LanguageMajorVersion
DTEntityInfo.UndefinedTypes
DTEntityInfo.Description
DTEntityInfo.DisplayName
DTEntityInfo.Comment
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 class DTStringInfo : DTPrimitiveSchemaInfo, IEquatable<DTEntityInfo>, IEquatable<DTSchemaInfo>, IEquatable<DTPrimitiveSchemaInfo>, IEquatable<DTStringInfo>

Properties

| Edit this page View Source

ClassId

Get the DTMI that identifies type String 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 String.

Overrides
DTPrimitiveSchemaInfo.ClassId
| Edit this page View Source

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
DTPrimitiveSchemaInfo.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.

| Edit this page View Source

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
DTPrimitiveSchemaInfo.SupplementalTypes

Methods

| Edit this page View Source

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
DTPrimitiveSchemaInfo.DeepEquals(DTEntityInfo)
| Edit this page View Source

DeepEquals(DTPrimitiveSchemaInfo)

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

Declaration
public override bool DeepEquals(DTPrimitiveSchemaInfo other)
Parameters
Type Name Description
DTPrimitiveSchemaInfo other

The other DTPrimitiveSchemaInfo object to compare to.

Returns
Type Description
bool

True if equal.

Overrides
DTPrimitiveSchemaInfo.DeepEquals(DTPrimitiveSchemaInfo)
| Edit this page View Source

DeepEquals(DTSchemaInfo)

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

Declaration
public override bool DeepEquals(DTSchemaInfo other)
Parameters
Type Name Description
DTSchemaInfo other

The other DTSchemaInfo object to compare to.

Returns
Type Description
bool

True if equal.

Overrides
DTPrimitiveSchemaInfo.DeepEquals(DTSchemaInfo)
| Edit this page View Source

DeepEquals(DTStringInfo)

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

Declaration
public virtual bool DeepEquals(DTStringInfo other)
Parameters
Type Name Description
DTStringInfo other

The other DTStringInfo object to compare to.

Returns
Type Description
bool

True if equal.

| Edit this page View Source

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
DTPrimitiveSchemaInfo.Equals(DTEntityInfo)
| Edit this page View Source

Equals(DTPrimitiveSchemaInfo)

Compares to another DTPrimitiveSchemaInfo object.

Declaration
public override bool Equals(DTPrimitiveSchemaInfo other)
Parameters
Type Name Description
DTPrimitiveSchemaInfo other

The other DTPrimitiveSchemaInfo object to compare to.

Returns
Type Description
bool

True if equal.

Overrides
DTPrimitiveSchemaInfo.Equals(DTPrimitiveSchemaInfo)
| Edit this page View Source

Equals(DTSchemaInfo)

Compares to another DTSchemaInfo object.

Declaration
public override bool Equals(DTSchemaInfo other)
Parameters
Type Name Description
DTSchemaInfo other

The other DTSchemaInfo object to compare to.

Returns
Type Description
bool

True if equal.

Overrides
DTPrimitiveSchemaInfo.Equals(DTSchemaInfo)
| Edit this page View Source

Equals(DTStringInfo)

Compares to another DTStringInfo object.

Declaration
public virtual bool Equals(DTStringInfo other)
Parameters
Type Name Description
DTStringInfo other

The other DTStringInfo object to compare to.

Returns
Type Description
bool

True if equal.

| Edit this page View Source

ValidateInstance(JsonElement)

Validate a JsonElement to determine whether it is a string value.

Declaration
public override IReadOnlyCollection<string> ValidateInstance(JsonElement instanceElt)
Parameters
Type Name Description
JsonElement instanceElt

The JsonElement to validate.

Returns
Type Description
IReadOnlyCollection<string>

A list of strings that each indicate a validation failure; the list is empty if the JsonElement conforms.

Overrides
DTEntityInfo.ValidateInstance(JsonElement)

Operators

| Edit this page View Source

operator ==(DTStringInfo, DTStringInfo)

Determines whether two DTStringInfo objects are equal.

Declaration
public static bool operator ==(DTStringInfo x, DTStringInfo y)
Parameters
Type Name Description
DTStringInfo x

One DTStringInfo object to compare.

DTStringInfo y

Another DTStringInfo object to compare to the first.

Returns
Type Description
bool

True if equal.

| Edit this page View Source

operator !=(DTStringInfo, DTStringInfo)

Determines whether two DTStringInfo objects are not equal.

Declaration
public static bool operator !=(DTStringInfo x, DTStringInfo y)
Parameters
Type Name Description
DTStringInfo x

One DTStringInfo object to compare.

DTStringInfo y

Another DTStringInfo object to compare to the first.

Returns
Type Description
bool

True if not equal.

Implements

IEquatable<T>
IEquatable<T>
IEquatable<T>
IEquatable<T>
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX