RadSpell.Net2

Type editor that selects the controls on a page.

Summary description for DictionarySorter.

Saves the dictionary to a file.

The output file name.

Load a word list from a file.

The import file name.

Load a word list from a StreamReader.

The import reader. "Vowels" to test for Prefixes when present which are not pronounced Maximum length of an encoding, default is 4 Encode a value with Double Metaphone @param value string to encode @return an encoded string Encode a value with Double Metaphone, optionally using the alternate encoding. @param value string to encode @param alternate use alternate encode @return an encoded string Check if the Double Metaphone values of two string values are equal. @param value1 The left-hand side of the encoded {@link string#equals(Object)}. @param value2 The right-hand side of the encoded {@link string#equals(Object)}. @return true if the encoded strings are equal; false otherwise. @see #isDoubleMetaphoneEqual(string,string,bool) Check if the Double Metaphone values of two string values are equal, optionally using the alternate value. @param value1 The left-hand side of the encoded {@link string#equals(Object)}. @param value2 The right-hand side of the encoded {@link string#equals(Object)}. @param alternate use the alternate value if true. @return true if the encoded strings are equal; false otherwise. Returns the maxCodeLen. @return int Sets the maxCodeLen. @param maxCodeLen The maxCodeLen to set Handles 'A', 'E', 'I', 'O', 'U', and 'Y' cases Handles 'C' cases Handles 'CC' cases Handles 'CH' cases Handles 'D' cases Handles 'G' cases Handles 'GH' cases Handles 'H' cases Handles 'J' cases Handles 'L' cases Handles 'P' cases Handles 'R' cases Handles 'S' cases Handles 'SC' cases Handles 'T' cases Handles 'W' cases Handles 'X' cases Handles 'Z' cases Complex condition 0 for 'C' Complex condition 0 for 'CH' Complex condition 1 for 'CH' Complex condition 0 for 'L' Complex condition 0 for 'M' Determines whether or not a value is of slavo-germanic orgin. A value is of slavo-germanic origin if it contians any of 'W', 'K', 'CZ', or 'WITZ'. Determines whether or not a character is a vowel or not Determines whether or not the value starts with a silent letter. It will return true if the value starts with any of 'GN', 'KN', 'PN', 'WR' or 'PS'. Cleans the input Gets the character at index index if available, otherwise it returns Character.MIN_VALUE so that there is some sort of a default Shortcut method with 1 criteria Shortcut method with 2 criteria Shortcut method with 3 criteria Shortcut method with 4 criteria Shortcut method with 5 criteria Shortcut method with 6 criteria * Determines whether value contains any of the criteria starting * at index start and matching up to length length Inner class for storing results, since there is the optional alternate encoding.

Initializes the length and offset arrays as well as the distance matrix.

Finds possible suggestions for a misspelled word.

the misspelled word string array of suggestion replacement strings

Calculates Levenshtein distance for two given strings.

String 1. String 2. Edit Distance.

A custom interface that defines the access to the custom dictionary. It can be used to replace the custom dictionary storage mechanism and store the words in a database or on a remote computer.

Reads a word from the storage. It should return null if no more words are present.

Adds a new custom word.

the new word

The directory that contains the custom dictionary file. Necessary only for file based storage -- it is set to the physical directory corresponding to RadSpell's DictPath property setting.

The language for the custom dictionary. It is usually a culture name like en-US or de-DE.

A custom appendix string that can be used to distinguish different custom dictionaries. It is passed the CustomAppendix of the RadSpell object. This way one can create different dictionaries for John and Mary.

This is the .NET 1.x implementation. The .NET 2.0 one gets into an infinite loop when using the WordComparer.

Summary description for WordComparer.

ISpellCheckProvider interface -- defines the behavior that we need from a component to do spell checking.

Summary description for TelerikSpellCheckProvider.

Utility class for Design - Time VisualStudio.NET project management.

Defines the common property categories' names

Gets the component's current version.

Gets or sets a value indicating whether to use the embedded JavaScript files or not.

True if embedded JavaScript files are to be used; otherwise false. The default value is true. Use this property for debugging purposes or to apply any modifications to the JavaScript files.

Provides access to the localization strings of the control.

This example demonstrates how to change the localization strings of RadProgressArea object with code.


            RadProgressArea1.Localization["CancelButton"] = "Cancel";
            RadProgressArea1.Localization["TimeElapsed"] = "Elapsed time: ";
            RadProgressArea1.Localization["TimeEstimated"] = "Estimated time: ";
            RadProgressArea1.Localization["TransferSpeed"] = "Speed: ";
            RadProgressArea1.Localization["CurrentFileName"] = "Uploading file: ";
            RadProgressArea1.Localization["Uploaded"] = "Uploaded ";
            RadProgressArea1.Localization["UploadedFiles"] = "Uploaded files: ";
            RadProgressArea1.Localization["Total"] = "Total ";
            RadProgressArea1.Localization["TotalFiles"] = "Total files: ";


            RadProgressArea1.Localization("CancelButton") = "Cancel"
            RadProgressArea1.Localization("TimeElapsed") = "Elapsed time: "
            RadProgressArea1.Localization("TimeEstimated") = "Estimated time: "
            RadProgressArea1.Localization("TransferSpeed") = "Speed: "
            RadProgressArea1.Localization("CurrentFileName") = "Uploading file: "
            RadProgressArea1.Localization("Uploaded") = "Uploaded "
            RadProgressArea1.Localization("UploadedFiles") = "Uploaded files: "
            RadProgressArea1.Localization("Total") = "Total "
            RadProgressArea1.Localization("TotalFiles") = "Total files: "

Localization name/value collection. This property is intended to be used when there is a need to access the localization strings of the control from the code behind.

Used from DialogLoaderBase to extract the definition of the dialog to be loaded

The parameters got from the DialogLoader. They must include either VirtualPath or Type for the control to be loaded.

Used from a RadControl (Editor, Spell) to define an UserControl dialog

The path to the ascx to be loaded The parameters to be passed to the dialog

Used from a RadControl (Editor, Spell) to define a WebControl dialog

The type of the control to be loaded The parameters to be passed to the dialog

Gets or sets an additional querystring appended to the dialog URL.

A String, appended to the dialog URL TODO

Gets the DialogDefinitionDictionary, containing the DialogDefinitions of the managed dialogs.

TODO TODO

Gets or sets a value, indicating if classic windows will be used for opening a dialog.

A boolean, indicating if classic windows will be used for opening a dialog When set to true, the DialogOpener shows a dialog similar to the ones opened by window.open and window.showModalDialog;

Gets or sets the value indicating how the control will pass the parameters to its dialogs.

The default value is DialogParametersMode.Javascript. DialogParametersMode enum members Member Description Javascript The dialog parameters are serialized and rendered between the control tags. This increases the html output a bit, but makes posible the usage of the control in a web farm and eliminates the problems when the session or the cookie expires. Session The dialog parameters are stored in the Session. This mode minimizes the size of the control html. It cannot be used when the SessionState is disabled and is prone to problems when the Session expires before the dialog is opened. Cookie The dialog parameters are stored in the application Cache; à cookie is used to transport the Cache object key. This mode also minimizes the size of the control html. It cannot be used on web farms and is prone to problems when the cookie expires before the dialog is opened.

Provides enumerated values specifying how the editor will pass the parameters to its dialogs.

The dialog parameters are serialized and rendered between the editor tags. This increases the control's html size a bit, but makes posible the usage of the control in a web farm and eliminates the problems when the session or the cookie expires.

The dialog parameters are stored in the Session. This mode minimizes the size of the control html. It cannot be used when the SessionState is disabled and is prone to problems when the Session expires before the dialog is opened.

The dialog parameters are stored in the application Cache; à cookie is used to transport the Cache object key. This mode also minimizes the size of the control html. It cannot be used on web farms and is prone to problems when the cookie expires before the dialog is opened.

Summary description for DialogParametersSerializer.

telerik r.a.d.spell

Gets or sets an additional querystring appended to the dialog URL.

A String, appended to the dialog URL TODO

Gets or sets the value indicating whether the spell will allow adding custom words.

The default is true

Gets or sets the URL which the AJAX call will be made to. Check the help for more information.

Gets or sets the type of the button that will start the spellcheck.

The default is PushButton Values allowed: PushButton/LinkButton/ImageButton/ None. Setting the value to None will not render a button. The only way to start a spellcheck will be through the client-side API.

The ID of the control to check.

The ID can be both a server-side ID, or a client-side ID. RadSpell will find the appropriate server control and use its ClientID to attach to it.

Gets or sets the fully qualified type name that will be used to store and read the custom dictionary.

The type name must be fully qualified if the type is in a GAC-deployed assembly. The type must implement the ICustomDictionarySource interface.


            spell1.CustomDictionarySourceTypeName = "RadSpellExtensions.CustomDictionarySource, RadSpellExtensions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b5e57ccb698eab8e";


            spell1.CustomDictionarySourceTypeName = "RadSpellExtensions.CustomDictionarySource, RadSpellExtensions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b5e57ccb698eab8e"

Gets or sets the suffix for the custom dictionary files.

The default is -Custom The filenames are formed with the following scheme: Language + CustomDictionarySuffix + ".txt". Different suffixes can be used to create different custom dictionaries for different users.

Gets or sets the value indicating how the control will pass the parameters to its dialogs.

Gets or sets the assembly qualified name of the SpellDialog type.

The default is string.Empty

Gets or sets the virtual path of the UserControl that represents the SpellDialog.

The default is string.Empty

Gets or sets the dictionary language used for spellchecking.

The default is en-US The language name is used to find a corresponding dictionary file. Spellchecking in en-US will work only if a file en-US.TDF can be found inside the folder pointed to by DictPath.

Gets or sets the path for the dictionary files.

The default is ~/RadControls/Spell/TDF/ This is the path that contains the TDF files, and the custom dictionary TXT files.

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.

The default is 1 This property takes effect only if the SpellCheckProvider property is set to EditDistanceProvider.

Configures the spellchecker engine, so that it knows whether to skip URL's, email addresses, and filenames and not flag them as erros.

Gets or sets a value indicating whether whether the ControlToCheck property provides a client element ID or a server side control ID.

The default is false. When true RadSpell will look for the server-side control and get its ClientID. When false the ControlToCheck property will be interpreted as a client-side ID and will be used to attach to the target control.

Gets or sets the value indicating if the target control has been spellchecked.

Spellchecking the entire text by the client would set the property to true on postback. You can set it to false if you wish to mark the text as "pending for spellchecking". The value can be used as an indication of whether the user has spellchecked the text before posting to the server. The property is used by the SpellCheckValidator class. You can set it on the client side with RadSpell's setSpellChecked(false) on various events, say a TEXTAREA's OnChange.

Specifies the spellchecking algorithm which will be used by RadSpell.

The default is TelerikProvider

Gets or sets the supported languages.

The supported languages will be displayed in a drop-down list, and the user can select the language for spellchecking. A string array containing the codes and names of the languages (code, name, code, name...)


            <radS:RadSpell ID="spell1"
                Runat="server"
                ControlToCheck="textBox1"
                SupportedLanguages="en-US,English,fr-FR,French">
            </radS:RadSpell>

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)

Gets or sets a value, indicating if classic windows will be used for opening a dialog.

Gets or sets a value indicating whether to use the embedded JavaScript files or not.

Gets or sets the name of the client-side function that will be called when the spell check starts.

The function accepts two parameters: sender and arguments.


            function onCheckStarted(sender, args)
            {
                log("spell: " + sender.clientId + " started for: " + sender.targetControlId);
            }

Gets or sets the name of the client-side function that will be called when the spell check is finished.

The function accepts two parameters: sender and arguments.


            function onCheckFinished(sender, args)
            {
                log("spell: " + sender.clientId + " finished for: " + sender.targetControlId);
            }

Specifies the name of the client-side function that will be called when the user cancels the spell check.

The function accepts two parameters: sender and arguments.


            function onCheckCancelled(sender, args)
            {
                log("spell: " + sender.clientId + " cancelled for: " + sender.targetControlId);
            }

Specifies the name of the client-side function that will be called before the spell check dialog closes.

The function accepts two parameters: sender and arguments.


            function onDialogClosing(sender, args)
            {
                log("spell: " + sender.clientId + " dialog closing for: " + sender.targetControlId);
            }

Gets or sets the name of the client-side function that will be called when the user corrects a mistake.

The function accepts two parameters: sender and arguments. The significant argument properties are: args.originalWord, args.newWord, args.offsets, args.changeAll.


            function onWordCorrected(sender, args)
            {
                log("spell: " + sender.clientId + " word corrected : " + args.originalWord + " --> " + args.newWord + " at [" + args.offsets + "]");
            }

Specifies the name of the client-side function that will be called when the user ignores a mistaken word.

The function accepts two parameters: sender and arguments. The significant argument properties are: args.ignoreWord, args.offsets, args.ignoreAll.


            function onWordIgnored(sender, args)
            {
                log("spell: " + sender.clientId + " word ignored: " + args.ignoreWord + " at [" + args.offsets+ "]");
            }

Specifies the name of the client side-function that will be called when the user undoes an operation.

The function accepts two parameters: sender and arguments. The significant argument properties are: args.originalWord, args.offsets.


            function onActionUndone(sender, args)
            {
                log("spell: " + sender.clientId + " restored word: " + args.originalWord + " offsets: " + args.offsets);
            }

Specifies the name of the client-side function that will be called when the user adds a word to the custom dictionary.

The function accepts two parameters: sender and arguments. The significant argument property is: args.customWord.


            function onCustomWordAdded(sender, args)
            {
                log("spell: " + sender.clientId + " custom word: " + args.customWord);
            }

Create a new RadSpellChecker object. You need to pass a correct path to the folder that contains the dictionary files (*.TDF)

The method expects local paths. E.g. "C:\SomeFolder\RadControls\Spell\TDF". Transform URL's to local paths with the method. C#


            SpellChecker checker = new SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"));

