API Overview

API Overview


Properties

AvailableLanguages

List(Of String)

List of langauges available on the system in the format languagecode2-country/regioncode2.

languagecode2 is a lowercase two-letter code derived from ISO 639-1. country/regioncode2 is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag

LanguageID

String

Language name in the format languagecode2-country/regioncode2. languagecode2 is a lowercase two-letter code derived from ISO 639-1. country/regioncode2 is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag

For example: en-US, en-GB, de-DE, fr-FR, es-ES

Default value - "SystemDefaultLanguage" - sets the language to the users system's default UI language ID

SpellCheckDialogCurrentTextboxShortcutKey

Shortcut

Assigns a shortcut key (for example; F7) that will, when pressed, initiate a spell checking dialog for any textbox assigned to the spell check control

ExcludedTextboxes

List (Of Textbox)

A list of text boxes that are excluded from spell checking

For example;

winformsSpell2.ExcludedTextBoxes.Add(textBox5); // adds a textbox to the excluded list

winformsSpell2.ExcludedTextBoxes.Remove(textBox5) // removes a textbox from the excluded list

Version

String

Retrieves the current version number of the Zoople Spelling for WinForms Textboxes control

Methods

AddSingleTextBox(TextBoxToAdd as Textbox)

Removes a single textbox from the spell checker's textbox collection

AddSingleTextBox(TextBoxToAdd as Textbox)

Adds a single textbox to the spell checker's textbox collection

InitSpelling_AllTextboxes()

Assigns all the textboxes in the parent container (Form, Frame etc) to the spell check control. This method must not be called before the textboxes individual handles have been created

SetLicense(User as String, LicenseKey as String)

Assigns a developer and runtime license to the control.

Events

SpellCheckComplete(sender As Object, e As Eventers)

Fires when spell checking is completed for a textbox.

SpellingObjectError(ByRef sender As Object, e As OperationErrorEventArgs)

Fires when an internal error occurs in the control