Documentation

Class PictureBoxBasePanelElement

base class used to hold items three panels of elements - Near, Center and Far.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
PictureBoxBasePanelElement
PictureBoxHorizontalPanelElement
PictureBoxVerticalPanelElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public abstract class PictureBoxBasePanelElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IPictureBoxPanelElement

Constructors

PictureBoxBasePanelElement()

Initializes a new instance of the PictureBoxBasePanelElement class.

Declaration
public PictureBoxBasePanelElement()

Properties

AllowAnimation

Gets or sets a value indicating whether to use animation when changing its state.

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

AnimationFrames

Gets or sets the animation frames.

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

AnimationInterval

Gets or sets the animation interval.

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

DisplayProperty

Gets or sets the RadProperty which is changed when the panel is Shown or Hidden. Note that when this property is changed the VisibleValue and HiddenValue must also be updated accordingly. Note that if the animation property is changed in the AnimationStarting event, it will affect this property.

Declaration
public RadProperty DisplayProperty { get; set; }
Property Value
RadProperty

HiddenValue

Gets or sets the value applied to the DisplayProperty when the panel is hidden. Note that if the animation property is changed in the AnimationStarting event, it will affect this property.

Declaration
public object HiddenValue { get; set; }
Property Value
System.Object

IsAnimating

Gets a value indicating whether the control is currently animating.

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

Orientation

Declaration
public Orientation Orientation { get; set; }
Property Value
System.Windows.Forms.Orientation

Implements

VisibleValue

Gets or sets the value applied to the DisplayProperty when the panel is displayed. Note that if the animation property is changed in the AnimationStarting event, it will affect this property.

Declaration
public object VisibleValue { get; set; }
Property Value
System.Object

Methods

ArrangeOverride(SizeF)

Arranges the PictureBoxBasePanelElement to its final location. The element must call the Arrange method of each of its children.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The size that is available for element.
Returns
System.Drawing.SizeF

The rectangle occupied by the element. Usually finalSize. Should you return different size, the Layout system will restart measuring and rearranging the items. That could lead to infinite recursion.
Overrides
Remarks

In this method call to the Arrange method of each child must be made.

CancelAnimation()

Cancels the currently running animation.

Declaration
public void CancelAnimation()

ChangeState(Boolean, Boolean)

Changes the state of this object by setting a new value to a specified RadProperty and applies animation. If animation is not allowed only applies the new value to the object.

Declaration
protected virtual void ChangeState(bool isPanelShowing, bool animate)
Parameters
System.Boolean isPanelShowing

If [true] shows the panel, otherwise hides it.
System.Boolean animate

Whether to apply animation.

CreateCenterElementsStack()

Creates an element stack positioned in the center.

Declaration
protected virtual StackLayoutElementLite CreateCenterElementsStack()
Returns
StackLayoutElementLite

CreateCenterItemsCollection()

Creates a new items collection positioned in the center.

Declaration
protected virtual RadItemOwnerCollection CreateCenterItemsCollection()
Returns
RadItemOwnerCollection

The items collection.

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

CreateFarElementsStack()

Creates an element stack positioned in the far end. When the Orientation is Horizontal the position is right. When the Orientation is Vertical the position is bottom.

Declaration
protected virtual StackLayoutElementLite CreateFarElementsStack()
Returns
StackLayoutElementLite

CreateFarItemsCollection()

Creates a new items collection positioned in the far end. When the Orientation is Horizontal the position is right. When the Orientation is Vertical the position is bottom.

Declaration
protected virtual RadItemOwnerCollection CreateFarItemsCollection()
Returns
RadItemOwnerCollection

The items collection.

CreateNearElementsStack()

Creates an element stack positioned in the near end. When the Orientation is Horizontal the position is left. When the Orientation is Vertical the position is top.

Declaration
protected virtual StackLayoutElementLite CreateNearElementsStack()
Returns
StackLayoutElementLite

CreateNearItemsCollection()

