ClassPictureBoxBasePanelElement
base class used to hold items three panels of elements - Near, Center and Far.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public abstract class PictureBoxBasePanelElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IPictureBoxPanelElementInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementPictureBoxBasePanelElement
Derived Classes:
Implements:
Inherited Members
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.
AnimationFrames
Gets or sets the animation frames.
AnimationInterval
Gets or sets the animation interval.
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
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.
IsAnimating
Gets a value indicating whether the control is currently animating.
Declaration
[Browsable(false)]
public bool IsAnimating { get; set; }Property Value
Orientation
Declaration
public Orientation Orientation { get; set; }Property Value
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.
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
finalSize
The size that is available for element.
Returns
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(bool, bool)
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.
CreateCenterElementsStack()
Creates an element stack positioned in the center.
Declaration
protected virtual StackLayoutElementLite CreateCenterElementsStack()Returns
CreateCenterItemsCollection()
Creates a new items collection positioned in the center.
Declaration
protected virtual RadItemOwnerCollection CreateCenterItemsCollection()Returns
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
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
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
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
The items collection.
Hide(bool)
Hides the panel.
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
availableSize
The size that is available to the PictureBoxBasePanelElement. The available size can be infinity (to take the full size of the element)
Returns
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
e
OnAnimationStarted(AnimationStatusEventArgs)
Declaration
protected virtual void OnAnimationStarted(AnimationStatusEventArgs e)Parameters
e
OnAnimationStarting(PictureBoxPanelAnimationStartingEventArgs)
Declaration
protected virtual void OnAnimationStarting(PictureBoxPanelAnimationStartingEventArgs e)Parameters
e
OnOrientationChanged()
Declaration
protected virtual void OnOrientationChanged()OnPropertyChanged(RadPropertyChangedEventArgs)
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Parameters
e
Event arguments containing information about the property that changed.
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
child
The child that is going to be arranged.
Returns
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
child
The child.
Returns
Whether the child will be measured in MeasureOverride.
Overrides
Show(bool)
Shows the panel.
Events
AnimationFinished
Occurs when the animation is finished.
Declaration
public event AnimationFinishedEventHandler AnimationFinishedEvent Value
AnimationStarted
Occurs when the animation is started.
Declaration
public event AnimationStartedEventHandler AnimationStartedEvent Value
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 AnimationStartingEvent Value