ClassRadPanorama
Represents a panoramic view control that can display and arrange tiles in grouped or ungrouped layouts with zoom and scroll capabilities.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Containers")]
public class RadPanorama : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadPanorama
Implements:
Inherited Members
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
[Browsable(true)]
public bool AllowDragDrop { get; set; }Property Value
AutoArrangeNewTiles
Gets or sets a value that indicates whether the newly added tiles should be automatically arranged.
Declaration
[Browsable(true)]
public bool AutoArrangeNewTiles { get; set; }Property Value
CellSize
Gets or sets the size of a single cell.
Declaration
[Browsable(true)]
public Size CellSize { get; set; }Property Value
ColumnsCount
Gets or sets the current number of columns.
Declaration
[Browsable(false)]
public int ColumnsCount { get; set; }Property Value
DefaultSize
Gets the default size of the RadPanorama control.
Declaration
protected override Size DefaultSize { get; }Property Value
Overrides
EnableZooming
Enables or Disables the build in zoom functionality
Declaration
[Browsable(true)]
public bool EnableZooming { get; set; }Property Value
Groups
Gets a collection of TileGroupElement objects that represent the tile groups that are displayed.
Declaration
[Browsable(true)]
public RadItemOwnerCollection Groups { get; }Property Value
Items
Gets a collection of RadTileElement objects that represent the tiles that are displayed.
Declaration
[Browsable(true)]
public RadItemOwnerCollection Items { get; }Property Value
MinimumColumns
Gets or sets the minimum number of columns that the view can be reduced to.
Declaration
[Browsable(true)]
public int MinimumColumns { get; set; }Property Value
MouseWheelBehavior
Gets or sets the way that RadPanorama should handle mouse wheel input.
Declaration
[Browsable(true)]
public PanoramaMouseWheelBehavior MouseWheelBehavior { get; set; }Property Value
MouseWheelScrollStep
Gets or sets the step size that is used, when scrolling with the mouse wheel.
Declaration
[Browsable(true)]
public int MouseWheelScrollStep { get; set; }Property Value
PanelImage
Gets or sets the image that is displayed in the background.
Declaration
[Browsable(false)]
public Image PanelImage { get; set; }Property Value
PanelImageSize
Gets or sets the size of the image that is displayed in the background.
Declaration
[Browsable(true)]
public Size PanelImageSize { get; set; }Property Value
PanoramaElement
Gets the RadPanoramaElement that represents the main element of the control.
Declaration
[Browsable(false)]
public RadPanoramaElement PanoramaElement { get; }Property Value
RowsCount
Gets or sets the number of rows.
Declaration
[Browsable(true)]
public int RowsCount { get; set; }Property Value
ScrollBarAlignment
Gets or sets the position on which the scrollbar should be aligned.
Declaration
[Browsable(true)]
public HorizontalScrollAlignment ScrollBarAlignment { get; set; }Property Value
ScrollBarThickness
Gets or sets the thickness of the scrollbar.
Declaration
[Browsable(true)]
public int ScrollBarThickness { get; set; }Property Value
ScrollingBackground
Gets or sets a value indicating whether the background image should be scrolled along with the tiles.
Declaration
[Browsable(true)]
public bool ScrollingBackground { get; set; }Property Value
ShowGroups
Gets or sets a value indicating whether the groups or the items should be displayed.
Declaration
[Browsable(true)]
public bool ShowGroups { get; set; }Property Value
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
[Browsable(false)]
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }Property Value
Methods
CreateChildItems(RadElement)
Creates the child items for the specified parent element.
Declaration
protected override void CreateChildItems(RadElement parent)Parameters
parent
The parent RadElement to create child items for.
Overrides
CreatePanoramaElement()
Creates the main element of the control.
Declaration
protected virtual RadPanoramaElement CreatePanoramaElement()Returns
The created element.
Dispose(bool)
Releases the unmanaged resources used by the RadPanorama and optionally releases the managed resources.
Declaration
protected override void Dispose(bool disposing)Parameters
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
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
stream
The stream to read from.
LoadLayout(XmlReader)
Loads the RadPanorama layout state from an XML reader using the serialization information provided by the XmlSerializationInfo property.
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
fileName
The file path to read from.
OnLoad(Size)
Called when the control is loaded with the specified desired size.
Declaration
protected override void OnLoad(Size desiredSize)Parameters
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
stream
The stream to write to.
Remarks
Writes the XML content to the stream and leaves the stream open.
SaveLayout(XmlWriter)
Stores the RadPanorama layout state in XML format using the serialization information provided by the XmlSerializationInfo property.
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
fileName
The file path to write to.
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