CompositionShapeCollection Class

Reference

Definition

Namespace:: Windows.UI.Composition

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a collection of CompositionShape objects that can be individually accessed by index.

public ref class CompositionShapeCollection sealed : CompositionObject, IIterable<CompositionShape ^>, IVector<CompositionShape ^>

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CompositionShapeCollection final : CompositionObject, IIterable<CompositionShape>, IVector<CompositionShape>

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CompositionShapeCollection : CompositionObject, IEnumerable<CompositionShape>, IList<CompositionShape>

Public NotInheritable Class CompositionShapeCollection
Inherits CompositionObject
Implements IEnumerable(Of CompositionShape), IList(Of CompositionShape)

Inheritance: Object Platform::Object IInspectable CompositionObject CompositionShapeCollection

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: IIterable<T> IEnumerable<T> IIterable<CompositionShape> IEnumerable<CompositionShape> IVector<CompositionShape> IList<CompositionShape>

Windows requirements

Device family	Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v6.0)

Properties

Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
Dispatcher	The dispatcher for the CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompostionObject. (Inherited from CompositionObject)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)
Size	Gets the size (count) of the collection.

Methods

Append(CompositionShape)	Adds a new item to the collection.
Clear()	Removes all items from the collection.
Close()	Closes the CompositionObject and releases system resources. (Inherited from CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Connects and animation. (Inherited from CompositionObject)
DisconnectAnimation(String)	Disconnects an animation. (Inherited from CompositionObject)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject)
First()	Returns an iterator for the items in the collection.
GetAt(UInt32)	Returns the item located at the specified index.
GetMany(UInt32, CompositionShape[])	Retrieves multiple elements in a single pass through the iterator.
GetView()	Gets an immutable view into the collection.
IndexOf(CompositionShape, UInt32)	Retrieves the index of the specified item.
InsertAt(UInt32, CompositionShape)	Inserts the specified item at the specified index.
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from CompositionObject)
RemoveAt(UInt32)	Removes the item at the specified index.
RemoveAtEnd()	Removes the last item in the collection.
ReplaceAll(CompositionShape[])	Initially clears the collection, then inserts the provided array as new items.
SetAt(UInt32, CompositionShape)	Sets the value at the specified index to the CompositionShape value specified.
StartAnimation(String, CompositionAnimation, AnimationController)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
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)
StopAnimation(String)	Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Stops an animation group. (Inherited from CompositionObject)
TryGetAnimationController(String)	Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject)

Applies to

Dela via