Click here to Skip to main content
Click here to Skip to main content

A flag editor

, 17 Oct 2002
Rate this:
Please Sign up or sign in to vote.
This piece of code is the implementation of a simple flags editor. It can be used to edit flags in a property grid.

Sample Image - FlagsEditor.gif

Introduction

This editor displays a dropdown control holding a CheckedListBox with all the values of an enumeration.

Using the FlagsEditor

You just have to put the Editor attributes on an enumeration to link it with the FlagsEditor. A Description attribute can also be added to each value. It will be shown as a tooltip on the CheckedListBox items.

Here is a sample.

[Flags,
  Editor(typeof(STUP.ComponentModel.Design.FlagsEditor), 
  typeof(System.Drawing.Design.UITypeEditor))]
public enum EnumerationTest
{
    [Description("Description for the first tested value.")]
    firstValue = 1,
    [Description("Description for the second tested value.")]
    secondValue = 2,
    [Description("Description for the third tested value.")]
    thirdValue = 4
}

How does it work ?

The Editor is just one class that inherits UITypeEditor. The behavior of Editor is controlled by two functions.

GetEditStyle

This function is used for controlling the appearance of the small button in the property grid. In this sample a dropdown arrow will be shown.

public override UITypeEditorEditStyle 
       GetEditStyle(ITypeDescriptorContext context) 
{
    return UITypeEditorEditStyle.DropDown;
}

EditValue

This function is called when the user clicks on the small button.

public override object EditValue(ITypeDescriptorContext context, 
        IServiceProvider provider, object value) 
{
    if (context != null
        && context.Instance != null
        && provider != null) 
    {

        // Get an instance of the IWindowsFormsEditorService. 
        edSvc = (IWindowsFormsEditorService)provider.GetService
                            (typeof(IWindowsFormsEditorService));

        if (edSvc != null) 
        {
            // Create a CheckedListBox
            clb = new CheckedListBox();

            ...

            // Show our CheckedListbox as a DropDownControl. 
            // This methods returns only when
            // the dropdowncontrol is closed
            edSvc.DropDownControl(clb);


            // return the right enum value
            // corresponding to the result
            return ...
        }
    }

    return value;
}

The DropDownControl can be closed by calling the edSvc.CloseDropDown() function.

For a complete example, just download the source file.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Thierry Bouquain
Web Developer
France France
No Biography provided

Comments and Discussions

 
GeneralVB.NET Port + Little Extra Feature PinmemberThe_Mega_ZZTer5-Aug-05 5:16 
Generalcant get the zip file PinsussPaul Ashton14-Apr-05 1:10 
GeneralRe: cant get the zip file PinmemberThe_Mega_ZZTer5-Aug-05 5:15 
GeneralThank You PinmemberDave Mc Kenzie14-Oct-04 22:26 
QuestionHow to use this concept for other types? PinmemberDerSebastian4-Oct-04 3:29 
AnswerRe: How to use this concept for other types? Pinmembereschneider1009-Nov-05 12:15 
GeneralNice Job! Pinmemberglusk30-Aug-04 9:52 
GeneralFlag Editor PinmemberFregate18-Dec-03 19:10 
GeneralRe: Flag Editor PinmemberShyH26-Jan-04 20:02 
GeneralIt took... PinmemberJames T. Johnson28-May-03 1:32 
GeneralRe: It took... PinmemberNnamdi Onyeyiri28-May-03 3:45 
GeneralIgnore the people PinmemberPete Bassett6-Dec-02 1:16 
GeneralRe: Ignore the people PinmemberVirender Sandhu9-Feb-03 10:28 
Questionumm ... I second the ... What is this exactly ? PinsussAnonymous18-Oct-02 17:17 
AnswerRe: umm ... I second the ... What is this exactly ? PineditorJames T. Johnson18-Oct-02 17:46 
GeneralRe: umm ... I second the ... What is this exactly ? PinmemberPhilippe Lhoste22-Oct-02 6:32 
GeneralRe: umm ... I second the ... What is this exactly ? Pinmemberstestagg10-Jul-08 2:01 
Questionumm...what is this exactly? PinmemberMarc Clifton18-Oct-02 11:13 
AnswerRe: umm...what is this exactly? PinmemberEd.Poore24-Aug-06 5:09 
GeneralRe: umm...what is this exactly? PinprotectorMarc Clifton24-Aug-06 8:07 
GeneralRe: umm...what is this exactly? PinmemberEd.Poore24-Aug-06 8:19 
GeneralRe: umm...what is this exactly? Pinmemberpeterchen11-Apr-07 3:01 
General!wow PinmemberNorm Almond18-Oct-02 7:56 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140827.1 | Last Updated 18 Oct 2002
Article Copyright 2002 by Thierry Bouquain
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid