DictionaryContainer Class

Definition

public abstract class DictionaryContainer

type DictionaryContainer = class

Inheritance

Object

DictionaryContainer

Derived

Accounts.AccountStoreOptions

AddressBook.InstantMessageService

AddressBook.PersonAddress

AddressBook.SocialProfile

AppKit.NSAttributedStringDocumentReadingOptions

More…

Remarks

Many APIs accept configuration options as untyped NSDictionary values, or return untyped NSDictionary values. The managed bindings offer strong-typed versions of those dictionaries, which allow developers to get code completion while passing parameters, and to extract data from return values. The DictionaryContainer class is an abstract base class that encapsulates the common code to wrap NSDictionary dictionaries like this.

When creating a strongly-typed wrapper for an NSDictionary, subclass the DictionaryContainer and provide two constructors: one taking an NSDictionary (to create the wrapper) and a default costructor. They should each call the corresponding base class (DictionaryContainer) constructor. Then use one of the various Get and Set methods exposed by this class to get and set values. This is how a sample class would work:

public class MyProperties : DictionaryContainer {
    public MyProperties () : base ()
    {
    }

    public MyProperties (NSDictionary dictionary) : base (dictionary)
    {
    }

    static NSString boolKey = new NSString ("SomeBoolKey");

    public bool MyBool {
        get => return GetInt32Value (boolKey);
        set => SetInt32Value (boolKey, value);
    }
}