ZDima.net

So I am still playing around with building a Northwind Dynamic Data web site. Tonight I thought it would be interesting to see what it would take to create a menu for navigating the tables in the site. I was particularly interested in seeing if I could get some grouping or categorization to the metadata so I could create a multi-leveled menu. It turns out it wasn't too difficult at all (see the screen shot below - the menu is on the left). I have my tables organized into 4 categories: Sales, People, Products and Reports. And the cool thing is that this menu is completely dynamic. You can add, remove or reorganize the categories without touching the UI. And depending where you are keeping your metadata you could even do this without recompiling your app. The grouping is automatically discovered from the metadata and the menu is built solely off the it so everything 'just works'.

Besides adding the grouping information, I also tagged each of my tables with a custom description that I am displaying under the grids title. Nothing too complicated, but still interesting. Read on if you are curious how I did this and don't forget to check out the download.

Download

Adding Category and Description

When MetaTable objects are created, the Dynamic Data components automatically populate the the MetaTable's DisplayName property from the DisplayNameAttribute that is hanging off the metadata class (if you are using the default metadata provider). This is why you see the nice 'Products By Category' title in the screen shot above. I have specifically told Dynamic Data to use this value because I tagged my metadata class with the DisplayName attribute and given it a value of 'Products By Category'. Below this metadata ...

[MetadataType(typeof(ProductByCategoryMetadata))]
public partial class Products_by_Category { }
 
[DisplayName("Products By Category")]
public class ProductByCategoryMetadata
{
    [ScaffoldColumn(false)]
    public object Discontinued { get; set; }
}

To add a category and description to the metadata, I just used the existing Category and Description attributes and added them to the metadata class as well. So now we have ...

[MetadataType(typeof(ProductByCategoryMetadata))]
public partial class Products_by_Category { }
 
[Category("Products")]
[Description("You can use this page to view your products by category")]
[DisplayName("Products By Category")]
public class ProductByCategoryMetadata
{
    [ScaffoldColumn(false)]
    public object Discontinued { get; set; }
}

The Category and Description attributes don't directly map to any properties on the MetaTable type. But, any extra custom attributes that are applied to in the metadata are passed through to the Attribute collection that hangs off the MetaTable class. So with a couple of pretty simple extensions methods I can add them myself (ignoring error handling for now) ...

public static class MetaTableExtensions
{
    /// 

    /// Gets the description for the MetaTable
    /// 
    public static string GetDescription(this MetaTable table)
    {
        return ((DescriptionAttribute)table.Attributes[typeof(DescriptionAttribute)]).Description;
    }
 
    /// 

    /// Gets the category for the MetaTable
    /// 
    public static string GetCategory(this MetaTable table)
    {
        return ((CategoryAttribute)table.Attributes[typeof(CategoryAttribute)]).Category;
    }
}

... and now to get at the MetaTable's description or category I can just go through these methods. So I updated the List template and added a little bit of code that generates a simple title bar generated from the MetaTables DisplayName and Description attributes.

and now our List pages have a nice dynamic title bar ...

Building the Menu

To build the menu, I am using a ListView tied to a LinqDataSource that uses a Linq query to create a 2 level object structure that I can bind to. First, I wired the LinqDataSource's Selecting event to the following bit of code that groups my tables by their category ...

protected void LdsMenu_Selecting(object sender, LinqDataSourceSelectEventArgs e)
{
    e.Result =
        from vt in MetaModel.Default.VisibleTables
        //  use the category to group the tables
        group vt by vt.GetCategory() into groups
        select new 
        {
            CategoryName = groups.Key,
            Tables = groups 
        };
}

Then I bound this data source to my ListView ...

And that's all it took to build my 2 level menu. Awesome!

Conclusion

Can Dynamic Data be used for more than admin screens and prototyping? I think it might. What about you?

That's it. Enjoy!