devexpress-winforms-accordion

name	devexpress-winforms-accordion
description	Expert skill for the DevExpress WinForms AccordionControl (DevExpress.XtraBars.Navigation.AccordionControl, DevExpress.Win.Navigation NuGet). Covers creating and populating accordion menus, data-driven element generation from collections, AccordionControlElement groups and items, content containers with embedded controls, header layout customization via HeaderTemplate, view types (Default accordion vs HamburgerMenu), Hamburger Menu display modes (Inline/Overlay/Minimal), minimize/expand state, Footer root-element mode, built-in and external search/filter panel, AI Smart Search, expand/collapse behavior, animations, appearance and HTML-CSS templates, context buttons, custom drawing, and guidance on choosing between AccordionControl, NavBarControl, and Hamburger Menu style. Use this skill when a user asks about WinForms side navigation, accordion menus, hamburger menus, collapsible navigation bars, AccordionControlElement configuration, NavigationFrame integration, or FluentDesignForm navigation setup.
compatibility	Requires .NET Framework 4.6.2+ or .NET 8+ targeting Windows. NuGet package `DevExpress.Win.Navigation`. DevExpress NuGet packages are published on nuget.org and via the local Unified Component Installer feed. A valid DevExpress license is required.
metadata	{"author":"DevExpress","version":"26.1","source-commit":"12b6ef2be47e805fd5fb7c9ce6f27cf705151d1c"}

DevExpress WinForms Accordion Control

AccordionControl is a side-navigation control that renders a hierarchical, expandable menu of groups and items. It is the recommended navigation control for new WinForms applications — more flexible than NavBarControl, and capable of serving as a full Hamburger Menu when ViewType = HamburgerMenu.

Groups (ElementStyle.Group) are expandable containers. Items (ElementStyle.Item) are clickable leaves that can optionally embed arbitrary WinForms controls inside an expandable content container. The hierarchy is unlimited in depth.

The control lives in the DevExpress.XtraBars.Navigation namespace and ships with the DevExpress.Win.Navigation NuGet package.

When to Use This Skill

• Setting up a side navigation menu in a WinForms application
• Adding groups, items, and content containers to an AccordionControl
• Generating menu items programmatically from data (lists, database queries, configuration)
• Switching the control to Hamburger Menu style and configuring display modes
• Customizing item headers, icons, appearance, and HTML-CSS templates
• Enabling search / filter functionality in the navigation menu
• Choosing between AccordionControl, NavBarControl, and Hamburger Menu style
• Integrating with NavigationFrame, RibbonForm, or FluentDesignForm

Prerequisites & Installation

NuGet Package

DevExpress.Win.Navigation

Install-Package DevExpress.Win.Navigation

Required Namespace Imports

using DevExpress.XtraBars.Navigation;
using DevExpress.XtraEditors;        // XtraForm
using DevExpress.XtraBars.Ribbon;    // RibbonForm (optional)

Host Form

Always host AccordionControl on XtraForm (or RibbonForm / FluentDesignForm) — not on plain Form — to get correct skin-aware rendering.

Before You Start — Ask the Developer

1. Is the navigation structure fixed at design time, or generated from data (list/database)?
2. Should the sidebar always be visible, or should it collapse to an icon strip (Hamburger Menu)?
3. Do items need embedded controls (DatePicker, ToggleSwitch, lists) inside them?
4. Does the app have a RibbonControl that should share a title bar with the accordion?
5. How deep is the hierarchy (2 levels → consider NavBarControl; 3+ → AccordionControl)?
6. Is there a search/filter requirement for the navigation items?

Documentation & Navigation Guide

Getting Started — Setup and Installation

Refer to references/getting-started.md (.NET 8+) or references/getting-started-dotnet-fw.md (.NET Framework 4.x) When you need to:

• Add AccordionControl to a project for the first time
• Choose the right host form type (XtraForm, RibbonForm, FluentDesignForm)
• Integrate with RibbonForm.NavigationControl

Data Binding and Populating Items

Refer to references/data-binding.md When you need to:

• Understand that AccordionControl has no DataSource — items are always added manually
• Generate items from a List<T>, database result, or configuration
• Use BeginUpdate() / EndUpdate() for bulk population
• Use Tag to attach data payloads to items
• Refresh items at runtime

When to Use AccordionControl vs NavBarControl vs Hamburger Menu

Refer to references/when-to-use.md When you need to:

• Choose between the three navigation controls
• Understand the feature differences (hierarchy depth, content containers, search, etc.)
• Migrate from NavBarControl to AccordionControl

View Modes

Refer to references/view-modes.md When you need to:

