参考手册

FineUI(开源版) 参考手册,包含所有控件的属性方法和事件的详细描述。

 全部  命名空间 函数 变量 枚举 枚举值 属性
| 枚举
包 FineUI

class  Container
 容器控件基类(抽象类) 更多...
 
class  PanelBase
 面板控件基类(抽象类) 更多...
 
class  CollapsablePanel
 可折叠面板控件基类(抽象类) 更多...
 
class  FormBase
 表单容器控件基类 更多...
 
class  Field
 表单字段基类(抽象类) 更多...
 
class  TooltipField
 支持提示的表单字段基类(抽象类) 更多...
 
class  TextField
 表单文本输入框字段基类(抽象类) 更多...
 
class  RealTextField
 表单文本输入框字段基类(抽象类) 更多...
 
class  BaseCollection< T >
 控件集合 更多...
 
class  ControlBase
 控件基类(抽象类) 更多...
 
class  ControlBaseCollection
 控件集合 更多...
 
class  Component
 控件基类(抽象类) 更多...
 
class  BoxComponent
 控件基类(抽象类) 更多...
 
class  ConfigSection
 FineUI在Web.config中的配置节 更多...
 
class  GlobalConfig
 全局配置参数 更多...
 
class  ControlBaseItemsEditor
 为设计时提供集合编辑器 更多...
 
class  GridColumnEditorEditor
 为设计时提供的表格列编辑器集合编辑器 更多...
 
class  GridColumnsEditor
 为设计时提供的表格列集合编辑器 更多...
 
class  MenuItemsEditor
 为设计时提供的菜单项集合编辑器 更多...
 
class  ToolbarItemsEditor
 为设计时提供的工具栏项集合编辑器 更多...
 
class  JsArrayBuilder
 创建Javascript数组参数的帮助类 更多...
 
class  JsHelper
 JavaScript帮助类 更多...
 
class  JsObjectBuilder
 创建Javascript对象参数的帮助类 更多...
 
class  ResourceHandler
 资源处理程序 更多...
 
class  ResourceHelper
 资源帮助类 更多...
 
class  ScriptModule
 请求处理模块(主要用来处理Response.Redirect的情况) 更多...
 
class  ControlUtil
 控件相关帮助函数 更多...
 
class  ExtDateTimeConvertor
 Extjs和.Net之间的日期格式转换 更多...
 
class  FState
 FineUI控件的状态保持机制 更多...
 
class  HtmlNodeBuilder
 创建HTML节点的帮助类 更多...
 
class  JSONUtil
 JSON帮助类 更多...
 
class  ObjectUtil
 对象帮助类 更多...
 
class  StringUtil
 字符串帮助类 更多...
 
class  StyleUtil
 样式帮助类 更多...
 
class  ActiveWindow
 当前活动窗体帮助类(静态类) 更多...
 
class  Alert
 对话框帮助类 更多...
 
class  Confirm
 确认对话框帮助类(静态类) 更多...
 
class  PageContext
 页面上下文帮助类(静态类),包括向页面注册脚本、刷新当前页面、页面重定向等实用函数 更多...
 
class  ToolbarFill
 工具栏左右分隔符控件 更多...
 
class  ToolbarSeparator
 工具栏分隔符控件 更多...
 
class  ToolbarText
 工具栏文本控件 更多...
 
class  Toolbar
 工具条控件 更多...
 
class  ToolbarCollection
 工具条控件集合 更多...
 
class  Button
 按钮控件 更多...
 
class  Calendar
 日期控件 更多...
 
class  Menu
 菜单控件 更多...
 
class  BaseMenuItem
 菜单项控件基类(抽象类) 更多...
 
class  MenuButton
 菜单项按钮控件 更多...
 
class  MenuCheckBox
 菜单项复选框控件(单选框) 更多...
 
class  MenuHyperLink
 菜单项超链接控件 更多...
 
class  MenuItem
 菜单项控件基类(抽象类) 更多...
 
class  MenuItemCollection
 菜单项控件集合 更多...
 
class  MenuSeparator
 菜单项分隔符控件 更多...
 
class  MenuText
 菜单项文本控件 更多...
 
class  SplitButton
 带下拉列表的按钮 更多...
 
class  PageLoading
 页面加载提示控件 更多...
 
class  CustomEventArgs
 自定义事件参数 更多...
 
class  PageManager
 页面配置管理器(每个页面必须包含一个 PageManager 控件) 更多...
 
class  Timer
 定时器控件 更多...
 
class  UserControlConnector
 用户控件的容器 更多...
 
class  CheckBox
 复选框控件 更多...
 
class  CheckedEventArgs
 复选框/单选框/复选框菜单按钮的事件参数 更多...
 
class  CheckBoxList
 复选框列表控件 更多...
 
class  CheckItem
 复选框列表项 更多...
 
class  CheckItemCollection
 复选项集合 更多...
 
class  HtmlEditor
 HTML编辑框控件 更多...
 
class  Label
 文本控件 更多...
 
class  HyperLink
 链接控件 更多...
 
class  Image
 图片控件 更多...
 
class  LinkButton
 链接按钮控件 更多...
 
class  RadioButton
 单选框控件 更多...
 
class  RadioButtonList
 单选框列表控件 更多...
 
class  RadioItem
 单项按钮项 更多...
 
class  RadioItemCollection
 单选项集合 更多...
 
class  DropDownList
 下拉列表控件 更多...
 
class  ListItem
 列表项 更多...
 
class  ListItemCollection
 列表项集合 更多...
 
class  DatePicker
 日期选择框控件 更多...
 
class  FileUpload
 文件上传控件 更多...
 
class  HiddenField
 隐藏表单控件 更多...
 
class  NumberBox
 数字输入框控件 更多...
 
class  TextArea
 多行文本框控件 更多...
 
class  TextBox
 文本框控件 更多...
 
class  TimePicker
 时间选择框控件 更多...
 
class  TriggerBox
 扩展文本框控件 更多...
 
class  TwinTriggerBox
 扩展文本框控件 更多...
 
class  Accordion
 手风琴控件 更多...
 
class  AccordionPane
 手风琴面板控件 更多...
 
class  AccordionPaneCollection
 手风琴面板控件集合 更多...
 
class  ContentPanel
 容器面板控件 更多...
 
class  Form
 表单面板控件 更多...
 
class  FormRow
 表单行控件 更多...
 
class  FormRowCollection
 表单行控件集合 更多...
 
class  GroupPanel
 分组面板控件 更多...
 
class  Panel
 面板控件 更多...
 
class  SimpleForm
 简单的表单容器控件 更多...
 
class  TreeCheckEventArgs
 树节点选中事件参数 更多...
 
class  TreeCommandEventArgs
 树节点命令事件参数 更多...
 
class  TreeExpandEventArgs
 树节点展开事件参数 更多...
 
class  Tree
 树控件 更多...
 
class  TreeNode
 树节点 更多...
 
class  TreeNodeCollection
 树节点控件集合 更多...
 
class  XmlAttributeMapping
 树节点的属性映射 更多...
 
class  XmlAttributeMappingCollection
 树节点的属性映射集合 更多...
 
class  WindowCloseEventArgs
 窗体关闭事件参数 更多...
 
class  Window
 窗体控件 更多...
 
class  GridColumnEditorCollection
 控件集合 更多...
 
class  GridAfterEditEventArgs
 表格行点击事件参数 更多...
 
class  GridCommandEventArgs
 表格行命令事件参数 更多...
 
class  GridPageEventArgs
 表格分页事件参数 更多...
 
class  GridPreRowEventArgs
 表格行预绑定事件参数 更多...
 
class  GridRowClickEventArgs
 表格行点击事件参数 更多...
 
class  GridRowEventArgs
 表格行绑定事件参数 更多...
 
class  GridRowSelectEventArgs
 表格行选中事件参数 更多...
 
class  GridSortEventArgs
 表格排序事件参数 更多...
 
class  Grid
 表格控件 更多...
 
class  BaseField
 表格列基类(抽象类) 更多...
 
class  BoundField
 表格数据绑定列 更多...
 
class  CheckBoxField
 表格复选框列 更多...
 
class  GridColumn
 表格列基类(抽象类) 更多...
 
class  GridColumnCollection
 表格列集合 更多...
 
class  GroupField
 表格分组列 更多...
 
class  HyperLinkField
 表格超链接列 更多...
 
class  ImageField
 表格图片列 更多...
 
class  LinkButtonField
 表格链接按钮列 更多...
 
class  RenderBaseField
 表格可编辑列的基类 更多...
 
class  RenderCheckField
 表格可编辑复选框列 更多...
 
class  RenderField
 表格可编辑列 更多...
 
class  RowNumberField
 表格数据绑定列 更多...
 
class  TemplateField
 表格模板列 更多...
 
class  WindowField
 表格窗体列 更多...
 
class  GridGroupColumn
 表格分组列 更多...
 
class  GridGroupColumnCollection
 表格分组列集合 更多...
 
class  GridRow
 表格行 更多...
 
class  GridRowCollection
 表格行控件集合 更多...
 
class  GridRowControl
 用来作为模板列的数据绑定容器,实现了IDataItemContainer接口 更多...
 
class  Region
 区域控件 更多...
 
class  RegionCollection
 Region控件集合 更多...
 
class  RegionPanel
 区域面板控件 更多...
 
class  Tab
 选项卡控件 更多...
 
class  TabCollection
 选项卡集合 更多...
 
class  TabStrip
 选项卡面板控件 更多...
 

枚举

enum  AjaxLoadingType { AjaxLoadingType.Default, AjaxLoadingType.Mask }
 Ajax提示信息的类型 更多...
 
enum  BoxLayoutAlign { BoxLayoutAlign.Top, BoxLayoutAlign.Middle, BoxLayoutAlign.Start, BoxLayoutAlign.Center, BoxLayoutAlign.Stretch, BoxLayoutAlign.StretchMax }
 在HBox布局或者VBox布局中,用来控制容器子控件的位置 更多...
 
enum  BoxLayoutPosition { BoxLayoutPosition.Left, BoxLayoutPosition.Center, BoxLayoutPosition.Right, BoxLayoutPosition.Start, BoxLayoutPosition.End }
 在HBox布局或者VBox布局中,用来控制容器子控件的位置 更多...
 
enum  ButtonSize { ButtonSize.Small, ButtonSize.Medium, ButtonSize.Large }
 按钮的大小 更多...
 
enum  ButtonType { ButtonType.Button, ButtonType.Submit, ButtonType.Reset }
 按钮类型 更多...
 
enum  CloseAction { CloseAction.Hide, CloseAction.HideRefresh, CloseAction.HidePostBack }
 关闭窗体的动作 更多...
 
enum  CollapseMode { CollapseMode.Default, CollapseMode.Mini }
 折叠模式(用于Region控件) 更多...
 
enum  CompareType { CompareType.Float, CompareType.Int, CompareType.String }
 相比较的数据类型(用于表单控件的客户端验证) 更多...
 
enum  FooterBarAlign { FooterBarAlign.Right, FooterBarAlign.Left, FooterBarAlign.Center }
 页脚工具栏的排列位置 更多...
 
enum  FieldType { FieldType.Auto, FieldType.String, FieldType.Int, FieldType.Float, FieldType.Boolean, FieldType.Date }
 表格可编辑字段的类型 更多...
 
enum  Renderer {
  Renderer.None, Renderer.Capitalize, Renderer.Date, Renderer.Ellipsis, Renderer.FileSize, Renderer.HtmlEncode, Renderer.HtmlDecode, Renderer.Lowercase,
  Renderer.Uppercase, Renderer.NL2BR, Renderer.Number, Renderer.StripScripts, Renderer.StripTags, Renderer.Trim, Renderer.UsMoney
}
 表格可编辑字段渲染器 更多...
 
enum  HideMode { HideMode.Visibility, HideMode.Offsets, HideMode.Display }
 隐藏的模式 更多...
 
enum  IconAlign { IconAlign.Top, IconAlign.Right, IconAlign.Bottom, IconAlign.Left }
 按钮上图标的摆放位置 更多...
 
