Class RadPanorama

Represents a panoramic view control that can display and arrange tiles in grouped or ungrouped layouts with zoom and scroll capabilities.

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

Syntax

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

Constructors

RadPanorama()

Initializes a new instance of the RadPanorama class.

Declaration
public RadPanorama()

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

AutoSize

This property is not relevant for this class.

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

Overrides

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

DefaultSize

Gets the default size of the RadPanorama control.

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

EnableZooming

Enables or Disables the build in zoom functionality

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

ForeColor

This property is not relevant for this class.

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

Overrides

Groups

Gets a collection of TileGroupElement objects that represent the tile groups that are displayed.

Declaration
public RadItemOwnerCollection Groups { get; }
Property Value
RadItemOwnerCollection

Items

Gets a collection of RadTileElement objects that represent the tiles that are displayed.

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 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

PanoramaElement

Gets the RadPanoramaElement that represents the main element of the control.

Declaration
public RadPanoramaElement PanoramaElement { get; }
Property Value
RadPanoramaElement

RowsCount

Gets or sets the number of rows.

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

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

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

Text

This property is not relevant for this class.

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

Overrides

XmlSerializationInfo

Gets or sets the serialization information for the RadPanorama used by Save/Load layout methods to persist the layout to/from XML. When set to null, the ComponentXmlSerializationInfo provided by GetDefaultXmlSerializationInfo() will be used.

Declaration
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }
Property Value
ComponentXmlSerializationInfo

Methods

CreateChildItems(RadElement)

Creates the child items for the specified parent element.

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

The parent RadElement to create child items for.
Overrides

CreatePanoramaElement()

Creates the main element of the control.

Declaration
protected virtual RadPanoramaElement CreatePanoramaElement()
Returns
RadPanoramaElement

The created element.

Dispose(Boolean)

Releases the unmanaged resources used by the RadPanorama 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

GetDefaultXmlSerializationInfo()

Gets the default serialization information for the RadPanorama used by Save/Load layout methods to persist the layout to/from XML.

Declaration
protected virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
Returns
ComponentXmlSerializationInfo

The default ComponentXmlSerializationInfo for the control.

LoadLayout(Stream)

Loads the RadPanorama layout state from a stream using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(Stream stream)
Parameters
System.IO.Stream stream

The stream to read from.

LoadLayout(String)

Loads the RadPanorama layout state from an XML file using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(string fileName)
Parameters
System.String fileName

The file path to read from.

LoadLayout(XmlReader)

Loads the RadPanorama layout state from an XML reader using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(XmlReader xmlReader)
Parameters
System.Xml.XmlReader xmlReader

The System.Xml.XmlReader to read the XML from.

OnLoad(Size)

Called when the control is loaded with the specified desired size.

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

The desired size for the control.
Overrides

ResetBackColorThemeOverrides()

Resets the back color theme overrides for the panorama element.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

SaveLayout(Stream)

Stores the RadPanorama layout state in XML format using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(Stream stream)
Parameters
System.IO.Stream stream

The stream to write to.
Remarks

Writes the XML content to the stream and leaves the stream open.

SaveLayout(String)

Stores the RadPanorama layout state in XML format using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(string fileName)
Parameters
System.String fileName

The file path to write to.

SaveLayout(XmlWriter)

Stores the RadPanorama layout state in XML format using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(XmlWriter xmlWriter)
Parameters
System.Xml.XmlWriter xmlWriter

The System.Xml.XmlWriter to use for the built-in serializer.

Select()

Selects the control and sets focus to the PanoramaElement.

Declaration
public void Select()

SetBackColorThemeOverrides()

Sets the back color theme overrides for the panorama element.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

Extension Methods