VB.NET

Dim checker As SpellChecker checker = New SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"))

Cleans up any resources held by the SpellChecker object. It is an alias of

Performs the actual spellchecking. It will be automatically called by the Errors property accessor.

-- a collection with all the errors found.

Adds a new word to the custom dictionary. It first checks if the word is already present in the current base or custom dictionaries.

The new custom word.

Clean up used resources.

Sets the text to be spellchecked. It can be plain text or HTML.

This property can be used to pass the text to the spellchecker engine programmatically. The engine can deal with plaintext or any HTML-like format. It ignores text inside angle brackets (<>) and transforms HTML entities to their character values. E.g. & becomes & C#:


            using (SpellChecker checker = new SpellChecker(Server.MapPath("~/RadControls/Spell/TDF")))
            {
            	checker.Text = text;
            	return checker.Errors;
            }

VB.NET


            Dim checker As SpellChecker
            Try
            	checker = New SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"))
            	checker.Text = text
            	Return checker.Errors
            Finally
            	checker.Dispose()
            End Try

The language of the dictionary to be used for spellchecking. It usually is the same as the corresponding TDF file (without the extension).

To spellcheck in German you have to have de-DE.tdf inside your dictionary folder, and set DictionaryLanguage to "de-DE" C#:


            spellChecker.DictionaryLanguage = "de-DE";

VB.NET


            spellChecker.DictionaryLanguage = "de-DE"

The default is en-US

The folder path that contains the TDF files.

The method expects local paths. E.g. "C:\SomeFolder\RadControls\Spell\TDF". Transform URL's to local paths with the method. C#


            SpellChecker checker = new SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"));

VB.NET

Dim checker As SpellChecker checker = New SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"))

The suffix that gets appended to the custom dictionary file name. It is usually a user specific string that allows to distinguish dictionaries for different users. Default filenames are Language + CustomAppendix + ".txt". The default is -Custom

Specifies the edit distance. If you increase the value, the checking speed decreases but more suggestions are presented. It does not do anything for the phonetic spellchecking.

The default is 1

Specifies whether or not to check words in CAPITALS (e.g. "UNESCO")

The default is false

Specifies whether or not to count repeating words as errors (e.g. "very very")

