SpellServer.NET Reference Documentation

Methods

[Visual Basic]
Public Function GetNextMisspelling (_
  ByRef sSuggestions As String, _
  ByRef nErrorFoundAt As Integer _
) As String

[C#]
public string GetNextMisspelling (
  ref string sSuggestions,
  ref int nErrorFoundAt
);

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 (set by the StringToCheck property) starting at the current point (set by the StartCheckingAt property) and returns the next misspelled word in the string.  If there are no further misspellings, then an empty string is returned.

[Visual Basic]
Public Sub ChangeWord (_
  ByVal sBadWord As String, _
  ByVal sNewWord As String, _
  ByVal bChangeAll As Boolean
)

[C#]
public void ChangeWord(
  string sBadWord,
  string sNewWord,
  bool bChangeAll
);

sBadWord

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]
Public Sub IgnoreWord (_
  ByVal sWord As String, _
  ByVal bIgnoreAll As Boolean
)

[C#]
public void IgnoreWord(
  string sWord,
  bool bIgnoreAll
);

sWord

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]
Public Sub AddWordsToCustomDict (_
  ByVal sWords As String
)

[C#]
public void AddWordsToCustomDict(
  string sWords
);

sWords

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

During spell checking, add 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]
Public Sub RemoveWordsFromDictionary (_
  ByVal sWords As String
)

[C#]
public void RemoveWordsFromDictionary(
  string sWords
);

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]
Public Sub ClearCustomDictionary ()

[C#]
public void 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]
Public Sub ClearBaseDictionary ()

[C#]
public void 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]
Public Sub ClearIgnoreAll ()

[C#]
public void 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

Properties

[Visual Basic]
Public WriteOnly Property CompanyName As String

[C#]
public string CompanyName {set;}

A string indicating the name of your company.

Setting this property loads in all words starting with the letter Q.  Note that when you install the retail version of SpellServer.NET, a Company Name is prompted for.  The value you entered during installation is used to create SpellServerUS.dat (and DAT files for UK English, French, and Spanish), which contains the Q words.  You must set the CompanyName property to match the value you entered during installation.

If you are using a dictionary other than US English, be sure to set the Language property before setting the CompanyName property.

[Visual Basic]
Public Property Language As String

[C#]
public string Language {get; set;}

"US" for US English (the default).
"UK" for UK English.
"FR" for French.
"SP" for Spanish.

Set this property to specify the language used to check spelling.  Note that each language has it's own Base Dictionary file (with a BDC extension), which must be located in the same bin folder as the SpellServer DLL.   The names of these files are SpellServerUS.bdc, SpellServerUK.bdc, SpellServerFR.bdc, and SpellServerSP.bdc.

[Visual Basic]
Public Property StringToCheck As String

[C#]
public string StringToCheck {get; set;}

The string currently being spell-checked.

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]
Public Property StartCheckingAt As Integer

[C#]
public int StartCheckingAt {get; set;}

The offset into the string to be checked.

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]
Public Property CustomDictionaryWords As String

[C#]
public string CustomDictionaryWords {get; set;}

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]
Public Property IgnoreAllWords As String

[C#]
public string IgnoreAllWords {get; set;}

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 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]
Public ReadOnly Property VersionInfo As String

[C#]
public string VersionInfo {get;}

A string that specifies the current version of SpellServer.NET.

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

[Visual Basic]
Public Property IgnoreCase As Boolean

[C#]
public bool IgnoreCase {get; set;}

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.  Performance is slightly faster when this property is set to true.

[Visual Basic]
Public Property IgnoreAllCaps As Boolean

[C#]
public bool IgnoreAllCaps {get; set;}

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]
Public Property IgnoreHTML As Boolean

[C#]
public bool IgnoreHTML {get; set;}

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]
Public Property IgnoreInternetAddrs As Boolean

[C#]
public bool IgnoreInternetAddrs {get; set;}

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]
Public Property IgnoreWithNumbers As Boolean

[C#]
public bool IgnoreWithNumbers {get; set;}

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.