FineUI.Core.Grid类 参考

表格控件 更多...

类 FineUI.Core.Grid 继承关系图:

Public 成员函数
	Grid ()
	构造函数
JArray	GetModifiedData ()
	获取用户在客户端修改、新增和删除的行数据
JArray	GetMergedData ()
	获取客户端回传的完整合并数据（包含修改和未修改的数据，不包含已经删除的行数据）
List< object[]>	GetSelectedDataKeys ()
	获取当前选中行的数据键。返回顺序与SelectedRowIDArray一致，每一项的字段顺序与DataKeyNames一致。 本方法通过DataIDField对应的数据键关联选中行，不依赖行索引，因此不受内存分页、排序和行移动影响。 推荐同时设置DataIDField和DataKeyNames，且DataKeyNames必须包含DataIDField； 返回值来自客户端回传，只能作为数据快照使用。
GridColumn	GetSortColumn (string sortField)
	通过列排序字段获取列实例
void	DataBind ()
	绑定到数据源
void	DataBind (bool keepCurrentData)
	绑定到数据源
int	GetStartRowIndex ()
	获取当前分页的起始行序号（不分页或者数据库分页时，返回零）
int	GetEndRowIndex ()
	获取当前分页的结束行序号
GridRow	FindRow (int rowIndex)
	通过行序号获取行对象
GridColumn	FindColumn (string columnID)
	通过列标识符获取列实例（如果列标识符未能匹配，尝试使用DataField匹配）
GridColumn	FindColumn (int columnIndex)
	通过列索引获取列实例
GridCommand	FindCommand (string commandName)
	通过行命令名称获取实例（仅RazorForms开发模式适用）
string	GetCommitChangesReference ()
	获取接受用户编辑单元格的客户端脚本（同时消除编辑单元格左上方的红色提示图标）
string	GetRejectChangesReference ()
	获取拒绝用户编辑单元格的客户端脚本（同时消除编辑单元格左上方的红色提示图标）
string	GetClearSelectionsReference ()
	获取清空表格选中项的客户端脚本
string	GetAddNewRecordReference (JObject defaultObject)
	获取添加一条新纪录的客户端脚本
string	GetAddNewRecordReference (JObject defaultObject, bool appendToEnd)
	获取添加一条新纪录的客户端脚本
string	GetAddNewRecordReference (JObject defaultObject, bool appendToEnd, string editColumnID)
	获取添加一条新纪录的客户端脚本
string	GetAddNewRecordReference (JObject defaultObject, int insertIndex)
	获取添加一条新纪录的客户端脚本
string	GetAddNewRecordReference (JObject defaultObject, int insertIndex, string editColumnID)
	获取添加一条新纪录的客户端脚本
string	GetUpdateCellValueReference (int rowIndex, string columnId, string cellValue)
	获取更新可编辑单元格值的客户端脚本
string	GetUpdateCellValueReference (string rowId, string columnId, string cellValue)
	获取更新可编辑单元格值的客户端脚本
string	GetUpdateCellValueReference (string rowId, JObject updateObject)
	获取更新可编辑单元格值的客户端脚本
string	GetUpdateCellValueReference (int rowIndex, JObject updateObject)
	获取更新可编辑单元格值的客户端脚本
string	GetDeleteRowReference (string rowId)
	获取删除指定行的客户端脚本
string	GetDeleteRowReference (string rowId, bool forceUpdate)
	获取删除指定行的客户端脚本
string	GetDeleteRowReference (int rowIndex)
	获取删除指定行的客户端脚本
string	GetDeleteRowReference (int rowIndex, bool forceUpdate)
	获取删除指定行的客户端脚本
string	GetDeleteSelectedRowsReference ()
	获取删除选中行的客户端脚本
string	GetDeleteSelectedRowsReference (bool forceUpdate)
	获取删除选中行的客户端脚本
string	GetHasSelectionReference ()
	获取表格是否有选中项的客户端脚本
string	GetSelectedCountReference ()
	获取表格选中项数的客户端脚本
string	GetSelectedCellReference ()
	获取表格选中单元格的客户端脚本（仅用于AllowCellEditing模式）
string	GetSelectCellReference (string rowId, string columnId)
	获取选中表格单元格的客户端脚本（仅用于AllowCellEditing模式）
string	GetSelectCellReference (int rowIndex, string columnId)
	获取选中表格单元格的客户端脚本（仅用于AllowCellEditing模式）
string	GetNoSelectionAlertReference (string message)
	获取表格没有任何选中项时在本窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertReference (string message, string title)
	获取表格没有任何选中项时在本窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertReference (string message, string title, MessageBoxIcon icon)
	获取表格没有任何选中项时在本窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertInParentReference (string message)
	获取表格没有任何选中项时在父级窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertInParentReference (string message, string title)
	获取表格没有任何选中项时在父级窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertInParentReference (string message, string title, MessageBoxIcon icon)
	获取表格没有任何选中项时在父级窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertInTopReference (string message)
	获取表格没有任何选中项时在顶级窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertInTopReference (string message, string title)
	获取表格没有任何选中项时在顶级窗口弹出提示对话框的客户端脚本
string	GetNoSelectionAlertInTopReference (string message, string title, MessageBoxIcon icon)
	获取表格没有任何选中项时在顶级窗口弹出提示对话框的客户端脚本
void	ConfigColumns (List< GridColumn > columns, GridConfigOptions configOptions, object dataSource)
	重新配置表格列并绑定数据
void	ConfigColumns (GridColumn[] columns, GridConfigOptions configOptions, object dataSource)
	重新配置表格列并绑定数据
string	GetSelectAllRowsReference ()
	获取选中所有行的脚本
string	GetDeselectAllRowsReference ()
	获取取消选中所有行的脚本
string	GetExpandRowExpandersReference ()
	获取展开全部行扩展列的脚本
string	GetCollapseRowExpandersReference ()
	获取折叠全部行扩展列的脚本
string	GetAppendDataReference (object dataSource)
	追加数据
string	GetLoadDataReference (string parentRowId, object dataSource)
	获取加载数据的脚本（启用树表格）
string	GetHideColumnReference (string columnId)
	获取隐藏列的脚本
string	GetShowColumnReference (string columnId)
	获取显示列的脚本
Public 成员函数 继承自 FineUI.Core.PanelBase
void	RefreshIFrame ()
	刷新面板中的IFrame页面
string	GetRefreshIFrameReference ()
	获取刷新面板中IFrame页面的客户端脚本
void	ClearDirty ()
	清空面板内表单字段的改变状态
string	GetClearDirtyReference ()
	获取清空面板内表单字段改变状态的客户端脚本
virtual void	Reset ()
	重置面板中所有字段
virtual string	GetResetReference ()
	获取重置面板中所有字段的客户端脚本
Public 成员函数 继承自 FineUI.Core.Component
void	ApplyStyles (string styles)
	设置控件样式
void	AddCssClass (string cssClass)
	添加控件样式类
void	RemoveCssClass (string cssClass)
	删除控件样式类
Public 成员函数 继承自 FineUI.Core.ControlBase
	ControlBase ()
	构造函数
bool	PropertyModified (string propertyName)
	回发过程中此属性是否被改变
bool	PropertyModified (params string[] propertyNames)
	回发过程中这些属性是否被改变
string	GetPostBackEventReference ()
	获取回发页面的客户端脚本
string	GetPostBackEventReference (string action)
	获取回发页面的客户端脚本
string	GetPostBackEventReference (string action, ParameterCollection parameters)
	获取回发页面的客户端脚本
string	GetPostBackEventReference (Event evt)
	获取回发页面的客户端脚本
virtual string	GetHideReference ()
	获取隐藏控件的客户端脚本
virtual string	GetShowReference ()
	获取显示控件的客户端脚本

静态 Public 属性
static readonly string	TEMPLATE_PLACEHOLDER_PREFIX = "#@TPL@#"
	模板列占位符前缀

属性
override bool	AutoScroll [get]
	不支持此属性
override ControlBaseCollection	Items [get]
	不支持此属性
override bool	EnableIFrame [get]
	不支持此属性
override string	IFrameUrl [get]
	不支持此属性
override string	IFrameName [get]
	不支持此属性
override LayoutType	Layout [get]
	布局类型
GridDisplayType	DisplayType [get, set]
	表格的显示类型
GridResponsiveCardSize	ResponsiveCardSize [get, set]
	响应式卡片断点（屏幕宽度≤该断点时自动切换为卡片模式，由屏幕主导）
string	CardRendererFunction [get, set]
	自定义卡片渲染器函数（JavaScript函数）
