IEmptyCheckable.IsEmpty Property

Gets if the IEmptyCheckable value is considered to be empty when validating via the RuleRequiredFieldAttribute.

Namespace: DevExpress.Persistent.Validation

Assembly: DevExpress.Persistent.Base.v24.1.dll

NuGet Package: DevExpress.Persistent.Base

Declaration

C#

bool IsEmpty { get; }

VB.NET

ReadOnly Property IsEmpty As Boolean

Property Value

Type	Description
Boolean	true, when the value is empty; otherwise, false.

Remarks

Support the IEmptyCheckable interface and implement the IsEmpty method, when it is required to validate properties of your custom type via the RuleRequiredField attribute. Below is the snippet from the Business Class Library’s FileData class, illustrating the implementation of this property:

C# (EF Core)

public class FileData :  BaseObject, IFileData, IEmptyCheckable {
    // ...
    public virtual string FileName { get; set; }
    // ...
    [Browsable(false)]
    public bool IsEmpty {
        get { return string.IsNullOrEmpty(FileName); }
    }
}

// Make sure that you use options.UseChangeTrackingProxies() in your DbContext settings.

C# (XPO)

public class FileData : BaseObject, IFileData, IEmptyCheckable {
    // ...
    public string FileName {
        get { return fileName; }
        set {
            SetPropertyValue<string>(nameof(FileName), ref fileName, value);
        }
    }
    // ...
    [NonPersistent, MemberDesignTimeVisibility(false)]
    public bool IsEmpty {
        get { return string.IsNullOrEmpty(FileName); }
    }
}

VB.NET (XPO)

Public Class FileData
    Inherits BaseObject
    Implements IFileData, IEmptyCheckable
    ' ...
    Public Property FileName() As String
        Get
            Return fileName
        End Get
        Set(ByVal value As String)
            SetPropertyValue(Of String)(NameOf(FileName), fileName, value)
        End Set
    End Property
    ' ...
    <NonPersistent, MemberDesignTimeVisibility(False)> _
    Public ReadOnly Property IsEmpty() As Boolean
        Get
            Return String.IsNullOrEmpty(FileName)
        End Get
    End Property
End Class

With the IEmptyCheckable interface supported, the property of the FileData type can be validated in the following manner:

C# (EF Core)

public class Resume : BaseObject {
     // ...
    [RuleRequiredField("RuleRequiredField for Resume.FileData", 
        DefaultContexts.Save, ,"The file must be specified"]
    public virtual FileData File { get; set; }
    // ...
}

// Make sure that you use options.UseChangeTrackingProxies() in your DbContext settings.

C# (XPO)

public class Resume : BaseObject {
     // ...
    [RuleRequiredField("RuleRequiredField for Resume.FileData", 
        DefaultContexts.Save, ,"The file must be specified"]
    public FileData File {
        // ...
    }
    // ...
}

VB.NET (XPO)

Public Class [Resume]
    Inherits BaseObject
    ' ...
    <RuleRequiredField("RuleRequiredField for Resume.FileData", _
    DefaultContexts.Save,"The file must be specified")> _
    Public ReadOnly Property File() As FileData
        ' ...
    End Property
    ' ...
End Class