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

XPanderControls

By , 27 Nov 2008
Rate this:
Please Sign up or sign in to vote.
pandercontrols.png

Introduction

The XPander library offers the option to store many user controls in one single document formula. They are optionally visible or non-visible, expanded or collapsed. The controls provide optically the Microsoft Outlook 2007 style with black, silver and blue color schemes. They also provide other styles. The included ToolStripRenderers offer some other opportunities. All the controls support visual designer, smart tag and RightToLeft features. It contains the following components.

BSE.Windows.Forms.Panel

The panel is a control that contains other controls. You can use a panel to group collections of controls such as the XPanderPanelList control. On top of the panel, there is the captionbar. This captionbar may contain an image and text. According to its dockstyle and properties, the panel is collapsible and/or closable.

panelexpanded.png

panelcollapsed.png

panelclosed.png

BSE.Windows.Forms.XPanderPanelList

The XPanderPanelList contains XPanderPanels, which are represented by XPanderPanel objects that you can add through the XPanderPanels property. The order of XPanderPanel objects reflects the order in which the xpanderpanels appear in the XPanderPanelList control.

xpanderpanellist.png

BSE.Windows.Forms.XPanderPanel

XPanderPanel controls represent the expandable and collapsible panels in XPanderPanelList. The XpanderPanel is a control that contains other controls. You can use an XPanderPanel to group collections of controls such as the XPanderPanelList. The order of xpanderpanels in the XPanderPanelList.XPanderPanels collection reflects the order of xpanderpanels controls. To change the order of tabs in the control, you must change their positions in the collection by removing them and inserting them at new indexes. You can change the xpanderpanel's appearance. For example, to make it appear flat, set the CaptionStyle property to CaptionStyle.Flat.

On top of the XPanderPanel, there is the captionbar. This captionbar may contain an image and text. According to its properties, the panel can be closed.

xpanderpanellist2.png

BSE.Windows.Forms.Splitter

This represents a splitter control that enables the user to resize docked controls. As different from the System.Windows.Forms.Splitter, the splitter supports a transparent background color.

panelsplitter.png

A splitter can be attached to a panel. If the visibility of the panel changes, the visibility of the splitter changes too.

splitter.png

All the panelcolors and properties are customizable and changeable with the visual designer.

xpandercontrolsdesigner.png

paneldesigner.png

If you want to expand a XPanderPanel in the Visual Designer, please click the captionbar.

xpanderpanelexpand.png

When the RightToLeft property value is set to RightToLeft.Yes, the horizontal alignment of the control's elements are reversed.

xpanderpanellistrighttoleft.png

Using the Code

Right click on the toolbox and choose add/remove items..., there you browse for the BSE.Windows.Forms.dll and press OK. All the controls will be added in the ToolBox under "My User Controls". Set BSE.Windows.Test as StartUp Project.

Using the RightToLeft Feature in the Test Sample

Open the Program.cs file in the BSE.Windows.Test project and remove the following comments:

    [STAThread]
	static void Main()
	{
		//// if you want to use the RightToLeft demo,
		//// please remove these comments
		//CultureInfo currentCulture = new CultureInfo
		// (BSE.Windows.Test.Properties.Settings.Default.Language);
		//Thread.CurrentThread.CurrentCulture = currentCulture;
		//Thread.CurrentThread.CurrentUICulture = currentCulture;

		Application.EnableVisualStyles();
		Application.SetCompatibleTextRenderingDefault(false);

		//// if you want to use the RightToLeft demo,
		//// please remove these comments
		//using (CCountrySelectionForm form = new CCountrySelectionForm())
		//{
			//form.ShowDialog();
		//}

		Application.Run(new Form1());
	}
	

Select the ar-EG culture name for the Arabic (Egypt) culture:

xpandercontrols5.png

Class Diagrams

XPanderPanelList

xpanderpanellistclass.png

Panel and XPanderPanel

panelsclass.png

