Class XPMemberInfo

Namespace

DevExpress.Xpo.Metadata

Assembly

DevExpress.Xpo.v24.1.dll

Serves as a base for classes that provide access to member metadata.

public abstract class XPMemberInfo : XPTypeInfo

Inheritance

object

XPTypeInfo

XPMemberInfo

Derived

IntermediateObjectFieldInfo

IntermediateObjectKeyFieldInfo

ServiceField

ReflectionMemberInfo

XPCustomMemberInfo

Inherited Members

XPTypeInfo.HasAttribute(Type)

XPTypeInfo.HasAttribute(string)

XPTypeInfo.FindAttributeInfo(Type)

XPTypeInfo.FindAttributeInfo(string)

XPTypeInfo.GetAttributeInfo(string)

XPTypeInfo.GetAttributeInfo(Type)

XPTypeInfo.RemoveAttribute(Type)

XPTypeInfo.AddAttribute(Attribute)

XPTypeInfo.Attributes

XPTypeInfo.CanPersist

XPTypeInfo.IsPersistent

XPTypeInfo.IsVisibleInDesignTime

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

XPMemberInfo(XPClassInfo, bool)

protected XPMemberInfo(XPClassInfo owner, bool isReadOnly)

Parameters

owner XPClassInfo

isReadOnly bool

Fields

EmptyList

protected static readonly List<XPMemberInfo> EmptyList

Field Value

List<XPMemberInfo>

subMembersArray

protected List<XPMemberInfo> subMembersArray

Field Value

List<XPMemberInfo>

valueParent

protected XPMemberInfo valueParent

Field Value

XPMemberInfo

Properties

CollectionElementType

Gets the XPClassInfo of the persistent object if the current member is a collection of these persistent objects.

public XPClassInfo CollectionElementType { get; }

Property Value

XPClassInfo

An XPClassInfo object which represents the type of a single element in the collection. null (Nothing in Visual Basic) if this XPMemberInfo object provides metadata for a member which is not a collection.

Converter

Gets the value converter.

public ValueConverter Converter { get; }

Property Value

ValueConverter

A ValueConverter object which represents the value converter.

DbDefaultValue

public string DbDefaultValue { get; }

Property Value

string

DefaultValue

public object DefaultValue { get; }

Property Value

object

DisplayName

Gets the member’s display name.

public string DisplayName { get; }

Property Value

string

A string value which specifies the member’s display name.

IntermediateClass

This member supports the internal infrastructure and is not intended to be used directly from your code.

public IntermediateClassInfo IntermediateClass { get; }

Property Value

IntermediateClassInfo

IsAggregated

Gets whether the member references other aggregated persistent objects.

public bool IsAggregated { get; }

Property Value

bool

true if the member references other aggregated persistent objects; otherwise, false.

IsAliased

Gets whether a PersistentAliasAttribute attribute is applied to the property.

public bool IsAliased { get; }

Property Value

bool

true if the member has the PersistentAliasAttribute attribute; otherwise, false.

IsAssociation

Gets whether the member sets up the relation.

public bool IsAssociation { get; }

Property Value

bool

true if the member sets up the relation; otherwise, false.

IsAssociationList

Indicates whether the current member represents the “many” side of the association.

public bool IsAssociationList { get; }

Property Value

bool

true if the member is IList or its descendant, with the AssociationAttribute applied; otherwise, false.

IsAutoGenerate

Gets whether the member is the auto-generated key.

public bool IsAutoGenerate { get; }

Property Value

bool

true if the member is the auto-generated key; otherwise, flase.

IsCollection

Gets whether the member represents a collection and is involved in associations.

public bool IsCollection { get; }

Property Value

bool

true if the member represents a collection and is involved in associations; otherwise, false.

IsDelayed

Gets whether the property is marked as delayed.

public bool IsDelayed { get; }

Property Value

bool

true if the property is marked as delayed; otherwise, false.

IsExpandableToPersistent

public bool IsExpandableToPersistent { get; }

Property Value

bool

IsFetchOnly

Specifies if the member value can be saved to the database.

public bool IsFetchOnly { get; }

Property Value

bool

true, if the member value can be loaded from the database but should not be saved (should not be included in the INSERT and UPDATE SQL statements); false - if the value can be both loaded and saved.

IsIdentity

Gets whether the member is an auto-generated integer key.

public bool IsIdentity { get; }

Property Value

bool

true if the member is an auto-generated integer key; otherwise, false.

IsKey

Gets whether the member represents a key member.

public bool IsKey { get; }

Property Value

bool

true if the member represents a key member; otherwise, false.

IsManyToMany

Gets whether a member is involved in a many-to-many association.

public bool IsManyToMany { get; }

Property Value

bool

true if the member is involved in a many-to-many association; otherwise, false.

IsManyToManyAlias

Indicates whether the ManyToManyAliasAttribute attribute is applied.

public bool IsManyToManyAlias { get; }

Property Value

bool

true if the ManyToManyAliasAttribute is applied; otherwise, false.

IsNonAssociationList

Indicates whether the current member represents a collection that is not decorated with AssociationAttribute.

public bool IsNonAssociationList { get; }

Property Value

bool

true, if the member is IList or its descendant, not decorated with AssociationAttribute; otherwise, false.

IsNullable

Determines if a nullable column should be created when updating the database schema for the persistent class member described by the current XPMemberInfo object.

public bool? IsNullable { get; }

Property Value

bool?

true, if a nullable column is created, otherwise, false.

IsOptimisticLockingIgnored

Indicates whether or not optimistic concurrency is ignored for the current member.

public bool IsOptimisticLockingIgnored { get; }

Property Value

bool

true, if optimistic locking is ignored; otherwise, false.

IsPublic