• Switch between Accordion (ViewType = Standard) and Hamburger Menu (ViewType = HamburgerMenu) styles
• Configure Hamburger Menu display modes: Inline, Overlay, Minimal
• Use Footer root-element mode (tab-like root items at the bottom)
• Control expand/collapse behavior, animation, and multi-expand settings

AccordionControlElement Settings and Customization

Refer to references/items-and-customization.md When you need to:

• Configure individual groups and items (text, icons, shortcuts, visibility)
• Embed custom controls inside an item via ContentContainer
• Rearrange header content blocks with HeaderTemplate
• Apply per-element appearance settings
• Use HTML-CSS templates for rich custom rendering
• Add context buttons or custom draw elements

Search and Filtering

Refer to references/search.md When you need to:

• Enable the built-in search panel (ShowFilterControl)
• Connect an external SearchControl to the accordion
• Implement custom filter logic with IFilterContent
• Configure filter delay
• Enable AI-powered Smart Search

Quick Start

Minimal side-navigation with two groups:

using DevExpress.XtraBars.Navigation;
using DevExpress.XtraEditors;
using System.Windows.Forms;

public partial class MainForm : XtraForm {
    public MainForm() {
        InitializeComponent();
        BuildNavigation();
    }

    void BuildNavigation() {
        var accordion = new AccordionControl {
            Dock = DockStyle.Left,
            Width = 220,
            ShowFilterControl = ShowFilterControl.Auto  // Ctrl+F to search
        };
        Controls.Add(accordion);

        accordion.BeginUpdate();

        var grpMain = new AccordionControlElement(ElementStyle.Group) {
            Text = "Main",
            Expanded = true
        };
        var itmDashboard = new AccordionControlElement(ElementStyle.Item) {
            Text = "Dashboard",
            Tag  = "dashboard"
        };
        var itmReports = new AccordionControlElement(ElementStyle.Item) {
            Text = "Reports",
            Tag  = "reports"
        };
        grpMain.Elements.AddRange(new[] { itmDashboard, itmReports });

        var grpSettings = new AccordionControlElement(ElementStyle.Group) {
            Text = "Settings"
        };
        var itmProfile = new AccordionControlElement(ElementStyle.Item) {
            Text = "Profile",
            Tag  = "profile"
        };
        grpSettings.Elements.Add(itmProfile);

        accordion.Elements.AddRange(new[] { grpMain, grpSettings });
        accordion.AllowItemSelection = true;
        accordion.EndUpdate();

        accordion.ElementClick += (s, e) => {
            if (e.Element.Style == ElementStyle.Item)
                // Navigate based on Tag
                NavigateTo(e.Element.Tag as string);
        };
    }

    void NavigateTo(string route) {
        // Update content area...
    }
}

Key API Surface

AccordionControl

API	Description
Elements	Root-level AccordionControlElement collection
ViewType	Standard (accordion) or HamburgerMenu
OptionsHamburgerMenu.DisplayMode	Inline, Overlay, or Minimal
OptionsMinimizing.State	Normal or Minimized
RootDisplayMode	Default or Footer
ExpandElementMode	Single or Multiple
AllowItemSelection	Highlight selected item
SelectedElement	Get/set selected element
ShowFilterControl	Never, Always, or Auto
FilterDelay	Delay (ms) before filter applies
FilterControl	Custom IFilterContent filter control (use IFilterContentEx for FilterText)
FilterText	Active filter text (effective when FilterControl implements IFilterContentEx)
HtmlTemplates	HTML-CSS templates for all element types
BeginUpdate() / EndUpdate()	Suppress redraws during bulk changes
ExpandAll() / CollapseAll()	Expand/collapse all elements
ElementClick	Fired when a group or item is clicked
ExpandStateChanging / ExpandStateChanged	Expand/collapse lifecycle events
CustomDrawElement	Owner-draw event

AccordionControlElement

API	Description
Style	Group or Item
Text	Header caption
Name	Code/designer identifier
Tag	User payload
Enabled / Visible	Enable/show element
Expanded	Initial expand state
Elements	Child elements collection (groups only)
ContentContainer	Embedded control area (items only)
ImageOptions.ImageUri.Uri	SVG icon from DX catalog
HeaderControl	Custom WinForms control in the header
HeaderTemplate	Header block order and alignment
Appearance	Per-element visual styles
ShortcutKey	Keyboard shortcut

Common Patterns

Pattern 1: Side Navigation with NavigationFrame

var navFrame = new NavigationFrame { Dock = DockStyle.Fill };
var accordion = new AccordionControl { Dock = DockStyle.Left };
Controls.AddRange(new Control[] { navFrame, accordion });
accordion.SendToBack();

