LIOT/Framework/Bowin.Web.Controls.Mvc/Component.Dropdown/DropdownListOptions.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Bowin.Web.Controls.Mvc
{
    /// <summary>
    /// 下拉菜单的配置类
    /// </summary>
    public class DropdownListOptions:BaseFormControlOptions
    {
        /// <summary>
        /// 下拉菜单的配置类
        /// </summary>
        public DropdownListOptions()
        {
            ItemList = new List<DropdownListItem>();
            IsEditable = false;
            IsMultiple = false;
            Validator = null;
        }

		///// <summary>
		///// 下拉菜单的Change事件触发后要关联刷新的控件ID(仅支持EasyUI控件)
		///// <para>多个控件之间用','符号分隔</para>
		///// <para>相关属性:ReloadSource</para>
		///// </summary>
		//public string Reload { get; set; }

		///// <summary>
		///// 自定义被关联控件的数据加载地址
		///// <para>不设置则使用控件自带源地址加载数据</para>
		///// <para>多个控件之间用','符号分隔</para>
		///// </summary>
		//public string ReloadSource { get; set; }

		///// <summary>
		///// 传递至数据加载地址的数据参数(支持调用函数输出)
		///// <para>格式:</para>
		///// <para>{ name1 : value1 , name2 : value2 }</para>
		///// </summary>
		//public string ReloadData { get; set; }

        /// <summary>
        /// 选中值，该值会在控件加载时默认选中，
        /// 当控件使用默认值作为查询条件时，需要同时配置OnLoadSuccess事件以确保默认值成功加载后再刷新数据列表
        /// </summary>
        public object SelectedValue
        {
            get;
            set;
        }

        /// <summary>
        /// 下拉项列表，可以直接用此种方式绑定控件
        /// </summary>
        public List<DropdownListItem> ItemList
        {
            get;
            set;
        }

        /// <summary>
        /// 下拉项数据源，如果指定下拉项列表，可通过异步访问该地址，读取返回的数据源绑定，指定该方式访问，需同时配置TextField和ValueField
        /// </summary>
        public string ItemSourceUrl
        {
            get;
            set;
        }

        /// <summary>
        /// 下拉项数据源的显示文本字段名
        /// </summary>
        public string TextField
        {
            get;
            set;
        }

        /// <summary>
        /// 下拉项数据源的隐藏值字段名
        /// </summary>
        public string ValueField
        {
            get;
            set;
        }

        /// <summary>
        /// 指定一个脚本函数名，该函数用于确定下拉项呈现的方式，
        /// 输出样式转换方法,如下
        /// function formatItem(row){
        ///     var s = '<span style="font-weight:bold">' + row.text + '</span><br/>' +
        ///        '<span style="color:#888">' + row.desc + '</span>';
        ///     return s;
        ///}
        /// </summary>
        public string Formatter
        {
            get;
            set;
        }

        /// <summary>
        /// 指定一个脚本函数名，该函数在下拉项被选中时触发，函数格式样例如下：
        /// function(rec){   
        ///    var url = 'get_data2.php?id='+rec.id;   
        ///    $('#cc2').combobox('reload', url);   
        /// }
        /// </summary>
        public string OnSelect
        {
            get;
            set;
        }

        /// <summary>
        /// 指定一个脚本函数名，该函数在控件选中值被改变时触发，函数格式样例如下：
        /// function(rec){   
        ///    var url = 'get_data2.php?id='+rec.id;   
        ///    $('#cc2').combobox('reload', url);   
        /// }
        /// </summary>
		public string OnChange { get; set; }

		/// <summary>
        /// 指定一个脚本函数名，该函数在取消选择一项时触发
		/// </summary>
		public string OnUnselect { get; set; }


        /// <summary>
        /// 指定一个脚本函数名，该函数在所有下拉项加载完成后触发，函数格式样例如下：
        /// function(data){   
        ///    ...
        /// }
        /// </summary>
        public string OnLoadSuccess
        {
            get;
            set;
        }

        /// <summary>
        /// 指定一个脚本函数名，该函数在所有下拉项加载前触发
        /// </summary>
        public string OnBeforeLoad { get; set; }

        /// <summary>
        /// 绑定类型，有三种方式，一般情况下，作为列表查询条件时，使用SelectAll，默认项显示"全部"；
        /// 作为明细页面编辑控件时，使用PleaseSelect，默认项显示"请选择"；
        /// 部分页面因为要求用户必须选择一个选项，例如报表的周期，这时候使用None，不显示默认项
        /// </summary>
        public DropdownListBindType BindType { get; set; }

        /// <summary>
        /// 当指定ItemSourceUrl时，可以从这里传入参数
        /// </summary>
		public Dictionary<string, string> UrlParameters { get; set; }
         
        /// <summary>
        /// 控件的宽度，如果大于1，则以px为单位，如果小于1，则是代表百分比，如0.3代表30%
        /// </summary>
        public int? Width { get; set; }

        /// <summary>
        /// 控件的高度，如果大于1，则以px为单位，如果小于1，则是代表百分比，如0.3代表30%
        /// </summary>
        public int? Height { get; set; }

        /// <summary>
        /// 是否可编辑
        /// </summary>
        public bool? IsEditable { get; set; }

        /// <summary>
        /// 是否可多选
        /// </summary>
        public bool? IsMultiple { get; set; }
    }
}