TileItem Class

Provides the functionality of tile items.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "RemoveGroup", "Remove Group", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "RemoveItem", "Remove Item", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "EditFrames", "Edit Animation Frames", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "EditElements", "Edit TileItem Elements", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "SelectTemplate", "Select TileItem Template", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "AddMediumItem", "Add Medium Item", SmartTagActionType.RefreshAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "AddSmallItem", "Add Small Item", SmartTagActionType.RefreshAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "AddWideItem", "Add Wide Item", SmartTagActionType.RefreshAfterExecute)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "AddLargeItem", "Add Large Item", SmartTagActionType.RefreshAfterExecute)]
[SmartTagSupport(typeof(TileItemDesignTimeBoundsProvider), SmartTagSupportAttribute.SmartTagCreationMode.Auto)]
[SmartTagAction(typeof(TileItemDesignTimeActionsProvider), "AddGroup", "Add Group", SmartTagActionType.RefreshAfterExecute)]
public class TileItem :
    Component,
    ITileItem,
    ITileItemProperties,
    IAppearanceOwner,
    INotifyElementPropertiesChanged,
    ISupportCommandBinding,
    ISupportAdornerElement,
    IUpdateAdornerUI,
    IXtraSerializable,
    IXtraSerializableLayoutEx,
    ITableLayoutOwner,
    ITileItemElementsDesigner

VB.NET

<SmartTagSupport(GetType(TileItemDesignTimeBoundsProvider), SmartTagSupportAttribute.SmartTagCreationMode.Auto)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "AddSmallItem", "Add Small Item", SmartTagActionType.RefreshAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "AddGroup", "Add Group", SmartTagActionType.RefreshAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "RemoveGroup", "Remove Group", SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "AddMediumItem", "Add Medium Item", SmartTagActionType.RefreshAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "EditFrames", "Edit Animation Frames", SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "AddWideItem", "Add Wide Item", SmartTagActionType.RefreshAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "RemoveItem", "Remove Item", SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "AddLargeItem", "Add Large Item", SmartTagActionType.RefreshAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "EditElements", "Edit TileItem Elements", SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(TileItemDesignTimeActionsProvider), "SelectTemplate", "Select TileItem Template", SmartTagActionType.CloseAfterExecute)>
Public Class TileItem
    Inherits Component
    Implements ITileItem,
               ITileItemProperties,
               IAppearanceOwner,
               INotifyElementPropertiesChanged,
               ISupportCommandBinding,
               ISupportAdornerElement,
               IUpdateAdornerUI,
               IXtraSerializable,
               IXtraSerializableLayoutEx,
               ITableLayoutOwner,
               ITileItemElementsDesigner

Related API Members

The following members accept/return TileItem objects:

• TileControl.SelectedItem
• TileGroup.GetTileItemByName(String)
• TileGroup.GetTileItemByText(String)
• TileItemCollection.Item[Int32]
• TileItemCollection.Item[String]
• TileItemDragEventArgs.Item
• TileItemEventArgs.Item

Remarks

TileItems are base TileControl elements. You can think of a tile item as a shortcut or a button. The difference is that not only does a TileItem perform actions on an end-user click, it also capable of displaying rich content, giving a user information at a glance. Moreover, TileItems can act like radio-buttons. See the Tile Groups and Items topic to learn more.

The Tile Item Structure topic covers aspects related to TileItem content.

TileItems can also be animated. See the Tile Frame Animation to learn more.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TileItem class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-animate-tile-frames-on-hovering-over-with-the-mouse-t549254/CS/FrameHoverHelper.cs#L14

foreach (TileGroup group in tileControl.Groups)
    foreach (TileItem item in group.Items)
        item.AllowAnimation = false;

how-to-use-searchcontrol-for-tilecontrol-t273248/CS/CustomTileControl.cs#L20

foreach (TileGroup group in this.Groups) {
    foreach (TileItem item in group.Items)
        item.Visible = true;

how-to-create-an-animated-tile-item-via-code-e3820/CS/WinTileItemCodeCreating/Form1.cs#L18

private void contentGenerate_Click(object sender, EventArgs e) {
    TileItem newTile = new TileItem();
    //First Frame - Image only

VB.NET

how-to-animate-tile-frames-on-hovering-over-with-the-mouse-t549254/VB/FrameHoverHelper.vb#L13

For Each group As TileGroup In tileControl.Groups
    For Each item As TileItem In group.Items
        item.AllowAnimation = False

how-to-use-searchcontrol-for-tilecontrol-t273248/VB/CustomTileControl.vb#L23

For Each group As TileGroup In Me.Groups
    For Each item As TileItem In group.Items
        item.Visible = True

how-to-create-an-animated-tile-item-via-code-e3820/VB/Form1.vb#L20

Private Sub contentGenerate_Click(ByVal sender As Object, ByVal e As EventArgs) Handles contentGenerate.Click
    Dim newTile As TileItem = New TileItem()
    'First Frame - Image only

Inheritance

Object

MarshalByRefObject

Component

TileItem

TileBarItem

TileViewItem