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

TaskDialog for WinForms

, 5 Jan 2007
Rate this:
Please Sign up or sign in to vote.
Using Vista Task Dialog from WinForms - here is some code to do it.

Introduction

Vista's new TaskDialog API’s are really cool and should see lame message boxes banished from you application. We've already seen some articles on using them from C++ but they are not trivial to use from managed code, so here is some code that makes using all the features of the new Task Dialogs really easy in WinForms.

The code is C# and is StyleCop, FXCop and PreSharp clean. Usability and discoverability were given preference to performance and size, with plenty of comments that should be really useful in Intellisense as you explore what Task Dialogs can do. You don’t have to use anything with a shouted (all capitals) name and all the features of Task Dialog are exposed including the callback and actions you can perform on an active Task Dialog. If you hate the very idea of wrappers and want the raw interop declarations, they are all there too.

Using the code

The main class is TaskDialog. The simplest usage gets you MessageBox behavior:

    TaskDialog taskDialog = new TaskDialog();
    taskDialog.WindowTitle = "My Application";
    taskDialog.MainInstruction = "Do you want to do this?";
    taskDialog.CommonButtons = TaskDialogCommonButtons.Yes | TaskDialogCommonButtons.No;
    int result = taskDialog.Show();
    if (result == (int)DialogResult.Yes)
    {
        // Do it.
    }

TaskDialog with Yes No buttons

From there you can add hyperlinks for help, more structure (adding content, extended info and footer to main instruction), a checkbox for "don’t ask me again", custom button names, etc.:

    private void SampleUsageComplex()
    {
        TaskDialog taskDialog = new TaskDialog();
        taskDialog.WindowTitle = "My Application";
        taskDialog.MainInstruction = "Do you want to do this?";

        taskDialog.EnableHyperlinks = true;
        taskDialog.Content = "If you do this there could be all sorts of consequences. " +
            "If you don't there will be other consequences. " +
            "You can <A HREF=\"Learn\">learn more about those consequences </A> or more " +
            "about <A HREF=\"blah\">blah blah blah</A>.";
        taskDialog.Callback = new TaskDialogCallback(this.MyTaskDialogCallback);
 
        taskDialog.VerificationText = "Don't ask me this ever again.";
        taskDialog.VerificationFlagChecked = false;
 
        TaskDialogButton doItButton = new TaskDialogButton();
        doItButton.ButtonId = 101;
        doItButton.ButtonText = "Do It";
 
        TaskDialogButton dontDoItButton = new TaskDialogButton();
        dontDoItButton.ButtonId = 102;
        dontDoItButton.ButtonText = "Don't Do It";

        taskDialog.Buttons = new TaskDialogButton[] { doItButton, dontDoItButton };
 
        bool dontShowAgain;
        int result = taskDialog.Show(null, out dontShowAgain);
        if (dontShowAgain)
        {
            // Suppress future asks.
        }
        if (result == doItButton.ButtonId)
        {
            // Do it.
        }
    }

    private bool MyTaskDialogCallback(
        ActiveTaskDialog taskDialog, 
        TaskDialogNotificationArgs args, 
        object callbackData)
    {
        if (args.Notification == TaskDialogNotification.HyperlinkClicked)
        {
            if (args.Hyperlink.Equals("Learn", StringComparison.Ordinal))
            {
                // Show a help topic.
            }
            else if (args.Hyperlink.Equals("blah", StringComparison.Ordinal))
            {
                // Show a different help topic.
            }
        }
        return false;
    }

TaskDialog with hyperlink and verify checkbox

To get a better idea of all the things you can do with a TaskDialog download the demo, extract the TaskDialogTest.exe and TaskDialog.dll to the same directory and run TaskDialogTest.exe. You'll get a rather large dialog which, while not beautiful, will let you try out the TaskDialog and perhaps sample what different uses in your application would look like.

TaskDialog with hyperlink and verify checkbox

To make use of TaskDialog in your own solution, download the source and include the following source files in your project and adapt them as you see fit:

  • ActiveTaskDialog.cs
  • TaskDialog.cs
  • TaskDialogNotificationArgs.cs
  • UnsafeNativeMethods.cs

Alternatively you could include the TaskDialog project into you solution.

I look forward to seeing a lot fewer Message Boxes in you applications and I hope this makes it easier. Keep in mind good UI design when you're tempted to use all those features in the one dialog.

License

This article, along with any associated source code and files, is licensed under A Public Domain dedication

Share

About the Author

KevinGre
Software Developer
United States United States
No Biography provided

Comments and Discussions

 
GeneralIssue in parameter to EnableButton() and EnableRadioButton() when calling from VB.NET PinmemberAndrewCushen18-Dec-08 16:58 
This is great work, and is much appreciated; I started to do this myself in VB.NET, but ran out of time and kept hitting walls with the unsafe code.
 
You may, however, wish to document that there's a minor issue in the EnableButton() and EnableRadioButton() functions in ActiveTaskDialog.CS, when you call the code from VB.NET:
 
The True/False test appears to be reversed when calling these two functions from VB.NET, so that when you pass in the button id and False, the button is enabled. This is contrary to your documentation, which states that passing in False should disable the button, and is also contrary to the behavior when calling your code from C#, where it exhibits the proper behavior.
 
I can only guess that this has to do with the differing way in which the C-based languages treat 0/1 as true/false.
 

With that in mind, there are two approaches a VB.NET user can take to work around the issue.
 
The first, and simplest, is to just remember to reverse True/False when calling the 2 functions from VB.NET.
 
The second is to actually change the code in the C# source to match the documentation. This approach is probably preferable for the VB.NET programmer if and only if they are 100% certain the code will never be called from C#.
 
For those who choose the second option, the following line in both functions:
(IntPtr)(enable ? 0 : 1 ));
 
should be changed to read:
(IntPtr)(enable ? 1 : 0 ));
 
It is extremely important that the user document whichever approach they choose; the "enable" parameter in the XML comment above the function in the source code file should be changed to indicate either that VB.NET users should reverse the Boolean logic, or that C# users should.
 
-AndrewC

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
Web03 | 2.8.140826.1 | Last Updated 5 Jan 2007
Article Copyright 2007 by KevinGre
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid