EdmStructuredType Class

Reference

Definition

Namespace:: Microsoft.OData.Edm

Assembly:: Microsoft.OData.Edm.dll

Package:: Microsoft.OData.Edm v7.9.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Common base class for definitions of EDM structured types.

public abstract class EdmStructuredType : Microsoft.OData.Edm.EdmType, Microsoft.OData.Edm.IEdmStructuredType

type EdmStructuredType = class
    inherit EdmType
    interface IEdmStructuredType
    interface IEdmType
    interface IEdmElement

Public MustInherit Class EdmStructuredType
Inherits EdmType
Implements IEdmStructuredType

Inheritance: Object

EdmElement

EdmType
EdmStructuredType

Derived: Microsoft.OData.Edm.EdmComplexType

Microsoft.OData.Edm.EdmEntityType

Microsoft.OData.Edm.EdmUntypedStructuredType

Implements: IEdmElement IEdmStructuredType IEdmType

Constructors

EdmStructuredType(Boolean, Boolean, IEdmStructuredType)

Initializes a new instance of the EdmStructuredType class.

Properties

BaseType	Gets the base type of this type.
DeclaredProperties	Gets the properties declared immediately within this type.
IsAbstract	Gets a value indicating whether this type is abstract.
IsOpen	Gets a value indicating whether this type is open.
PropertiesDictionary	Gets a dictionary of the properties in this type definition for faster lookup.
TypeKind	Gets the kind of this type. (Inherited from EdmType)

Methods

AddProperty(IEdmProperty)	Adds the `property` to this type. DeclaringType of the `property` must be this type.
AddStructuralProperty(String, EdmPrimitiveTypeKind, Boolean)	Creates and adds a nullable structural property to this type.
AddStructuralProperty(String, EdmPrimitiveTypeKind)	Creates and adds a nullable structural property to this type.
AddStructuralProperty(String, IEdmTypeReference, String)	Creates and adds a structural property to this type.
AddStructuralProperty(String, IEdmTypeReference)	Creates and adds a structural property to this type.
AddUnidirectionalNavigation(EdmNavigationPropertyInfo)	Creates and adds a unidirectional navigation property to this type.
FindProperty(String)	Searches for a structural or navigation property with the given name in this type and all base types and returns null if no such property exists.
ToString()	Returns the text representation of the current object. (Inherited from EdmType)

Extension Methods

IsEquivalentTo(IEdmType, IEdmType)	Returns true if the compared type is semantically equivalent to this type. Schema types (IEdmSchemaType) are compared by their object refs.
AsActualType(IEdmType)	Returns the actual type of the given type. If the given type is type definition, the actual type is its underlying type; otherwise, return the given type itself.
InheritsFrom(IEdmStructuredType, IEdmStructuredType)	Determines if the potential base type is in the inheritance hierarchy of the type being tested.
IsBinary(IEdmType)	Returns true if this definition refers to a binary type.
IsDecimal(IEdmType)	Returns true if this definition refers to a decimal type.
IsGeography(IEdmType)	Returns true if this definition refers to a geography type.
IsGeometry(IEdmType)	Returns true if this definition refers to a geometry type.
IsOnSameTypeHierarchyLineWith(IEdmType, IEdmType)	Determines whether thisType is the same as otherType, or thisType derives from otherType, or otherType derives from thisType.
IsOrInheritsFrom(IEdmType, IEdmType)	Determines if a type is equivalent to or derived from another type.
IsSpatial(IEdmType)	Returns true if this definition refers to a spatial type.
IsStream(IEdmType)	Returns true if this reference refers to a stream type.
IsString(IEdmType)	Returns true if this definition refers to a string type.
IsTemporal(IEdmType)	Returns true if this definition refers to a temporal type.
IsUntyped(IEdmType)	Returns true if this definition refers to an untyped type.
AsElementType(IEdmType)	Gets the element type of a collection definition or itself of a non-collection definition referred to by the type reference.
BaseType(IEdmStructuredType)	Gets the base type of this structured type definition.
DeclaredNavigationProperties(IEdmStructuredType)	Gets the navigation properties declared in this structured type definition.
DeclaredStructuralProperties(IEdmStructuredType)	Gets all structural properties declared in the IEdmStructuredTypeDefinition.
FullTypeName(IEdmType)	Gets the full name of the definition referred to by the type reference.
IsOpen(IEdmType)	Returns true if the definition of this reference is open.
Location(IEdmElement)	Gets the location of this element.
NavigationProperties(IEdmStructuredType)	Get the navigation properties declared in this structured type and all base types.
Properties(IEdmStructuredType)	Gets all properties of the structured type definition and its base types.
StructuralProperties(IEdmStructuredType)	Gets the structural properties declared in this type definition and all base types.
ToTraceString(IEdmType)	Returns the text representation of the current object.
Errors(IEdmElement)	Gets the errors, if any, that belong to this element or elements that this element contains. For example errors for a structural type include the errors of the type itself and errors of its declared properties. The method does not analyze elements referenced by this element. For example errors of a property do not include errors from its type.
IsBad(IEdmElement)	Returns true if this element contains errors returned by the Errors(IEdmElement) method.

Applies to

Share via