Практическое руководство. Отображение переключателей в элементе управления MenuStrip (Windows Forms)

Похожи переключателей, также известный как переключатели, флажки, за исключением того, что пользователи могут выбрать только один раз. Несмотря на то что по умолчанию ToolStripMenuItem класс не предоставляет поведение переключателей, класс обеспечивает поведение "флажок", которое можно настроить для реализации поведения переключателей для пунктов меню в MenuStrip элемента управления.

Когда CheckOnClick свойство пункта меню true, пользователь может щелкнуть элемент, чтобы показать или скрыть метку. Checked Свойство указывает текущее состояние элемента. Для реализации поведения базовый переключатель, вы должны убедиться, что при выборе элемента Checked свойство для ранее выбранный элемент в false.

Следующие процедуры описывают способы реализации это так и дополнительную функциональность в класс, наследующий ToolStripMenuItem класса. ToolStripRadioButtonMenuItem Класс переопределяет члены, такие как OnCheckedChanged и OnPaint для предоставления выбора поведение и внешний вид кнопки. Кроме того, этот класс переопределяет Enabled свойство, параметры в подменю отключены, если не выбран родительский элемент.

Для реализации поведения выбора переключателей

Инициализировать CheckOnClick свойства true Включение выбора элемента.

// Called by all constructors to initialize CheckOnClick.
private void Initialize()
{
    CheckOnClick = true;
}

Переопределить OnCheckedChanged метод, чтобы снять выделение ранее выбранного элемента, если элемент выбран.

protected override void OnCheckedChanged(EventArgs e)
{
    base.OnCheckedChanged(e);

    // If this item is no longer in the checked state or if its 
    // parent has not yet been initialized, do nothing.
    if (!Checked || this.Parent == null) return;

    // Clear the checked state for all siblings. 
    foreach (ToolStripItem item in Parent.Items)
    {
        ToolStripRadioButtonMenuItem radioItem =
            item as ToolStripRadioButtonMenuItem;
        if (radioItem != null && radioItem != this && radioItem.Checked)
        {
            radioItem.Checked = false;

            // Only one item can be selected at a time, 
            // so there is no need to continue.
            return;
        }
    }
}

Переопределить OnClick метод, чтобы гарантировать, что нажатие кнопки элемента, который уже был выбран не очищает выделение.
```
protected override void OnClick(EventArgs e)
{
    // If the item is already in the checked state, do not call 
    // the base method, which would toggle the value. 
    if (Checked) return;

    base.OnClick(e);
}
```

Чтобы изменить внешний вид элементов переключателей

Переопределить OnPaint метод для замены по умолчанию — флажок кнопки выбора параметра с помощью RadioButtonRenderer класса.

// Let the item paint itself, and then paint the RadioButton
// where the check mark is normally displayed.
protected override void OnPaint(PaintEventArgs e)
{
    if (Image != null)
    {
        // If the client sets the Image property, the selection behavior
        // remains unchanged, but the RadioButton is not displayed and the
        // selection is indicated only by the selection rectangle. 
        base.OnPaint(e);
        return;
    }
    else
    {
        // If the Image property is not set, call the base OnPaint method 
        // with the CheckState property temporarily cleared to prevent
        // the check mark from being painted.
        CheckState currentState = this.CheckState;
        this.CheckState = CheckState.Unchecked;
        base.OnPaint(e);
        this.CheckState = currentState;
    }

    // Determine the correct state of the RadioButton.
    RadioButtonState buttonState = RadioButtonState.UncheckedNormal;
    if (Enabled)
    {
        if (mouseDownState)
        {
            if (Checked) buttonState = RadioButtonState.CheckedPressed;
            else buttonState = RadioButtonState.UncheckedPressed;
        }
        else if (mouseHoverState)
        {
            if (Checked) buttonState = RadioButtonState.CheckedHot;
            else buttonState = RadioButtonState.UncheckedHot;
        }
        else
        {
            if (Checked) buttonState = RadioButtonState.CheckedNormal;
        }
    }
    else
    {
        if (Checked) buttonState = RadioButtonState.CheckedDisabled;
        else buttonState = RadioButtonState.UncheckedDisabled;
    }

    // Calculate the position at which to display the RadioButton.
    Int32 offset = (ContentRectangle.Height -
        RadioButtonRenderer.GetGlyphSize(
        e.Graphics, buttonState).Height) / 2;
    Point imageLocation = new Point(
        ContentRectangle.Location.X + 4,
        ContentRectangle.Location.Y + offset);

    // Paint the RadioButton. 
    RadioButtonRenderer.DrawRadioButton(
        e.Graphics, imageLocation, buttonState);
}

Переопределить OnMouseEnter, OnMouseLeave, OnMouseDown, и OnMouseUp методы для отслеживания состояния мыши и убедитесь, что OnPaint метод рисует состояния правильный переключателя.

private bool mouseHoverState = false;

protected override void OnMouseEnter(EventArgs e)
{
    mouseHoverState = true;

    // Force the item to repaint with the new RadioButton state.
    Invalidate();

    base.OnMouseEnter(e);
}

protected override void OnMouseLeave(EventArgs e)
{
    mouseHoverState = false;
    base.OnMouseLeave(e);
}

private bool mouseDownState = false;

protected override void OnMouseDown(MouseEventArgs e)
{
    mouseDownState = true;

    // Force the item to repaint with the new RadioButton state.
    Invalidate();

    base.OnMouseDown(e);
}

protected override void OnMouseUp(MouseEventArgs e)
{
    mouseDownState = false;
    base.OnMouseUp(e);
}

Отключение пунктов подменю, если родительский элемент не выбран

Переопределить Enabled свойства таким образом, элемент остается недоступной, если он имеет родительский элемент с обоими CheckOnClick значение true и Checked значение false.

// Enable the item only if its parent item is in the checked state 
// and its Enabled property has not been explicitly set to false. 
public override bool Enabled
{
    get
    {
        ToolStripMenuItem ownerMenuItem =
            OwnerItem as ToolStripMenuItem;

        // Use the base value in design mode to prevent the designer
        // from setting the base value to the calculated value.
        if (!DesignMode &&
            ownerMenuItem != null && ownerMenuItem.CheckOnClick)
        {
            return base.Enabled && ownerMenuItem.Checked;
        }
        else return base.Enabled;
    }
    set
    {
        base.Enabled = value;
    }
}

Переопределить OnOwnerChanged метод подписаться на CheckedChanged событий родительского элемента.

// When OwnerItem becomes available, if it is a ToolStripMenuItem 
// with a CheckOnClick property value of true, subscribe to its 
// CheckedChanged event. 
protected override void OnOwnerChanged(EventArgs e)
{
    ToolStripMenuItem ownerMenuItem =
        OwnerItem as ToolStripMenuItem;
    if (ownerMenuItem != null && ownerMenuItem.CheckOnClick)
    {
        ownerMenuItem.CheckedChanged +=
            new EventHandler(OwnerMenuItem_CheckedChanged);
    }
    base.OnOwnerChanged(e);
}

В обработчике родительского элемента CheckedChanged событий, сделайте элемент для обновления экрана с новым состоянием включено.
```
// When the checked state of the parent item changes, 
// repaint the item so that the new Enabled state is displayed. 
private void OwnerMenuItem_CheckedChanged(
    object sender, EventArgs e)
{
    Invalidate();
}
```

Пример

В следующем примере кода приводится полное описание ToolStripRadioButtonMenuItem класса и Form класса и Program для демонстрации поведения переключателей.

using System;
using System.Drawing;
using System.Windows.Forms;
using System.Windows.Forms.VisualStyles;

public class ToolStripRadioButtonMenuItem : ToolStripMenuItem
{
    public ToolStripRadioButtonMenuItem()
        : base()
    {
        Initialize();
    }

    public ToolStripRadioButtonMenuItem(string text)
        : base(text, null, (EventHandler)null)
    {
        Initialize();
    }

    public ToolStripRadioButtonMenuItem(Image image)
        : base(null, image, (EventHandler)null)
    {
        Initialize();
    }

    public ToolStripRadioButtonMenuItem(string text, Image image)
        : base(text, image, (EventHandler)null)
    {
        Initialize();
    }

    public ToolStripRadioButtonMenuItem(string text, Image image,
        EventHandler onClick)
        : base(text, image, onClick)
    {
        Initialize();
    }

    public ToolStripRadioButtonMenuItem(string text, Image image,
        EventHandler onClick, string name)
        : base(text, image, onClick, name)
    {
        Initialize();
    }