GridRowDensity	RowDensity [get, set]
	表格的行密度
bool	FixedRowHeight [get, set]
	行高度固定
int?	RowHeightLines [get, set]
	设置行高度可以容纳几行文字（也就是默认行高度的整数倍）
int?	RowHeight [get, set]
	行高度
int?	RowHeightCompact [get, set]
	紧凑模式下的行高度
int?	RowHeightSmall [get, set]
	小字体模式下的行高度
int?	RowHeightLarge [get, set]
	大字体模式下的行高度
int?	RowHeightLargeSpace [get, set]
	大间距模式下的行高度
bool	IncludeMergedData [get, set]
	是否在回发参数中包含修改后的合并数据（仅在启用单元格编辑时有效）
bool	AllowCellEditing [get, set]
	允许单元格编辑
bool	IsRowEditing [get, set]
	是否行编辑（仅在表格的AllowCellEditing=true时有效）
int	ClicksToEdit [get, set]
	编辑单元格时点击单元格的次数（默认为2次）
bool	AllowColumnLocking [get, set]
	允许列锁定
bool	ColumnLockingRight [get, set]
	是否启用右侧列锁定
bool	AllowFilters [get, set]
	允许过滤
bool	SeparateFilterMenu [get, set]
	是否启用单独的过滤菜单
bool	InlineFilters [get, set]
	是否内联过滤
JArray	FilteredData [get, set]
	过滤数据
JArray	ModifiedData [get, set]
	修改的数据（包含新增和删除的行信息）
JArray	MergedData [get, set]
	合并后的表格数据（包含修改和未修改的数据，不包含已经删除的行数据）
bool	AutoSelectEditor [get, set]
	单元格编辑时自动选中编辑框内的文本（默认为false）
bool	AllowPaging [get, set]
	允许服务器端分页
bool	IsDatabasePaging [get, set]
	是否数据库分页
bool	ClearSelectionBeforePaging [get, set]
	分页前清空选中项（客户端）
bool	ClearSelectionBeforeSorting [get, set]
	排序前清空选中项（客户端）
bool	ClearSelectionBeforeBinding [get, set]
	数据绑定前清空选中项（服务端调用DataBind方法时）
int	PageSize [get, set]
	每页显示项数
bool	ShowPageSizeSelector [get, set]
	是否显示页大小选择器（分页栏内的“每页记录数”下拉框）
string[]	PageSizeOptions [get, set]
	页大小可选项（如 10,20,50,100）。开启 ShowPageSizeSelector 但未设置时使用默认值
string	PageSizeText [get, set]
	页大小下拉框前的提示文字（未设置时使用本地化默认）
bool	PageSizeChangeResetsPageIndex [get, set]
	切换页大小是否重置到第一页（默认值：true）
int	MaxPagingNumberButton [get, set]
	最多显示数字分页按钮的个数（默认值：5）
int	PageIndex [get, set]
	当前显示页索引
int	PageCount [get]
	总页数
int	RecordCount [get, set]
	总记录数
string[]	SortFieldArray [get, set]
	排序字段列表（每个排序字段后面紧跟着排序方向，例如：["Name","ASC","EntranceYear","DESC"]）
bool	SortingMulti [get, set]
	支持多列排序
bool	SortingToolTip [get, set]
	显示列头的排序提示信息
bool	SortingCancel [get, set]
	允许点击列头来取消排序
bool	AllowSorting [get, set]
	允许服务器端排序
bool	IsDatabaseSorting [get, set]
	是否数据库排序（仅在启用网址数据源时有效）
string	SortDirection [get, set]
	排序方向("ASC", "DESC")
string	SortField [get, set]
	排序字段
bool	EnableSummary [get, set]
	启用合计行
JObject	SummaryData [get, set]
	合计行数据
JArray	SummaryDataArray [get, set]
	合计行数据
SummaryPosition	SummaryPosition [get, set]
	合计行的位置
int	SummaryRowCount [get, set]
	合计行的行数
string	DataUrl [get, set]
	网址数据源
string	DataMethod [get, set]
	请求网址数据源的方法（GET或者POST）
string	RowRendererFunction [get, set]
	自定义行渲染器函数（JavaScript函数）（推荐使用RowDataBoundFunction属性）
string	RowDataBoundFunction [get, set]
	自定义行数据绑定函数（JavaScript函数）
bool	EnableBigData [get, set]
	启用大数据模式
bool	EnableBigDataRowTip [get, set]
	启用大数据模式下的行数提示
BigDataRowTipPosition	BigDataRowTipPosition [get, set]
	大数据模式下行数提示的位置
bool	EnableRowGroup [get, set]
	启用行分组
string	DataRowGroupField [get, set]
	行数据分组字段名
bool	RowGroupCollapsible [get, set]
	是否显示行分组折叠图标
bool	RowGroupExpandOnDblClick [get, set]
	双击展开行分组节点
bool	ExpandAllRowGroups [get, set]
	展开所有的行分组
string	RowGroupRendererFunction [get, set]
	自定义行分组渲染器函数（JavaScript函数）
bool	RowGroupSummary [get, set]
	启用行分组合计行
int	RowGroupSummaryRowCount [get, set]
	行分组的合计行行数
string	SelectionMessageRendererFunction [get, set]
	自定义选中行消息渲染器函数（JavaScript函数）
bool	EnableRowHoverState [get, set]
	是否启用表格行的鼠标悬停样式
bool	ScrollTopAfterPaging [get, set]
	翻页后滚动到顶部（默认为false）
bool	ScrollTopAfterSorting [get, set]
	排序后滚动到顶部（默认为false）
bool	ClickOnContextMenu [get, set]
	右键点击时选中当前行（默认为true）
bool	EnableSimulateTree [get, set]
	是否启用模拟树显示
bool	ArrowKeySelection [get, set]
	箭头按键改变选中行和单元格
bool	MouseWheelSelection [get, set]
	鼠标滚轮改变选中行
bool	QuickPaging [get, set]
	是否启用快速翻页功能（上下按键或者鼠标滚轮改变选中行）
bool	QuickPagingThenSelect [get, set]
	快速翻页后自动选中第一行或者最后一行
int?	MinColumnWidth [get, set]
	最小列宽度
bool	DisableUnselectableRows [get, set]
	为不可选择的行应用禁用样式
bool	TabVerticalNavigate [get, set]
	Tab键纵向导航单元格
bool	TabEditableCell [get, set]
	Tab键只在可编辑单元格之间导航（仅用于单元格编辑）
bool	EnterSameAsTab [get, set]
	Enter键Tab键行为相同（仅用于单元格编辑）
bool	EnterNavigate [get, set]
	Enter键导航单元格（仅用于单元格编辑）
bool	EnterVerticalNavigate [get, set]
	Enter键纵向导航单元格（仅用于单元格编辑）
bool	EnterEditableCell [get, set]
	Enter键只在可编辑单元格之间导航（仅用于单元格编辑）
string	DataIDField [get, set]
	行数据标识字段名
string	DataTextField [get, set]
	行数据文本字段名
string	EmptyText [get, set]
	数据为空时显示在内容区域的文本，可以是HTML标签
bool	ShowEmptyIconText [get, set]
	数据为空且未设置EmptyText时，是否显示内置的「图标+文案」空状态（默认false，保持空白）
bool	EmptyTextRaw [get, set]
	EmptyText 是否为开发者信任的 HTML。为真时前端原样输出、不转义；默认 false 会做 HTML 转义（防 XSS）
RawHtml	EmptyTextRawHtml [get, set]
	把 EmptyText 设为可信 HTML 的便捷写法：赋值时同时设置 EmptyText 和 EmptyTextRaw=true；读取时若已标记可信则返回 RawHtml、否则返回 null
bool	ShowTooltipWhenTruncated [get, set]
	单元格tooltip仅在文本被列宽截断时显示（默认false）
VerticalAlign	RowVerticalAlign [get, set]
	行中文字的垂直排列位置（默认为Middle）
bool	EnableDelayRender [get, set]
	是否延迟渲染
bool	ExpandAllRowExpanders [get, set]
	展开所有的行扩展列
bool	EnableTextSelection [get, set]
	启用表格中的文字选择
bool	StoreDateAsString [get, set]
	在表格的客户端数据中，将日期对象存储为格式化后的字符串（仅用于FieldType=Date的列）
bool	ConvertLongToString [get, set]
	自动将表格数据源中的长整型转化为字符串（JavaScript无法处理精度大于16位的整数，会出现精度丢失的问题）
bool	HeaderSortIconVisible [get, set]
	始终显示表格标题栏排序图标
bool	HeaderFilterIconVisible [get, set]
	始终显示表格标题栏过滤图标
bool	PagingToolbarVisible [get, set]
	始终显示表格分页工具栏
bool	ShowPagingMessage [get, set]
	显示表格的分页信息
bool	ShowSelectionMessage [get, set]
	显示表格的选中行信息
bool	PagerAlignRight [get, set]
	表格分页控制按钮位于工具栏的右侧
bool	PagerAutoSimpleMode [get, set]
	窄屏自动简洁分页：分页栏宽度放不下时，自动把完整分页器降级为简洁形态（上一页 + 当前/总页 + 下一页）。默认关闭。
PagingType	PagingType [get, set]
	分页工具栏的显示类型
bool	ShowGridHeader [get, set]
	显示表格表头
bool	EnableHeaderMenu [get, set]
	启用表头菜单
bool	EnableHeaderMenuSort [get, set]
	启用排序菜单项
bool	EnableHeaderMenuColumns [get, set]
	启用隐藏列菜单项
bool	EnableColumnLines [get, set]
	启用表格列分隔线（默认为false）
bool	EnableColumnResize [get, set]
	是否启用列宽度调整
bool	EnableColumnMove [get, set]
	是否启用列拖拽排序
bool	EnableSameGroupColumnMove [get, set]
	是否启用同一分组内移动
bool	EnableRowLines [get, set]
	启用表格行分隔线（默认为true）
bool	EnableAlternateRowColor [get, set]
	启用交替行显示不同的颜色
bool	EnableMouseOverColor [get, set]
	启用鼠标移动到行的颜色
string	AutoExpandColumn [get, set]
	自动扩展宽度以填充剩余空间的列（ColumnID）
bool	ForceFit [get, set]
	成比例改变表格各列的宽度，防止出现水平滚动条（改变表格宽度之后此属性失效）
CheckBoxDisplayType	CheckBoxSelectDisplayType [get, set]
	多选框列的显示类型
int?	CheckBoxSelectWidth [get, set]
	多选框列的宽度
string	CheckBoxSelectHeaderText [get, set]
	多选框列的标题栏文字
bool	CheckBoxSelectHeaderTextRaw [get, set]
	CheckBoxSelectHeaderText 是否为开发者信任的 HTML。为真时前端原样输出、不转义；默认 false 会做 HTML 转义（防 XSS）
RawHtml	CheckBoxSelectHeaderTextRawHtml [get, set]
	把 CheckBoxSelectHeaderText 设为可信 HTML 的便捷写法：赋值时同时设置 CheckBoxSelectHeaderText 和 CheckBoxSelectHeaderTextRaw=true；读取时若已标记可信则返回 RawHtml、否则返回 null
bool	EnableCheckBoxSelect [get, set]
	启用多选框
bool	CheckBoxSelectOnly [get, set]
	只能通过多选框选中行（仅在启用EnableCheckBoxSelect属性时有效）
bool	CheckBoxSelectAutoHide [get, set]
	是否自动隐藏多选框（仅在启用EnableCheckBoxSelect属性时有效）
bool	EnableMultiSelect [get, set]
	启用多行选择
bool	KeepCurrentSelection [get, set]
	多选时保持当前已选中行（客户端）
bool	KeepPagedSelection [get, set]
	多选时保持分页中已选中行（客户端）
bool?	ShowSelectedCell [get, set]
	高亮显示选中的单元格
bool	ShowSelectedRow [get, set]
	高亮显示选中的行
string[]	SelectedCell [get, set]
	选中的单元格（[行ID,列标识符]）
string[]	HiddenColumns [get, set]
	隐藏的列标识符列表
int	SelectedRowIndex [get, set]
	选中行的索引（列表中的第一项）。行索引会随分页、排序和行移动变化， 请设置DataIDField并改用SelectedRowID。
int[]	SelectedRowIndexArray [get, set]
	选中行的索引列表（选中行在当前分页中的索引值）。行索引会随分页、排序和行移动变化， 请设置DataIDField并改用SelectedRowIDArray。
string	SelectedRowID [get, set]
	选中的行ID（当DataIDField属性存在时有效）
string[]	SelectedRowIDArray [get, set]
	选中的行ID列表（当DataIDField属性存在时有效）
object	DataSource [get, set]
	数据源
string[]	DataAttributeFields [get, set]
	行属性字段
string[]	DataKeyNames [get, set]
	行关键字段（仅RazorForms开发模式适用）。推荐同时设置DataIDField，并在本属性中包含该字段； 读取选中行数据时请使用GetSelectedDataKeys。
List< object[]>	DataKeys [get]
	行关键字段的值（仅RazorForms开发模式适用）。读取当前选中行时请使用GetSelectedDataKeys， 不要按行索引访问本列表。
virtual ControlBaseCollection	PageItems [get]
	分页工具条项集合
GridColumnCollection	Columns [get]
	列集合
virtual Collection< GridColumn >	AllColumns [get]
	全部的列
virtual GridRowCollection	Rows [get]
	行数据
bool	EnableTree [get, set]
	启用树表格
bool	ExpandAllTreeNodes [get, set]
	默认展开全部树节点（仅用于树表格）
string	DataParentIDField [get, set]
	行数据父节点标识字段名（仅用于树表格）
string	TreeColumn [get, set]
	显示树状层级的列标识符（ColumnID）（仅用于树表格）
bool	TreeExpandOnDblClick [get, set]
	双击展开树节点
bool	EnableTreeIcons [get, set]
	启用树节点图标
bool	TreeCheckBox [get, set]
	是否启用节点复选框（仅适用于树表格）
bool	TreeOnlyLeafCheck [get, set]
	是否只显示叶子节点复选框（仅适用于树表格）
bool	TreeOnlyFolderCheck [get, set]
	是否只显示目录节点复选框（仅适用于树表格）
bool	TreeCascadeCheck [get, set]
	是否启用级联选择（仅适用于树表格）
属性 继承自 FineUI.Core.CollapsablePanel
virtual bool	Expanded [get, set]
	是否展开
virtual bool	Collapsed [get, set]
	是否折叠
virtual bool	EnableCollapse [get, set]
	是否允许折叠
string	Title [get, set]
	标题
bool	TitleRaw [get, set]
	Title 是否为开发者信任的 HTML。为真时前端原样输出、不转义；默认 false 会做 HTML 转义（防 XSS）
RawHtml	TitleRawHtml [get, set]
	把 Title 设为可信 HTML 的便捷写法：赋值时同时设置 Title 和 TitleRaw=true；读取时若已标记可信则返回 RawHtml、否则返回 null
TextAlign	TitleAlign [get, set]
	标题文本的排列位置
string	TitleToolTip [get, set]
	标题的提示文本
ToolTipType	TitleToolTipType [get, set]
	标题的提示文本类型
ToolTipPosition	TitleToolTipPosition [get, set]
	标题的提示文本位置
virtual bool	ShowHeader [get, set]
	是否显示标题栏
string	IconUrl [get, set]
	图标地址
virtual Icon	Icon [get, set]
	预定义图标
IconFont	IconFont [get, set]
	预定义图标字体
string	IconFontClass [get, set]
	自定义图标字体的样式类
bool	RemoveLastFieldsMargin [get, set]
	移除最后一行中表单字段的底部外边距
bool	RemoveFieldsMargin [get, set]
	移除所有表单字段的底部外边距
属性 继承自 FineUI.Core.PanelBase
virtual bool	AutoScroll [get, set]
	是否自动滚动
bool?	EnableDefaultCorner [get, set]
	是否为圆角边框
bool	EnableTableStyle [get, set]
	是否启用表格样式
int?	MinHeight [get, set]
	最小高度
int?	MinWidth [get, set]
	最小宽度
int?	MaxHeight [get, set]
	最大高度
int?	MaxWidth [get, set]
	最大宽度
bool	EnableFrame [get, set]
	启用自定义的圆角边框
string	BodyClass [get, set]
	内容区域的样式类名
string	BodyStyle [get, set]
	内容区域的样式
virtual string	BodyPadding [get, set]
	内容区域的内边距（设置上右下左的内边距，比如'0px 5px'或'5px 10px 2px 2px'）
virtual bool	ShowBorder [get, set]
	是否显示边框
virtual bool	ShowBorderShadow [get, set]
	是否显示边框阴影效果
bool	IsViewPort [get, set]
	是否全屏视图（占据整个屏幕，仅适用于最外层控件）