Creates a new items collection positioned in the near end. When the Orientation is Horizontal the position is left. When the Orientation is Vertical the position is top.

Declaration
protected virtual RadItemOwnerCollection CreateNearItemsCollection()
Returns
RadItemOwnerCollection

The items collection.

Hide(Boolean)

Hides the panel.

Declaration
public virtual void Hide(bool animate)
Parameters
System.Boolean animate

InitializeFields()

Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the space required by the PictureBoxBasePanelElement

Used by the layout system.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The size that is available to the PictureBoxBasePanelElement. The available size can be infinity (to take the full size of the element)
Returns
System.Drawing.SizeF

The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides
Remarks

In this method call to the Measure method of each child must be made.

OnAnimationFinished(AnimationStatusEventArgs)

Declaration
protected virtual void OnAnimationFinished(AnimationStatusEventArgs e)
Parameters
AnimationStatusEventArgs e

OnAnimationStarted(AnimationStatusEventArgs)

Declaration
protected virtual void OnAnimationStarted(AnimationStatusEventArgs e)
Parameters
AnimationStatusEventArgs e

OnAnimationStarting(PictureBoxPanelAnimationStartingEventArgs)

Declaration
protected virtual void OnAnimationStarting(PictureBoxPanelAnimationStartingEventArgs e)
Parameters
PictureBoxPanelAnimationStartingEventArgs e

OnOrientationChanged()

Declaration
protected virtual void OnOrientationChanged()

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

ShouldArrangeChild(RadElement)

Determines whether a given child should be arranged. For example when base.ArrangeOverride() is called, but we have custom layout logic for current element.

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

The child that is going to be arranged.
Returns
System.Boolean

A value indicating whether the base class layout will be executed for the given child.
Overrides

ShouldMeasureChild(RadElement)

Gets a value indicating, whether a child will be measured during the MeasureOverride.

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

The child.
Returns
System.Boolean

Whether the child will be measured in MeasureOverride.
Overrides

Show(Boolean)

Shows the panel.

Declaration
public virtual void Show(bool animate)
Parameters
System.Boolean animate

Events

AnimationFinished

Occurs when the animation is finished.

Declaration
public event AnimationFinishedEventHandler AnimationFinished
Event Type
AnimationFinishedEventHandler

AnimationStarted

Occurs when the animation is started.

Declaration
public event AnimationStartedEventHandler AnimationStarted
Event Type
AnimationStartedEventHandler

AnimationStarting

Occurs before the start of the animation. Suitable to change any animation property(for example the animated property) or cancel the animation.

Declaration
public event PictureBoxPanelAnimationStartingEventHandler AnimationStarting
Event Type
PictureBoxPanelAnimationStartingEventHandler

Explicit Interface Implementations

IPictureBoxPanelElement.CenterElementsStack

Declaration
StackLayoutElementLite IPictureBoxPanelElement.CenterElementsStack { get; }
Returns
StackLayoutElementLite

Implements

IPictureBoxPanelElement.CenterItems

Declaration
RadItemOwnerCollection IPictureBoxPanelElement.CenterItems { get; }
Returns
RadItemOwnerCollection

Implements

IPictureBoxPanelElement.FarElementsStack

Declaration
StackLayoutElementLite IPictureBoxPanelElement.FarElementsStack { get; }
Returns
StackLayoutElementLite

Implements

IPictureBoxPanelElement.FarItems

Declaration
RadItemOwnerCollection IPictureBoxPanelElement.FarItems { get; }
Returns
RadItemOwnerCollection

Implements

IPictureBoxPanelElement.NearElementsStack

Declaration
StackLayoutElementLite IPictureBoxPanelElement.NearElementsStack { get; }
Returns
StackLayoutElementLite

Implements

IPictureBoxPanelElement.NearItems

Declaration
RadItemOwnerCollection IPictureBoxPanelElement.NearItems { get; }
Returns
RadItemOwnerCollection

Implements

Extension Methods