SpellServer Reference Documentation

Methods

[Visual Basic]   [Sessionless Interface]

Public Function GetNextMisspelling (_
  ByRef sSuggestions As String, _
  ByRef nErrorFoundAt As Integer _
) As String

[Visual Basic]   [Sessions Interface]

Public Function GetNextMisspelling (_
  ByRef sResultSoFar As String, _
  ByRef sSuggestions As String, _
  ByRef nErrorFoundAt As Integer _
) As String

sResultSoFar

(For Sessions interface only) A string containing the current string being checked, including any changes that may have been made

sSuggestions

A string containing a list of suggestions for the misspelled word, separated by character 13 (carriage return).

nErrorFoundAt

The numeric offset from the start of the string that the mispelled word was found at.

A string containing the misspelled word.  Returns an empty string if there are no further misspellings in the string.

This function checks the current string starting at the current point and returns the next misspelled word in the string.  If there are no further misspellings, then an empty string is returned.

[Visual Basic]   [Sessionless Interface]

Public Sub ChangeWord (_
  ByVal sBadWord As String, _
  ByVal sNewWord As String, _
  ByVal bChangeAll As Boolean
)

[Visual Basic]   [Sessions Interface]

Public Sub ChangeWord (_
  ByVal sNewWord As String, _
  ByVal bChangeAll As Boolean
)

sBadWord

(For Sessionless interface only) A string containing the misspelled word.

sNewWord

A string containing the value that the misspelled word should be replaced with.

bChangeAll

A boolean indicating if all occurances of the misspelled word should be replaced with the new word.

Depending on the value of the bChangeAll parameter, this routine will change either the currently misspelled word with a new word, or the currently misspelled word and all subsequent occurances of that word from the current point to the end of the current string.

[Visual Basic]   [Sessionless Interface]

Public Sub IgnoreWord (_
  ByVal sWord As String, _
  ByVal bIgnoreAll As Boolean
)

[Visual Basic]   [Sessions Interface]

Public Sub IgnoreWord (_
  ByVal bIgnoreAll As Boolean
)

sWord

(For Sessionless interface only) A string containing the misspelled word.

bIgnoreAll

A boolean indicating if all occurances of the misspelled word should be ignored when they are encountered in the future.

This routine will skip past the misspelled word and continue checking immediately after it.  If the bIgnoreAll parameter is set to True, this routine will add this word to it's Ignore-All list of words, and all subsequent occurances of this word will be ignored during checking.

IgnoreAllWords

[Visual Basic]   [Both Interfaces]

Public Sub LoadCCD (_
  ByVal sFName As String,
  ByVal bAppend As Boolean 
)

sFName

A string containing the file name for a Compiled Custom Dictionary (CCD) file.

bAppend

A boolean that controls whether the custom dictionary will be cleared before loading the CCD file.  Defaults to True, which means that the words from the CCD will be appended to the existing custom dictionary.

Compiled Custom Dictionary (CCD) files provide a very efficient method of adding large numbers of words to the custom dictionary.  Run the included Custom Dict Compiler app to create the CCD file, then include the CCD file in your deployment and load it with the LoadCCD method.

The default is to add the words in the CCD to the existing custom dictionary, but you can easily empty the custom dictionary before loading by setting the second parameter of this call to False.

ClearCustomDictionary   | CustomDictionaryWords

[Visual Basic]   [Both Interfaces]

Public Sub AddToCustom (_
  ByVal sWords As String
)

sWords

A string containing one or more words to add to the custom dictionary, separated by blanks or other white space.

During spell checking, all words are checked against the standard base dictionary.  If a word is not found in this dictionary, then the Ignore-All list and the custom dictionary are searched.

When adding words to the custom dictionary, be sure to capitalize words that must be capitalized (like "Michigan"), but leave all other words lower case (like "house").

ClearCustomDictionary   | CustomDictionaryWords

[Visual Basic]   [Both Interfaces]

Public Sub RemoveWordsFromDictionary (_
  ByVal sWords As String
)

sWords

A string containing one or more words to be removed, separated by blanks or other white space.

This function removes all occurances of the specified words from both the base dictionary and the custom dictionary.  The removal is case-insensitive, so if you specify that you wish "michigan" to be removed, the word "Michigan" will be removed (in this case, from the base dictionary).

[Visual Basic]   [Both Interfaces]

Public Sub ClearCustomDictionary ()

This function can be used to ensure that the custom dictionary is clear.  The custom dictionary is initialized as empty, so there is no need to call this function during normal initialization.

ClearBaseDictionary   | ClearIgnoreAll

[Visual Basic]   [Both Interfaces]

Public Sub ClearBaseDictionary ()