bool	IsFluid [get, set]
	是否流式面板（占据整个宽度，仅适用于最外层控件）
bool	CustomToolAhead [get, set]
	自定义工具图标显示在系统工具图标的前面
virtual ToolbarCollection	Toolbars [get]
	工具栏控件集合
virtual ControlBaseCollection	Items [get]
	子控件集合
virtual ToolCollection	Tools [get]
	工具图标集合
string	Content [get, set]
	面板内容
string	ContentEl [get, set]
	面板内容的jQuery选择器
virtual JObject	IFrameAttributes [get, set]
	Iframe标签的属性
virtual string	IFrameUrl [get, set]
	IFrame的地址
virtual string	IFrameName [get, set]
	IFrame的名称
virtual bool	EnableIFrame [get, set]
	是否启用IFrame
属性 继承自 FineUI.Core.Container
override bool	FocusOnPageLoad [get]
	不支持此属性
bool	LayoutAfterImagesLoad [get, set]
	容器中的全部图片加载完毕后，对容器重新进行布局
virtual LayoutType	Layout [get, set]
	布局类型
属性 继承自 FineUI.Core.BoxComponent
int?	Width [get, set]
	宽度
int?	Height [get, set]
	高度
string	AnchorValue [get, set]
	锚点值（当父容器的Layout=Anchor时有效）
string	ColumnWidth [get, set]
	列的宽度（当父容器的Layout=Column时有效）
int?	AbsoluteX [get, set]
	绝对定位的X坐标（当父容器的Layout=Absolute时有效）
int?	AbsoluteY [get, set]
	绝对定位的Y坐标（当父容器的Layout=Absolute时有效）
int	TableConfigColumns [get, set]
	表格列数（当父容器的Layout=Table时有效）
int	TableRowspan [get, set]
	表格合并行（当父容器的Layout=Table时有效）
int	TableColspan [get, set]
	表格合并列（当父容器的Layout=Table时有效）
BoxLayoutAlign	BoxConfigAlign [get, set]
	控制子控件的位置（当本容器的Layout=VBox或者HBox时有效）
BoxLayoutPosition	BoxConfigPosition [get, set]
	控制子控件的位置（当本容器的Layout=VBox或者HBox时有效）
string	BoxConfigPadding [get, set]
	内边距（当本容器的Layout=VBox或者HBox时有效）
string	BoxConfigChildMargin [get, set]
	子控件的外边距（当本容器的Layout=VBox或者HBox时有效）
string	BoxConfigLastChildMargin [get, set]
	最后一个子控件的外边距（当本容器的Layout=VBox或者HBox时有效）
int?	BoxConfigSpace [get, set]
	子控件之间的间距（当本容器的Layout=VBox或者HBox时有效）
int	BoxFlex [get, set]
	控制子控件的尺寸（当父容器的Layout=VBox或者HBox时有效）
bool	RegionSplit [get, set]
	是否启用区域分隔条
bool	RegionSplitDraggable [get, set]
	区域分隔条是否可拖动
bool	RegionSplitIcon [get, set]
	是否显示区域分隔条图标
bool	RegionSplitTransparent [get, set]
	区域分隔条是否透明
int?	RegionSplitWidth [get, set]
	区域分隔条的宽度
string	RegionPercent [get, set]
	区域的百分比尺寸（当父容器的Layout=Region时有效）
bool	RegionSplitHeaderClass [get, set]
	是否为区域分隔条使用表头样式
Position	RegionPosition [get, set]
	区域所在的位置
int?	BlockConfigSpace [get, set]
	块间距（当本容器的Layout=Block时有效）
int	BlockConfigBlockCount [get, set]
	自定义总块数（当本容器的Layout=Block时有效）
int	Block [get, set]
	块大小，超小屏幕（当父容器的Layout=Block时有效）
int	BlockSM [get, set]
	块大小，小屏幕（当父容器的Layout=Block时有效）
int	BlockMD [get, set]
	块大小，中等屏幕（当父容器的Layout=Block时有效）
int	BlockLG [get, set]
	块大小，大屏幕（当父容器的Layout=Block时有效）
属性 继承自 FineUI.Core.Component
bool	EnableAjaxLoading [get, set]
	是否显示本控件发起的回发提示；未设置时沿用页面配置。
AjaxLoadingType	AjaxLoadingType [get, set]
	本控件发起回发时的提示类型；未设置时沿用页面配置。
string	AjaxLoadingText [get, set]
	本控件发起回发时的默认风格提示文本。
string	AjaxLoadingMaskText [get, set]
	本控件发起回发时的遮罩提示文本。
bool	ShowAjaxLoadingMaskText [get, set]
	本控件发起回发时是否显示遮罩提示文本。
virtual ? bool	EncodeText [get, set]
	是否在客户端进行HTML编码
virtual bool	FocusOnPageLoad [get, set]
	页面加载后立即获得焦点
virtual string	CssClass [get, set]
	控件样式类名
virtual string	CssStyle [get, set]
	控件样式
string	Margin [get, set]
	外边距
int?	MarginRight [get, set]
	右侧外边距
int?	MarginLeft [get, set]
	左侧外边距
int?	MarginTop [get, set]
	顶部外边距
int?	MarginBottom [get, set]
	底部外边距
属性 继承自 FineUI.Core.ControlBase
ControlBase	Parent [get]
	父控件
string	ProductName [get]
	产品名称
virtual string	ProductVersion [get]
	产品版本
virtual JObject	Attributes [get, set]
	HTML标签属性
string	AttributeDataTag [get, set]
	HTML标签属性（data-tag）
string	WrapperID [get]
	控件外部容器的客户端ID（比如：Button1_wrapper）
string	ID [get, set]
	控件ID
virtual bool	Enabled [get, set]
	是否可用
virtual bool	Hidden [get, set]
	是否隐藏控件
virtual HideMode	HideMode [get, set]
	隐藏模式
bool	IsFineUIAjaxPostBack [get]
	是否处于FineUI的AJAX回发过程
bool	IsFineUICoreAjaxPostBack [get]
	是否处于FineUI的AJAX回发过程
virtual ListenerCollection	Listeners [get, set]
	客户端事件列表
virtual EventCollection	Events [get, set]
	服务端事件列表

事件
EventHandler< GridRowDataBoundEventArgs >	RowDataBound
	行绑定事件（仅RazorForms开发模式适用）

详细描述

表格控件

构造及析构函数说明

Grid()

FineUI.Core.Grid.Grid

(

)

构造函数

成员函数说明

ConfigColumns() [1/2]

void FineUI.Core.Grid.ConfigColumns	(	GridColumn[]	columns,
		GridConfigOptions	configOptions,
		object	dataSource )

重新配置表格列并绑定数据

参数

columns
configOptions
dataSource

ConfigColumns() [2/2]

void FineUI.Core.Grid.ConfigColumns	(	List< GridColumn >	columns,
		GridConfigOptions	configOptions,
		object	dataSource )

重新配置表格列并绑定数据

参数

columns
configOptions
dataSource

DataBind() [1/2]

void FineUI.Core.Grid.DataBind

(

)

绑定到数据源

DataBind() [2/2]

void FineUI.Core.Grid.DataBind

(

bool

keepCurrentData

)

绑定到数据源

参数

keepCurrentData

是否保持当前数据

FindColumn() [1/2]

GridColumn FineUI.Core.Grid.FindColumn

(

int

columnIndex

)

通过列索引获取列实例

参数

columnIndex

列索引

返回

列实例

FindColumn() [2/2]

GridColumn FineUI.Core.Grid.FindColumn

(

string

columnID

)

通过列标识符获取列实例（如果列标识符未能匹配，尝试使用DataField匹配）

参数

columnID

列标识符

返回

列实例

FindCommand()

GridCommand FineUI.Core.Grid.FindCommand

(

string

commandName

)

通过行命令名称获取实例（仅RazorForms开发模式适用）

参数

commandName

返回

FindRow()

GridRow FineUI.Core.Grid.FindRow

(

int

rowIndex

)

通过行序号获取行对象

参数

rowIndex

行序号

返回

行对象

GetAddNewRecordReference() [1/5]

string FineUI.Core.Grid.GetAddNewRecordReference

(

JObject

defaultObject

)

获取添加一条新纪录的客户端脚本

参数

defaultObject

缺省值

返回

客户端脚本

GetAddNewRecordReference() [2/5]

string FineUI.Core.Grid.GetAddNewRecordReference	(	JObject	defaultObject,
		bool	appendToEnd )

获取添加一条新纪录的客户端脚本

参数

defaultObject	缺省值
appendToEnd	是否添加到末尾

返回

客户端脚本

GetAddNewRecordReference() [3/5]

string FineUI.Core.Grid.GetAddNewRecordReference	(	JObject	defaultObject,
		bool	appendToEnd,
		string	editColumnID )

获取添加一条新纪录的客户端脚本

参数

defaultObject	缺省值
appendToEnd	是否添加到末尾
editColumnID	添加后使某列处于编辑状态

返回

客户端脚本

GetAddNewRecordReference() [4/5]

string FineUI.Core.Grid.GetAddNewRecordReference	(	JObject	defaultObject,
		int	insertIndex )

获取添加一条新纪录的客户端脚本

参数

defaultObject	缺省值
insertIndex	插入的位置

返回

客户端脚本

GetAddNewRecordReference() [5/5]

string FineUI.Core.Grid.GetAddNewRecordReference	(	JObject	defaultObject,
		int	insertIndex,
		string	editColumnID )

获取添加一条新纪录的客户端脚本

参数

defaultObject	缺省值
insertIndex	插入的位置
editColumnID	添加后使某列处于编辑状态

返回

客户端脚本

GetAppendDataReference()

string FineUI.Core.Grid.GetAppendDataReference

(

object

dataSource

)

追加数据

参数

dataSource

GetClearSelectionsReference()

string FineUI.Core.Grid.GetClearSelectionsReference

(

)

获取清空表格选中项的客户端脚本

返回

客户端脚本

GetCollapseRowExpandersReference()

string FineUI.Core.Grid.GetCollapseRowExpandersReference

(

)

获取折叠全部行扩展列的脚本

返回

GetCommitChangesReference()

string FineUI.Core.Grid.GetCommitChangesReference

(

)

获取接受用户编辑单元格的客户端脚本（同时消除编辑单元格左上方的红色提示图标）

返回

客户端脚本

GetDeleteRowReference() [1/4]

string FineUI.Core.Grid.GetDeleteRowReference

(

int

rowIndex

)

获取删除指定行的客户端脚本

参数

rowIndex

行索引

返回

客户端脚本

GetDeleteRowReference() [2/4]

string FineUI.Core.Grid.GetDeleteRowReference	(	int	rowIndex,
		bool	forceUpdate )

获取删除指定行的客户端脚本

参数

rowIndex	行索引
forceUpdate	是否强制更新

返回

客户端脚本

GetDeleteRowReference() [3/4]

string FineUI.Core.Grid.GetDeleteRowReference

(

string

rowId

)

获取删除指定行的客户端脚本

参数

rowId

行ID

返回

客户端脚本

GetDeleteRowReference() [4/4]

string FineUI.Core.Grid.GetDeleteRowReference	(	string	rowId,
		bool	forceUpdate )

获取删除指定行的客户端脚本

参数

rowId	行ID
forceUpdate	是否强制更新

返回

客户端脚本

GetDeleteSelectedRowsReference() [1/2]

string FineUI.Core.Grid.GetDeleteSelectedRowsReference

(

)

获取删除选中行的客户端脚本

返回

客户端脚本

GetDeleteSelectedRowsReference() [2/2]

string FineUI.Core.Grid.GetDeleteSelectedRowsReference

(

bool

forceUpdate

)

获取删除选中行的客户端脚本

参数

forceUpdate

是否强制更新

返回

客户端脚本

GetDeselectAllRowsReference()

string FineUI.Core.Grid.GetDeselectAllRowsReference

(

)

获取取消选中所有行的脚本

返回

GetEndRowIndex()

int FineUI.Core.Grid.GetEndRowIndex

(

)

获取当前分页的结束行序号

返回

GetExpandRowExpandersReference()

string FineUI.Core.Grid.GetExpandRowExpandersReference

(

)

获取展开全部行扩展列的脚本

返回

GetHasSelectionReference()

string FineUI.Core.Grid.GetHasSelectionReference

(

)

获取表格是否有选中项的客户端脚本

返回

客户端脚本

GetHideColumnReference()

string FineUI.Core.Grid.GetHideColumnReference

(

string

columnId

)

获取隐藏列的脚本

参数

columnId

返回

GetLoadDataReference()

string FineUI.Core.Grid.GetLoadDataReference	(	string	parentRowId,
		object	dataSource )

获取加载数据的脚本（启用树表格）

参数

parentRowId
dataSource

返回

GetMergedData()

JArray FineUI.Core.Grid.GetMergedData

(

)

获取客户端回传的完整合并数据（包含修改和未修改的数据，不包含已经删除的行数据）

返回

完整合并数据；没有数据时返回空数组

GetModifiedData()

JArray FineUI.Core.Grid.GetModifiedData

(

)

获取用户在客户端修改、新增和删除的行数据

返回

用户修改的数据；没有改动时返回空数组

GetNoSelectionAlertInParentReference() [1/3]

string FineUI.Core.Grid.GetNoSelectionAlertInParentReference

(

string

message

)

获取表格没有任何选中项时在父级窗口弹出提示对话框的客户端脚本

参数

message

对话框消息

返回

客户端脚本

GetNoSelectionAlertInParentReference() [2/3]

string FineUI.Core.Grid.GetNoSelectionAlertInParentReference	(	string	message,
		string	title )

获取表格没有任何选中项时在父级窗口弹出提示对话框的客户端脚本

参数

message	对话框消息
title	对话框标题

返回

客户端脚本

GetNoSelectionAlertInParentReference() [3/3]

string FineUI.Core.Grid.GetNoSelectionAlertInParentReference	(	string	message,
		string	title,
		MessageBoxIcon	icon )

获取表格没有任何选中项时在父级窗口弹出提示对话框的客户端脚本

参数

message	对话框消息
title	对话框标题
icon	对话框图标

返回

客户端脚本

GetNoSelectionAlertInTopReference() [1/3]

string FineUI.Core.Grid.GetNoSelectionAlertInTopReference

(

string

message

)

获取表格没有任何选中项时在顶级窗口弹出提示对话框的客户端脚本

参数

message

对话框消息

返回

客户端脚本

GetNoSelectionAlertInTopReference() [2/3]

string FineUI.Core.Grid.GetNoSelectionAlertInTopReference	(	string	message,
		string	title )

获取表格没有任何选中项时在顶级窗口弹出提示对话框的客户端脚本

参数

message	对话框消息
title	对话框标题

返回

客户端脚本

GetNoSelectionAlertInTopReference() [3/3]

string FineUI.Core.Grid.GetNoSelectionAlertInTopReference	(	string	message,
		string	title,
		MessageBoxIcon	icon )

获取表格没有任何选中项时在顶级窗口弹出提示对话框的客户端脚本

参数

message	对话框消息
title	对话框标题
icon	对话框图标

返回

客户端脚本

GetNoSelectionAlertReference() [1/3]

string FineUI.Core.Grid.GetNoSelectionAlertReference

(

string

message

)

获取表格没有任何选中项时在本窗口弹出提示对话框的客户端脚本

返回

客户端脚本

GetNoSelectionAlertReference() [2/3]

string FineUI.Core.Grid.GetNoSelectionAlertReference	(	string	message,
		string	title )

获取表格没有任何选中项时在本窗口弹出提示对话框的客户端脚本

参数

message	对话框消息
title	对话框标题

返回

客户端脚本

GetNoSelectionAlertReference() [3/3]

string FineUI.Core.Grid.GetNoSelectionAlertReference	(	string	message,
		string	title,
		MessageBoxIcon	icon )

获取表格没有任何选中项时在本窗口弹出提示对话框的客户端脚本

参数

message	对话框消息
title	对话框标题
icon	对话框图标

返回

客户端脚本

GetRejectChangesReference()

string FineUI.Core.Grid.GetRejectChangesReference

(

)

获取拒绝用户编辑单元格的客户端脚本（同时消除编辑单元格左上方的红色提示图标）

GetSelectAllRowsReference()

string FineUI.Core.Grid.GetSelectAllRowsReference

(

)

获取选中所有行的脚本

返回

GetSelectCellReference() [1/2]

string FineUI.Core.Grid.GetSelectCellReference	(	int	rowIndex,
		string	columnId )

获取选中表格单元格的客户端脚本（仅用于AllowCellEditing模式）

参数

rowIndex	行索引
columnId	列标识符

返回

客户端脚本

GetSelectCellReference() [2/2]

string FineUI.Core.Grid.GetSelectCellReference	(	string	rowId,
		string	columnId )

获取选中表格单元格的客户端脚本（仅用于AllowCellEditing模式）

参数

