Version

WebCaptcha Class Members

The following tables list the members exposed by WebCaptcha.

Public Constructors
 NameDescription
Public ConstructorWebCaptcha ConstructorDefault Constructor  
Public Fields
Public Properties
 NameDescription
Public PropertyAccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl object that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyAudioButtonaudio button for captcha image  
Public PropertyCaptchaDictionaryModesets the mode of the captcha Off - random text generated on an image Words - words loaded from dictionary and generated on an image LogicalQuestionAnswer - question that will be not generated on the image but will be plain text  
Public PropertyCaptchaDictionaryPathpath from where the Dictionary will be loaded, if CaptchaDictionaryMode is "Words" or "LogocalQuestionAnswer" the dictionary format is : when CaptchaDictionaryMode is Words, every line represents some word(s) when CaptchaDictionaryMode is LogicalQuestionAnswer, then first line is question, second line is answer, and so on two lines each  
Public PropertyCaptchaEditorIDID of server-side control on the form that we are going to use as an editor for the captcha (where the end user will enter text) the editor must implement ITextControl  
Public PropertyCaptchaErrorLabelIDID of server-side control on the form that we are going to use to visualize the error message it must implement ITextControl  
Public PropertyCaptchaImageRegenerationTimeoutdefines after how many seconds the captcha image will get automatically regenerated (refreshed)  
Public PropertyCaptchaImageSettingsImageSettings Object  
Public PropertyCaptchaImagesPathPath from where predefined images will be loaded, and an image from the list will be randomly chosen this is sort-of logical captchas, but instead of text (question), an image will be displayed and the end user will type what he sees on the image  
Public PropertyCaptchaInfoTextLabelLabel that will be rendered below the captcha image (text used for informative purposes about what the end user should do  
Public PropertyCaptchaSoundsPathPath from where the Captcha audio files will be loaded - so that we can support different languages  
Public PropertyClientEventsGet reference to the CaptchaClientEvents.  
Public PropertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from System.Web.UI.Control)
Public PropertyClientIDModeGets or sets the algorithm that is used to generate the value of the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Public PropertyControlsGets a System.Web.UI.ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyControlStyleCreatedGets a value indicating whether a System.Web.UI.WebControls.Style object has been created for the System.Web.UI.WebControls.WebControl.ControlStyle property. This property is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCustomAJAXResponseContainer for values passed to client within AJAX response. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyEnableAjaxViewStateGets sets ability to maintain view state of controls on page if their properties were modified while asynchronous postback of this control. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyEnableCaptchaImageRegenerationallows captcha image to be generated (manually), if it is not readable by the user  
Public PropertyEnabledGets or sets a value whether the Aikido control is enabled. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyEnableEmbeddedJavaScriptInstructs the control to load its embedded Java Script. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from System.Web.UI.Control)
Public PropertyErrorMessageerror message in case IsValid is false  
Public PropertyFontGets the font properties associated with the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyFormSubmissionTimeoutSecondsthe maximum form submission timeout allowed, to which we compare the value of CurrentFormSubmissionTimeoutSeconds  
Public PropertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHeightGets or sets the height of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from System.Web.UI.Control)
Public PropertyInputValueValue that was entered by the user  
Public PropertyInputValueEditorReference to WebTextEditor control  
Public PropertyInsecureSubmitTokensGets sets list of insecure strings as array.

That property is designed to protect application from scripting vulnerability. When request comes from client and the value of the hidden field contains insecure tokens, then all changes on client are discarded. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyInsecureSubmitTokensAsStringGets sets list of insecure strings separated by the "|" character.

That property is designed to protect application from scripting vulnerability. When request comes from client and the value of the hidden field contains insecure tokens, then all changes on client are discarded. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyIsValidvalue indicating whether validation has succeeded or failed  
Public PropertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same System.Web.UI.Control.ID property value. (Inherited from System.Web.UI.Control)
Public PropertyOptimizeCollectionsStateThe collections client state will be stored in the view state and the client collections will not be sent from the client on postback. This will increase page size in terms of view state, but will decrease the postback time numerously, because the collections state will not be uploaded from the client. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyPageGets a reference to the System.Web.UI.Page instance that contains the server control. (Inherited from System.Web.UI.Control)
Public PropertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyProtectionModeProtection mode - Captcha, FormSubmissionTimeout, and InvisibleInputField  
Public PropertyRefreshButtonrefresh button for captcha image  
Public PropertyRendererSets or Gets a rendering object derived from RendererBase that serves to emit html markup that is appropriate to the control. This property can be set by an application to a Renderer other than the one normally provided by the Control. The Custom Renderer can override any of the virtual methods exposed or can implement an entirely new set of rendering logic if desired. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from System.Web.UI.Control)
Public PropertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from System.Web.UI.Control)
Public PropertySkinIDGets or sets the skin to apply to the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyStyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyStyleSetNameName of the Application Styling Framework(tm) style set defining the themed appearance for this control. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertyStyleSetPathPath containing the Application Styling Framework(tm) style set files for this type of control. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public PropertySubmitButtonASP:Button that will be rendered below image and input  
Public PropertySupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's System.Web.UI.WebControls.WebControl.IsEnabled property is false. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTabIndexGets or sets the tab index of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectoryGets the virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl that contains the current server control. (Inherited from System.Web.UI.Control)
Public PropertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
Public PropertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from System.Web.UI.Control)
Public PropertyValidationGroupASP.NET 2.0 validation groups support - if this is specified, validation will be performed by calling Page.Validate(ValidationGroup)  
Public PropertyValueCurrent Captcha Value (server-side only!)  
Public PropertyViewStateModeGets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control)
Public PropertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control)
Public PropertyWidthGets or sets the width of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Protected Properties
 NameDescription
Protected PropertyAdapterGets the browser-specific adapter for the control. (Inherited from System.Web.UI.Control)
Protected PropertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from System.Web.UI.Control)
Protected PropertyClientIDSeparatorGets a character value representing the separator character used in the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Protected PropertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from System.Web.UI.Control)
Protected PropertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from System.Web.UI.Control)
Protected PropertyIdSeparatorGets the character used to separate control identifiers. (Inherited from System.Web.UI.Control)
Protected PropertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from System.Web.UI.Control)
Protected PropertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by System.Web.UI.Control.ID instead of index. (Inherited from System.Web.UI.Control)
Protected PropertyPreviousValuePrevious value - to compare on postback against back-button security  
Protected PropertyRunBotProvides the Control with access to runtime support services provided by the RunBot class. By separating these services from the control itself, there is no requirement that a particular control must inherit from a specific base class in order to benefit from the services provided. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected PropertyStyleBotProvides the Control with access to style support services provided by the StyleBot class. By separating these services from the control itself, there is no requirement that a particular control must inherit from a specific base class in order to benefit from the services provided. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected PropertyTagKeyGets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyViewStateGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from System.Web.UI.Control)
Protected PropertyViewStateIgnoresCaseGets a value that indicates whether the System.Web.UI.StateBag object is case-insensitive. (Inherited from System.Web.UI.Control)
Public Methods
 NameDescription
Public MethodApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
Public MethodClearTemplatesMethod to override to ensure that templates are cleared (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public MethodCopyBaseAttributesCopies the properties not encapsulated by the System.Web.UI.WebControls.WebControl.Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodDataBindOverloaded. Binds a data source to the invoked server control and all its child controls. (Inherited from System.Web.UI.Control)
Public MethodDisposeDisposes of this control (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public MethodEnsureTemplatesMethod to override to ensure that templates have been created (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public MethodFindControlOverloaded. Searches the current naming container for a server control with the specified id parameter. (Inherited from System.Web.UI.Control)
Public MethodFocusSets input focus to a control. (Inherited from System.Web.UI.Control)
Public MethodGetRouteUrlOverloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
Public MethodGetUniqueIDRelativeToReturns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
Public MethodHasControlsDetermines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
Public MethodLoadPostDataIf any properties, objects, or collections were modified on the client, their transacation lists are loaded here. Also, if this is a Callback, it is where CallbackCreated is called from. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public MethodMergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRaisePostDataChangedEventUsed to notify the ASP.Net application that the state of the control has changed. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public MethodRenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderControlOverloaded. Outputs server control content to a provided System.Web.UI.HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from System.Web.UI.Control)
Public MethodRenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodResolveClientUrlGets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
Public MethodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
Public MethodSetRenderMethodDelegateAssigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
Public MethodValidatePerforms validation on the Captcha image against the entered text  
Protected Methods
 NameDescription
Protected MethodAddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's System.Web.UI.ControlCollection object. (Inherited from System.Web.UI.Control)
Protected MethodBuildProfileTreeGathers information about the server control and delivers it to the System.Web.UI.Page.Trace property to be displayed when tracing is enabled for the page. (Inherited from System.Web.UI.Control)
Protected MethodCallbackCreatedOverridden.   
Protected MethodCallbackRenderOverridden.   
Protected MethodClearCachedClientIDSets the cached System.Web.UI.Control.ClientID value to a null reference (Nothing in Visual Basic). (Inherited from System.Web.UI.Control)
Protected MethodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearEffectiveClientIDModeSets the System.Web.UI.Control.ClientIDMode property of the current control instance and of any child controls to System.Web.UI.ClientIDMode.Inherit. (Inherited from System.Web.UI.Control)
Protected MethodCreateChildControlsOverridden.   
Protected MethodCreateClientEventsOverridden. Control which exposes ClientEvents must override that method and return instance of ClientEvents object.  
Protected MethodCreateControlCollectionCreates a new System.Web.UI.ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from System.Web.UI.Control)
Protected MethodCreateControlStyleCreates the style object that is used internally by the System.Web.UI.WebControls.WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodCreateRendererOverridden. A virtual method called by the framework base when a renderer is required for the control. Derived classes may override this method in order to provide specific rendering markup. Many of the rendering methods within the Renderer class may also be overridable in order to customize specific aspects of the rendering.  
Protected MethodCreateRunBotOverridden. A virtual method called by the framework base when the RunBot is required for the control. Derived classes may override this method in order to provide extra functionality to the RunBot. Many of the methods within the RunBot class may also be overridable in order to add additional logic to the control.  
Protected MethodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
Protected MethodGetClientEventsObjectControl which exposes ClientEvents should return that method within its ClientEvents property with a proper typecast. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected MethodGetDesignModeStateGets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from System.Web.UI.Control)
Protected MethodIsLiteralContentDetermines if the server control holds only literal content. (Inherited from System.Web.UI.Control)
Protected MethodLoadAdditionalViewStateLoad ViewStates of additional objects used by extended classes. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected MethodLoadControlStateOverridden. Load's the control's state  
Protected MethodLoadViewStateLoad data modified at run time. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected MethodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from System.Web.UI.Control)
Protected MethodOnDataBindingRaises the System.Web.UI.Control.DataBinding event. (Inherited from System.Web.UI.Control)
Protected MethodOnInitOverridden. Enable ControlState.  
Protected MethodOnLoadOverridden.   
Protected MethodOnPreRenderOverridden.   
Protected MethodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from System.Web.UI.Control)
Protected MethodRenderRenders this control (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected MethodRenderContentsOverride the WebControl RenderContents method to redirect rendering to the appropriate renderer. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected MethodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
Protected MethodSaveAdditionalViewStateSave ViewStates of additional objects used by extended classes. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected MethodSaveControlStateOverridden. Saves the control's state  
Protected MethodSaveViewStateSave data modified at run time. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Protected MethodSetDesignModeStateSets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodTrackViewStateNotify subobjects about TrackViewState event. (Inherited from Infragistics.Web.UI.Framework.ControlMain)
Public Events
 NameDescription
Public EventDataBindingOccurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
Public EventDisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
Public EventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
Public EventLoadOccurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control)
Public EventPreRenderOccurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
Public EventUnloadOccurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
See Also