Panel

Wisej.Web.Panel

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • ScrollableControl

    • Panel

Represents a collapsible panel with an optional header that contains a group of controls.

C#

public class Panel : ScrollableControl, IImage

VB.NET

Constructors

Panel()

Initializes a new instance of the Panel class.

Panel(controls)

Initializes a new instance of the Panel class with the specified settings.

Name	Type	Description
controls	Control[]	An array of Control objects to be added to the panel.

Panel(location, size, controls)

Initializes a new instance of the Panel class with the specified settings.

Name	Type	Description
location	Point	The location of the panel on its parent control.
size	Size	The size of the panel.
controls	Control[]	An array of Control objects to be added to the panel.

Properties

AutoShow

PanelAutoShowMode: Returns or sets a value that indicates whether the collapsed panel is automatically expanded when the mouse hovers over the title bar. (Default: OnClick)

AutoSize

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: False)

AutoSizeMode

AutoSizeMode: Indicates the automatic sizing behavior of the control. (Default: GrowOnly)

BorderStyle

BorderStyle: Indicates the border style for the control. (Default: None)

ClientArea

Rectangle: Returns the client rectangle to use in the designer.

Collapsed

Boolean: Returns or sets a value that indicates whether the Panel is collapsed. (Default: False)

CollapsedBounds

Rectangle: Returns the collapsed bounds.

CollapseSide

HeaderPosition: Returns or sets a value that indicates to which side should the panel collapse. (Default: Top)

DisplayRectangle

Rectangle: Returns a rectangle that represents the dimensions of the GroupBox.

Focusable

Boolean: Returns or sets whether the control can gain the focus. (Default: False)

HeaderAlignment

HorizontalAlignment: Returns or sets the alignment of the header text in the Panel control. (Default: Left)

HeaderBackColor

Color: Returns or sets the background color of the header of the panel.

HeaderForeColor

Color: Returns or sets the text color of the header of the panel.

HeaderPosition

HeaderPosition: Returns or sets a value that indicates on which side to display the header when the header is visible. (Default: Top)

HeaderSize

Int32: Returns or sets the size of the header. When the header is horizontal, the size if the height; when it's vertical, the size if the width. Set it to -1 to reset to the size set in the current theme.

Image

Image: Returns or sets the image that is displayed in the header of the panel.

ImageIndex

Int32: Returns or sets the image list index value of the image in the ImageList displayed in the button control. (Default: -1)

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

ImageKey

String: Returns or sets the key accessor for the image in the ImageList displayed in the header of the panel. (Default: "")

ImageList

ImageList: Returns or sets the ImageList that contains the Image displayed in the header of the panel control. (Default: null)

ImageSource

String: Returns or sets the theme name or URL for the image to display in the header of the panel.

IsVertical

Boolean: Returns if the panel's header is oriented vertically.

RightToLeftLayout

Boolean: Enables or disables right-to-left layout when the value of RightToLeft is Yes (Default: False)

ShowCloseButton

Boolean: Returns or sets a value that indicates the caption bar displays the close button to collapse or expand the panel. (Default: True)

ShowHeader

Boolean: Returns or sets a value that indicates whether the caption bar is visible. (Default: False)

TabStop

Boolean: Returns or sets whether the user can give the focus to this control using the TAB key and the Focusable property is set to true. (Default: False)

Text

String: Returns or sets the title of the Panel panel. (Default: "")

Tools

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

ToolTipText

String: Returns or sets the ToolTip text for the header of the panel. (Default: "")

Methods

Dispose(disposing)

Parameter	Type	Description
disposing	Boolean

OnFontChanged(e)

Fires the FontChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnPanelCollapsed(e)

Fires the PanelCollapsed event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnPanelExpanded(e)

Fires the PanelExpanded event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnRightToLeftLayoutChanged(e)

Fires the RightToLeftLayoutChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnToolClick(e)

Fires the ToolClick event.

Parameter	Type	Description
e	ToolClickEventArgs	A ToolClickEventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

OnWebUpdate(state)

Updates the client component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

SetBoundsCore(x, y, width, height, specified)

Sets the specified bounds of the Panel control.

Parameter	Type	Description
x	Int32	The new Left property value of the control.
y	Int32	The new Top property value of the control.
width	Int32	The new Width property value of the control.
height	Int32	The new Height property value of the control.
specified	BoundsSpecified	A combination of the BoundsSpecified values.

SizeFromClientSize(clientSize)

Converts the client size into the panel size.

Parameter	Type	Description
clientSize	Size

Returns: Size.

Events

PanelCollapsed

EventHandler Fired when the panel is collapsed.

PanelExpanded

EventHandler Fired when the panel is expanded.

RightToLeftLayoutChanged

EventHandler Fired when the value of the RightToLeftLayout property changes.

ToolClick

ToolClickEventHandler Fired when a ComponentTool is clicked.

Inherited By

Name	Description
TableLayoutPanel	Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.
BindingNavigator	Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
FlowLayoutPanel	Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns.
SplitterPanel	Creates a panel that is associated with a SplitContainer.
TabPage	Represents a single tab page in a TabControl.
DataRepeaterItem	Used by the DataRepeater control to display data at run time.
AccordionPanel	Represents a panel in a Accordion control.
FlexLayoutPanel	Represents a panel that dynamically arranges its child controls.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IImage	Provides access to common image properties across the controls that implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.