rowId	行ID
columnId	列标识符

返回

客户端脚本

GetSelectedCellReference()

string FineUI.Core.Grid.GetSelectedCellReference

(

)

获取表格选中单元格的客户端脚本（仅用于AllowCellEditing模式）

返回

客户端脚本

GetSelectedCountReference()

string FineUI.Core.Grid.GetSelectedCountReference

(

)

获取表格选中项数的客户端脚本

返回

客户端脚本

GetSelectedDataKeys()

List< object[]> FineUI.Core.Grid.GetSelectedDataKeys

(

)

获取当前选中行的数据键。返回顺序与SelectedRowIDArray一致，每一项的字段顺序与DataKeyNames一致。 本方法通过DataIDField对应的数据键关联选中行，不依赖行索引，因此不受内存分页、排序和行移动影响。 推荐同时设置DataIDField和DataKeyNames，且DataKeyNames必须包含DataIDField； 返回值来自客户端回传，只能作为数据快照使用。

GetShowColumnReference()

string FineUI.Core.Grid.GetShowColumnReference

(

string

columnId

)

获取显示列的脚本

参数

columnId

返回

GetSortColumn()

GridColumn FineUI.Core.Grid.GetSortColumn

(

string

sortField

)

通过列排序字段获取列实例

参数

sortField

排序字段

返回

列实例

GetStartRowIndex()

int FineUI.Core.Grid.GetStartRowIndex

(

)

获取当前分页的起始行序号（不分页或者数据库分页时，返回零）

返回

GetUpdateCellValueReference() [1/4]

string FineUI.Core.Grid.GetUpdateCellValueReference	(	int	rowIndex,
		JObject	updateObject )

获取更新可编辑单元格值的客户端脚本

参数

rowIndex	行索引
updateObject	更新的值

返回

客户端脚本

GetUpdateCellValueReference() [2/4]

string FineUI.Core.Grid.GetUpdateCellValueReference	(	int	rowIndex,
		string	columnId,
		string	cellValue )

获取更新可编辑单元格值的客户端脚本

参数

rowIndex	行索引
columnId	列标识符
cellValue	单元格的值

返回

客户端脚本

GetUpdateCellValueReference() [3/4]

string FineUI.Core.Grid.GetUpdateCellValueReference	(	string	rowId,
		JObject	updateObject )

获取更新可编辑单元格值的客户端脚本

参数

rowId	行ID
updateObject	更新的值

返回

客户端脚本

GetUpdateCellValueReference() [4/4]

string FineUI.Core.Grid.GetUpdateCellValueReference	(	string	rowId,
		string	columnId,
		string	cellValue )

获取更新可编辑单元格值的客户端脚本

参数

rowId	行ID
columnId	列标识符
cellValue	单元格的值

返回

客户端脚本

类成员变量说明

TEMPLATE_PLACEHOLDER_PREFIX

readonly string FineUI.Core.Grid.TEMPLATE_PLACEHOLDER_PREFIX = "#@TPL@#"

static

模板列占位符前缀

属性说明

AllColumns

virtual Collection<GridColumn> FineUI.Core.Grid.AllColumns

get

全部的列

AllowCellEditing

bool FineUI.Core.Grid.AllowCellEditing

getset

允许单元格编辑

AllowColumnLocking

bool FineUI.Core.Grid.AllowColumnLocking

getset

允许列锁定

AllowFilters

bool FineUI.Core.Grid.AllowFilters

getset

允许过滤

AllowPaging

bool FineUI.Core.Grid.AllowPaging

getset

允许服务器端分页

AllowSorting

bool FineUI.Core.Grid.AllowSorting

getset

允许服务器端排序

ArrowKeySelection

bool FineUI.Core.Grid.ArrowKeySelection

getset

箭头按键改变选中行和单元格

AutoExpandColumn

string FineUI.Core.Grid.AutoExpandColumn

getset

自动扩展宽度以填充剩余空间的列（ColumnID）

AutoScroll

override bool FineUI.Core.Grid.AutoScroll

get

不支持此属性

AutoSelectEditor

bool FineUI.Core.Grid.AutoSelectEditor

getset

单元格编辑时自动选中编辑框内的文本（默认为false）

BigDataRowTipPosition

BigDataRowTipPosition FineUI.Core.Grid.BigDataRowTipPosition

getset

大数据模式下行数提示的位置

CardRendererFunction

string FineUI.Core.Grid.CardRendererFunction

getset

自定义卡片渲染器函数（JavaScript函数）

CheckBoxSelectAutoHide

bool FineUI.Core.Grid.CheckBoxSelectAutoHide

getset

是否自动隐藏多选框（仅在启用EnableCheckBoxSelect属性时有效）

CheckBoxSelectDisplayType

CheckBoxDisplayType FineUI.Core.Grid.CheckBoxSelectDisplayType

getset

多选框列的显示类型

CheckBoxSelectHeaderText

string FineUI.Core.Grid.CheckBoxSelectHeaderText

getset

多选框列的标题栏文字

CheckBoxSelectHeaderTextRaw

bool FineUI.Core.Grid.CheckBoxSelectHeaderTextRaw

getset

CheckBoxSelectHeaderText 是否为开发者信任的 HTML。为真时前端原样输出、不转义；默认 false 会做 HTML 转义（防 XSS）

CheckBoxSelectHeaderTextRawHtml

RawHtml FineUI.Core.Grid.CheckBoxSelectHeaderTextRawHtml

getset

把 CheckBoxSelectHeaderText 设为可信 HTML 的便捷写法：赋值时同时设置 CheckBoxSelectHeaderText 和 CheckBoxSelectHeaderTextRaw=true；读取时若已标记可信则返回 RawHtml、否则返回 null

CheckBoxSelectOnly

bool FineUI.Core.Grid.CheckBoxSelectOnly

getset

只能通过多选框选中行（仅在启用EnableCheckBoxSelect属性时有效）

CheckBoxSelectWidth

int? FineUI.Core.Grid.CheckBoxSelectWidth

getset

多选框列的宽度

ClearSelectionBeforeBinding

bool FineUI.Core.Grid.ClearSelectionBeforeBinding

getset

数据绑定前清空选中项（服务端调用DataBind方法时）

ClearSelectionBeforePaging

bool FineUI.Core.Grid.ClearSelectionBeforePaging

getset

分页前清空选中项（客户端）

ClearSelectionBeforeSorting

bool FineUI.Core.Grid.ClearSelectionBeforeSorting

getset

排序前清空选中项（客户端）

ClickOnContextMenu

bool FineUI.Core.Grid.ClickOnContextMenu

getset

右键点击时选中当前行（默认为true）

ClicksToEdit

int FineUI.Core.Grid.ClicksToEdit

getset

编辑单元格时点击单元格的次数（默认为2次）

ColumnLockingRight

bool FineUI.Core.Grid.ColumnLockingRight

getset

是否启用右侧列锁定

Columns

GridColumnCollection FineUI.Core.Grid.Columns

get

列集合

ConvertLongToString

bool FineUI.Core.Grid.ConvertLongToString

getset

自动将表格数据源中的长整型转化为字符串（JavaScript无法处理精度大于16位的整数，会出现精度丢失的问题）

DataAttributeFields

string [] FineUI.Core.Grid.DataAttributeFields

getset

行属性字段

DataIDField

string FineUI.Core.Grid.DataIDField

getset

行数据标识字段名

DataKeyNames

string [] FineUI.Core.Grid.DataKeyNames

getset

行关键字段（仅RazorForms开发模式适用）。推荐同时设置DataIDField，并在本属性中包含该字段； 读取选中行数据时请使用GetSelectedDataKeys。

DataKeys

List<object[]> FineUI.Core.Grid.DataKeys

get

行关键字段的值（仅RazorForms开发模式适用）。读取当前选中行时请使用GetSelectedDataKeys， 不要按行索引访问本列表。

DataMethod

string FineUI.Core.Grid.DataMethod

getset

请求网址数据源的方法（GET或者POST）

DataParentIDField

string FineUI.Core.Grid.DataParentIDField

getset

行数据父节点标识字段名（仅用于树表格）

DataRowGroupField

string FineUI.Core.Grid.DataRowGroupField

getset

行数据分组字段名

DataSource

object FineUI.Core.Grid.DataSource

getset

数据源

DataTextField

string FineUI.Core.Grid.DataTextField

getset

行数据文本字段名

DataUrl

string FineUI.Core.Grid.DataUrl

getset

网址数据源

DisableUnselectableRows

bool FineUI.Core.Grid.DisableUnselectableRows

