Class RadCollapsiblePanel

Inheritance
System.Object
RadControl
RadCollapsiblePanel
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadCollapsiblePanel : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadCollapsiblePanel()

Initializes a new instance of the RadCollapsiblePanel class with default settings.

Declaration
public RadCollapsiblePanel()

Properties

AnimationEasingType

Gets or sets the easing type that controls the acceleration curve of the expand or collapse animation.

Declaration
public RadEasingType AnimationEasingType { get; set; }
Property Value
RadEasingType

AnimationFrames

Gets or sets the total number of animation frames used during expand or collapse operations.

Declaration
public int AnimationFrames { get; set; }
Property Value
System.Int32

AnimationInterval

Gets or sets the interval in milliseconds between animation frames during expand or collapse operations.

Declaration
public int AnimationInterval { get; set; }
Property Value
System.Int32

AnimationType

Gets or sets the visual style of animation used during expand or collapse operations.

Declaration
public CollapsiblePanelAnimationType AnimationType { get; set; }
Property Value
CollapsiblePanelAnimationType

BackColor

Gets or sets the background color of the RadCollapsiblePanel control.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

CollapsiblePanelElement

Gets the main element that provides the core functionality for the collapsible panel control.

Declaration
public RadCollapsiblePanelElement CollapsiblePanelElement { get; }
Property Value
RadCollapsiblePanelElement

ContentSizingMode

Gets or sets the content sizing mode that determines how the panel's size is calculated when expanded.

Declaration
public CollapsiblePanelContentSizingMode ContentSizingMode { get; set; }
Property Value
CollapsiblePanelContentSizingMode

ControlsContainer

Gets the controls container that hosts all child controls added to the RadCollapsiblePanel.

Declaration
public CollapsiblePanelControlsContainer ControlsContainer { get; }
Property Value
CollapsiblePanelControlsContainer

DefaultSize

Gets the default size of the RadCollapsiblePanel control when it is created.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

The default System.Drawing.Size of the control.

EnableAnimation

Gets or sets a value indicating whether animation effects are used when expanding or collapsing the panel.

Declaration
public bool EnableAnimation { get; set; }
Property Value
System.Boolean

ExpandDirection

Gets or sets the direction in which the panel expands when the expand operation is performed.

Declaration
public RadDirection ExpandDirection { get; set; }
Property Value
RadDirection

HeaderText

Gets or sets the text displayed in the header of the collapsible panel.

Declaration
public string HeaderText { get; set; }
Property Value
System.String

HorizontalHeaderAlignment

Gets or sets the horizontal alignment of the header content within the header area.

Declaration
public RadHorizontalAlignment HorizontalHeaderAlignment { get; set; }
Property Value
RadHorizontalAlignment

IsAnimating

Gets a value indicating whether the panel is currently performing an expand or collapse animation.

Declaration
public bool IsAnimating { get; }
Property Value
System.Boolean

IsExpanded

Gets or sets a value indicating whether the panel is currently in an expanded state.

Declaration
public bool IsExpanded { get; set; }
Property Value
System.Boolean

OwnerBoundsCache

This property is not relevant for this class.

Declaration
public Rectangle OwnerBoundsCache { get; set; }
Property Value
System.Drawing.Rectangle

PanelContainer

Gets the panel container that contains and manages the child controls of the RadCollapsiblePanel.

Declaration
public CollapsiblePanelPanelContainer PanelContainer { get; }
Property Value
CollapsiblePanelPanelContainer

ShowHeaderLine

Gets or sets a value indicating whether a visual line separator is displayed in the header area.

Declaration
public bool ShowHeaderLine { get; set; }
Property Value
System.Boolean

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

VerticalHeaderAlignment

Gets or sets the vertical alignment of the header content within the header area.

Declaration
public RadVerticalAlignment VerticalHeaderAlignment { get; set; }
Property Value
RadVerticalAlignment

Methods

Collapse()

Collapses the panel if it is currently expanded. Has no effect if the panel is already collapsed or currently animating.

Declaration
public void Collapse()

CreateChildItems(RadElement)

Creates the child elements for the RadCollapsiblePanel control.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element that will contain the child elements.
Overrides

CreateCollapsiblePanelElement()

Creates and returns a new instance of the main collapsible panel element.

Declaration
protected virtual RadCollapsiblePanelElement CreateCollapsiblePanelElement()
Returns
RadCollapsiblePanelElement

A new RadCollapsiblePanelElement instance.

CreateControlsContainer()

Creates and returns a new instance of the controls container that hosts child controls.

Declaration
protected virtual CollapsiblePanelControlsContainer CreateControlsContainer()
Returns
CollapsiblePanelControlsContainer

A new CollapsiblePanelControlsContainer instance.

CreateControlsInstance()

Creates a new instance of the control collection for the RadCollapsiblePanel.

Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
System.Windows.Forms.Control.ControlCollection

A new instance of RadCollapsiblePanelControlsCollection assigned to the control.

Dispose(Boolean)

Releases the unmanaged resources used by the RadCollapsiblePanel and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

True to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

Expand()

Expands the panel if it is currently collapsed. Has no effect if the panel is already expanded or currently animating.

Declaration
public void Expand()

InitializeInternalContainer()

Initializes the internal container structure that hosts the child controls.

Declaration
protected virtual void InitializeInternalContainer()

OnLoad(Size)

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnRightToLeftChanged(EventArgs)

Raises the System.Windows.Forms.Control.RightToLeftChanged event and updates the right-to-left layout for child elements.

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnThemeChanged()

Called when the theme of the control changes and updates the theme for child containers.

Declaration
protected override void OnThemeChanged()
Overrides

ResetBackColorThemeOverrides()

Resets background color theme overrides to their default values.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Resets foreground color theme overrides to their default values.

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

ScaleControl(SizeF, BoundsSpecified)

Scales the control according to the specified scaling factor and bounds specification.

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

The System.Drawing.SizeF representing the width and height scaling factors.
System.Windows.Forms.BoundsSpecified specified

A System.Windows.Forms.BoundsSpecified value specifying the bounds to be scaled.
Overrides

SetBackColorThemeOverrides()

Applies background color theme overrides to the collapsible panel elements.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Applies foreground color theme overrides to the collapsible panel elements.

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

ToggleExpandCollapse()

Toggles the panel state between expanded and collapsed.

Declaration
public void ToggleExpandCollapse()

ToggleExpandCollapse(Boolean, Boolean)

Toggles the panel state between expanded and collapsed with additional control options.

Declaration
protected void ToggleExpandCollapse(bool ignoreIsExpanded, bool stopAnimations)
Parameters
System.Boolean ignoreIsExpanded

If set to true, ignores the current IsExpanded property value.
System.Boolean stopAnimations

If set to true, performs the toggle operation without animation effects.

Events

Collapsed

Occurs when the panel has completed the collapse operation.

Declaration
public event EventHandler Collapsed
Event Type
System.EventHandler

Collapsing

Occurs before the panel starts the collapse operation and allows the operation to be cancelled.

Declaration
public event CancelEventHandler Collapsing
Event Type
System.ComponentModel.CancelEventHandler

Expanded

Occurs when the panel has completed the expand operation.

Declaration
public event EventHandler Expanded
Event Type
System.EventHandler

Expanding

Occurs before the panel starts the expand operation and allows the operation to be cancelled.

Declaration
public event CancelEventHandler Expanding
Event Type
System.ComponentModel.CancelEventHandler

Extension Methods