Blue Theme Orange Theme Green Theme Red Theme
 
ASP.Net 4 Hosting is here
Home | Forums | Videos | Photos | Blogs | Beginners
 | Consulting  
Submit an Article Submit a Blog 
 Jump to
Skip Navigation Links
TechnologyExpand Technology
WebsiteExpand Website
ASP.Net 4 Hosting is here
 Resources  
Close
 Our Network  
Close
Search :       Advanced Search »
Home » VB.NET » Bit Flags Type Converter

Bit Flags Type Converter


This article shows an implementation of TypeConverter which allows you to edit bit flags enumerations in PropertyGrid.

Total page views :  6066
Total downloads :  56
   Print Read/Post comments Post a comment  Similar Articles  
   Email to a friend  Bookmark  Author's other articles  
Download Files:
FlagEnumConverter.zip
 
Become a Sponsor

While developing one of our components, iGrid.NET, I came across a problem: the PropertyGrid control does not provide you with a comfortable-enough editor for enumerations marked with the Flags attribute (enumerations that can be treated as bit fields; that are a set of flags). The property grid treats them as usual enumerations and allows you to select a single field from the drop-down list or enter a value as text. So I decided to implement own TypeConverter which would help to edit bit fields properties.

 

Sample Image

 

There can be a few solutions to this problem, for example we could show a check list box in the drop-down list. My solution is to show flags as sub-properties.

 

To assign a custom type converter to a property, you should use the TypeConverterAttribute attribute:

 

Public Class TestClass

 

    <TypeConverter(GetType(FlagsEnumConverter))> _

    Public Property FontStyle() As FontStyle

        Get

        End Get

        Set(ByVal value As FontStyle)

        End Set

    End Property

End Class

 

The parameter passed to the TypeConverterAttribute attribute should be inherited from the TypeConverter class or one of its descendents.

 

Our type converter is named FlagsEnumConverter and is inherited from the standard .NET EnumConverter class:

 

Friend Class FlagsEnumConverter

    Inherits EnumConverter

 

    Public Overloads Overrides Function GetProperties(ByVal context As ITypeDescriptorContext, ByVal value As  

    Object, ByVal attributes As Attribute()) As PropertyDescriptorCollection

    End Function

 

    Public Overloads Overrides Function GetPropertiesSupported(ByVal context As ITypeDescriptorContext) As Boolean

    End Function

End Class                       

TypeConverter has several overridable properties and methods which allow you to customize the appearance of a property in the property grid. In our type converter I overrode two methods: GetPropertiesSupported and GetProperties. By using these methods we inform the property grid that our property is complex (has several nested properties) and return descriptors of these nested properties (we show a single nested Boolean property for each bit flag):

 

Public Overrides Function GetProperties(ByVal context As ITypeDescriptorContext, ByVal value As Object, ByVal attributes As Attribute()) As PropertyDescriptorCollection

    Dim myType As Type = value.GetType

    Dim myNames As String() = Enum.GetNames(myType)

    Dim myValues As Array = Enum.GetValues(myType)

    If Not (myNames Is Nothing) Then

        Dim myCollection As PropertyDescriptorCollection = New PropertyDescriptorCollection(Nothing)

        Dim i As Integer = 0

        While i < myNames.Length

            myCollection.Add(New EnumFieldDescriptor(myType, myNames(i), context))

            System.Math.Min(System.Threading.Interlocked.Increment(i), i - 1)

        End While

        Return myCollection

    End If

End Function                       

Each bit flag (nested property) is represented with the EnumFieldDescriptor class inherited from the standard .NET class named SimplePropertyDescriptor. This is a base class which allows you to represent a custom property in property grid. The main interest of the EnumFieldDescriptor class is the GetValue and SetValue methods. The GetValue method is called each time when the property grid displays a custom property (a bit flag) and returns the value of the custom property (in our case it is a Boolean value which indicates whether the bit flag is included in the enumeration property value):

 

Public Overrides Function GetValue(ByVal component As Object) As Object

Return Not ((CType(component, Integer) And CType(Enum.Parse(ComponentType, Name), Integer)) = 0)

End Function                       

In the code snippet above ComponentType is the type of the enumeration, and Name is the name of the enumeration field (bit flag).

 

The SetValue method is more complicated, it is called when the user modifies a custom property. In our case it sets a particular bit flag to the enumeration value:

 

Public Overrides Sub SetValue(ByVal component As Object, ByVal value As Object)

    Dim myValue As Boolean = CType(value, Boolean)

    Dim myNewValue As Integer

    If myValue Then

        myNewValue = CType(component, Integer) Or CType(Enum.Parse(ComponentType, Name), Integer)

    Else

        myNewValue = CType(component, Integer) And Not CType(Enum.Parse(ComponentType, Name), Integer)

    End If

    Dim myField As FieldInfo = component.GetType.GetField("value_", BindingFlags.Instance Or BindingFlags.Public)

    myField.SetValue(component, myNewValue)

    fContext.PropertyDescriptor.SetValue(fContext.Instance, component)

End Sub    

In this method we accept a boxed enumeration value (the object type component parameter) which we should modify. The main problem is that an enumeration is value type (non-reference type) and if we unbox it (convert from the object type to an enumeration type), we will obtain different object, not the one passed with the component parameter. To solve it, I have done a little trick. Enumeration in core stores its actual value in a private parameter named value_ (you can trace it with a disassembler or decompiler). I have accessed this parameter by using reflection and set its value without unboxing.

 

NOTE: THIS ARTICLE IS CONVERTED FROM C# TO VB.NET USING A CONVERSION TOOL. ORIGINAL ARTICLE CAN BE FOUND ON C# CORNER (http://www.c-sharpcorner.com/).


Login to add your contents and source code to this article
 About the author
 
Serge Gorbenko
Looking for C# Consulting?
C# Consulting is founded in 2002 by the founders of C# Corner. Unlike a traditional consulting company, our consultants are well-known experts in .NET and many of them are MVPs, authors, and trainers. We specialize in Microsoft .NET development and utilize Agile Development and Extreme Programming practices to provide fast pace quick turnaround results. Our software development model is a mix of Agile Development, traditional SDLC, and Waterfall models.
Click here to learn more about C# Consulting.
 
Introducing MaxV - one click. infinite control. Hyper-V Hosting from MaximumASP.
Finally – a virtual platform that delivers next-generation Windows Server 2008 Hyper-V virtualization technology from a managed hosting partner you can truly depend on. Visit www.maximumasp.com/max for a FREE 30 day trial. Hurry offer ends soon. Climb aboard the MaxV platform and take advantage of High Availability, Intelligent Monitoring, Recurrent Backups, and Scalability – with no hassle or hidden fees. As a managed hosting partner focused solely on Microsoft technologies since 2000, MaximumASP is uniquely qualified to provide the superior support that our business is built on. Unparalleled expertise with Microsoft technologies lead to working directly with Microsoft as first to offer IIS 7 and SQL 2008 betas in a hosted environment; partnering in the Go Live Program for Hyper-V; and product co-launches built on WS 2008 with Hyper-V technology.
Dynamic PDF
ceTE software specializes in components for dynamic PDF generation and manipulation. The DynamicPDF™ product line allows you to dynamically generate PDF documents, merge PDF documents and new content to existing PDF documents from within your applications.
SQL and .NET performance profiling in one place
Investigate SQL and .NET code side-by-side with ANTS Performance Profiler 6, so you can see which is causing the problem without switching tools.
Go.NET
Build custom interactive diagrams, network, workflow editors, flowcharts, or software design tools. Includes many predefined kinds of nodes, links, and basic shapes. Supports layers, scrolling, zooming, selection, drag-and-drop, clipboard, in-place editing, tooltips, grids, printing, overview window, palette. 100% implemented in C# as a managed .NET Control. Document/View/Tool architecture with many properties&events. Optional automatic layout.
Dundas Software
Dundas Chart for .NET is the most advanced .NET charting package available today.  With an extremely complete feature set, elegant architecture and easy implementation, Dundas Chart can quickly add advanced Charting functionality to enhance and transform ASP.NET and Windows Forms applications.  Whether you are implementing charting into internal projects, or building applications for clients, Dundas Chart offers advanced technology and advanced results to get the most out of data.
60 FREE UI Controls from DevExpress
Register for your FREE copy on over 60 free presentation controls from DevExpress - Absolutely Free-of-Charge without any royalties or distribution costs. Visit Devexpress.com/60 today. Free controls include advanced lists box, dropdown calendar, rich text edit, spin edit, tab control and so much more!

DevExpress engineers feature rich presentation controls and reporting tools for WinForms, ASP.NET, WPF, and Silverlight. Our technologies help you build your best, see complex software with greater clarity and deliver compelling business solutions for Windows and the web in the shortest possible time.
Clickatell's SMS Gateway
Clickatell's Developer Solutions allow you to SMS enable any website or application via a range of API's. Learn More about our API connections.
Free access to .NET Memory Management video
Everything you need to know about Garbage Collection, Temporary Objects, Fragmentation, Finalization and common causes of memory leaks in .NET. Watch the video here.
Microsoft Visual Studio 2010
Visualize your workspace with new multiple monitor support, powerful Web development, new SharePoint support with tons of templates and Web parts, and more accurate targeting of any version of the .NET Framework. Get set to unleash your creativity.
Nevron Chart for .NET 2010.1 Now Available
The leading .NET charting control now features PDF, Flash and Silverlight export, visualization of large datasets and more. Deliver true charting functionality to your BI, Scorecard, Presentation or Scientific apps. Download evaluation now.
Developer-Ready ASP.NET 2.0 Web Hosting with 3 MONTHS FREE
Now supporting .NET 3.0 Framework with Windows Workflow Foundation, Windows Communication Foundation (WCF), Windows Presentation Foundation (WPF), windows CardSpace (WCS)! Providing more flexibility for Developers with Web Services Support and a User/Permission Manger. Also supporting MS SQL 2005/2000 with Real-Time Backups, FREE Automated Attach .MDF Tool, FREE SQL Restore and Shrink SQL DB Tools, and SQL
Read the Top 10 Books for Microsoft Developers, 15 Days FREE
Read the Top 10 Books for Microsoft Developers, 15 Days FREE
Try Safari Books Online - 15 Days FREE + 15% Off for 1 Year
Try Safari Books Online - 15 Days FREE + 15% Off for 1 Year
 
 Post a Feedback, Comment, or Question about this article
Subject:
Comment:
Nevron Chart
Become a Sponsor
 Comments

 Hosted by MaximumASP  |  Found a broken link?  |  Contact Us  |  Terms & conditions  |  Privacy Policy  |  Site Map  |  Suggest an Idea  |  Media Kit
Current Version: 5.2010.8.14
 © 2010  contents copyright of their authors. Rest everything copyright Mindcracker. All rights reserved.