Click or drag to resize
KaxSpell Properties

The KaxSpell type exposes the following members.

Properties
  Name Description
Public property AdditionalQueryString
Gets or sets an additional querystring appended to the dialog URL.
Public property AjaxUrl
Gets or sets the URL which the AJAX call will be made to. Check the help for more information.
Public property AllowAddCustom
Gets or sets the value indicating whether the spell will allow adding custom words.
Public property ButtonText
Gets or sets the text of the button that will start the spellcheck. This property is localizable.
Public property ButtonType
Gets or sets the type of the button that will start the spellcheck.
Public property Code example ClientTextSource
Gets or sets the class of the client side text source object.
Public property ControlsToCheck
An array of IDs of the control to check.
Public property ControlToCheck
The ID of the control to check.
Public property Code example CustomDictionarySourceTypeName
Gets or sets the fully qualified type name that will be used to store and read the custom dictionary.
Public property CustomDictionarySuffix
Gets or sets the suffix for the custom dictionary files.
Public property DialogsCssFile
Gets or sets the location of a CSS file, that will be added in the dialog window. If you need to include more than one file, use the CSS @import url(); rule to add the other files from the first.
Remarks
This property is needed if you are using a custom skin. It allows you to include your custom skin CSS in the dialogs, which are separate from the main page.
Public property DialogsScriptFile
Gets or sets the location of a JavaScript file, that will be added in the dialog window. If you need to include more than one file, you will need to combine the scripts into one first.
Remarks
This property is needed if want to override some of the default functionality without loading the dialog from an external ascx file.
Public property DialogTypeName
Gets or sets the assembly qualified name of the SpellDialog type.
Public property DialogVirtualPath
Gets or sets the virtual path of the UserControl that represents the SpellDialog.
Public property DictionaryLanguage
Gets or sets the dictionary language used for spellchecking.
Public property DictionaryPath
Gets or sets the path for the dictionary files.
Public property EditDistance
Gets or sets a the edit distance. If you increase the value, the checking speed decreases but more suggestions are presented. Applicable only in EditDistance mode.
Public property EnableAjaxSkinRendering
Gets or sets a Boolean value that indicates whether render the skin CSS at AJAX request. The default value is true.
(Overrides KaxWebControl.EnableAjaxSkinRendering.)
Public property EnableEmbeddedBaseStylesheet
Gets or sets a Boolean value that indicates whether enable the embedded basic style sheet in the control.
(Overrides KaxWebControl.EnableEmbeddedBaseStylesheet.)
Public property EnableEmbeddedScripts
Gets or sets a Boolean value that indicates whether enable the embedded script.
(Overrides KaxWebControl.EnableEmbeddedScripts.)
Public property EnableEmbeddedSkins
Gets or sets a Boolean value that indicates whether enable the embedded skin for the control.
(Overrides KaxWebControl.EnableEmbeddedSkins.)
Public property FragmentIgnoreOptions
Configures the spellchecker engine, so that it knows whether to skip URL's, email addresses, and filenames and not flag them as erros.
Public property HandlerUrl
Gets or sets the URL for the spell dialog handler
Public property IsClientID
Gets or sets a value indicating whether whether the ControlToCheck property provides a client element ID or a server side control ID.
Public property Language
Gets or sets the localization language for the user interface.
Public property LocalizationPath
Gets or sets a value indicating where the soell will look for its .resx localization files. By default these files should be in the App_GlobalResources folder. However, if you cannot put the resource files in the default location or .resx files compilation is disabled for some reason (e.g. in a DotNetNuke environment), this property should be set to the location of the resource files.
Public property Code example OnClientCheckCancelled
Specifies the name of the client-side function that will be called when the user cancels the spell check.
Public property Code example OnClientCheckFinished
Gets or sets the name of the client-side function that will be called when the spell check is finished.
Public property Code example OnClientCheckStarted
Gets or sets the name of the client-side function that will be called when the spell check starts.
Public property Code example OnClientDialogClosed
Specifies the name of the client-side function that will be called before the spell check dialog closes.
Public property Code example OnClientLoad
Gets or sets the name of the client-side function that will be called when the spell control is initialized on the page.
Public property Skin
Gets or sets the skin name for the control user interface.
(Overrides KaxWebControl.Skin.)
Public property SpellChecked
Gets a value indicating if the target control has been spellchecked.
Public property SpellCheckProvider
Specifies the spellchecking algorithm which will be used by KaxSpell.
Public property SpellCheckProviderTypeName
Allows the use of a custom spell checking provider. It must implement the ISpellCheckProvider interface.
Public property Code example SupportedLanguages
Gets or sets the supported languages.
Public property WordIgnoreOptions
Gets or sets the value used to configure the spellchecker engine to ignore words containing: UPPERCASE, some CaPitaL letters, numbers; or to ignore repeated words (very very)
Top
See Also