Code Examples

Using the ToolstripProfessionalRenderer and the PanelsettingsManager at runtime:

public class Form2 : Form
{
	private BSE.Windows.Forms.Panel panel1;
        
	public Form2()
	{
		// Create and initialize a Panel.
		this.panel1 = new BSE.Windows.Forms.Panel();
		this.panel1.Text = "panel1";
		// Set the panel background.
		this.panel1.ShowTransparentBackground = false;
		// Set the panel's DockStyle to DockStyle.Fill
		this.panel1.Dock = DockStyle.Fill;
		// Add the panel to the form
		this.Controls.Add(this.panel1);

		// Create and initialize a ToolStripProfessionalRenderer.
		ToolStripProfessionalRenderer renderer = 
			new BSE.Windows.Forms.Office2007Renderer();
		// Add it to the ToolStripManager.Renderer
		ToolStripManager.Renderer = renderer;

		// Get the ProfessionalColorTable colorTable for the current renderer.
		BSE.Windows.Forms.ProfessionalColorTable colorTable = 
		    renderer.ColorTable as BSE.Windows.Forms.ProfessionalColorTable;
		if (colorTable != null)
		{
			// Get the PanelColors panelColorTable for the 
			// current  colortable.
			BSE.Windows.Forms.PanelColors panelColorTable = 
						colorTable.PanelColorTable;
			if (panelColorTable != null)
			{
				// Set the panel properties for the form 
				// controls collection
				BSE.Windows.Forms.PanelSettingsManager.
				SetPanelProperties(this.Controls, panelColorTable);
			}
		}
	}
}

Adaption of the Panel Colors

Create a colortable that derives from BSE.Windows.Forms.PanelColors and overwrite the protected method InitColors:

public class YourPanelColors : PanelColorsOffice
{
    protected override void InitColors(Dictionary<panelcolors.knowncolors>, rgbTable)
    {
        base.InitColors(rgbTable);
        rgbTable[KnownColors.BorderColor] = Color.FromArgb(101, 147, 207);
        rgbTable[KnownColors.InnerBorderColor] = Color.White;
        rgbTable[KnownColors.PanelCaptionCloseIcon] = Color.Black;
        rgbTable[KnownColors.PanelCaptionExpandIcon] = Color.FromArgb(21, 66, 139);
        rgbTable[KnownColors.PanelCaptionGradientBegin] = 
					Color.FromArgb(227, 239, 255);
        rgbTable[KnownColors.PanelCaptionGradientEnd] = 
					Color.FromArgb(173, 209, 255);
        rgbTable[KnownColors.PanelCaptionGradientMiddle] = 
					Color.FromArgb(199, 224, 255);
        rgbTable[KnownColors.PanelContentGradientBegin] = 
					Color.FromArgb(227, 239, 255);
        rgbTable[KnownColors.PanelContentGradientEnd] = 
					Color.FromArgb(227, 239, 255);
        rgbTable[KnownColors.PanelCaptionText] = Color.FromArgb(22, 65, 139);
        rgbTable[KnownColors.PanelCollapsedCaptionText] = 
					Color.FromArgb(21, 66, 139);
        rgbTable[KnownColors.XPanderPanelBackColor] = Color.Transparent;
        rgbTable[KnownColors.XPanderPanelCaptionCloseIcon] = Color.Black;
        rgbTable[KnownColors.XPanderPanelCaptionExpandIcon] = 
					Color.FromArgb(21, 66, 139);
        rgbTable[KnownColors.XPanderPanelCaptionText] = Color.FromArgb(21, 66, 139);
        rgbTable[KnownColors.XPanderPanelCaptionGradientBegin] = 
					Color.FromArgb(227, 239, 255);
        rgbTable[KnownColors.XPanderPanelCaptionGradientEnd] = 
					Color.FromArgb(199, 224, 255);
        rgbTable[KnownColors.XPanderPanelCaptionGradientMiddle] = 
					Color.FromArgb(173, 209, 255);
        rgbTable[KnownColors.XPanderPanelFlatCaptionGradientBegin] = 
					Color.FromArgb(214, 232, 255);
        rgbTable[KnownColors.XPanderPanelFlatCaptionGradientEnd] = 
					Color.FromArgb(253, 253, 254);
    }
}    </panelcolors.knowncolors>

