GradientStopCollection Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Media

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 GradientStop objects that can be individually accessed by index.

public ref class GradientStopCollection sealed : IIterable<GradientStop ^>, IVector<GradientStop ^>

/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class GradientStopCollection final : IIterable<GradientStop>, IVector<GradientStop>

[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class GradientStopCollection : IEnumerable<GradientStop>, IList<GradientStop>

Public NotInheritable Class GradientStopCollection
Implements IEnumerable(Of GradientStop), IList(Of GradientStop)

<object>
  <object.property>
    oneOrMoreGradientStops
  </object.property>
</object>

Inheritance: Object Platform::Object IInspectable GradientStopCollection

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

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

Remarks

Enumerating the collection in C# or Microsoft Visual Basic

A GradientStopCollection is enumerable, so you can use language-specific syntax such as foreach in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to IEnumerable<GradientStop> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable with a GradientStop constraint.

Constructors

GradientStopCollection()

Initializes a new instance of the GradientStopCollection class.

Properties

Size	Gets the size (count) of the collection.

Methods

Append(GradientStop)	Adds a new item to the collection.
Clear()	Removes all items from the collection.
First()	Returns an iterator for the items in the collection.
GetAt(UInt32)	Returns the item located at the specified index.
GetMany(UInt32, GradientStop[])	Retrieves multiple elements in a single pass through the iterator.
GetView()	Gets an immutable view into the collection.
IndexOf(GradientStop, UInt32)	Retrieves the index of the specified item.
InsertAt(UInt32, GradientStop)	Inserts the specified item at the specified index.
RemoveAt(UInt32)	Removes the item at the specified index.
RemoveAtEnd()	Removes the last item in the collection.
ReplaceAll(GradientStop[])	Initially clears the collection, then inserts the provided array as new items.
SetAt(UInt32, GradientStop)	Sets the value at the specified index to the GradientStop value specified.

Applies to

Share via