The default is false

Specifies whether or not to check words in Capitals (e.g. "Washington")

The default is true

Specifies whether or not to check words containing numbers (e.g. "l8r")

The default is false

Specifies whether RadSpell should use the internal spellchecking algorithm or try to use Microsoft Word. The possible values are defined in the enum.

The default is TelerikProvider

Configures the spellchecker engine, so that it knows whether to skip URL's, email addresses, and filenames and not flag them as erros.

Manipulate the custom dictionary source. The new value must implement ICustomDictionarySource.

The fully qualified name of the type that will be used for the custom dictionary storage. The type name must include the assembly, culture and public key token. A new instance will be created internally unless you set CustomDictionarySource directly.

The errors after the last spellcheck. The getter method will call automatically that.

Contains the information about a spellcheck error. The most important properties are the mistaken word and its offset in the source text.

The offset in the source text. It is useful for locating the original word and replacing it with one of the suggestions.

The original word that the spellchecker has determined to be wrong.

Suggestions for replacing the mistaken word.

A collection that stores objects.

Initializes a new instance of .

Adds a with the specified value to the .

The to add. The index at which the new element was inserted.

Copies the elements of an array to the end of the .

An array of type containing the objects to add to the collection. None.

Adds the contents of another to the end of the collection.

A containing the objects to add to the collection. None.

Gets a value indicating whether the contains the specified .

The to locate. if the is contained in the collection; otherwise, .

Copies the values to a one-dimensional instance at the specified index.

The one-dimensional that is the destination of the values copied from . The index in where copying begins. None. is multidimensional. -or- The number of elements in the is greater than the available space between and the end of . is . is less than 's lowbound.

Returns the index of a in the .

The to locate. The index of the of in the , if found; otherwise, -1.

Inserts a into the at the specified index.

The zero-based index where should be inserted. The to insert. None.

Returns an enumerator that can iterate through the .

None.

Removes a specific from the .

The to remove from the . None. is not found in the Collection.

Represents the entry at the specified index of the .

The zero-based index of the entry to locate in the collection. The entry at the specified index of the collection. is outside the valid range of indexes for the collection.

The spellcheck provider enumeration.

The default provider. The same as PhoneticProvider

This provider uses the edit distance algorithm. It will work for non-western languages.

This provider uses phonetic codes to provide "sounds like" word suggestions. Really effective for English, and less so for other languages.

This provider automates Microsoft Word via its COM Interop interface.

Gets or sets the fully qualified type name that will be used to store and read the custom dictionary.

The type name must be fully qualified if the type is in a GAC-deployed assembly. The type must implement the ICustomDictionarySource interface.


            spell1.CustomDictionarySourceTypeName = "RadSpellExtensions.CustomDictionarySource, RadSpellExtensions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b5e57ccb698eab8e";


            spell1.CustomDictionarySourceTypeName = "RadSpellExtensions.CustomDictionarySource, RadSpellExtensions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b5e57ccb698eab8e"

Gets or sets the suffix for the custom dictionary files.

Gets or sets the dictionary language used for spellchecking.

Gets or sets the path for the dictionary files.

The default is ~/RadControls/Spell/TDF/ This is the path that contains the TDF files, and the custom dictionary TXT files.

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.

The default is 1 This property takes effect only if the SpellCheckProvider property is set to EditDistanceProvider.

Configures the spellchecker engine, so that it knows whether to skip URL's, email addresses, and filenames and not flag them as erros.

Specifies the spellchecking algorithm that will be used.

The default is TelerikProvider

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)

Gets or sets a value indicating whether to use the embedded JavaScript files or not.

SpellCheckValidator validates a form based on a RadSpell control. It can be used to enforce spellchecking before form submission. The ControlToValidate must be set to the ID of a RadSpell control. The RadSpell control should be separately set up with a control to check and other options.

Specifies whether or not to check words in CAPITALS (e.g. 'UNESCO')

Specifies whether or not to check words in Capitals (e.g. 'Washington')

Specifies whether or not to count repeating words as errors (e.g. 'very very')

Specifies whether or not to check words containing numbers (e.g. 'l8r')