C# ListBox实现Item项显示多行("C# ListBox 多行显示Item项的实现方法")

原创

ithorizon 6个月前 (10-20) 阅读数 17 #后端开发

C# ListBox 多行显示Item项的实现方法

在C#的WinForms应用程序中，ListBox控件通常用于显示一个列表项集合。默认情况下，ListBox中的每个项都是单行显示的。但是，有时候我们需要在一个项中显示多行文本，以便提供更多的信息。下面，我将介绍怎样在C#中实现ListBox的多行显示Item项的功能。

一、设置ListBox的属性

要使ListBox能够显示多行文本，首先需要设置其几个关键属性：

MultiSelect属性设置为false，考虑到多行显示通常不需要多选功能。

SelectionMode属性设置为One，这描述用户只能选择一个项。

IntegralHeight属性设置为false，这样可以确保ListBox不会自动调整其高度以显示所有项。

DrawMode属性设置为OwnerDrawFixed，这描述列表项的绘制将由应用程序负责。

二、重写OnDrawItem方法

在设置了DrawMode属性后，需要重写ListBox的OnDrawItem方法来自定义每个项的绘制过程。以下是具体的实现代码：


protected override void OnDrawItem(DrawItemEventArgs e)
{
    e.DrawBackground();
    if (e.Index >= 0)
    {
        string text = this.Items[e.Index].ToString();
        string[] lines = text.Split(new string[] { Environment.NewLine }, StringSplitOptions.None);
        using (var brush = new SolidBrush(e.ForeColor))
        {
            for (int i = 0; i < lines.Length; i++)
            {
                e.Graphics.DrawString(lines[i], e.Font, brush, e.Bounds.X, e.Bounds.Y + i * e.Font.Height);
            }
        }
    }
    e.DrawFocusRectangle();
}

在这个方法中，我们首先调用e.DrawBackground()来绘制背景。然后，我们通过Items集合获取当前项的文本，并使用Environment.NewLine作为分隔符来拆分成多行。接着，我们使用Graphics对象来绘制每一行文本。最后，我们调用e.DrawFocusRectangle()来绘制焦点矩形。

三、设置Item的显示文本

为了在ListBox中显示多行文本，需要将每个项的文本设置为包含换行符的字符串。例如：


listBox1.Items.Add("第一行文本" + Environment.NewLine + "第二行文本");
listBox1.Items.Add("第三行文本" + Environment.NewLine + "第四行文本");

四、完整示例代码

下面是一个完整的示例，展示了怎样设置ListBox以显示多行文本项：


using System;
using System.Drawing;
using System.Windows.Forms;
public class MultiLineListBox : ListBox
{
    public MultiLineListBox()
    {
        this.DrawMode = DrawMode.OwnerDrawFixed;
        this.MultiSelect = false;
        this.SelectionMode = SelectionMode.One;
        this.IntegralHeight = false;
    }
    protected override void OnDrawItem(DrawItemEventArgs e)
    {
        e.DrawBackground();
        if (e.Index >= 0)
        {
            string text = this.Items[e.Index].ToString();
            string[] lines = text.Split(new string[] { Environment.NewLine }, StringSplitOptions.None);
            using (var brush = new SolidBrush(e.ForeColor))
            {
                for (int i = 0; i < lines.Length; i++)
                {
                    e.Graphics.DrawString(lines[i], e.Font, brush, e.Bounds.X, e.Bounds.Y + i * e.Font.Height);
                }
            }
        }
        e.DrawFocusRectangle();
    }
}
public class MainForm : Form
{
    private MultiLineListBox listBox1;
    public MainForm()
    {
        listBox1 = new MultiLineListBox();
        listBox1.Items.Add("第一行文本" + Environment.NewLine + "第二行文本");
        listBox1.Items.Add("第三行文本" + Environment.NewLine + "第四行文本");
        listBox1.Location = new Point(10, 10);
        listBox1.Size = new Size(200, 100);
        this.Controls.Add(listBox1);
    }
    [STAThread]
    static void Main()
    {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        Application.Run(new MainForm());
    }
}