IMEX.mes.wcf/DK.Basics/WFControls/10_Base/Interface/IDataVerifiable.cs


using System.Drawing;

namespace Dongke.WinForm.Controls
{
    /// <summary>
    /// 控件自动验证接口
    /// </summary>
    public interface IDataVerifiable : IMustInput, IDKControl
    {
        #region 属性

        /// <summary>
        /// 获取或设置是否显示边框颜色
        /// </summary>
        bool ShowBorderColor
        {
            get;
            set;
        }

        /// <summary>
        /// 获取或设置控件的项目名称
        /// </summary>
        string CDItemName
        {
            get;
            set;
        }

        /// <summary>
        /// 获取或设置控件在验证输入错误时，如何提示。
        /// </summary>
        InputErrorAlert InputErrorAlert
        {
            get;
            set;
        }

        /// <summary>
        /// 获取或设置当验证不通过时，控件是否可以失去焦点。
        /// </summary>
        bool CanLostFocusOnError
        {
            get;
            set;
        }

        /// <summary>
        /// 获取控件校验时是否有错误。
        /// </summary>
        bool HasError
        {
            get;
        }

        /// <summary>
        /// 获取控件校验时的错误编码。
        /// </summary>
        ControlErrorCode ErrorCode
        {
            get;
        }

        /// <summary>
        /// 获取控件校验时的错误消息。
        /// </summary>
        string ErrorMessage
        {
            get;
        }
        #endregion

        #region 方法
        ///// <summary>
        ///// 清除输入项
        ///// </summary>
        //void ClearValue();

        /// <summary>
        /// 设置自定义错误。
        /// </summary>
        /// <param name="hasError">输入是否有错误</param>
        /// <param name="errorMessage">错误消息</param>
        void SetCustomerError(bool hasError, string errorMessage);

        /// <summary>
        /// 清除自定义错误
        /// </summary>
        void ClearCustomerError();

        /// <summary>
        /// 验证输入内容。
        /// </summary>
        /// <returns>验证结果</returns>
        bool ValidateData();
        #endregion

        #region 事件
        /// <summary>
        /// 当 HasError 属性的值更改时发生。
        /// </summary>
        event System.EventHandler HasErrorChanged;
        #endregion
    }
}