可自定义的 WPF 消息框

当我开始研究标准的 WPF 消息框时，我惊讶地发现它不是一个 WPF 特定的对象。事实证明，它完全由 Win32.Interop 功能实现，并且没有一丁点 WPF 的优点。我猜一个微软的辩护者可能会试图说明他们的方法如何通过几千字节来减少整体 .Net 代码占用，但我不买账。这里有一个真正的机会，但微软浪费了它。顺便说一句，这就是它无法以任何方式配置的原因——它使用 Windows 系统属性，仅此而已。您不允许偏离这些参数。糟糕的程序员！糟糕！糟糕！

除了标准功能，我还增加了对以下项目的修改支持。这首先是编写此代码的主要原因。

• 字体族
• 字体大小
• 消息区域文本和背景颜色
• 按钮面板背景颜色
• 自定义按钮模板支持
• 增强的默认按钮支持
• 设置消息框的最大可能宽度

如果你曾为 Windows.Forms 编写过代码，你可能曾需要使用 Windows.Forms.MessageBox，你可能已经注意到微软决定不支持 MessageBoxButton.AbortRetryIgnore 或 MessageBoxButton.RetryCancel。这也意味着这些按钮在默认按钮设置中也不可用。MessageBoxEx 将这些按钮（和相关的默认值）重新添加回了使用范围——请参阅下一篇文章部分。太棒了！

如您所知，标准的 MessageBox 是一个不需要实例化即可使用的静态对象。这个新的 MessageBoxEx 也是静态的，或者至少是“静态的”。为了实现它，我创建了一个标准的 WPF 窗口，其中包含静态和非静态属性和方法。其思想是程序员将调用一个静态的 MessageBoxEx.Show...() 方法，该方法将实例化该窗口的非静态版本。我还希望外部体验与标准的 MessageBox 尽可能相同，因此返回值与您从标准消息框获得的返回值相同。

此表单的 XAML 相当有限，因为我们并没有做任何花哨的事情。我认为 XAML 中的注释提供了足够的文档，不需要伴随的叙述。

可点击图标 - 由于图像不可“点击”，我不得不求助于处理 MouseLeftButtonUp 事件。最重要的是，我希望当鼠标悬停在图标上时，图标的视觉外观会发生变化，所以我将默认不透明度设置为 0.85，当消息框显示错误时，我会在图像中添加一个自定义样式（在代码隐藏中）来响应鼠标悬停，这将不透明度更改为 1.0 并将光标更改为手形。我还使用代码隐藏将工具提示添加到图像（实际上是图像的父网格，因为我无法使绑定工具提示在图像元素上工作），因此用户可以得到某种指示，表明该图标确实是可点击的。

可点击 URL - 可点击 URL 大致相同。底层控件是 TextBlock，不支持 Click 事件，所以我不得不再次处理 MouseLeftButtonUp 事件。我还创建了一个自定义样式，在 MouseEnter 上触发，以便我可以将光标更改为手形。事后看来，我本可以S使用 RichTextBox 来显示 URL，但我认为为时已晚，而且，我不认为这样做值得费力。

粗略检查后，代码背后并没有什么特别或技术上难以理解的地方。如前所述，代码主要分为静态和非静态字段、属性和方法。消息框本身需要实例化，但该类具有可用于轻松配置和渲染消息框的静态属性和方法。就像 MessageBox 一样，MessageBoxEx 提供了 Show() 方法（及其变体）的多个重载来显示自身。

就代码组织而言，我做了一些我通常不会做的事情，但这样做是为了方便将文件复制到您自己的代码中。首先，所有与 MessageBoxEx 类相关的类都位于 MessageBoxEx.xaml.cs 文件中。其次，我利用了该类是一个部分类的事实，将静态部分与非静态部分分开了。这可能看起来很奇怪，但它对我有所帮助，而这是最重要的事情。

为了使表单大小适中，我利用了窗口的 SizeToContent 属性（在 XAML 中）。此属性允许窗口根据其内容进行增长/缩小，从而使窗口仅在 XAML 中指定的最小和最大宽度/高度限制下尽可能大。SizeToContent 属性的一个奇怪的副作用是它在窗口在屏幕上定位之后才生效。这意味着如果窗口需要显示多行消息，则窗口将不会像预期那样在屏幕上“居中”。为了缓解这种行为，我必须处理窗口的 SizeChanged 事件，并手动将表单重新居中到屏幕上。代码足够简单，但我想在这里引用一下。

1月8日 - 请参阅本节末尾的更新通知！

扩展功能需要不同的方法名称（和必要的重载），因为这会导致参数冲突。除此之外，还需要一些额外的类来使实现和使用尽可能无缝。下面描述的所有扩展功能都可以组合到单个消息框中。

CheckBox

/// <summary>
/// Reresents the object that allows the checkbox state to be discoevered externally of the 
/// messagebox.
/// </summary>
public class MsgBoxExCheckBoxData : INotifyPropertyChanged
{
#region INotifyPropertyChanged

private bool isModified = false;
public bool IsModified { get { return this.isModified; } set { if (value != this.isModified) { this.isModified = true; this.NotifyPropertyChanged(); } } }
public event PropertyChangedEventHandler PropertyChanged;

protected void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
{
    if (this.PropertyChanged != null)
    {
        this.PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
        if (propertyName != "IsModified")
        {
            this.IsModified = true;
        }
    }
}
    
#endregion INotifyPropertyChanged

private string checkBoxText;
private bool   checkBoxIsChecked;

/// <summary>
/// Get/set the text content of the checkbox
/// </summary>
public string CheckBoxText      
{ 
    get { return this.checkBoxText;} 
    set 
    { 
        if (value != this.checkBoxText) 
        { 
            this.checkBoxText = value; 
            this.NotifyPropertyChanged(); 
        } 
    } 
}

/// <summary>
/// Get/set the flag that indicates whether the checkbox is checked
/// </summary>
public bool CheckBoxIsChecked 
{ 
    get { return this.checkBoxIsChecked; } 
    set 
    { 
        if (value != this.checkBoxIsChecked) 
        { 
            this.checkBoxIsChecked = value; 
            this.NotifyPropertyChanged(); 
        } 
    } 
}
}

MsgBoxExCheckBoxData checkboxData = new MsgBoxExCheckBoxData()
{ 
// I suspect you're sometimes going to want to persist this value (app 
// settings, etc), so how you set this value is completely up to you.
CheckBoxIsChecked = false, 
CheckBoxText = "Don't show this message anymore"
};

// In this particular example, handling the decision to show/not show a messagebox is 
// handled by checking the status of the checkbox data. The mesagebox itself doesn't care.
if (this.checkboxData != null && !this.checkboxData.CheckBoxIsChecked)
{
// show box with a checkbox
MessageBoxEx.ShowWithCheckBox("This is possibly pointless and can be permenantly "+
                                "dismissed by clicking the checkbox below."
                                , this.checkboxData, "Checkbox Sample");
}
else
{
MessageBoxEx.Show("But you said not to show the message anymore. Make up your mind.","Hypocrite Notice");
}

详细说明

MessageBoxEx.ShowWithDetails("Here's some source code. Click the Details expander below."
                            , Testmsg()
                            , "Really Long Message, With Deatils"
                            , MessageBoxButton.OK
                            , MessageBoxImage.Information);

可点击错误图标

public abstract class MsgBoxExDelegate
{
/// <summary>
/// Get/set the message text from the calling message box
/// </summary>
public string   Message     { get; set; }
/// <summary>
/// Get/set the details text (if it was specified in the messagebox)
/// </summary>
public string   Details     { get; set; }
/// <summary>
/// Get/set the message datetime at which this object was created
/// </summary>
public DateTime MessageDate { get; set; }

/// <summary>
/// Performs the desired action, and returns the result. MUST BE OVERIDDEN IN INHERITING CLASS. 
/// </summary>
/// <returns></returns>
public virtual MessageBoxResult PerformAction(string message, string details=null)
{ 
    throw new NotImplementedException(); 
}
}

public class ErrorMsgDelegate : MsgBoxExDelegate
{
public override MessageBoxResult PerformAction(string message, string details=null)
{
    this.Message = message;
    this.Details = details;
    this.MessageDate = DateTime.Now;

    // for this sample, we're just showing another messagebox
    MessageBoxResult result = MessageBoxEx.Show("You're about to do something because this is an "+
                                                "error message (clicking yes with play a beep sound). "+
                                                "Are you sure?", 
                                                "Send Error Message To Support", 
                                                MessageBoxButton.YesNo, 
                                                MessageBoxImage.Question);
    if (result == MessageBoxResult.Yes)
    {
        //indicate that they clicked yes
        SystemSounds.Beep.Play();
    }
    return result;
}
}

MessageBoxEx.SetErrorDelegate(this.errorDelegate);

// if you want the message box to be closed when the action is completed, do this:
MessageBoxEx.SetExitAfterErrorAction(true);

MessageBoxEx.Show("Show an error message. The icon is clickable.", "Error"
                , MessageBoxButton.OK, MessageBoxImage.Error);

在实现新的 URL 代码时，很明显扩展参数变得难以控制（URL 是第四个添加的扩展功能），所以我创建了一个额外的对象，作为参数传递给 ShowExt 方法（连同消息、标题、按钮和图像）。这个对象叫做 MsgBoxExtendedFunctionality，你可以在其中放置一个或多个你想要在给定消息框中使用的扩展功能。这有几个目的：a) 减少“特殊”版本的 Show 方法的数量（每个都有八个重载），以及 b) 如果我想添加更多扩展功能，可以减少维护时间。旧的方法（ShowWithCheckBox、ShowWithDetails 和 ShowWithCheBoxAndDetails）仍然存在，但它们已被修改为调用新的 ShowExt 方法，并且 Intellisense 已更新以显示它们已弃用。

要查看其用法示例，请查找 ClickMe_Nc 方法（它们处理示例应用程序窗口右侧按钮的点击）。

在您的应用程序启动的某个地方（我建议在 MainWindow 的构造函数中使用，因为那时您可以指定要继承适当字体属性的父窗口。在示例应用程序中，我创建了一个名为 InitMessageBox() 的方法，其中包含以下语句。

MessageBoxEx.SetParentWindow(this);
MessageBoxEx.SetMessageForeground(Colors.White);
MessageBoxEx.SetMessageBackground(Colors.Black);
MessageBoxEx.SetButtonBackground(MessageBoxEx.ColorFromString("#333333"));
MessageBoxEx.SetButtonTemplateName("AefCustomButton");
MessageBoxEx.SetMaxFormWidth(500);
		

在应用程序中完成此操作一次后，使用 MessageBoxEx 与使用原始 MessageBox 完全相同。

MessageBoxResult result = MessageBoxEx.Show("Your message. Continue?", "Caption", MessageBoxButton.YesNoCancel);
		

当然，如果未指定按钮组，则按钮规范默认为 MessageBoxButton.OK。

Show() 方法显示一个消息框，它代表标准 WPF MessageBox 的功能类似版本。此方法接受以下参数。

Show() 方法返回一个 MessageBoxResult 值。这用于指示单击了哪个按钮来关闭消息框窗口。如果用户单击窗口的关闭按钮，则返回值将根据以下内容选择：

• 对于 MessageBoxButton.OK，结果将是 MessageBoxButton.OK
• 对于 MessageBoxButton.OKCancel，结果将是 MessageBoxButton.Cancel
• 对于 MessageBoxButton.YesNo，结果将是 MessageBoxButton.No
• 对于 MessageBoxButton.YesNoCancel，结果将是 MessageBoxButton.Cancel

ShowEx() 方法与 Show() 方法类似，不同之处在于它显示一个实现扩展功能的消息框。此方法接受以下参数。

MessageBoxEx.Show("My message text", MessageBoxButtonEx.YesNo, MessageBoxButtonEx.OK)

MessageBoxEx.Show("My message text", MessageBoxButtonEx.OK, MessageBoxButtonEx.YesNo)

MessageBoxEx.Show("My message text", MessageBoxButtonEx.OkayCancel, MessageBoxButtonEx.YesNo)

扩展功能类（MsgBoxExtendedFunctionality）为标准消息框的所有可用/未来扩展提供了一站式服务。它只是所有扩展功能对象的容器，使扩展功能的使用变得更加简单。其思想是用户将根据给定情况所需的内容填充此对象。事实上，只需要包含给定消息框实例所需的那些对象。如果未填充的对象可能影响其当前属性值，消息框将简单地使用其当前属性值。

使用此类别相当简单，您可以使用对象初始化器填充它，如下所示

MsgBoxExtendedFunctionality ext = new MsgBoxExtendedFunctionality()
{
// Default button - you only need to set this if you want to use something 
// other than the standard Windows.Forms.MessageBox default button 
staticButtonDefault = this.ButtonDefault;

// clickable icon
MessageDelegate  = this.errorDelegate,
ExitAfterAction  = true,
// you can also set the tooltip text, but for the purposes of this demo, we're 
// using the default value
//,DelegateToolTip = null

// checkbox
CheckBoxData     = this.checkboxData,

// details
DetailsText      = this.Testmsg(),

// url
    
URL              = new MsgBoxUrl()
{
    URL          = new Uri("http://www.google.com"),
    DisplayName  = "Google",
    Foreground   = Colors.LightBlue
}
};

当您查看构造函数时，您会发现所有内容都设置为某个默认值，以确保每次调用 MessageBoxEx.ShowEx() 都使用自己的设置。

public MsgBoxExtendedFunctionality()
{
this.ButtonDefault   = MessageBoxButtonDefault.Forms;
this.DetailsText     = null;
this.CheckBoxData    = null;
this.MessageDelegate = null;
this.URL             = null;
this.DelegateToolTip = "Click this icon for additional info/actions.";
}

如果您想添加新的扩展功能，请创建您的扩展功能对象，并将其作为属性添加到此类别中。您可能还需要在 MessageBoxEx 中添加更多的静态配置方法来处理新功能的设置。

此对象允许您创建一个可绑定的对象，该对象可以在消息框外部（在显示消息框的代码中）进行评估，并且最有可能用于允许应用程序用户选择不查看给定消息框。

public class MsgBoxExCheckBoxData : INotifyPropertyChanged
{
#region INotifyPropertyChanged

private bool isModified = false;
public bool IsModified { get { return this.isModified; } set { if (value != this.isModified) { this.isModified = true; this.NotifyPropertyChanged(); } } }
/// <summary>
/// Occurs when a property value changes.
/// </summary>
public event PropertyChangedEventHandler PropertyChanged;

/// <summary>
/// Notifies that the property changed, and sets IsModified to true.
/// </summary>
/// <param name="propertyName">Name of the property.</param>
protected void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
{
    if (this.PropertyChanged != null)
    {
        this.PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
        if (propertyName != "IsModified")
        {
            this.IsModified = true;
        }
    }
}
    
#endregion INotifyPropertyChanged

private string checkBoxText;
private bool   checkBoxIsChecked;

/// <summary>
/// Get/set the text content of the checkbox
/// </summary>
public string CheckBoxText      
{ 
    get { return this.checkBoxText; } 
    set 
    { 
        if (value != this.checkBoxText) 
        { 
            this.checkBoxText = value; 
            this.NotifyPropertyChanged(); 
        } 
    } 
}
/// <summary>
/// Get/set the flag that indicates whether the checkbox is checked
/// </summary>
public bool CheckBoxIsChecked 
{ 
    get { return this.checkBoxIsChecked; } 
    set 
    { 
        if (value != this.checkBoxIsChecked) 
        { 
            this.checkBoxIsChecked = value; 
            this.NotifyPropertyChanged(); 
        } 
    } 
}
}

一种可能的用法是这样的

MsgBoxExCheckBoxData checkboxData = new MsgBoxExCheckBoxData()
{ 
CheckBoxIsChecked = false, 
CheckBoxText = "Don't show this message any more"
};
MsgBoxExtendedFunctionality ext = new MsgBoxExtendedFunctionality()
{
CheckBoxData = this.checkboxData
};
MessageBoxEx.ShowEx("Message text", ext);

当消息框返回时，ext.CheckBoxData 对象包含在消息框中设置的复选框的当前选中状态。如何持久化此值完全取决于您。

public abstract class MsgBoxExDelegate
{
/// <summary>
/// Get/set the message text from the calling message box
/// </summary>
public string   Message     { get; set; }
/// <summary>
/// Get/set the details text (if it was specified in the messagebox)
/// </summary>
public string   Details     { get; set; }
/// <summary>
/// Get/set the message datetime at which this object was created
/// </summary>
public DateTime MessageDate { get; set; }

/// <summary>
/// Performs the desired action, and returns the result. MUST BE OVERIDDEN IN INHERITING CLASS. 
/// </summary>
/// <returns></returns>
public virtual MessageBoxResult PerformAction(string message, string details = null)
{
    throw new NotImplementedException();
}
}

此类允许您使消息框图标可点击，并且当它被点击时，执行此对象中包含的代码（PerformAction 方法）。此（抽象）类必须被继承，并且当图标被点击时，PerformAction 方法将被执行。

public class MsgBoxUrl
{
/// <summary>
/// Get/set the web link. Any Uri type other than "http" is ignored. The URL is also used for the tooltip.
/// </summary>
public Uri                        URL         { get; set; }
/// <summary>
/// Get/set the optional display name for the web link
/// </summary>
public string                     DisplayName { get; set; }
/// <summary>
/// Get/set the foreground color for the web link
/// </summary>
public System.Windows.Media.Color Foreground  { get; set; }

public MsgBoxUrl()
{
    // default color
    this.Foreground = MessageBoxEx.DefaultUrlForegroundColor;
}

此类允许您在消息框中指定用户可以点击的 URL。