Back to Devexpress

TileContainer Members

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-views-dot-windowsui-dot-tilecontainer-dot-underscore-members.md

latest36.5 KB
Original Source

TileContainer Members

A WindowsUI View container that displays Tiles and unites them in multiple groups.

Constructors

NameDescription
TileContainer()Initializes a new instance of the TileContainer class with the default settings.
TileContainer(ITileContainerProperties)Initializes a new instance of the TileContainer class with custom settings.
TileContainer(IContainer)Initializes a new instance of the TileContainer class with the specified container.

Properties

NameDescription
ActionsProvides access to the collection of Custom Navigation Bar Actions used within the current Content Container. Inherited from BaseContentContainer.
ActivationTargetGets or sets the content container activated when any tile within the current TileContainer is clicked.
AllowButtonGlyphSkinningGets or sets whether or not container buttons should paint their glyphs with the foreground color. See the Glyph Skinning help article to learn more. Inherited from BaseContentContainer.
AppearanceButtonProvides access to the appearance settings used to paint WindowsUI Buttons within the current Content Container. Inherited from BaseContentContainer.
AppearanceGroupTextProvides access to appearance settings used to paint the current TileContainer groups’ captions.
AppearanceItemProvides access to appearance settings used to paint the current TileContainer‘s Tiles in different visual states.
AppearanceSubtitleProvides access to appearance settings used to paint the current Content Container‘s BaseContentContainer.Subtitle. Inherited from BaseContentContainer.
AppearanceTextProvides access to appearance settings used to paint the current TileContainer‘s caption.
BackgroundImageGets or sets the TileContainer‘s background image.
ButtonBackgroundImagesGets or sets the collection of background images for the current Content Container‘s Custom Buttons. Inherited from BaseContentContainer.
ButtonIntervalGets or sets the distance between neighboring WindowsUI Buttons in the current Content Container. Inherited from BaseContentContainer.
ButtonsProvides access to the Content Container’s WindowsUI Buttons collection. Inherited from BaseContentContainer.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CaptionGets or sets the current Content Container‘s caption. Inherited from BaseContentContainer.
CheckedTilesGets all checked tiles within the current TileContainer.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExcludeFromSearchGets or sets whether this Content Container should be removed from the list of places where the Search Panel looks for the entered text. Inherited from BaseContentContainer.
GroupsGets a list of all groups used within the current TileContainer.
ImageGets or sets an icon for the current Content Container. Inherited from BaseContentContainer.
ImageOptionsProvides access to properties that allow you to set up raster and vector images for this container. Inherited from BaseContentContainer.
ImageUriGets or sets an image stored within the DevExpress Image Gallery that should be assigned to this BaseContentContainer. Inherited from BaseContentContainer.
InfoGets the object providing information about the current TileContainer.
IsActiveGets whether the Content Container is currently active. Inherited from BaseContentContainer.
IsAutoCreatedGets whether the current Content Container is created automatically. Inherited from BaseContentContainer.
IsDisposingGets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent.
IsFilledUpGets whether the number of current Content Container items has reached its limit. Inherited from BaseContentContainer.
IsHorizontalGets whether the current Content Container is orientated horizontally. Inherited from BaseContentContainer.
IsInitializedIndicates whether or not the BaseComponent object has been fully initialized. Inherited from BaseComponent.
IsInitializingReturns whether or not the BaseComponent object is currently being initialized. Inherited from BaseComponent.
IsLoadedGets if the current Content Container is loaded. Inherited from BaseContentContainer.
IsUpdateLockedReturns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent.
ItemsGets a collection of Tile s contained within the current TileContainer.
ManagerGets a DocumentManager that owns the current Content Container. Inherited from BaseContentContainer.
NameGets or sets the current Content Container‘s name. Inherited from BaseContentContainer.
ParentGets or sets the current Content Container‘s parent Container. Inherited from BaseContentContainer.
PositionGets or sets the TileContainer‘s offset.
PropertiesProvides access to the current TileContainer‘s settings.
SearchTagsGets or sets the collection of string tags for this BaseContentContainer. The Search Panel will check these tags for the desired text. Inherited from BaseContentContainer.
SiteGets or sets the ISite of the Component. Inherited from Component.
SubtitleGets or sets the current Content Container‘s subtitle. Inherited from BaseContentContainer.
TagGets or sets a tag that labels this BaseContentContainer. Inherited from BaseContentContainer.
UseButtonBackgroundImagesGets or sets whether or not container buttons should display their background images. Inherited from BaseContentContainer.

