_Global.GetSpellingSuggestions Method
Returns a SpellingSuggestions collection that represents the words suggested as spelling replacements for a given word.
Namespace: Microsoft.Office.Interop.Word
Assembly: Microsoft.Office.Interop.Word (in Microsoft.Office.Interop.Word.dll)
Syntax
'Declaration
Function GetSpellingSuggestions ( _
Word As String, _
ByRef CustomDictionary As Object, _
ByRef IgnoreUppercase As Object, _
ByRef MainDictionary As Object, _
ByRef SuggestionMode As Object, _
ByRef CustomDictionary2 As Object, _
ByRef CustomDictionary3 As Object, _
ByRef CustomDictionary4 As Object, _
ByRef CustomDictionary5 As Object, _
ByRef CustomDictionary6 As Object, _
ByRef CustomDictionary7 As Object, _
ByRef CustomDictionary8 As Object, _
ByRef CustomDictionary9 As Object, _
ByRef CustomDictionary10 As Object _
) As SpellingSuggestions
'Usage
Dim instance As _Global
Dim Word As String
Dim CustomDictionary As Object
Dim IgnoreUppercase As Object
Dim MainDictionary As Object
Dim SuggestionMode As Object
Dim CustomDictionary2 As Object
Dim CustomDictionary3 As Object
Dim CustomDictionary4 As Object
Dim CustomDictionary5 As Object
Dim CustomDictionary6 As Object
Dim CustomDictionary7 As Object
Dim CustomDictionary8 As Object
Dim CustomDictionary9 As Object
Dim CustomDictionary10 As Object
Dim returnValue As SpellingSuggestions
returnValue = instance.GetSpellingSuggestions(Word, _
CustomDictionary, IgnoreUppercase, _
MainDictionary, SuggestionMode, _
CustomDictionary2, CustomDictionary3, _
CustomDictionary4, CustomDictionary5, _
CustomDictionary6, CustomDictionary7, _
CustomDictionary8, CustomDictionary9, _
CustomDictionary10)
SpellingSuggestions GetSpellingSuggestions(
string Word,
ref Object CustomDictionary,
ref Object IgnoreUppercase,
ref Object MainDictionary,
ref Object SuggestionMode,
ref Object CustomDictionary2,
ref Object CustomDictionary3,
ref Object CustomDictionary4,
ref Object CustomDictionary5,
ref Object CustomDictionary6,
ref Object CustomDictionary7,
ref Object CustomDictionary8,
ref Object CustomDictionary9,
ref Object CustomDictionary10
)
Parameters
- Word
Type: System.String
Required String. The word whose spelling is to be checked.
- CustomDictionary
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of the custom dictionary.
- IgnoreUppercase
Type: System.Object%
Optional Object. True to ignore words in all uppercase letters. If this argument is omitted, the current value of the IgnoreUppercase property is used.
- MainDictionary
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of the main dictionary. If you don't specify a main dictionary, Microsoft Word uses the main dictionary that corresponds to the language formatting of Word or of the first word in the range.
- SuggestionMode
Type: System.Object%
Optional Object. Specifies the way Word makes spelling suggestions. Can be one of the following WdSpellingWordType constants. The default value is WdSpellword.
- CustomDictionary2
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary. You can specify as many as nine additional dictionaries.
- CustomDictionary3
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary.
- CustomDictionary4
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary.
- CustomDictionary5
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary.
- CustomDictionary6
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary.
- CustomDictionary7
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary.
- CustomDictionary8
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary.
- CustomDictionary9
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary.
- CustomDictionary10
Type: System.Object%
Optional Object. Either an expression that returns a Dictionary object or the file name of an additional custom dictionary. You can specify as many as nine additional dictionaries.
Return Value
Type: Microsoft.Office.Interop.Word.SpellingSuggestions
Remarks
If the word is spelled correctly, the Count property of the SpellingSuggestions object returns 0 (zero).