    public ToolStripRadioButtonMenuItem(string text, Image image,
        params ToolStripItem[] dropDownItems)
        : base(text, image, dropDownItems)
    {
        Initialize();
    }

    public ToolStripRadioButtonMenuItem(string text, Image image,
        EventHandler onClick, Keys shortcutKeys)
        : base(text, image, onClick)
    {
        Initialize();
        this.ShortcutKeys = shortcutKeys;
    }

    // Called by all constructors to initialize CheckOnClick.
    private void Initialize()
    {
        CheckOnClick = true;
    }

    protected override void OnCheckedChanged(EventArgs e)
    {
        base.OnCheckedChanged(e);

        // If this item is no longer in the checked state or if its 
        // parent has not yet been initialized, do nothing.
        if (!Checked || this.Parent == null) return;

        // Clear the checked state for all siblings. 
        foreach (ToolStripItem item in Parent.Items)
        {
            ToolStripRadioButtonMenuItem radioItem =
                item as ToolStripRadioButtonMenuItem;
            if (radioItem != null && radioItem != this && radioItem.Checked)
            {
                radioItem.Checked = false;

                // Only one item can be selected at a time, 
                // so there is no need to continue.
                return;
            }
        }
    }

    protected override void OnClick(EventArgs e)
    {
        // If the item is already in the checked state, do not call 
        // the base method, which would toggle the value. 
        if (Checked) return;

        base.OnClick(e);
    }

    // Let the item paint itself, and then paint the RadioButton
    // where the check mark is normally displayed.
    protected override void OnPaint(PaintEventArgs e)
    {
        if (Image != null)
        {
            // If the client sets the Image property, the selection behavior
            // remains unchanged, but the RadioButton is not displayed and the
            // selection is indicated only by the selection rectangle. 
            base.OnPaint(e);
            return;
        }
        else
        {
            // If the Image property is not set, call the base OnPaint method 
            // with the CheckState property temporarily cleared to prevent
            // the check mark from being painted.
            CheckState currentState = this.CheckState;
            this.CheckState = CheckState.Unchecked;
            base.OnPaint(e);
            this.CheckState = currentState;
        }

        // Determine the correct state of the RadioButton.
        RadioButtonState buttonState = RadioButtonState.UncheckedNormal;
        if (Enabled)
        {
            if (mouseDownState)
            {
                if (Checked) buttonState = RadioButtonState.CheckedPressed;
                else buttonState = RadioButtonState.UncheckedPressed;
            }
            else if (mouseHoverState)
            {
                if (Checked) buttonState = RadioButtonState.CheckedHot;
                else buttonState = RadioButtonState.UncheckedHot;
            }
            else
            {
                if (Checked) buttonState = RadioButtonState.CheckedNormal;
            }
        }
        else
        {
            if (Checked) buttonState = RadioButtonState.CheckedDisabled;
            else buttonState = RadioButtonState.UncheckedDisabled;
        }

        // Calculate the position at which to display the RadioButton.
        Int32 offset = (ContentRectangle.Height -
            RadioButtonRenderer.GetGlyphSize(
            e.Graphics, buttonState).Height) / 2;
        Point imageLocation = new Point(
            ContentRectangle.Location.X + 4,
            ContentRectangle.Location.Y + offset);

        // Paint the RadioButton. 
        RadioButtonRenderer.DrawRadioButton(
            e.Graphics, imageLocation, buttonState);
    }

    private bool mouseHoverState = false;

    protected override void OnMouseEnter(EventArgs e)
    {
        mouseHoverState = true;

        // Force the item to repaint with the new RadioButton state.
        Invalidate();

        base.OnMouseEnter(e);
    }

    protected override void OnMouseLeave(EventArgs e)
    {
        mouseHoverState = false;
        base.OnMouseLeave(e);
    }

    private bool mouseDownState = false;

    protected override void OnMouseDown(MouseEventArgs e)
    {
        mouseDownState = true;

        // Force the item to repaint with the new RadioButton state.
        Invalidate();

        base.OnMouseDown(e);
    }

    protected override void OnMouseUp(MouseEventArgs e)
    {
        mouseDownState = false;
        base.OnMouseUp(e);
    }

