NamedRange.CheckSpelling(Object, Object, Object, Object) Method

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.dll

Checks the spelling of text in the NamedRange control.

public object CheckSpelling (object CustomDictionary, object IgnoreUppercase, object AlwaysSuggest, object SpellLang);

abstract member CheckSpelling : obj * obj * obj * obj -> obj

Public Function CheckSpelling (Optional CustomDictionary As Object, Optional IgnoreUppercase As Object, Optional AlwaysSuggest As Object, Optional SpellLang As Object) As Object

Parameters

CustomDictionary

Object

Indicates the file name of the custom dictionary to be examined if the word is not found in the main dictionary. If this argument is omitted, the currently specified dictionary is used.

IgnoreUppercase

Object

true to have Microsoft Office Excel ignore words that are all uppercase; false to have Excel check words that are all uppercase. If this argument is omitted, the current setting is used.

AlwaysSuggest

Object

true to have Excel display a list of suggested alternate spellings when an incorrect spelling is found; false to have Excel pause while you input the correct spelling. If this argument is omitted, the current setting is used.

SpellLang

Object

The language of the dictionary being used. Can be one of the MsoLanguageID values used by the LanguageID[MsoAppLanguageID] property.

Returns

Object

Examples

The following code example uses the CheckSpelling method to check the spelling of the string "Mongeese".

This example is for a document-level customization.

private void CheckRangeSpelling()
{
    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A1"],
        "namedRange1");

    namedRange1.Value2 = "Mongeese";
    namedRange1.CheckSpelling(true, true,
        Office.MsoLanguageID.msoLanguageIDEnglishUS);
}

Private Sub CheckRangeSpelling()
    Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange _
        = Me.Controls.AddNamedRange(Me.Range("A1"), _
        "namedRange1")

    namedRange1.Value2 = "Mongeese"
    namedRange1.CheckSpelling(, True, True, _
        Office.MsoLanguageID.msoLanguageIDEnglishUS)
End Sub

Remarks

This form has no return value; Excel displays the Spelling dialog box.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.