Or you may set the ColorScheme property to ColorScheme.Custom and fill the CustomColors properties with your colors.

Credits

  • Thanks to Phil. Wright for his Office 2007 ToolStrip Renderer. That gave me an insight into toolstrip rendering.
  • Thanks to Bernhard Jenny for many tips.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Uwe Eichkorn

Switzerland Switzerland
No Biography provided

Comments and Discussions

 
Questionbug ... when i add a lot of xpanderPanel in xpanderListPanel PinmemberEhsanf37-Mar-14 19:13 
QuestionCaption image PinmemberMember 882350017-Dec-12 7:31 
BugA Bug? when i add lots of sub panel, the property of AutoScroll is failed. PinmemberIcyJiang7-Aug-12 20:04 
Questiondowloading xpandercontrol.zip [modified] Pinmemberkhanzzirfan15-Jun-12 19:54 
AnswerRe: dowloading xpandercontrol.zip PinmemberUwe Eichkorn18-Jun-12 2:45 
BugBug Solution For XpanderPanelCollection.Insert method Pinmemberterminal_gr17-May-12 6:41 
QuestionAlpha blending... Pinmember93Current5-Jan-12 23:24 
AnswerRe: Alpha blending... Pinmember93Current6-Jan-12 7:20 
QuestionVB version Pinmemberdherrmann18-Oct-11 9:46 
AnswerRe: VB version PinmemberUwe Eichkorn25-Oct-11 1:22 
GeneralRe: VB version [modified] Pinmemberdherrmann25-Oct-11 5:44 
Question.NET 4.0 PinmemberMatt U.30-Aug-11 7:58 
QuestionIs it or isn't it? PinmemberJohnny J.2-Aug-11 13:05 
AnswerRe: Is it or isn't it? PinmemberJohnny J.21-Sep-11 2:24 
OK, I solved the problem - It wasn't 100% straightforward, but absolutely doable.
 
But I am a little bit concerned with the article author's obvious disinterest in his article and disinclination to answer requests for help/support... Frown | :(
Why can't I be applicable like John? - Me, April 2011
-----
Beidh ceol, caint agus craic againn - Seán Bán Breathnach
-----
Da mihi sis crustum Etruscum cum omnibus in eo!
-----
Just because a thing is new don’t mean that it’s better - Will Rogers, September 4, 1932

Questionadd gradient to content panels? Pinmemberroger_2721-Jul-11 7:14 
QuestionExpand to left/right Direction PinmemberXennon114-Jul-11 2:16 
QuestionChm file can't open Pinmembernrdsp13-Jul-11 0:13 
AnswerRe: Chm file can't open PinmemberJohnny J.2-Aug-11 13:06 
GeneralProblems with Install on Visual C# 2008 Express Pinmemberhsfan17-May-11 3:20 
GeneralMy vote of 5 Pinmemberrahul_raut17-May-11 0:13 
GeneralMy vote of 5 Pingrouplianghuating12-May-11 17:18 
QuestionCan I use it in commercial product? PinmemberSouthmountain25-Nov-10 8:27 
AnswerRe: Can I use it in commercial product? PinmemberUwe Eichkorn10-Dec-10 22:14 
GeneralMy vote of 5 Pinmembertubeastig28-Sep-10 20:29 
QuestionExpand clicking on caption not on icon Pinmemberromias20-Sep-10 8:27 

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
Web01 | 2.8.140415.2 | Last Updated 27 Nov 2008
Article Copyright 2007 by Uwe Eichkorn
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid