MvcCaptcha 帮助文档 — MvcCaptchaOptions 类

表示包含MvcCaptcha验证码控件相关选项和设置的对象。

公共属性:

Width:获取或设置验证码图片的宽度。
语法(C#):public int Width {get;set;}
属性值:System.Int32。
备注:单位为象素,默认值为160,最小值为TextLength属性值*18。
Height:获取或设置验证码图片的高度。
语法(C#):public int Height {get;set;}
属性值:System.Int32。
备注:单位为象素,默认值为40,最小值为32,低于32时将默认为32。
TextLength:获取或设置验证码文本个数。
语法(C#):public int TextLength {get;set;}
属性值:System.Int32。
备注:默认值为4,最小值为3,低于3时将默认为3。
TextChars:获取或设置用于生成验证码文本的字符。
语法(C#):public string TextChars {get;set;}
属性值:System.String。
备注:默认值为“ACDEFGHJKLMNPQRSTUVWXYZ2346789”,之所以未包含B、I、O三个字母和0、1、5三个数字是因为这些字符或数字相似度太高(O与0、B与8、I与1、5与S等),不容易辨别。若该属性值设置的字符串总长度小于3时,将使用默认值。
FontWarp:获取或设置验证码图片文本扭曲程度。
语法(C#):public Level FontWarp {get;set;}
属性值:Webdiyer.WebControls.Mvc.Level
备注:默认值为Level.Medium。
BackgroundNoise:获取或设置验证码图片背景杂色级别。
语法(C#):public Level BackgroundNoise {get;set;}
属性值:Webdiyer.WebControls.Mvc.Level
备注:默认值为Level.Low。
LineNoise:获取或设置验证码图片干扰线条级别。
语法(C#):public Level LineNoise {get;set;}
属性值:Webdiyer.WebControls.Mvc.Level
备注:默认值为Level.Low。
ValidationInputBoxId:获取或设置验证码输入文本框的客户端Id。
语法(C#):public string ValidationInputBoxId {get;set;}
属性值:System.String。
备注:当DelayLoad属性设为true时,必须指定该值,验证码控件通过监视验证码输入文本框的激活状态来决定是否生成并加载图片,如果该值对应的文本框不存在,则验证码图片无法生成并加载。
CaptchaImageContainerId:获取或设置包含验证码图片控件的父容器的客户端Id。
语法(C#):public string CaptchaImageContainerId {get;set;}
属性值:System.String。
备注:当DelayLoad属性设为true时,必须指定该值,当验证码文本输入框被激活(获得焦点)时,验证码控件将通过Ajax加载验证码图片并将图片显示在该值对应的容器元素中,如果该元素不存在,则验证码图片无法显示。
ReloadLinkText:获取或设置重新加载验证码图片超链接的文本。
语法(C#):public string ReloadLinkText {get;set;}
属性值:System.String。
备注:默认值为“换一张”。
DelayLoad:获取或设置一个值,该值指示验证码图片是否通过Ajax延迟加载。
语法(C#):public bool DelayLoad {get;set;}
属性值:System.String。
备注:默认值为false,当设为true时,验证码图片只在验证码输入文本框被激活(获得焦点)时才生成并通过Ajax方式加载,对于缓存的页面,则必须将此值设为true,否则验证码图片也会被一同缓存而失去验证作用。
当该值设为true时,需注意如下事项:
  • 必须引入jQuery脚本库;
  • 必须指定ValidationInputBoxId和CaptchaImageContainerId的值;
  • MvcCaptchaOptions的设置中,TextLength、TextChars、FontWarp、LineNoise和BackgroundNoise将不起作用且一律使用默认值,若需设置这些属性的值,必须在web.config中添加自定义配置节来实现;