Add Method

Description

Adds objects of the type Dictionary to the collection and validates them for spell checking and suggestion operations.

Syntax

public int Add(Dictionary dictionary);

Public Function Add(dictionary As Dictionary) As Integer

Parameters

Return Value

The collection index at which the dictionary has been added.

Examples

The following example adds an item to the dictionary collection.

var result = dictionaryCollection.Add(new TXTextControl.Proofing.UserDictionary());
Console.WriteLine($"Add result: {result}");

Dim result = dictionaryCollection.Add(New TXTextControl.Proofing.UserDictionary())
Console.WriteLine($"Add result: {result}")

Remarks

This method throws an exception when called while the SpellCheckDialog is open (except for adding dictionaries of type UserDictionary when the built-in options dialog was invoked by a SpellCheckDialog's dialog button).