enum  LabelAlign { LabelAlign.Left, LabelAlign.Right, LabelAlign.Top }
 表单中标签的排列位置 更多...
 
enum  Language { Language.EN, Language.ZH_CN, Language.ZH_TW, Language.PT_BR, Language.TR, Language.RU }
 语言 更多...
 
enum  Layout {
  Layout.Container, Layout.Anchor, Layout.Border, Layout.Fit, Layout.Accordion, Layout.Form, Layout.Card, Layout.Column,
  Layout.Absolute, Layout.Table, Layout.VBox, Layout.HBox
}
 布局类型 更多...
 
enum  MessageBoxIcon { MessageBoxIcon.Information, MessageBoxIcon.Warning, MessageBoxIcon.Question, MessageBoxIcon.Error }
 消息框图标类型 更多...
 
enum  MessageTarget { MessageTarget.Qtip, MessageTarget.Title, MessageTarget.Under, MessageTarget.Side, MessageTarget.None }
 表单客户端验证提示消息的类型 更多...
 
enum  Operator { Operator.Equal, Operator.GreaterThan, Operator.GreaterThanEqual, Operator.LessThan, Operator.LessThanEqual, Operator.NotEqual }
 操作符(用于表单控件的客户端验证) 更多...
 
enum  Position { Position.Top, Position.Bottom, Position.Left, Position.Right, Position.Center }
 Region控件所在RegionPanel中的位置 更多...
 
enum  RegexPattern {
  RegexPattern.None, RegexPattern.NUMBER, RegexPattern.ALPHA, RegexPattern.ALPHA_NUMERIC, RegexPattern.ALPHA_UNDERLINE, RegexPattern.ALPHA_NUMERIC_UNDERLINE, RegexPattern.ALPHA_LOWER_CASE, RegexPattern.ALPHA_UPPER_CASE,
  RegexPattern.EMAIL, RegexPattern.URL, RegexPattern.POSTAL_CODE, RegexPattern.IP_ADDRESS, RegexPattern.IDENTITY_CARD
}
 正则表达式常用类型(用于表单控件的客户端验证) 更多...
 
enum  SummaryPosition { SummaryPosition.Flow, SummaryPosition.Top, SummaryPosition.Bottom }
 表格合计行的位置 更多...
 
enum  TabPosition { TabPosition.Top, TabPosition.Bottom, TabPosition.Left, TabPosition.Right }
 Tab标签的显示位置 更多...
 
enum  Target { Target.Self, Target.Parent, Target.Top }
 窗体以及对话框的显示位置 更多...
 
enum  TextAlign { TextAlign.Left, TextAlign.Center, TextAlign.Right }
 文本排列位置 更多...
 
enum  TextMode { TextMode.Text, TextMode.Password }
 文本框类型 更多...
 
enum  Theme { Theme.Blue, Theme.Gray, Theme.Access, Theme.Neptune }
 样式 更多...
 
enum  ToolbarAlign { ToolbarAlign.Right, ToolbarAlign.Left, ToolbarAlign.Center }
 工具栏的排列位置 更多...
 
enum  ToolbarPosition { ToolbarPosition.Top, ToolbarPosition.Bottom, ToolbarPosition.Footer, ToolbarPosition.Left, ToolbarPosition.Right, ToolbarPosition.Buttons }
 工具条的位置 更多...
 
enum  ToolTipType { ToolTipType.Qtip, ToolTipType.Title }
 提示框的类型 更多...
 
enum  TriggerIcon { TriggerIcon.None, TriggerIcon.Search, TriggerIcon.Clear, TriggerIcon.Date }
 触发器输入框右侧图标的类型 更多...
 
enum  VerticalAlign { VerticalAlign.Middle, VerticalAlign.Top, VerticalAlign.Bottom }
 垂直排列位置 更多...
 
enum  WindowPosition { WindowPosition.Center, WindowPosition.GoldenSection }
 窗体的初始显示位置 更多...
 

枚举类型说明

Ajax提示信息的类型

枚举值
Default 

在页面顶部显示黄色提示框(默认值)

Mask 

Extjs的页面遮罩提示框

在HBox布局或者VBox布局中,用来控制容器子控件的位置

枚举值
Top 

所有子控件位于父容器的开始位置(废弃,请使用Start代替)

Middle 

所有子控件位于父容器的中间位置(废弃,请使用Center代替)

Start 

所有子控件位于父容器的开始位置(默认值)

Center 

所有子控件位于父容器的中间位置

Stretch 

所有子控件被拉伸至父容器的大小

StretchMax 

所有子控件被拉伸至最大子控件的大小

在HBox布局或者VBox布局中,用来控制容器子控件的位置

枚举值
Left 

子控件靠父容器的开始位置排列(废弃,请使用Start代替)

Center 

子控件靠父容器的中间位置排列

Right 

子控件靠父容器的结束位置排列(废弃,请使用End代替)

Start 

子控件靠父容器的开始位置排列(默认值)

End 

子控件靠父容器的结束位置排列

按钮的大小

枚举值
Small 

小尺寸(默认值)

Medium 

中等尺寸

Large 

大尺寸

按钮类型

枚举值
Button 

普通按钮(默认值)

Submit 

提交按钮(会为生成的input标签添加type="submit")

Reset 

重置按钮(会为生成的input标签添加type="reset")

关闭窗体的动作

枚举值
Hide 

关闭窗体(默认值)

HideRefresh 

关闭窗体后刷新父页面

HidePostBack 

关闭窗体后会发父页面(需要注册OnClose事件处理函数)

折叠模式(用于Region控件)

枚举值
Default 

通过点击工具栏上的按钮来折叠展开面板(默认值)

Mini 

通过点击面板分隔条上的迷你按钮来折叠展开面板

相比较的数据类型(用于表单控件的客户端验证)

枚举值
Float 

浮点数

Int 

整形

String 

字符串(默认值)

表格可编辑字段的类型

枚举值
Auto 

自动(默认值)

String 

字符串

Int 

整型

Float 

浮点数

Boolean 

布尔型

Date 

日期

页脚工具栏的排列位置

枚举值
Right 

靠右(默认值)

Left 

靠左

Center 

居中

隐藏的模式

枚举值
Visibility 

通过设置CSS属性visibility来控制显示隐藏

Offsets 

通过设置CSS属性top/left来控制显示隐藏

Display 

通过设置CSS属性display来控制显示隐藏(默认值)

按钮上图标的摆放位置

枚举值
Top 

靠上

Right 

靠右

Bottom 

靠下

Left 

靠左(默认值)

表单中标签的排列位置

枚举值
Left 

靠左(默认值)

Right 

靠右

Top 

靠上

语言

枚举值
EN 

英文

ZH_CN 

中文(默认值)

ZH_TW 

中文(台湾)

PT_BR 

葡萄牙文(巴西)

TR 

土耳其文

RU 

俄文

布局类型

枚举值
Container 

容器布局(默认值)

Anchor 

锚点布局

Border 

边框布局(只用于RegionPanel控件)

Fit 

自适应布局(用于只有一个子控件的情况)

Accordion 

手风琴布局(只用于Accordion控件)

Form 

表单布局(用于SimpleForm和Form控件)

Card 

卡片布局(只用于TabStrip控件)

Column 

列布局

Absolute 

绝对定位布局

Table 

表格布局

VBox 

垂直盒子布局

HBox 

水平盒子布局

消息框图标类型

枚举值
Information 

信息(默认值)

Warning 

警告

Question 

问题

Error 

错误

表单客户端验证提示消息的类型

枚举值
Qtip 

浮动提示(默认值)

Title 

使用HTML标签的title属性

Under 

在字段下面通过一个div层来显示消息

Side 

在字段右侧显示一个错误图标

None 

不显示错误信息

操作符(用于表单控件的客户端验证)

枚举值
Equal 

等于(默认值)

GreaterThan 

大于

GreaterThanEqual 

大于等于

LessThan 

小于

LessThanEqual 

小于等于

NotEqual 

不等于

Region控件所在RegionPanel中的位置

枚举值
Top 

上方

Bottom 

底部

Left 

左侧

Right 

右侧

Center 

中部(默认值)

正则表达式常用类型(用于表单控件的客户端验证)

