Edit

Global.GetSpellingSuggestions method (Word)

  • Article

Returns a SpellingSuggestions collection that represents the words suggested as spelling replacements for a given word.

Syntax

expression. GetSpellingSuggestions( _Word_ , _CustomDictionary_ , _IgnoreUppercase_ , _MainDictionary_ , _SuggestionMode_ , _CustomDictionary2_ , _CustomDictionary3_ , _CustomDictionary4_ , _CustomDictionary5_ , _CustomDictionary6_ , _CustomDictionary7_ , _CustomDictionary8_ , _CustomDictionary9_ , _CustomDictionary10_ )

expression Required. A variable that represents a 'Global' object.

Parameters

Name Required/Optional Data type Description
Word Required String The word whose spelling is to be checked.
IgnoreUppercase Optional Variant True to ignore words in all uppercase letters. If this argument is omitted, the current value of the IgnoreUppercase property is used.
SuggestionMode Optional Variant Specifies the way Word makes spelling suggestions. Can be one of the following WdSpellingWordType constants: wdAnagram, wdSpellword, or wdWildcard. The default value is WdSpellword.

Remarks

If the word is spelled correctly, the Count property of the SpellingSuggestions object returns 0 (zero).

Example

This example looks for the alternate spelling suggestions for the word "*ook." Suggestions include replacements for the * wildcard character. Any suggested spellings are displayed in message boxes.

Sub DisplaySuggestions() 
 Dim sugList As SpellingSuggestions 
 Dim sug As SpellingSuggestion 
 Dim strSugList As String 
 Set sugList = GetSpellingSuggestions(Word:="lrok", _ 
 SuggestionMode:=wdSpellword) 
 If sugList.Count = 0 Then 
 MsgBox "No suggestions." 
 Else 
 For Each sug In sugList 
 strSugList = strSugList & vbTab & sug.Name & vbLf 
 Next sug 
 MsgBox "The suggestions for this word are: " _ 
 & vbLf & strSugList 
 End If 
End Sub

See also

Global Object

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.