Edit

Share via


Word.DocumentCheckSpellingOptions interface

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Provides configuration options for the Document.checkSpelling method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

alwaysSuggest

If provided, specifies whether to always suggest spelling corrections. The default value is true.

customDictionary

If provided, specifies the custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary10

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary2

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary3

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary4

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary5

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary6

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary7

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary8

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary9

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

ignoreUppercase

If provided, specifies whether to ignore uppercase words during spell checking. The default value is false.

Property Details

alwaysSuggest

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to always suggest spelling corrections. The default value is true.

alwaysSuggest?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary10

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary10?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary2

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary2?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary3

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary3?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary4

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary4?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary5

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary5?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary6

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary6?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary7

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary7?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary8

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary8?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

customDictionary9

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string).

customDictionary9?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

ignoreUppercase

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to ignore uppercase words during spell checking. The default value is false.

ignoreUppercase?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]