This function can be used to clear the base dictionary.  The primary reason to do this would be if you wished to use only a custom dictionary, with no other words during the checking process.

ClearCustomDictionary   | ClearIgnoreAll

[Visual Basic]   [Both Interfaces]

Public Sub ClearIgnoreAll ()

This function can be used to ensure that the Ignore-All list is clear.  The Ignore-All list is initialized as empty, so there is no need to call this function during normal initialization.

ClearCustomDictionary   | ClearBaseDictionary

[Visual Basic]   [Sessions Interfaces]

Public Sub CheckString (_
  ByVal sStringToCheck As String
)

This function is only used for the Sessions interface.   It initially loads the string to be checked into SpellServer.

Properties

[Visual Basic]   [Sessionless Interface]

Public Property StringToCheck As String

The string currently being spell-checked.

Used only in the Sessionless interface, this property gives you access to the string that is currently being spell-checked.  The string is stored in an internal buffer, and can be modified by the ChangeWord function.

[Visual Basic]   [Sessionless Interface]

Public Property StartCheckingAt As Integer

The offset into the string to be checked.

Used only in the Sessionless interface, this property gives you access to the current starting point for spell-checking.  SpellServer will modify this value in response to calling IgnoreWord, ChangeWord, or GetNextMisspelling.  Changing the value of StringToCheck will reset this value to 0, so be sure to set StringToCheck before you set StartCheckingAt.

[Visual Basic]   [Both Interfaces]

Public Property CustomDictionary As String

A sequence of words, separated by blanks or other white space.

This property allows you to either retrieve or change the value of the entire custom dictionary in a single step.  When setting this value, the entire custom dictionary will be replaced with the string.  If you wish to append words to the current custom dictionary (rather than replace the dictionary), use the AddWordsToCustomDict method.

[Visual Basic]   [Both Interfaces]

Public Property IgnoreAllDictionary As String

A sequence of words, separated by blanks or other white space.

Available in both interfaces, this property allows you to either retrieve or change the value of the entire Ignore-All list in a single step.  When setting this value, the entire Ignore-All list will be replaced with the string.  If you wish to append words to the Ignore-All list (rather than replace it), use the IgnoreWord method.

[Visual Basic]   [Both Interfaces]

Public ReadOnly Property VersionInfo As String

A string that specifies the current version of SpellServer.

This read-only property returns the current version information of SpellServer.  Additionally, the number of words currently stored in the base dictionary is also returned.

[Visual Basic]   [Both Interfaces]

Public Property IgnoreCase As Boolean

True if the checking should ignore the case of words it checks; otherwise, false. The default is true.

Typically this option will be true, to handle different cases of words.  Note that SpellServer always handles words that are initially capitalized.  This property is designed for use for words that may be in ALL CAPS, or that have UnUsUal cApITAlization. 

Setting this property to true automatically sets IgnoreAllCaps to False.

Performance is significantly slower when this property is set to true.

[Visual Basic]   [Both Interfaces]

Public Property IgnoreAllCaps As Boolean

True if the checking should ignore (i.e., not spell-check) words that are ALL CAPS; otherwise, false. The default is false.

Often, words in ALL CAPS are acronyms (like "NAFTA"), and should be ignored during the spell-checking process.  However, the default is false since some people will type in all of their text in all caps, and setting this value to true would cause SpellServer to ignore all of their text. 

[Visual Basic]   [Both Interfaces]
Public Property IgnoreHTML As Boolean

True if the checking should ignore (i.e., not spell-check) words that appear to be HTML tags or special characters (like " "); otherwise, false. The default is true.

If you know that the text you are checking will not include any HTML tags or special characters, you may wish to set this property to false for increased accuracy during checking.  Note that SpellServer does not keep detailed information about whether it is inside certain tag blocks (like "<SCRIPT>"), and will continue to check the spelling of words inside of complex tags, regardless of the setting of this property.

[Visual Basic]   [Both Interfaces]

Public Property IgnoreInternetAddrs As Boolean

True if the checking should ignore (i.e., not spell-check) words that appear to be URLs or e-mail addresses; otherwise, false. The default is true.

Typically this value will be true.  If you know that the text you are checking will never contain any URLs or e-mail addresses, you may wish to set this property to false for greater spell-checking accuracy.

[Visual Basic]   [Both Interfaces]

Public Property IgnoreWithNumbers As Boolean

True if the checking should ignore (i.e., not spell-check) words that have embedded digits; otherwise, false. The default is true.

Typically this value will be true.  If you wish to have greater spell-checking accuracy, you may wish to set it to false.

[Visual Basic]   [Both Interfaces]

Public Property LicenseKey As String

Set this value to the string you receive when you purchase the product.

You must set this property when using the retail version of SpellServer.