Class RadPanoramaElement

Represents the main element of RadPanorama control.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadPanoramaElement
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 class RadPanoramaElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadPanoramaElement()

Declaration
public RadPanoramaElement()

Fields

ScrollBarThicknessProperty

Identifies the ScrollBarThickness dependency property.

Declaration
public static RadProperty ScrollBarThicknessProperty
Field Value
RadProperty

Properties

AllowDragDrop

Gets or sets a value indicating whether reordering of tiles via drag and drop is allowed.

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

AutoArrangeNewTiles

Gets or sets a value that indicates whether the newly added tiles should be automatically arranged.

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

BackgroundImagePrimitive

Gets the image primitive that represents tha image in the background.

Declaration
public ImagePrimitive BackgroundImagePrimitive { get; }
Property Value
ImagePrimitive

CellSize

Gets or sets the size of a single cell.

Declaration
public Size CellSize { get; set; }
Property Value
System.Drawing.Size

ColumnsCount

Gets or sets the current number of columns.

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

DragDropService

Gets or sets the RadDragDropService that is responsible for the drag-drop reorder of tiles.

Declaration
public RadDragDropService DragDropService { get; set; }
Property Value
RadDragDropService

EnableZooming

Enables or Disables the build in zoom functionality

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

GroupLayout

Gets the layout that arranges the tile groups.

Declaration
public StackLayoutPanel GroupLayout { get; }
Property Value
StackLayoutPanel

Groups

Gets a collection of TileGroupElement items that should be displayed in ungrouped mode.

Declaration
public RadItemOwnerCollection Groups { get; }
Property Value
RadItemOwnerCollection

Items

Gets a collection of RadTileElement items that should be displayed in grouped mode.

Declaration
public RadItemOwnerCollection Items { get; }
Property Value
RadItemOwnerCollection

MinimumColumns

Gets or sets the minimum number of columns that the view can be reduced to.

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

MouseWheelBehavior

Gets or sets the way that RadPanorama should handle mouse wheel input.

Declaration
public PanoramaMouseWheelBehavior MouseWheelBehavior { get; set; }
Property Value
PanoramaMouseWheelBehavior

MouseWheelScrollStep

Gets or sets the step size in pixels that is used when scrolling with the mouse wheel.

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

PanelImage

Gets or sets the image that is displayed in the background.

Declaration
public Image PanelImage { get; set; }
Property Value
System.Drawing.Image

PanelImageSize

Gets or sets the size of the image that is displayed in the background.

Declaration
public Size PanelImageSize { get; set; }
Property Value
System.Drawing.Size

RowsCount

Gets or sets the number of rows.

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

ScrollBar

Gets the scrollbar of the view.

Declaration
public RadScrollBarElement ScrollBar { get; }
Property Value
RadScrollBarElement

ScrollBarAlignment

Gets or sets the position on which the scrollbar should be aligned.

Declaration
public HorizontalScrollAlignment ScrollBarAlignment { get; set; }
Property Value
HorizontalScrollAlignment

ScrollBarThickness

Gets or sets the thickness of the scrollbar.

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

ScrollingBackground

Gets or sets a value indicating whether the background image should be scrolled along with the tiles.

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

ScrollService

Gets the ScrollService that is responsible for kinetic scrolling behavior with the mouse pointer.

Declaration
public ScrollService ScrollService { get; }
Property Value
ScrollService

ShowGroups

Gets or sets a value indicating whether the groups or the items should be displayed.

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

TileLayout

Gets the layout that arranges the tiles in ungrouped mode.

Declaration
public GridLayout TileLayout { get; }
Property Value
GridLayout

ZoomedOut

Indicates whether the view is zoomed out.

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

Methods

ArrangeOverride(SizeF)

Arranges the child elements within the final size bounds.

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

The final area within which the element should arrange itself and its children.
Returns
System.Drawing.SizeF

The actual size used by the element.
Overrides

CreateChildElements()

