VSSpell All Members

All of the properties, events, and methods for the VSSpell control are listed in the following tables. Properties, events, and methods that apply only to this control, or that require special consideration when used with it, are marked with an asterisk (*). These are documented in later sections. For documentation on the remaining properties, see the Visual Basic documentation.

Properties

AddBtnVisible	Sets or returns whether the Add button is displayed on the bad-word dialog box.
AddCustomWord	Adds the specified word to the custom dictionary specified by the WhichCustomDict property.
AutoLinkHwnd	Sets or returns the window handle (hWnd) of a control or window that will supply the text for spell checking.
AverageWordLength	Returns the average length of the words that were checked either using the CheckWord property or the Text/Start method of spell checking.
BadWordCount	Returns the number of bad words that were found during the last spell check.
BadWordDialog	Sets or returns whether the bad-word dialog will be used and the language that should be used to display it.
CaretPosX	Returns the horizontal position of the caret on the edit window linked to the VSSpell control.
CaretPosY	Returns the vertical position of the caret on the edit window linked to the VSSpell control.
ChangeAll	Returns a specific word from the ChangeAll property array.
ChangeAllCount	Returns the number of elements in the ChangeAll or ChangeAllTo string array.
ChangeAllTo	Returns a specific word from the ChangeAllTo property array.
ChangeAllToWord	Setting this property adds the specified word to the ChangeAllTo property array.
ChangeWord	Setting this property changes the word being checked into the specified word.
CheckSpelling	Sets or returns whether a spell check will be done.
CheckWord	Sets a word to spell check or returns the word being checked.
ClearChangeAll	Setting this property to True clears the ChangeAll and ChangeAllTo property arrays.
ClearIgnoreAll	Setting this property to True clears the IgnoreAll property array.
CommonWordCache	Sets or returns which cache of common words (if any) the control will use.
CustomDictFile	Sets or returns the path and filename of the custom dictionary file.
CustomDictFile2	Sets or returns the path and filename of an additional custom dictionary file.
CustomDictFile3	Sets or returns the path and filename of an additional custom dictionary file.
CustomDictFile4	Sets or returns the path and filename of an additional custom dictionary file.
CustomDictFile5	Sets or returns the path and filename of an additional custom dictionary file.
CustomDictListVisible	Sets or returns whether the custom dictionary list is visible on the bad word dialog box.
DialogChangedWord	Returns the last word typed by the user into the bad-word dialog box.
DialogFont	Sets or returns the font used in the bad-word dialog box.
DialogLeft	Sets or returns the position (in twips) of the left edge of the bad-word dialog box relative to the left of the desktop.
DialogTitle	Sets or returns the title displayed as the caption of the bad-word dialog box.
DialogTop	Sets or returns the position (in twips) of the top edge of the bad-word dialog box, relative to the top of the desktop.
DictionaryIsProtected	Returns whether the main dictionary file was protected when it was created.
DictionaryLanguage	Returns the language of the current main dictionary file.
DictionaryVersion	Returns the version number of the main dictionary file.
DontCorrectText	Sets or returns whether VSSpell should suppress changes to the Text property when the user presses the Change button on the built-in bad-word dialog.
HelpBtnVisible	Sets or returns whether the Help button will be visible on the bad-word dialog box.
IgnoreAll	Returns a specific word from the IgnoreAll property array.
IgnoreAllCount	Returns the number of elements in the IgnoreAll string array.
IgnoreAllWord	Setting this property to True adds the word in the CheckWord property to the IgnoreAll property array.
IgnoreInMixedCase	Sets or returns if words with uppercase characters after lowercase characters are ignored (for example, 'IOleObject').
IgnoreInUpperCase	Sets or returns if words in all uppercase are ignored (for example, 'RTF').
IgnoreWithNumbers	Sets or returns if words containing numbers are ignored.
IgnoreWord	Setting this property to True causes the current word being checked to be ignored (this time only).
IntegerTag	This property is similar to the Tag standard property.
LastSpellError	Returns the last error code that occurred on the VSSpell control.
MainDictFile	Sets or returns the fully qualified filename of the main dictionary file.
OptionBtnCaption	Sets or returns the caption of the Option button on the bad-word dialog box.
OptionBtnVisible	Sets or returns if the Option button is visible on the bad-word dialog box.
SelLength	Sets or returns the length of the word currently being checked in the Text property.
SelStart	Sets or returns the zero-based offset to the beginning of the word currently being checked in the Text property.
Start	Starts the checking of the word(s) stored in the Text property.
Suggest	Sets or returns whether suggestions are generated for bad words.
Suggestion	Returns the suggested word specified by element during a BadWord event.
SuggestionCount	Returns the number of elements in the Suggestion string array.
Text	Sets or returns the string of words to be spell checked.
TypingErrorAction	Sets or returns the action to be taken when a typing error is detected.
UnderlineColor	Sets or returns the color of the underline effect used to highlight typing errors.
UnderlineStyle	Sets or returns the style of the underline effect used to highlight typing errors.
WhichCustomDict	Sets or returns which custom dictionary to use when adding words to the custom dictionary.
WordCount	Returns the number of individual words in the Text property following a spell check.
WordsPerMinute	Returns the number of words processed per minute during a spell check.

Methods

AddChangeAll	Adds a word to the ChangeAll and ChangeAllTo property arrays.
AddIgnoreAll	Adds a word to the IgnoreAll property array.
CheckText	Start spell checking the text in the Text property.
CheckTyping	Start spell checking a control as the user types.
CheckWindow	Start spell checking the text in a given control.
Clear	Clears the contents of all control properties.

Events

BadWord	Fired when a bad word is encountered during a spell check.
Changed	Fired after the Text property changes.
Checking	Fired every second while spell checking to provide user feedback while checking long documents.
Complete	Fired after the spell check has been completed.
DialogAction	Fired when a button is clicked on the bad-word dialog box.
HelpBtnClick	Fired when the Help button on the bad-word dialog box is clicked.
OptionBtnClick	Fired when the Option button on the bad-word dialog box is clicked.
Suggestion	Fired after a word has been added to the Suggestion property array.
TypingError	Fired when a typing error is detected after the CheckTyping method is invoked.
TypingOK	Fired when a correct word is typed after the CheckTyping method is invoked.