getset

为不可选择的行应用禁用样式

DisplayType

GridDisplayType FineUI.Core.Grid.DisplayType

getset

表格的显示类型

EmptyText

string FineUI.Core.Grid.EmptyText

getset

数据为空时显示在内容区域的文本，可以是HTML标签

EmptyTextRaw

bool FineUI.Core.Grid.EmptyTextRaw

getset

EmptyText 是否为开发者信任的 HTML。为真时前端原样输出、不转义；默认 false 会做 HTML 转义（防 XSS）

EmptyTextRawHtml

RawHtml FineUI.Core.Grid.EmptyTextRawHtml

getset

把 EmptyText 设为可信 HTML 的便捷写法：赋值时同时设置 EmptyText 和 EmptyTextRaw=true；读取时若已标记可信则返回 RawHtml、否则返回 null

EnableAlternateRowColor

bool FineUI.Core.Grid.EnableAlternateRowColor

getset

启用交替行显示不同的颜色

EnableBigData

bool FineUI.Core.Grid.EnableBigData

getset

启用大数据模式

EnableBigDataRowTip

bool FineUI.Core.Grid.EnableBigDataRowTip

getset

启用大数据模式下的行数提示

EnableCheckBoxSelect

bool FineUI.Core.Grid.EnableCheckBoxSelect

getset

启用多选框

EnableColumnLines

bool FineUI.Core.Grid.EnableColumnLines

getset

启用表格列分隔线（默认为false）

EnableColumnMove

bool FineUI.Core.Grid.EnableColumnMove

getset

是否启用列拖拽排序

EnableColumnResize

bool FineUI.Core.Grid.EnableColumnResize

getset

是否启用列宽度调整

EnableDelayRender

bool FineUI.Core.Grid.EnableDelayRender

getset

是否延迟渲染

EnableHeaderMenu

bool FineUI.Core.Grid.EnableHeaderMenu

getset

启用表头菜单

EnableHeaderMenuColumns

bool FineUI.Core.Grid.EnableHeaderMenuColumns

getset

启用隐藏列菜单项

EnableHeaderMenuSort

bool FineUI.Core.Grid.EnableHeaderMenuSort

getset

启用排序菜单项

EnableIFrame

override bool FineUI.Core.Grid.EnableIFrame

get

不支持此属性

EnableMouseOverColor

bool FineUI.Core.Grid.EnableMouseOverColor

getset

启用鼠标移动到行的颜色

EnableMultiSelect

bool FineUI.Core.Grid.EnableMultiSelect

getset

启用多行选择

EnableRowGroup

bool FineUI.Core.Grid.EnableRowGroup

getset

启用行分组

EnableRowHoverState

bool FineUI.Core.Grid.EnableRowHoverState

getset

是否启用表格行的鼠标悬停样式

EnableRowLines

bool FineUI.Core.Grid.EnableRowLines

getset

启用表格行分隔线（默认为true）

EnableSameGroupColumnMove

bool FineUI.Core.Grid.EnableSameGroupColumnMove

getset

是否启用同一分组内移动

EnableSimulateTree

bool FineUI.Core.Grid.EnableSimulateTree

getset

是否启用模拟树显示

EnableSummary

bool FineUI.Core.Grid.EnableSummary

getset

启用合计行

EnableTextSelection

bool FineUI.Core.Grid.EnableTextSelection

getset

启用表格中的文字选择

EnableTree

bool FineUI.Core.Grid.EnableTree

getset

启用树表格

EnableTreeIcons

bool FineUI.Core.Grid.EnableTreeIcons

getset

启用树节点图标

EnterEditableCell

bool FineUI.Core.Grid.EnterEditableCell

getset

Enter键只在可编辑单元格之间导航（仅用于单元格编辑）

EnterNavigate

bool FineUI.Core.Grid.EnterNavigate

getset

Enter键导航单元格（仅用于单元格编辑）

EnterSameAsTab

bool FineUI.Core.Grid.EnterSameAsTab

getset

Enter键Tab键行为相同（仅用于单元格编辑）

EnterVerticalNavigate

bool FineUI.Core.Grid.EnterVerticalNavigate

getset

Enter键纵向导航单元格（仅用于单元格编辑）

ExpandAllRowExpanders

bool FineUI.Core.Grid.ExpandAllRowExpanders

getset

展开所有的行扩展列

ExpandAllRowGroups

bool FineUI.Core.Grid.ExpandAllRowGroups

getset

展开所有的行分组

ExpandAllTreeNodes

bool FineUI.Core.Grid.ExpandAllTreeNodes

getset

默认展开全部树节点（仅用于树表格）

FilteredData

JArray FineUI.Core.Grid.FilteredData

getset

过滤数据

FixedRowHeight

bool FineUI.Core.Grid.FixedRowHeight

getset

行高度固定

ForceFit

bool FineUI.Core.Grid.ForceFit

getset

成比例改变表格各列的宽度，防止出现水平滚动条（改变表格宽度之后此属性失效）

HeaderFilterIconVisible

bool FineUI.Core.Grid.HeaderFilterIconVisible

getset

始终显示表格标题栏过滤图标

HeaderSortIconVisible

bool FineUI.Core.Grid.HeaderSortIconVisible

getset

始终显示表格标题栏排序图标

HiddenColumns

string [] FineUI.Core.Grid.HiddenColumns

getset

隐藏的列标识符列表

IFrameName

override string FineUI.Core.Grid.IFrameName

get

不支持此属性

IFrameUrl

override string FineUI.Core.Grid.IFrameUrl

get

不支持此属性

IncludeMergedData

bool FineUI.Core.Grid.IncludeMergedData

getset

是否在回发参数中包含修改后的合并数据（仅在启用单元格编辑时有效）

InlineFilters

bool FineUI.Core.Grid.InlineFilters

getset

是否内联过滤

IsDatabasePaging

bool FineUI.Core.Grid.IsDatabasePaging

getset

是否数据库分页

IsDatabaseSorting

bool FineUI.Core.Grid.IsDatabaseSorting

getset

是否数据库排序（仅在启用网址数据源时有效）

IsRowEditing

bool FineUI.Core.Grid.IsRowEditing

getset

是否行编辑（仅在表格的AllowCellEditing=true时有效）

Items

override ControlBaseCollection FineUI.Core.Grid.Items

get

不支持此属性

KeepCurrentSelection

bool FineUI.Core.Grid.KeepCurrentSelection

getset

多选时保持当前已选中行（客户端）

KeepPagedSelection

bool FineUI.Core.Grid.KeepPagedSelection

getset

多选时保持分页中已选中行（客户端）

Layout

override LayoutType FineUI.Core.Grid.Layout

get

布局类型

MaxPagingNumberButton

int FineUI.Core.Grid.MaxPagingNumberButton

getset

最多显示数字分页按钮的个数（默认值：5）

MergedData

JArray FineUI.Core.Grid.MergedData

getset

合并后的表格数据（包含修改和未修改的数据，不包含已经删除的行数据）

此属性作为回发状态恢复入口和兼容 API 保留，业务代码请使用 GetMergedData()。

MinColumnWidth

int? FineUI.Core.Grid.MinColumnWidth

getset

最小列宽度

ModifiedData

JArray FineUI.Core.Grid.ModifiedData

getset

修改的数据（包含新增和删除的行信息）

此属性作为回发状态恢复入口和兼容 API 保留，业务代码请使用 GetModifiedData()。

MouseWheelSelection

bool FineUI.Core.Grid.MouseWheelSelection

getset

鼠标滚轮改变选中行

PageCount

int FineUI.Core.Grid.PageCount

get

总页数

PageIndex

int FineUI.Core.Grid.PageIndex

getset

当前显示页索引

PageItems

virtual ControlBaseCollection FineUI.Core.Grid.PageItems

get

分页工具条项集合

PagerAlignRight

bool FineUI.Core.Grid.PagerAlignRight

getset

表格分页控制按钮位于工具栏的右侧

PagerAutoSimpleMode

bool FineUI.Core.Grid.PagerAutoSimpleMode

getset

窄屏自动简洁分页：分页栏宽度放不下时，自动把完整分页器降级为简洁形态（上一页 + 当前/总页 + 下一页）。默认关闭。

PageSize

int FineUI.Core.Grid.PageSize

getset

每页显示项数

PageSizeChangeResetsPageIndex

bool FineUI.Core.Grid.PageSizeChangeResetsPageIndex

getset

切换页大小是否重置到第一页（默认值：true）

PageSizeOptions

string [] FineUI.Core.Grid.PageSizeOptions

getset

页大小可选项（如 10,20,50,100）。开启 ShowPageSizeSelector 但未设置时使用默认值

PageSizeText

string FineUI.Core.Grid.PageSizeText

getset

页大小下拉框前的提示文字（未设置时使用本地化默认）

PagingToolbarVisible

bool FineUI.Core.Grid.PagingToolbarVisible

getset

始终显示表格分页工具栏

PagingType

PagingType FineUI.Core.Grid.PagingType

getset

分页工具栏的显示类型

QuickPaging

bool FineUI.Core.Grid.QuickPaging

getset

是否启用快速翻页功能（上下按键或者鼠标滚轮改变选中行）

QuickPagingThenSelect

bool FineUI.Core.Grid.QuickPagingThenSelect

getset

快速翻页后自动选中第一行或者最后一行

RecordCount

int FineUI.Core.Grid.RecordCount

getset

总记录数

ResponsiveCardSize

GridResponsiveCardSize FineUI.Core.Grid.ResponsiveCardSize

getset

响应式卡片断点（屏幕宽度≤该断点时自动切换为卡片模式，由屏幕主导）

RowDataBoundFunction

string FineUI.Core.Grid.RowDataBoundFunction

getset

自定义行数据绑定函数（JavaScript函数）

RowDensity

GridRowDensity FineUI.Core.Grid.RowDensity

getset

表格的行密度

RowGroupCollapsible

bool FineUI.Core.Grid.RowGroupCollapsible

getset

是否显示行分组折叠图标

RowGroupExpandOnDblClick

bool FineUI.Core.Grid.RowGroupExpandOnDblClick

getset

双击展开行分组节点

RowGroupRendererFunction

string FineUI.Core.Grid.RowGroupRendererFunction

getset

自定义行分组渲染器函数（JavaScript函数）

RowGroupSummary

bool FineUI.Core.Grid.RowGroupSummary

getset

启用行分组合计行

RowGroupSummaryRowCount

int FineUI.Core.Grid.RowGroupSummaryRowCount

getset

行分组的合计行行数

RowHeight

int? FineUI.Core.Grid.RowHeight

getset

行高度

RowHeightCompact

int? FineUI.Core.Grid.RowHeightCompact

getset

紧凑模式下的行高度

RowHeightLarge

int? FineUI.Core.Grid.RowHeightLarge

getset

大字体模式下的行高度

RowHeightLargeSpace

int? FineUI.Core.Grid.RowHeightLargeSpace

getset

大间距模式下的行高度

RowHeightLines

int? FineUI.Core.Grid.RowHeightLines

getset

设置行高度可以容纳几行文字（也就是默认行高度的整数倍）

RowHeightSmall

int? FineUI.Core.Grid.RowHeightSmall

getset

小字体模式下的行高度

RowRendererFunction

string FineUI.Core.Grid.RowRendererFunction

getset

自定义行渲染器函数（JavaScript函数）（推荐使用RowDataBoundFunction属性）

Rows

virtual GridRowCollection FineUI.Core.Grid.Rows

get

行数据

RowVerticalAlign

VerticalAlign FineUI.Core.Grid.RowVerticalAlign

getset

行中文字的垂直排列位置（默认为Middle）

ScrollTopAfterPaging

bool FineUI.Core.Grid.ScrollTopAfterPaging

getset

翻页后滚动到顶部（默认为false）

ScrollTopAfterSorting

bool FineUI.Core.Grid.ScrollTopAfterSorting

getset

排序后滚动到顶部（默认为false）

SelectedCell

string [] FineUI.Core.Grid.SelectedCell

getset

选中的单元格（[行ID,列标识符]）

SelectedRowID

string FineUI.Core.Grid.SelectedRowID

getset

选中的行ID（当DataIDField属性存在时有效）

SelectedRowIDArray

string [] FineUI.Core.Grid.SelectedRowIDArray

getset

选中的行ID列表（当DataIDField属性存在时有效）

SelectedRowIndex

int FineUI.Core.Grid.SelectedRowIndex

getset

选中行的索引（列表中的第一项）。行索引会随分页、排序和行移动变化， 请设置DataIDField并改用SelectedRowID。

SelectedRowIndexArray

int [] FineUI.Core.Grid.SelectedRowIndexArray

getset

选中行的索引列表（选中行在当前分页中的索引值）。行索引会随分页、排序和行移动变化， 请设置DataIDField并改用SelectedRowIDArray。

SelectionMessageRendererFunction

string FineUI.Core.Grid.SelectionMessageRendererFunction

getset

自定义选中行消息渲染器函数（JavaScript函数）

SeparateFilterMenu

bool FineUI.Core.Grid.SeparateFilterMenu

getset

是否启用单独的过滤菜单

ShowEmptyIconText

bool FineUI.Core.Grid.ShowEmptyIconText

getset

数据为空且未设置EmptyText时，是否显示内置的「图标+文案」空状态（默认false，保持空白）

ShowGridHeader

bool FineUI.Core.Grid.ShowGridHeader

getset

显示表格表头

ShowPageSizeSelector

bool FineUI.Core.Grid.ShowPageSizeSelector

getset

是否显示页大小选择器（分页栏内的“每页记录数”下拉框）

ShowPagingMessage

bool FineUI.Core.Grid.ShowPagingMessage

getset

显示表格的分页信息

ShowSelectedCell

bool? FineUI.Core.Grid.ShowSelectedCell

getset

高亮显示选中的单元格

ShowSelectedRow

bool FineUI.Core.Grid.ShowSelectedRow

getset

高亮显示选中的行

ShowSelectionMessage

bool FineUI.Core.Grid.ShowSelectionMessage

getset

显示表格的选中行信息

ShowTooltipWhenTruncated

bool FineUI.Core.Grid.ShowTooltipWhenTruncated

getset

单元格tooltip仅在文本被列宽截断时显示（默认false）

SortDirection

string FineUI.Core.Grid.SortDirection

getset

排序方向("ASC", "DESC")

SortField

string FineUI.Core.Grid.SortField

getset

排序字段

SortFieldArray

string [] FineUI.Core.Grid.SortFieldArray

getset

排序字段列表（每个排序字段后面紧跟着排序方向，例如：["Name","ASC","EntranceYear","DESC"]）

SortingCancel

bool FineUI.Core.Grid.SortingCancel

getset

允许点击列头来取消排序

SortingMulti

bool FineUI.Core.Grid.SortingMulti

getset

支持多列排序

SortingToolTip

bool FineUI.Core.Grid.SortingToolTip

getset

显示列头的排序提示信息

StoreDateAsString

bool FineUI.Core.Grid.StoreDateAsString

getset

在表格的客户端数据中，将日期对象存储为格式化后的字符串（仅用于FieldType=Date的列）

SummaryData

JObject FineUI.Core.Grid.SummaryData

getset

合计行数据

SummaryDataArray

JArray FineUI.Core.Grid.SummaryDataArray

getset

合计行数据

SummaryPosition

SummaryPosition FineUI.Core.Grid.SummaryPosition

getset

合计行的位置

SummaryRowCount

int FineUI.Core.Grid.SummaryRowCount

getset

合计行的行数

TabEditableCell

bool FineUI.Core.Grid.TabEditableCell

getset

Tab键只在可编辑单元格之间导航（仅用于单元格编辑）

TabVerticalNavigate

bool FineUI.Core.Grid.TabVerticalNavigate

getset

Tab键纵向导航单元格

TreeCascadeCheck

bool FineUI.Core.Grid.TreeCascadeCheck

getset

是否启用级联选择（仅适用于树表格）

TreeCheckBox

bool FineUI.Core.Grid.TreeCheckBox

getset

是否启用节点复选框（仅适用于树表格）

TreeColumn

string FineUI.Core.Grid.TreeColumn

getset

显示树状层级的列标识符（ColumnID）（仅用于树表格）

TreeExpandOnDblClick

bool FineUI.Core.Grid.TreeExpandOnDblClick

getset

双击展开树节点

TreeOnlyFolderCheck

bool FineUI.Core.Grid.TreeOnlyFolderCheck

getset

是否只显示目录节点复选框（仅适用于树表格）

TreeOnlyLeafCheck

bool FineUI.Core.Grid.TreeOnlyLeafCheck

getset

是否只显示叶子节点复选框（仅适用于树表格）

事件说明

RowDataBound

EventHandler<GridRowDataBoundEventArgs> FineUI.Core.Grid.RowDataBound

行绑定事件（仅RazorForms开发模式适用）

---

该类的文档由以下文件生成:

• Grid.cs