枚举值
None 

无(默认值)

NUMBER 

数字

ALPHA 

字母

ALPHA_NUMERIC 

字母数字

ALPHA_UNDERLINE 

字母下划线

ALPHA_NUMERIC_UNDERLINE 

字母数字下划线

ALPHA_LOWER_CASE 

小写字母

ALPHA_UPPER_CASE 

大写字母

EMAIL 

电子邮箱

URL 

网址

POSTAL_CODE 

邮政编码(中华人民共和国)

IP_ADDRESS 

IP地址

IDENTITY_CARD 

身份证(中华人民共和国)

表格可编辑字段渲染器

枚举值
None 

无(默认值)

Capitalize 

首字母大写

Date 

日期(RendererArgument来指定日期格式化字符串) RendererArgument:

  1. d 月中的某一天。一位数的日期没有前导零。
  2. dd 月中的某一天。一位数的日期有一个前导零。
  3. ddd 周中某天的缩写名称,在 AbbreviatedDayNames 中定义。
  4. dddd 周中某天的完整名称,在 DayNames 中定义。
  5. M 月份数字。一位数的月份没有前导零。
  6. MM 月份数字。一位数的月份有一个前导零。
  7. MMM 月份的缩写名称,在 AbbreviatedMonthNames 中定义。
  8. MMMM 月份的完整名称,在 MonthNames 中定义。
  9. y 不包含纪元的年份。如果不包含纪元的年份小于 10,则显示不具有前导零的年份。
  10. yy 不包含纪元的年份。如果不包含纪元的年份小于 10,则显示具有前导零的年份。
  11. yyyy 包括纪元的四位数的年份。
Ellipsis 

截断字符串并添加省略号(RendererArgument来指定最大长度)

FileSize 

文件大小

HtmlEncode 

HTML编码

HtmlDecode 

HTML解码

Lowercase 

转化为小写字符

Uppercase 

转化为大写字符

NL2BR 

换行符转换为HTML标签

Number 

格式化为数字(RendererArgument来指定数字的显示格式) RendererArgument:

  1. 0 - (123456) 只显示数字,没有精度
  2. 0.00 - (123456.78) 只显示数字,两位精度
  3. 0.0000 - (123456.7890) 只显示数字,四位精度
  4. 0,000 - (123,456) 显示数字和逗号,没有精度
  5. 0,000.00 - (123,456.78) 显示数字和逗号,两位精度
StripScripts 

删除所有的脚本标签

StripTags 

删除所有的标签

Trim 

清除字符串两端的空白字符

UsMoney 

美元

表格合计行的位置

枚举值
Flow 

紧跟数据行(默认值)

Top 

表格顶部

Bottom 

表格底部

Tab标签的显示位置

枚举值
Top 

顶部(默认值)

Bottom 

底部

Left 

左侧

Right 

右侧

窗体以及对话框的显示位置

枚举值
Self 

当前页面(默认值)

Parent 

父页面

Top 

最外层页面

文本排列位置

枚举值
Left 

靠左排列(默认值)

Center 

居中排列

Right 

靠右排列

文本框类型

枚举值
Text 

普通文本框(默认值)

Password 

密码输入框

样式

枚举值
Blue 

蓝色

Gray 

银灰色

Access 

高对比度

Neptune 

海王星(默认值)

工具栏的排列位置

枚举值
Right 

靠右

Left 

靠左(默认值)

Center 

居中

工具条的位置

枚举值
Top 

顶部(默认值)

Bottom 

底部

Footer 

页脚

Left 

左侧

Right 

右侧

Buttons 

底部按钮

提示框的类型

枚举值
Qtip 

Extjs的浮动提示框(默认值)

Title 

HTML标签的title属性

触发器输入框右侧图标的类型

枚举值
None 

无(默认值)

Search 

搜索图标

Clear 

清空图标

Date 

日期图标

垂直排列位置

枚举值
Middle 

居中排列(默认值)

Top 

靠上排列

Bottom 

靠下排列

窗体的初始显示位置

枚举值
Center 

页面的中部

GoldenSection 

页面的黄金分割点处(默认值)