FineUIPro 16.0.0
.NET 企业级全栈 UI 框架
载入中...
搜索中...
未找到
FineUIPro.Tool类 参考

工具图标控件 更多...

类 FineUIPro.Tool 继承关系图:
FineUIPro.Component FineUIPro.ControlBase

Public 成员函数

 Tool ()
 构造函数
void RaisePostBackEvent (string eventArgument)
 处理回发事件
Public 成员函数 继承自 FineUIPro.Component
 Component ()
 构造函数
Public 成员函数 继承自 FineUIPro.ControlBase
 ControlBase ()
 构造函数
override void RenderControl (HtmlTextWriter writer)
 重载 RenderControl,为了向子控件公开 RenderBeginTag 和 RenderEndTag 两个方法
bool PropertyModified (string propertyName)
 回发过程中此属性是否被改变 如果是客户端可以改变的属性,仅在服务器端改变时才返回 true, (如果仅是客户端改变,则返回 false,因为客户端改变的属性不需要再输出相应的 JavaScript 脚本)
bool PropertyModified (params string[] propertyNames)
 回发过程中这些属性是否被改变 只要任何属性被改变,就返回 true
void RecoverPropertiesFromJObject (JObject state)
 从JObject恢复控件的属性
JObject ConvertPropertiesToJObject (List< string > propertyList)
 将控件的属性列表转化为JObject对象
string GetPostBackEventReference ()
 获取使用当前控件默认 F.js 客户端事件名的回发脚本(比如:__doPostBack('btnChangeEnable','click');)
string GetPostBackEventReference (string eventArgument)
 获取使用明确 F.js 客户端事件名及业务参数的回发脚本(比如:__doPostBack('Grid1','paging$2$1');)
string GetPostBackEventReference (string eventArgument, bool enableAjax)
 获取使用明确 F.js 客户端事件名及业务参数的回发脚本
string GetPostBackEventReference (string eventArgument, bool enableAjax, bool persistOriginal)
 获取使用明确 F.js 客户端事件名及业务参数的回发脚本

属性

short? TabIndex [get, set]
 Tab键索引(默认为-1)
string OnClientClick [get, set]
 [AJAX属性]点击按钮时需要执行的客户端脚本
string ClickHandler [get, set]
 客户端 click 事件的处理函数名称(回调首参为 event;等价于在 Listeners 中声明 click 事件)。仅接受开发者可信的函数名,绝不能拼入用户输入(该值会原样输出为 JavaScript)。回发中修改本属性会推送到已渲染的页面(客户端 setClickHandler,只下发函数名、不下发脚本)
bool EnablePostBack [get, set]
 当前点击是否自动回发。未显式设置时,由 Click 事件和 EnableImplicitPostBack 决定有效值
Icon Icon [get, set]
 [AJAX属性]预定义图标
string IconUrl [get, set]
 [AJAX属性]图标地址
IconFont IconFont [get, set]
 [AJAX属性]预定义图标字体
string IconFontClass [get, set]
 [AJAX属性]自定义图标字体的样式类
string ToolTip [get, set]
 [AJAX属性]提示文本
bool ToolTipRaw [get, set]
 ToolTip 是否为开发者信任的 HTML。为真时前端原样输出、不转义;默认 false 会做 HTML 转义(防 XSS)
RawHtml ToolTipRawHtml [get, set]
 把 ToolTip 设为可信 HTML 的便捷写法:赋值时同时设置 ToolTip 和 ToolTipRaw=true;读取时若已标记可信则返回 RawHtml、否则返回 null
ToolTipType ToolTipType [get, set]
 提示文本类型
ToolTipPosition ToolTipPosition [get, set]
 提示文本的位置
string Text [get, set]
 [AJAX属性]文本
bool TextRaw [get, set]
 Text 是否为开发者信任的 HTML。为真时前端原样输出、不转义;默认 false 会做 HTML 转义(防 XSS)
RawHtml TextRawHtml [get, set]
 把 Text 设为可信 HTML 的便捷写法:赋值时同时设置 Text 和 TextRaw=true;读取时若已标记可信则返回 RawHtml、否则返回 null
bool DisableControlBeforePostBack [get, set]
 回发之前禁用控件(防止重复提交)
string[] ValidateForms [get, set]
 需要验证的表单名称列表(逗号分隔)
Target ValidateTarget [get, set]
 验证失败时提示对话框弹出位置
bool ValidateMessageBox [get, set]
 验证失败时是否出现提示对话框
bool ValidateMessageBoxPlain [get, set]
 是否简单提示对话框
string ConfirmTitle [get, set]
 [AJAX属性]确认对话框标题
string ConfirmText [get, set]
 [AJAX属性]确认对话框内容
bool ConfirmTextRaw [get, set]
 ConfirmText 是否为开发者信任的 HTML。为真时确认框原样输出、不转义;默认 false 会做 HTML 转义(防 XSS)
RawHtml ConfirmTextRawHtml [get, set]
 把 ConfirmText 设为可信 HTML 的便捷写法:赋值时同时设置 ConfirmText 和 ConfirmTextRaw=true;读取时若已标记可信则返回 RawHtml、否则返回 null
MessageBoxIcon ConfirmIcon [get, set]
 [AJAX属性]确认对话框提示图标
Target ConfirmTarget [get, set]
 [AJAX属性]确认对话框弹出位置
string MenuID [get, set]
 按钮的上下文菜单
Menu Menu [get]
 按钮的上下文菜单
属性 继承自 FineUIPro.Component
virtual ? bool EncodeText [get, set]
virtual bool FocusOnPageLoad [get, set]
 页面加载后立即获得焦点
virtual string CssClass [get, set]
 [AJAX属性]控件样式类名
virtual string CssStyle [get, set]
 [AJAX属性]控件样式
string Margin [get, set]
 外边距
Unit MarginRight [get, set]
 右侧外边距
Unit MarginLeft [get, set]
 左侧外边距
Unit MarginTop [get, set]
 顶部外边距
Unit MarginBottom [get, set]
 底部外边距
属性 继承自 FineUIPro.ControlBase
override bool EnableViewState [get]
 不支持此属性
override string ClientID [get]
 控件的客户端ID(比如:RegionPanel1_Button1)
string WrapperID [get]
 控件外部容器的客户端ID(比如:Button1_wrapper)
string ProductName [get]
 产品名称
virtual string ProductVersion [get]
 产品版本
virtual JObject Attributes [get, set]
 HTML标签属性
string AttributeDataTag [get, set]
 HTML标签属性(data-tag)
override string ID [get, set]
 控件ID
virtual bool Enabled [get, set]
 [AJAX属性]是否可用
bool RenderToClient [get, set]
 指示控件是否被渲染出来(显示隐藏控件,请使用Hidden属性)
override bool Visible [get]
 是否向前台输出控件(避免使用此属性!!如果要显示隐藏控件,请使用Hidden属性)
virtual bool Hidden [get, set]
 [AJAX属性]是否隐藏控件
virtual HideMode HideMode [get, set]
 隐藏模式
virtual bool EnableAjax [get, set]
 是否启用AJAX
bool EnableAjaxLoading [get, set]
 是否启用Ajax正在加载提示
AjaxLoadingType AjaxLoadingType [get, set]
 Ajax正在加载提示的类型
string AjaxLoadingText [get, set]
 AJAX提示的文本
string AjaxLoadingMaskText [get, set]
 Mask类型的AJAX提示文本
bool ShowAjaxLoadingMaskText [get, set]
 是否显示Mask类型的提示文本
bool IsFineUIAjaxPostBack [get]
 是否处于FineUI的AJAX回发过程
bool IsFineUIProAjaxPostBack [get]
 是否处于FineUI的AJAX回发过程
virtual ListenerCollection Listeners [get]
 客户端事件列表

事件

EventHandler Click [add, remove]
 按钮点击事件

详细描述

工具图标控件

构造及析构函数说明

◆ Tool()

FineUIPro.Tool.Tool ( )

构造函数

成员函数说明

◆ RaisePostBackEvent()

void FineUIPro.Tool.RaisePostBackEvent ( string eventArgument)

处理回发事件

参数
eventArgument事件参数

属性说明

◆ ClickHandler

string FineUIPro.Tool.ClickHandler
getset

客户端 click 事件的处理函数名称(回调首参为 event;等价于在 Listeners 中声明 click 事件)。仅接受开发者可信的函数名,绝不能拼入用户输入(该值会原样输出为 JavaScript)。回发中修改本属性会推送到已渲染的页面(客户端 setClickHandler,只下发函数名、不下发脚本)

◆ ConfirmIcon

MessageBoxIcon FineUIPro.Tool.ConfirmIcon
getset

[AJAX属性]确认对话框提示图标

◆ ConfirmTarget

Target FineUIPro.Tool.ConfirmTarget
getset

[AJAX属性]确认对话框弹出位置

◆ ConfirmText

string FineUIPro.Tool.ConfirmText
getset

[AJAX属性]确认对话框内容

◆ ConfirmTextRaw

bool FineUIPro.Tool.ConfirmTextRaw
getset

ConfirmText 是否为开发者信任的 HTML。为真时确认框原样输出、不转义;默认 false 会做 HTML 转义(防 XSS)

◆ ConfirmTextRawHtml

RawHtml FineUIPro.Tool.ConfirmTextRawHtml
getset

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

◆ ConfirmTitle

string FineUIPro.Tool.ConfirmTitle
getset

[AJAX属性]确认对话框标题

◆ DisableControlBeforePostBack

bool FineUIPro.Tool.DisableControlBeforePostBack
getset

回发之前禁用控件(防止重复提交)

◆ EnablePostBack

bool FineUIPro.Tool.EnablePostBack
getset

当前点击是否自动回发。未显式设置时,由 Click 事件和 EnableImplicitPostBack 决定有效值

◆ Icon

Icon FineUIPro.Tool.Icon
getset

[AJAX属性]预定义图标

◆ IconFont

IconFont FineUIPro.Tool.IconFont
getset

[AJAX属性]预定义图标字体

◆ IconFontClass

string FineUIPro.Tool.IconFontClass
getset

[AJAX属性]自定义图标字体的样式类

◆ IconUrl

string FineUIPro.Tool.IconUrl
getset

[AJAX属性]图标地址

◆ Menu

Menu FineUIPro.Tool.Menu
get

按钮的上下文菜单

◆ MenuID

string FineUIPro.Tool.MenuID
getset

按钮的上下文菜单

◆ OnClientClick

string FineUIPro.Tool.OnClientClick
getset

[AJAX属性]点击按钮时需要执行的客户端脚本

不推荐:值是一段内联脚本,服务端会把它下发成一个独立的客户端函数,排在 click 事件之前执行(点击链条:表单验证 → beforeclick → 本属性 → click 事件 → 确认框与回发)。客户端点击逻辑请改用 ClickHandler(页面里写具名函数、属性填函数名);要中断后续动作,脚本里必须写 return false,别的返回值一律按「继续」处理。服务端注册 / 回发中改变客户端点击回调,也请用 ClickHandler;本属性只为兼容存量代码保留。

◆ TabIndex

short? FineUIPro.Tool.TabIndex
getset

Tab键索引(默认为-1)

◆ Text

string FineUIPro.Tool.Text
getset

[AJAX属性]文本

◆ TextRaw

bool FineUIPro.Tool.TextRaw
getset

Text 是否为开发者信任的 HTML。为真时前端原样输出、不转义;默认 false 会做 HTML 转义(防 XSS)

◆ TextRawHtml

RawHtml FineUIPro.Tool.TextRawHtml
getset

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

◆ ToolTip

string FineUIPro.Tool.ToolTip
getset

[AJAX属性]提示文本

◆ ToolTipPosition

ToolTipPosition FineUIPro.Tool.ToolTipPosition
getset

提示文本的位置

◆ ToolTipRaw

bool FineUIPro.Tool.ToolTipRaw
getset

ToolTip 是否为开发者信任的 HTML。为真时前端原样输出、不转义;默认 false 会做 HTML 转义(防 XSS)

◆ ToolTipRawHtml

RawHtml FineUIPro.Tool.ToolTipRawHtml
getset

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

◆ ToolTipType

ToolTipType FineUIPro.Tool.ToolTipType
getset

提示文本类型

◆ ValidateForms

string [] FineUIPro.Tool.ValidateForms
getset

需要验证的表单名称列表(逗号分隔)

◆ ValidateMessageBox

bool FineUIPro.Tool.ValidateMessageBox
getset

验证失败时是否出现提示对话框

◆ ValidateMessageBoxPlain

bool FineUIPro.Tool.ValidateMessageBoxPlain
getset

是否简单提示对话框

◆ ValidateTarget

Target FineUIPro.Tool.ValidateTarget
getset

验证失败时提示对话框弹出位置

事件说明

◆ Click

EventHandler FineUIPro.Tool.Click
addremove

按钮点击事件


该类的文档由以下文件生成:
  • Tool.cs