Methods

NameDescription
AllowAnimation(BaseTile, Boolean)Gets or sets whether or not Tile Animation is enabled for the target tile.
BeginUpdate()Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseComponent.
CancelUpdate()Unlocks the BaseComponent object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseComponent.
CanExtend(Object)Specifies whether this TileContainer can provide its extender properties to the specified object.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose()Releases all resources used by the Component. Inherited from Component.
EndUpdate()Unlocks the BaseComponent object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseComponent.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetEnumerator()Gets an Enumerator that can iterate through the BaseContentContainer‘s content. Inherited from BaseContentContainer.
GetEnumerator(IContentContainer, Predicate<IContentContainer>, Int32) staticGets an enumerator that goes down the BaseContentContainer‘s hierarchy and iterates the children that meet a specific set of criteria. Inherited from BaseContentContainer.
GetEnumerator(Int32)Gets an enumerator that goes down the BaseContentContainer‘s hierarchy and iterates its children. Inherited from BaseContentContainer.
GetEnumerator(Predicate<IContentContainer>)Gets an enumerator that iterates through the current BaseContentContainer with a specific criteria. Inherited from BaseContentContainer.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetID(BaseTile)Gets a specific Tile‘s ID.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetRoot(IContentContainer) staticGets the root parent for the specific Content Container. Inherited from BaseContentContainer.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
IsChild(IContentContainer, IContentContainer) staticGets whether the ‘container’ Content Container is the ‘parent’ container’s child. Inherited from BaseContentContainer.
LayoutChanged()Updates the element. Inherited from BaseComponent.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
NextFrame(BaseTile)Forces the target tile to display its next animation frame.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RestoreLayoutFromJson(Stream)Loads the tile container’s layout from a file in JSON format.
RestoreLayoutFromRegistry(String)Restores the TileContainer‘s layout from a registry.
RestoreLayoutFromStream(Stream)Restores the TileContainer‘s layout from a stream.
RestoreLayoutFromXml(String)Restores the TileContainer‘s layout from an XML file.
SaveLayoutToJson(Stream)Saves the tile container’s layout to a file in JSON format.
SaveLayoutToRegistry(String)Saves the current TileContainer‘s layout to a registry.
SaveLayoutToStream(Stream)Saves the current TileContainer‘s layout to a stream.
SaveLayoutToXml(String)Saves the current TileContainer‘s layout to an XML file.
SetID(BaseTile, Int32)Sets an ID for a specific Tile within the current TileContainer.
StartAnimation(BaseTile)Starts the Tile Animation for the target tile.
StopAnimation(BaseTile)Stops the running frame animation for the target tile.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
UpdateDocumentActions()Refreshes document actions displayed within this BaseContentContainer‘s child documents. Inherited from BaseContentContainer.

Events

NameDescription
ActionCustomizationOccurs whenever Navigation Bars within the current BaseContentContainer are to be displayed. Allows you to customize this container’s Navigation Bar Actions. Inherited from BaseContentContainer.
ActualActionsChangedFires when the current Content Container‘s actions collection changes. Inherited from BaseContentContainer.
ButtonCheckedOccurs when a Custom Button within the current Content Container is checked. Inherited from BaseContentContainer.
ButtonClickOccurs when a regular Custom Button within the current Content Container is clicked. Inherited from BaseContentContainer.
ButtonUncheckedOccurs when a Custom Button within the current Content Container is checked. Inherited from BaseContentContainer.
CheckedChangedOccurs when any Tile‘s checked state within the current TileContainer was changed.
ClickOccurs after any Tile within the current TileContainer was clicked.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
EndItemDraggingOccurs when an end-user drops a TileItem after dragging.
PressOccurs immediately after a Tile within the current TileContainer is pressed.
StartItemDraggingOccurs whenever an end-user starts dragging a TileContainer‘s tile.

See Also

TileContainer Class

DevExpress.XtraBars.Docking2010.Views.WindowsUI Namespace