Class CaptionCollection
A collection of Caption objects on a MediaShape.
Provides Add, Insert, Remove, Clear,
and indexer access. Maps to p:subTitles.
Inherited Members
Namespace: DRIT.Presentation.Drawing
Assembly: DRIT.Presentation.dll
Syntax
public class CaptionCollection : IList<Caption>, ICollection<Caption>, IEnumerable<Caption>, IEnumerableProperties
Count
Gets the number of captions in the collection.
Declaration
public int Count { get; }Property Value
| Type | Description |
|---|---|
| int |
IsReadOnly
Gets a value indicating whether the collection is read-only.
Declaration
public bool IsReadOnly { get; }Property Value
| Type | Description |
|---|---|
| bool |
this[int]
Gets or sets the caption at the specified index.
Declaration
public Caption this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| int | index |
Property Value
| Type | Description |
|---|---|
| Caption |
Methods
Add(Caption)
Adds the specified caption to the collection.
Declaration
public void Add(Caption item)Parameters
| Type | Name | Description |
|---|---|---|
| Caption | item |
Add(Stream, string)
Creates and adds a caption with the specified label and data stream.
Declaration
public Caption Add(Stream stream, string label)Parameters
| Type | Name | Description |
|---|---|---|
| Stream | stream | The caption data stream. |
| string | label | The display label for this caption track. |
Returns
| Type | Description |
|---|---|
| Caption | The newly created caption. |
Clear()
Removes all captions from the collection.
Declaration
public void Clear()Contains(Caption)
Determines whether the collection contains the specified caption.
Declaration
public bool Contains(Caption item)Parameters
| Type | Name | Description |
|---|---|---|
| Caption | item |
Returns
| Type | Description |
|---|---|
| bool |
CopyTo(Caption[], int)
Copies the captions to an array starting at the specified index.
Declaration
public void CopyTo(Caption[] array, int arrayIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Caption[] | array | |
| int | arrayIndex |
GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
public IEnumerator<Caption> GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator<Caption> |
IndexOf(Caption)
Returns the index of the specified caption, or -1 if not found.
Declaration
public int IndexOf(Caption item)Parameters
| Type | Name | Description |
|---|---|---|
| Caption | item |
Returns
| Type | Description |
|---|---|
| int |
Insert(int, Caption)
Inserts a caption at the specified index.
Declaration
public void Insert(int index, Caption item)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | |
| Caption | item |
Remove(Caption)
Removes the first occurrence of the specified caption.
Declaration
public bool Remove(Caption item)Parameters
| Type | Name | Description |
|---|---|---|
| Caption | item |
Returns
| Type | Description |
|---|---|
| bool |
RemoveAt(int)
Removes the caption at the specified index.
Declaration
public void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index |