When implemented in a derived class, gets whether the member is declared as public.

public abstract bool IsPublic { get; }

Property Value

bool

true if the member is declared as public; otherwise, false.

IsReadOnly

Gets whether the member is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the member is read-only; otherwise, false.

IsStruct

Gets whether the member represents a data structure.

public virtual bool IsStruct { get; }

Property Value

bool

true if the member represents a data structure; otherwise, false.

MappingField

Gets the column’s name in the data store which the member’s value is stored in.

public string MappingField { get; }

Property Value

string

A string value that specifies the column’s name in the data store which the member’s value is stored in.

MappingFieldDBType

Gets the MappingField‘s data type.

public DBColumnType MappingFieldDBType { get; }

Property Value

DBColumnType

One of the enumeration values. Specifies the .NET analog of the data store column’s type. Use the MappingFieldDBTypeName property to get the SQL type name.

MappingFieldDBTypeName

Gets the MappingField‘s SQL type name.

public string MappingFieldDBTypeName { get; }

Property Value

string

Specifies the

MappingFieldSize

Gets the maximum number of characters that can be stored in a field which the member is mapped to.

public int MappingFieldSize { get; }

Property Value

int

An integer value which specifies the maximum number of characters that can be stored. 0 if the type in which the member’s value is saved to a data store isn’t a string.

MemberType

When implemented in a derived class, gets the member’s type.

public abstract Type MemberType { get; }

Property Value

Type

A Type descendant which represents the member’s type.

MergeCollisionBehavior

Gets a value that indicates the behavior when merging changed objects (objects with different versions).

public OptimisticLockingReadMergeBehavior MergeCollisionBehavior { get; }

Property Value

OptimisticLockingReadMergeBehavior

A OptimisticLockingReadMergeBehavior enumeration value that indicates the behavior when merging changed objects.

Name

When implemented in a derived class, gets the member’s name.

public abstract string Name { get; }

Property Value

string

A string value which specifies the member’s name.

Owner

Gets the XPClassInfo object which owns this XPMemberInfo object.

public XPClassInfo Owner { get; }

Property Value

XPClassInfo

An XPClassInfo object which owns this XPMemberInfo object.

ReferenceType

Gets the XPClassInfo of the referenced object if the member is a reference to another persistent object.

public virtual XPClassInfo ReferenceType { get; }

Property Value

XPClassInfo

An XPClassInfo object which provides the metadata of the referenced object.

StorageType

Gets the type that the member’s value is saved as in the data store.

public Type StorageType { get; }

Property Value

Type

A Type descendant representing the type that the member’s value is saved as in the data store.

SubMembers

Gets a collection of sub members.

public IList SubMembers { get; }

Property Value

IList

A collection of XPMemberInfo objects.

Methods

DropCache()

protected override void DropCache()

ExpandId(object)

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public object ExpandId(object id)

Parameters

id object

Returns

object

FindAssociationAttributeInfo()

protected AssociationAttribute FindAssociationAttributeInfo()

Returns

AssociationAttribute

GetAssociatedMember()

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public XPMemberInfo GetAssociatedMember()

Returns

XPMemberInfo

GetAssociationAttributeInfo()

protected AssociationAttribute GetAssociationAttributeInfo()

Returns

AssociationAttribute

GetConst(object, XPMemberInfo)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public virtual object GetConst(object target, XPMemberInfo targetMember)

Parameters

target object

targetMember XPMemberInfo

Returns

object

GetDefaultMappingField()

protected virtual string GetDefaultMappingField()

Returns

string

GetMappingClass(XPClassInfo)

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public XPClassInfo GetMappingClass(XPClassInfo branch)

Parameters

branch XPClassInfo

An XPClassInfo object.

Returns

XPClassInfo

An XPClassInfo object.

GetModified(object)

Checks whether or not the member is modified.

public abstract bool GetModified(object theObject)

Parameters

theObject object

A persistent object that will be checked.

Returns

bool

true, if the member is modified; otherwise, false.

GetOldValue(object)

Returns the old value of the member.

public abstract object GetOldValue(object theObject)

Parameters

theObject object

A persistent object for which the member value will be obtained.

Returns

object

An object which is the old value of the member.

GetValue(object)

When implemented in a derived class, returns the property’s value.

public abstract object GetValue(object theObject)

Parameters

theObject object

An object whose value will be returned.

Returns

object

An object which represents the property’s value.

IsMappingClass(XPClassInfo)

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public bool IsMappingClass(XPClassInfo branch)

Parameters

branch XPClassInfo

An XPClassInfo object.

Returns

bool

The Boolean value.

MakeGetExpression(Expression)

This method is intended for internal use.

public virtual Expression MakeGetExpression(Expression ownerExpression)

Parameters

ownerExpression Expression

Returns

Expression

ProcessAssociationRefChange(Session, object, object, object)

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public void ProcessAssociationRefChange(Session session, object referenceMemberOwner, object oldValue, object newValue)

Parameters

session Session

referenceMemberOwner object

oldValue object

newValue object

ResetModified(object)

Resets the member’s modification.

public abstract void ResetModified(object theObject)

Parameters

theObject object

A persistent object whose member modification will be reset.

SetModified(object, object)

Marks the member as modified.

public abstract void SetModified(object theObject, object oldValue)

Parameters

theObject object

A persistent object whose member will be marked as modified.

oldValue object

An object that is the member’s old value.

SetValue(object, object)

When implemented in a derived class, sets the property’s value.

public abstract void SetValue(object theObject, object theValue)

Parameters

theObject object

An object whose property value will be set.

theValue object

An object which represents the new value for this property.

ToString()

Returns a string which represents the current object.

public override string ToString()

Returns

string

A string value which represents the current XPMemberInfo object.