var page1 = new NavigationPage { Caption = "Dashboard" };
navFrame.Pages.Add(page1);

var item1 = new AccordionControlElement(ElementStyle.Item) {
    Text = "Dashboard",
    Tag  = page1
};
accordion.Elements.Add(item1);

accordion.ElementClick += (s, e) => {
    if (e.Element.Tag is NavigationPage page)
        navFrame.SelectedPage = page;
};

Pattern 2: Hamburger Menu (Overlay)

accordion.ViewType = AccordionControlViewType.HamburgerMenu;
accordion.OptionsHamburgerMenu.DisplayMode = AccordionControlDisplayMode.Overlay;

Pattern 3: Data-Driven Items

accordion.BeginUpdate();
accordion.Elements.Clear();
foreach (var section in GetSections()) {
    var grp = new AccordionControlElement(ElementStyle.Group) {
        Text = section.Name, Expanded = true
    };
    foreach (var item in section.Items) {
        grp.Elements.Add(new AccordionControlElement(ElementStyle.Item) {
            Text = item.Label, Tag = item.Id
        });
    }
    accordion.Elements.Add(grp);
}
accordion.EndUpdate();

Pattern 4: Item with Embedded Control

var container = new AccordionContentContainer();
container.Padding = new Padding(-1);   // skin-aware padding
container.Controls.Add(new ToggleSwitch {
    Dock = DockStyle.Fill,
    Properties = { OnText = "Enabled", OffText = "Disabled" }
});
accordion.Controls.Add(container);
mySettingsItem.ContentContainer = container;

Troubleshooting

Symptom	Cause	Solution
Control looks unstyled	Hosted on plain Form	Derive from XtraForm
Items not visible	Elements collection empty	Populate in constructor or Form_Load
Slow rendering with many items	No batch update	Wrap additions in BeginUpdate() / EndUpdate()
Content container not expanding	Container not in accordion.Controls	Call accordion.Controls.Add(container)
All groups collapse on one expand	ExpandElementMode = Single	Change to Multiple
Hamburger button missing	ViewType = Standard	Set ViewType = HamburgerMenu
Search panel not showing	ShowFilterControl = Never	Set to Always or Auto

Constraints & Rules

CRITICAL — follow these rules in every interaction:

1. After any code changes, run dotnet build and report errors before claiming success.
2. Target .NET Framework 4.6.2+ or .NET 8+ (Windows only). Do not generate code that targets cross-platform net8.0 without -windows suffix.
3. Always reference DevExpress.Win.Navigation — never reference individual assemblies by path. Keep all DevExpress NuGet packages in the project on the same version number (mismatched versions cause runtime assembly-binding conflicts).
4. Do not use DataSource or ItemsSource on AccordionControl — these properties do not exist. Items are added via Elements.Add().
5. Always host AccordionControl on XtraForm, RibbonForm, or FluentDesignForm — not plain Form.
6. Set the application skin before any form is shown; do not change it after forms are visible.
7. For content containers, always call accordion.Controls.Add(container) in addition to assigning item.ContentContainer = container. Never wrap a content container in BeginInit()/EndInit() — AccordionContentContainer does not implement ISupportInitialize (casting it throws InvalidCastException); in a *.Designer.cs only the AccordionControl itself is wrapped in BeginInit/EndInit.
8. Wrap all bulk element additions in BeginUpdate() / EndUpdate().
9. Accordion elements use Hint for tooltip text — there is no ToolTipText property on AccordionControlElement.
10. .NET Framework references: add DevExpress via the NuGet Package Manager (DevExpress.Win.Navigation) or by dropping an AccordionControl from the Toolbox once (auto-adds references). Do not hand-edit a non-SDK .csproj or copy DevExpress DLLs with shell/PowerShell commands — that routinely breaks the build; if you cannot run NuGet, ask the developer to add the package.
11. Never construct DevExpress documentation URLs from training data — always use the MCP tool to search.
12. Do not mix AccordionControl with NavBarControl API (different namespaces, different element models).

Using DevExpress Documentation MCP

• Search: devexpress_docs_search(technologies=["WindowsForms"], question="<keywords>")
• Fetch: devexpress_docs_get_content(url="<url-from-search>")

Use MCP for: Fluent Design Form integration, Office Navigation Bar attachment, serialization/layout save-restore, advanced HTML-CSS templates, IFilterContent interface, AI Smart Search setup, and DirectX hardware acceleration notes.

---

Next Steps

See the references/ folder for detailed coverage of each topic: getting-started.md → data-binding.md → when-to-use.md → view-modes.md → items-and-customization.md → search.md