RadTileList
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[EmbeddedSkin("TileList")]
[EmbeddedSkin("TileList", "Default")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadTileList))]
[RequiredScript(typeof(RadTileListScripts))]
[ToolboxBitmap(typeof(RadTileList), "Toolbox.Icons.TileList.png")]
[ClientScriptResource("Telerik.Web.UI.RadTileList", "Telerik.Web.UI.TileList.RadTileListScripts.js")]
[TelerikToolboxCategory("Data")]
public class RadTileList : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, INamingContainerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadTileList...
Implements:
Inherited Members
Constructors
public RadTileList()Properties
Gets or sets a bool value that indicates whether all existing tiles are deleted before client data binding.
[ClientControlProperty]
public bool AppendClientDataBoundItems { get; set; }Gets or sets a bool value that indicates whether the tiles are cleared before data binding.
public bool AppendDataBoundItems { get; set; }Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the RadTileList selection or clicks on a tile.
[Bindable(false)]
[ClientControlProperty]
public bool AutoPostBack { get; set; }The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
protected override string CssClassFormatString { get; }Overrides:
[PersistenceMode(PersistenceMode.InnerProperty)]
public TileListBinding DataBindings { get; set; }Gets or sets a value indicating whether a drag and drop functionality is enabled.
[Bindable(false)]
[ClientControlProperty]
public bool EnableDragAndDrop { get; set; }Groups
TileGroupCollection
Gets a TileGroupCollection object that contains the tile groups of the TileList.
[PersistenceMode(PersistenceMode.InnerProperty)]
public TileGroupCollection Groups { get; }Gets or sets the height of the RadTileList control
[ClientControlProperty]
[ClientPropertyName("height")]
public override Unit Height { get; set; }Overrides:
Gets or sets a value indicating the client-side event handler that is called after the client object of RadTileList is initialized.
[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
Use the OnClientLoad property to specify a JavaScript function that is executed after the client object of RadTileList is initialized.
A single parameter is passed to the handler, which is the client-side RadTileList object.
Gets or sets the name of the JavaScript function that will be called when a tile in a RadTileList is clicked, after the OnClientClicking event.
[ClientControlEvent]
[ClientPropertyName("tileClicked")]
public string OnClientTileClicked { get; set; }Gets or sets the name of the JavaScript function that will be called when a tile in a RadTileList is clicked. The event is cancelable.
[ClientControlEvent]
[ClientPropertyName("tileClicking")]
public string OnClientTileClicking { get; set; }Gets or sets the name of the JavaScript function that will be called, after the contentTemplate of RadContentTemplateTile is databound.
[ClientControlEvent]
[ClientPropertyName("clientTileContentTemplateDataBound")]
public string OnClientTileContentTemplateDataBound { get; set; }Gets or sets the name of the JavaScript function that will be called, before a tile is created. The event is cancelable.
[ClientControlEvent]
[ClientPropertyName("tileCreating")]
public string OnClientTileCreating { get; set; }Gets or sets the name of the JavaScript function that will be called, after a tile is databound.
[ClientControlEvent]
[ClientPropertyName("tileDataBound")]
public string OnClientTileDataBound { get; set; }Gets or sets the name of the JavaScript function that will be called, when a tile is dragged.
[ClientControlEvent]
[ClientPropertyName("tileDragging")]
public string OnClientTileDragging { get; set; }Gets or sets the name of the JavaScript function that will be called before a tile dragging starts.
[ClientControlEvent]
[ClientPropertyName("tileDragStart")]
public string OnClientTileDragStart { get; set; }Gets or sets the name of the JavaScript function that will be called, after a tile is dropped.
[ClientControlEvent]
[ClientPropertyName("tileDropped")]
public string OnClientTileDropped { get; set; }Gets or sets the name of the JavaScript function that will be called, before a tile is dropped.
[ClientControlEvent]
[ClientPropertyName("tileDropping")]
public string OnClientTileDropping { get; set; }Gets or sets the name of the JavaScript function that will be called, after the TileList is databound.
[ClientControlEvent]
[ClientPropertyName("tileListDataBound")]
public string OnClientTileListDataBound { get; set; }Gets or sets the name of the JavaScript function that will be called, after the client PeekTemplate is databound.
[ClientControlEvent]
[ClientPropertyName("clientTilePeekTemplateDataBound")]
public string OnClientTilePeekTemplateDataBound { get; set; }Gets or sets the name of the JavaScript function which handles the selection of a tile client-side event.
[ClientControlEvent]
[ClientPropertyName("tileSelected")]
public string OnClientTileSelected { get; set; }The clientTileSelected client-side event occurs after a tile is selected.
Gets or sets the name of the JavaScript function which handles the selecting of a tile client-side event.
[ClientControlEvent]
[ClientPropertyName("tileSelecting")]
public string OnClientTileSelecting { get; set; }The clientTileSelecting client-side event occurs before a tile is selected.
Gets or sets the URL of the page to post to from the current page when a tile from RadTileList is clicked.
[Themeable(false)]
public virtual string PostBackUrl { get; set; }The URL of the Web page to post to from the current page when a tile from the RadTileList control is clicked. The default value is an empty string (""), which causes the page to post back to itself.
Gets or sets the value defining the scroll behavior of the TileList control.
[ClientControlProperty]
[Bindable(true)]
public TileListScrollingMode ScrollingMode { get; set; }Auto Scrolling mode is automatically set to Native or Accelerated depending on the device touch capabilities.
None The scroll bars are hidden and the scrolling is disabled in the TileList container.
NativeThe default behaviour - The native browser horizontal scroll bar is used for scrolling.
Accelerated The native browser horizontal scroll bar is hidden and a custom touch scroll extender is used for scrolling.
Gets or sets the value indicating the TileList selection mode, giving the tiles ability to be selected on context menu click.
[ClientControlProperty]
[Bindable(true)]
public TileListSelectionMode SelectionMode { get; set; }None The default behaviour - tiles can not be selected.
Single Only one tile can be selected at a time.
Multiple Allows selection of multiple tiles.
protected override HtmlTextWriterTag TagKey { get; }Overrides:
Gets or sets in how many rows the tiles will be ordered.
[ClientControlProperty]
public int TileRows { get; set; }Methods
Unselects all selected tiles
public void ClearSelection()Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
protected override void ControlPreRender()Overrides:
protected override void CreateChildControls()Overrides:
protected void CreateChildControls(IEnumerable dataSource, bool dataBinding)protected override void DescribeComponent(IScriptDescriptor descriptor)Overrides:
Get all the tiles in a RadTileList
public List<RadBaseTile> GetAllTiles()List<RadBaseTile>
Generic List of type RadBaseTile
Creates a PostBackOptions object that represents the RadTileList control's postback behavior, and returns the client script generated as a result of the PostBackOptions.
protected virtual string GetPostbackEventReference()The client script that represents the RadTileList control's PostBackOptions.
Get all selected tiles in a RadTileList
public List<RadBaseTile> GetSelectedTiles()List<RadBaseTile>
Generic List of type RadBaseTile
Find a tile by name.
public RadBaseTile GetTileByName(string name)Tile name
Returns:RadBaseTile
RadBaseTile
Loads the posted content of the list control, if it is different from the last posting.
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)The key identifier for the control, used to index the postCollection.
postCollectionNameValueCollectionA NameValueCollection that contains value information indexed by control identifiers.
Returns:true if the posted content is different from the last posting; otherwise, false.
Overrides:
Raises the SelectionChanged event.
protected virtual void OnSelectionChanged(TileListDataEventArgs e)The EventArgs instance containing the event data.
Raises the TileClick event of the RadTileList control.
protected virtual void OnTileClick(TileListEventArgs e)A TileListEventArgs that contains the event data.
Raises the TileCreated event of the RadTileList control.
protected virtual void OnTileCreated(TileListEventArgs e)A TileListEventArgs that contains the event data.
Raises the TileDataBound event of the RadTileList control.
protected virtual void OnTileDataBound(TileListEventArgs e)A TileListEventArgs that contains the event data.
protected override void PerformDataBinding(IEnumerable data)Overrides:
protected void PrepareForDataBinding()Invokes the OnSelectionChanged method, when there are tiles in _selectionStateChangedTiles is true.
protected override void RaisePostDataChangedEvent()Overrides:
Registers the CSS references
protected override void RegisterCssReferences()Overrides:
protected override void RenderContents(HtmlTextWriter writer)Overrides:
protected override void TrackViewState()Overrides:
Events
Occurs when the selected index has changed.
public event TileListDataEventHandler SelectionChangedAdds or removes an event handler method from the TileClick event. The event is fired when a tile is clicked.
public event TileListEventHandler TileClickAdds or removes an event handler method from the TileCreated event. The event is fired after a tile is created during data binding or restoring the data bound tiles after postback.
public event TileListEventHandler TileCreatedAdds or removes an event handler method from the TileDataBound event. The event is fired after a data bound tile is created.
public event TileListEventHandler TileDataBound