UPDATE: Xavier Decoster already wrote a nice article on this topic some time ago. Please check it out! (Note to self: improve google skills)
First, let me say that I’ll take the long route, so if you are already familiar with dynamic typing in C# you can probably jump straight to the last section. Otherwise read on, you may learn something cool that is not used every day but can save you in some situations.
In the [not so] old days of Silverlight 3 if you wanted to dynamically create a class you had to emit intermediate language instructions, etc. Definitely not so easy. Silverlight 4 (with C# 4.0) introduced support for dynamics and simplified this a lot.
Straight from the DynamicObject documentation, this simple implementation of a dynamic dictionary uses an internal dictionary to store string/object pairs where the key is the member name and value is its associated value.
public class DynamicDictionary : DynamicObject
{
Dictionary<string, object> dictionary =
new Dictionary<string, object>();
public override bool TryGetMember(
GetMemberBinder binder, out object result)
{
return dictionary.TryGetValue(binder.Name, out result);
}
public override bool TrySetMember(
SetMemberBinder binder, object value)
{
dictionary[binder.Name] = value;
return true;
}
}
In a DynamicObject you have two methods (TryGetMember and TrySetMember) that are invoked every time someone tries to access the objects’ members. In this particular implementation, when this code is executed
dynamic myDynamicObject = new DynamicDictionary();
myDynamicObject.FirstName = "John";
myDynamicObject.Age = 18;
two pairs “FirstName”/”John” and “Age”/18 are stored in the internal dictionary. On the other hand when you do
string test = myDynamicObject.FirstName;
instead of calling the getter of FirstName (like any statically typed object would do), TryGetMember is invoked and the value corresponding to key “FirstName” is looked up from the internal dictionary.
The dynamic keyword tells the compiler that the member will be looked up at runtime, so you can set/get any member you want and the compiler won’t complain: he knows the members will be resolved while the program is running.
The binding problem
Now there is only a small problem with this approach (and it’s the whole point of this post): if you create a binding that targets a dynamic member you’ll get an error. It looks like the Silverlight binding engine “cannot discover” dynamic properties.
For example this does not work:
public dynamic MyDynamicDictionary { get; set; }
// ...
MyDynamicDictionary = new DynamicDictionary();
MyDynamicDictionary.Label = "Hello, I'm dynamic!";
<Button Content="{Binding MyDynamicDictionary.Label}"/>
If you look at the output:
System.Windows.Data Error: BindingExpression path error: 'Label' property not found on 'SilverlightApplication22.DynamicDictionary'
Indexed binding to the rescue
Telerik’s Vladimir Enchev explains on his blog how this approach can be used to implement a dataTable-like structure that can back for ex. a datagrid. The clever bit is that he added to the DynamicDictionary the [] indexer:
public object this[string columnName]
{
get
{
if (dictionary.ContainsKey(columnName))
return dictionary[columnName];
return null;
}
set
{
if (!dictionary.ContainsKey(columnName))
{
dictionary.Add(columnName, value);
RaisePropertyChanged(columnName);
}
else
{
dictionary[columnName] = value;
RaisePropertyChanged(columnName);
}
}
}
Now we have two alternatives to access the dynamically-created members:
// like before:
dynamic myDynamicObject2 = new DynamicDictionary();
myDynamicObject2.FirstName = "John";
myDynamicObject2.LastName = "Smith";
// using []:
var myDynamicObject3 = new DynamicDictionary();
myDynamicObject["FirstName"] = "John";
myDynamicObject["LastName"] = "Smith";
The two approaches have exactly the same effect (notice that in the second version the variable is declared with var instead of dynamic).
Using square brackets to access members has the advantage that you can actually create members using strings: let’s say you have a string/object dictionary, it’s easy to loop the dictionary entries and “create” a member for every key while setting the value as the member value. After this you’ll have an object that mirrors the dictionary:
var source = new Dictionary<string, object>();
source.Add("FirstName", "John");
source.Add("LastName", "Smith");
source.Add("Age", 18);
var target = new DynamicDictionary();
foreach (var entry in source)
target[entry.Key] = entry.Value;
now target is the same as you would have after doing
new something() { FirstName = "John", LastName = "Smith", Age = 18 };
except that it “adapts” to any key/value you have in the dictionary. Cool eh?!
It turns out that the indexer has another side benefit (that solves the binding problem). In fact Silverlight 4 also introduced indexed bindings: you can create bindings that target indexed structures (like a list or a dictionary) simply using square brackets. The nice thing is that our dynamic class happens to have an indexer.
Let’s revisit our code: if we declare the property as DynamicDictyionary instead of dynamic (we now must set the properties using the indexer because the compiler only allows “non-existing” properties on object of dynamic type):
public DynamicDictionary MyDynamicDictionary { get; set; }
//...
MyDynamicDictionary = new DynamicDictionary();
MyDynamicDictionary["Label"] = "Hello, I'm dynamic!";
and change the XAML to look like this (notice the square brackets)
<Button Content="{Binding MyDynamicDictionary2[Label]}"/>
the dynamic binding does work fine:
Happy dynamic binding!
Download the code
