RadCollapsiblePanel
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Containers")]
public class RadCollapsiblePanel : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadCollapsiblePanel...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadCollapsiblePanel class with default settings.
public RadCollapsiblePanel()
Properties
Gets or sets the easing type that controls the acceleration curve of the expand or collapse animation.
public RadEasingType AnimationEasingType { get; set; }
Gets or sets the total number of animation frames used during expand or collapse operations.
public int AnimationFrames { get; set; }
Gets or sets the interval in milliseconds between animation frames during expand or collapse operations.
public int AnimationInterval { get; set; }
Gets or sets the visual style of animation used during expand or collapse operations.
public CollapsiblePanelAnimationType AnimationType { get; set; }
Gets or sets the background color of the RadCollapsiblePanel control.
public override Color BackColor { get; set; }
Overrides:
Gets the main element that provides the core functionality for the collapsible panel control.
public RadCollapsiblePanelElement CollapsiblePanelElement { get; }
Gets or sets the content sizing mode that determines how the panel's size is calculated when expanded.
public CollapsiblePanelContentSizingMode ContentSizingMode { get; set; }
Gets the controls container that hosts all child controls added to the RadCollapsiblePanel.
public CollapsiblePanelControlsContainer ControlsContainer { get; }
Gets the default size of the RadCollapsiblePanel control when it is created.
protected override Size DefaultSize { get; }
The default Size of the control.
Overrides:
Gets or sets a value indicating whether animation effects are used when expanding or collapsing the panel.
public bool EnableAnimation { get; set; }
Gets or sets the direction in which the panel expands when the expand operation is performed.
public RadDirection ExpandDirection { get; set; }
Gets or sets the text displayed in the header of the collapsible panel.
public string HeaderText { get; set; }
Gets or sets the horizontal alignment of the header content within the header area.
public RadHorizontalAlignment HorizontalHeaderAlignment { get; set; }
Gets a value indicating whether the panel is currently performing an expand or collapse animation.
[Browsable(false)]
public bool IsAnimating { get; }
Gets or sets a value indicating whether the panel is currently in an expanded state.
public bool IsExpanded { get; set; }
Gets the panel container that contains and manages the child controls of the RadCollapsiblePanel.
public CollapsiblePanelPanelContainer PanelContainer { get; }
Gets or sets a value indicating whether a visual line separator is displayed in the header area.
public bool ShowHeaderLine { get; set; }
Gets or sets the vertical alignment of the header content within the header area.
public RadVerticalAlignment VerticalHeaderAlignment { get; set; }
Methods
Collapses the panel if it is currently expanded. Has no effect if the panel is already collapsed or currently animating.
public void Collapse()
Creates the child elements for the RadCollapsiblePanel control.
protected override void CreateChildItems(RadElement parent)
The parent element that will contain the child elements.
Overrides:
Creates and returns a new instance of the main collapsible panel element.
protected virtual RadCollapsiblePanelElement CreateCollapsiblePanelElement()
A new RadCollapsiblePanelElement instance.
Creates and returns a new instance of the controls container that hosts child controls.
protected virtual CollapsiblePanelControlsContainer CreateControlsContainer()
CollapsiblePanelControlsContainer
A new CollapsiblePanelControlsContainer instance.
Creates a new instance of the control collection for the RadCollapsiblePanel.
protected override Control.ControlCollection CreateControlsInstance()
A new instance of RadCollapsiblePanelControlsCollection assigned to the control.
Overrides:
Releases the unmanaged resources used by the RadCollapsiblePanel and optionally releases the managed resources.
protected override void Dispose(bool disposing)
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides:
Expands the panel if it is currently collapsed. Has no effect if the panel is already expanded or currently animating.
public void Expand()
Initializes the internal container structure that hosts the child controls.
protected virtual void InitializeInternalContainer()
Notifies that the control is about to be visualized.
Raises the RightToLeftChanged event and updates the right-to-left layout for child elements.
Called when the theme of the control changes and updates the theme for child containers.
protected override void OnThemeChanged()
Overrides:
Resets background color theme overrides to their default values.
protected override void ResetBackColorThemeOverrides()
Overrides:
Resets foreground color theme overrides to their default values.
protected override void ResetForeColorThemeOverrides()
Overrides:
Scales the control according to the specified scaling factor and bounds specification.
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
The SizeF representing the width and height scaling factors.
specifiedBoundsSpecifiedA BoundsSpecified value specifying the bounds to be scaled.
Overrides:
Applies background color theme overrides to the collapsible panel elements.
protected override void SetBackColorThemeOverrides()
Overrides:
Applies foreground color theme overrides to the collapsible panel elements.
protected override void SetForeColorThemeOverrides()
Overrides:
Toggles the panel state between expanded and collapsed.
public void ToggleExpandCollapse()
Toggles the panel state between expanded and collapsed with additional control options.
protected void ToggleExpandCollapse(bool ignoreIsExpanded, bool stopAnimations)
If set to true, ignores the current IsExpanded property value.
stopAnimationsboolIf set to true, performs the toggle operation without animation effects.
Events
Occurs when the panel has completed the collapse operation.
public event EventHandler Collapsed
Occurs before the panel starts the collapse operation and allows the operation to be cancelled.
public event CancelEventHandler Collapsing
Occurs when the panel has completed the expand operation.
public event EventHandler Expanded
Occurs before the panel starts the expand operation and allows the operation to be cancelled.
public event CancelEventHandler Expanding