VisualCollection VisualCollection VisualCollection VisualCollection Class

Definition

Represents a collection of visual instances.

public : sealed class VisualCollection : CompositionObject
struct winrt::Windows::UI::Composition::VisualCollection : CompositionObject
public sealed class VisualCollection : CompositionObject
Public NotInheritable Class VisualCollection Inherits CompositionObject
Inheritance
VisualCollectionVisualCollectionVisualCollectionVisualCollection
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

VisualCollections are ordered from bottom to top and iterating or enumerating through a collection is always done from bottom to top.

Properties

Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
Count Count Count Count

Gets the number of visual instances in the collection.

Dispatcher Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)

Methods

Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
First() First() First() First()

Retrieves an iterator with the first object at the bottom of the collection.

InsertAbove(Visual, Visual) InsertAbove(Visual, Visual) InsertAbove(Visual, Visual) InsertAbove(Visual, Visual)

Inserts a visual above the specified sibling visual in the visual collection.

InsertAtBottom(Visual) InsertAtBottom(Visual) InsertAtBottom(Visual) InsertAtBottom(Visual)

Inserts a new visual at the bottom of the visual collection.

InsertAtTop(Visual) InsertAtTop(Visual) InsertAtTop(Visual) InsertAtTop(Visual)

Inserts a new visual at the top of the visual collection.

InsertBelow(Visual, Visual) InsertBelow(Visual, Visual) InsertBelow(Visual, Visual) InsertBelow(Visual, Visual)

Insert a new visual below the specified visual in the visual collection.

PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from CompositionObject)
Remove(Visual) Remove(Visual) Remove(Visual) Remove(Visual)

Removes the specified visual instance from the collection.

RemoveAll() RemoveAll() RemoveAll() RemoveAll()

Removes all of the visual instances from the collection.

StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

Connects an animation with the specified property of the object and starts the animation.

(Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase)

Starts an animation group.

The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

(Inherited from CompositionObject)
StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase)

Starts an animation group on the specified target.

(Inherited from CompositionObject)
StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation)

Connects an animation with the specified property of the target object and starts the animation.

(Inherited from CompositionObject)
StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String)

Disconnects an animation from the specified property and stops the animation.

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

Returns an AnimationController for the animation running on the specified property.

(Inherited from CompositionObject)

See also