    // Enable the item only if its parent item is in the checked state 
    // and its Enabled property has not been explicitly set to false. 
    public override bool Enabled
    {
        get
        {
            ToolStripMenuItem ownerMenuItem =
                OwnerItem as ToolStripMenuItem;

            // Use the base value in design mode to prevent the designer
            // from setting the base value to the calculated value.
            if (!DesignMode &&
                ownerMenuItem != null && ownerMenuItem.CheckOnClick)
            {
                return base.Enabled && ownerMenuItem.Checked;
            }
            else return base.Enabled;
        }
        set
        {
            base.Enabled = value;
        }
    }

    // When OwnerItem becomes available, if it is a ToolStripMenuItem 
    // with a CheckOnClick property value of true, subscribe to its 
    // CheckedChanged event. 
    protected override void OnOwnerChanged(EventArgs e)
    {
        ToolStripMenuItem ownerMenuItem =
            OwnerItem as ToolStripMenuItem;
        if (ownerMenuItem != null && ownerMenuItem.CheckOnClick)
        {
            ownerMenuItem.CheckedChanged +=
                new EventHandler(OwnerMenuItem_CheckedChanged);
        }
        base.OnOwnerChanged(e);
    }

    // When the checked state of the parent item changes, 
    // repaint the item so that the new Enabled state is displayed. 
    private void OwnerMenuItem_CheckedChanged(
        object sender, EventArgs e)
    {
        Invalidate();
    }

}

public class Form1 : Form
{
    private MenuStrip menuStrip1 = new MenuStrip();
    private ToolStripMenuItem mainToolStripMenuItem = new ToolStripMenuItem();
    private ToolStripMenuItem toolStripMenuItem1 = new ToolStripMenuItem();
    private ToolStripRadioButtonMenuItem toolStripRadioButtonMenuItem1 = 
        new ToolStripRadioButtonMenuItem();
    private ToolStripRadioButtonMenuItem toolStripRadioButtonMenuItem2 = 
        new ToolStripRadioButtonMenuItem();
    private ToolStripRadioButtonMenuItem toolStripRadioButtonMenuItem3 = 
        new ToolStripRadioButtonMenuItem();
    private ToolStripRadioButtonMenuItem toolStripRadioButtonMenuItem4 = 
        new ToolStripRadioButtonMenuItem();
    private ToolStripRadioButtonMenuItem toolStripRadioButtonMenuItem5 = 
        new ToolStripRadioButtonMenuItem();
    private ToolStripRadioButtonMenuItem toolStripRadioButtonMenuItem6 = 
        new ToolStripRadioButtonMenuItem();

    public Form1()
    {
        mainToolStripMenuItem.Text = "main";
        toolStripRadioButtonMenuItem1.Text = "option 1";
        toolStripRadioButtonMenuItem2.Text = "option 2";
        toolStripRadioButtonMenuItem3.Text = "option 2-1";
        toolStripRadioButtonMenuItem4.Text = "option 2-2";
        toolStripRadioButtonMenuItem5.Text = "option 3-1";
        toolStripRadioButtonMenuItem6.Text = "option 3-2";
        toolStripMenuItem1.Text = "toggle";
        toolStripMenuItem1.CheckOnClick = true;

        mainToolStripMenuItem.DropDownItems.AddRange(new ToolStripItem[] {
            toolStripRadioButtonMenuItem1, toolStripRadioButtonMenuItem2,
            toolStripMenuItem1});
        toolStripRadioButtonMenuItem2.DropDownItems.AddRange(
            new ToolStripItem[] {toolStripRadioButtonMenuItem3, 
            toolStripRadioButtonMenuItem4});
        toolStripMenuItem1.DropDownItems.AddRange(new ToolStripItem[] {
            toolStripRadioButtonMenuItem5, toolStripRadioButtonMenuItem6});

        menuStrip1.Items.AddRange(new ToolStripItem[] {mainToolStripMenuItem});
        Controls.Add(menuStrip1);
        MainMenuStrip = menuStrip1;
        Text = "ToolStripRadioButtonMenuItem demo";
    }
}

static class Program
{
    [STAThread]
    static void Main()
    {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        Application.Run(new Form1());
    }
}

Компиляция кода

Для этого примера требуются:

ссылки на сборки System, System.Drawing и System.Windows.Forms.