Creates and initializes the child elements of the RadPanoramaElement.

Declaration
protected override void CreateChildElements()
Overrides

MeasureOverride(SizeF)

Measures the desired size of the element and its child elements.

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

The available size for this element.
Returns
System.Drawing.SizeF

The desired size of this element.
Overrides

OnBubbleEvent(RadElement, RoutedEventArgs)

Handles bubbled events from child elements and processes mouse wheel events when appropriate.

Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The source of the event.
RoutedEventArgs args

The RoutedEventArgs that contains the event data.
Overrides

OnMouseDown(MouseEventArgs)

Handles mouse down events and initiates scroll capture when the view is zoomed in.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseMove(MouseEventArgs)

Handles mouse move events to update scroll position during scroll capture.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseUp(MouseEventArgs)

Handles mouse up events and finalizes scroll operations or performs zoom in when clicked.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseWheel(MouseEventArgs)

Handles mouse wheel events for zooming or scrolling based on the MouseWheelBehavior setting.

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnPanGesture(PanGestureEventArgs)

Handles pan gesture events for scrolling the panorama view.

Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
PanGestureEventArgs args

The PanGestureEventArgs that contains the event data.
Overrides

OnZoomGesture(ZoomGestureEventArgs)

Handles zoom gesture events for zooming in and out of the panorama view.

Declaration
protected override void OnZoomGesture(ZoomGestureEventArgs args)
Parameters
ZoomGestureEventArgs args

The ZoomGestureEventArgs that contains the event data.
Overrides

ProcessDragOver(Point, ISupportDrag)

Processes drag over operations to determine if a drag object can be dropped.

Declaration
protected override bool ProcessDragOver(Point mousePosition, ISupportDrag dragObject)
Parameters
System.Drawing.Point mousePosition

The current position of the mouse cursor.
ISupportDrag dragObject

The object being dragged.
Returns
System.Boolean

true if the drag object can be dropped; otherwise, false.
Overrides

ScrollToItem(RadTileElement)

Scrolls the view to make the specified tile visible in the viewport.

Declaration
public void ScrollToItem(RadTileElement tile)
Parameters
RadTileElement tile

The RadTileElement to scroll to.

ScrollToItem(RadTileElement, Int32)

Scrolls the view to make the specified tile visible in the viewport with a custom offset.

Declaration
public void ScrollToItem(RadTileElement tile, int desiredOffset)
Parameters
RadTileElement tile

The RadTileElement to scroll to.
System.Int32 desiredOffset

The additional horizontal offset in pixels from the left edge.

ScrollView(Int32)

Scrolls the view horizontally with a specified offset value.

Declaration
public void ScrollView(int offset)
Parameters
System.Int32 offset

The horizontal offset in pixels to scroll by.

ScrollView(Int32, Boolean)

Scrolls the view horizontally with a specified offset value, with optional buffering for performance optimization.

Declaration
public void ScrollView(int offset, bool buffered)
Parameters
System.Int32 offset

The horizontal offset in pixels to scroll by.
System.Boolean buffered

If set to true, scroll operations are buffered to improve performance when called frequently.

UpdateCellCount()

Updates the number of columns and rows based on the current tile positions and span values.

Declaration
protected virtual void UpdateCellCount()

UpdateScrollBar(SizeF)

Updates the scrollbar properties based on the available size and content dimensions.

Declaration
protected virtual void UpdateScrollBar(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size for the scrollbar layout.

UpdateViewOnScroll()

Updates the visual layout to reflect the current scrollbar value and position.

Declaration
public void UpdateViewOnScroll()

ZoomIn(Point)

Zooms the view in towards the specified location with scaling animation.

Declaration
public void ZoomIn(Point location)
Parameters
System.Drawing.Point location

The point on the control to zoom towards.

ZoomOut()

Zooms the view out to show an overview of all tiles with scaling animation.

Declaration
public void ZoomOut()

Extension Methods