MediaBookmark Struct

Namespace:: GemBox.Presentation.Media

Assembly:: GemBox.Presentation.dll

Represents a named location in the media content that is located at the specific time offset from the beginning of the media.

C#
VB.NET

public struct MediaBookmark : IComparable<MediaBookmark>, IEquatable<MediaBookmark>

Public Structure MediaBookmark
    Implements IComparable(Of MediaBookmark), IEquatable(Of MediaBookmark)

Implements

System.IComparable<MediaBookmark>

System.IEquatable<MediaBookmark>

Properties

Name

Gets the name.

C#
VB.NET

public readonly string Name { get; }

Public ReadOnly Property Name As String

Property Value

System.String

The name.

Time

Gets the time offset from the beginning of the media.

C#
VB.NET

public readonly TimeOffset Time { get; }

Public ReadOnly Property Time As TimeOffset

Property Value

TimeOffset

The time offset from the beginning of the media

Methods

CompareTo(MediaBookmark)

Compares the value of this instance to a specified MediaBookmark value and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified MediaBookmark value.

C#
VB.NET

public int CompareTo(MediaBookmark other)

Public Function CompareTo(other As MediaBookmark) As Integer

Parameters

other: MediaBookmark

The object to compare to the current instance.

Returns

System.Int32

A signed number indicating the relative values of this instance and the other parameter.

If returned value is less than zero, then this instance is earlier than other; else, if it is zero, then this instance is the same as other; else (if it is greater than zero) this instance is later than other.

Equals(MediaBookmark)

Determines whether the other MediaBookmark is equal to this MediaBookmark instance.

C#
VB.NET

public bool Equals(MediaBookmark other)

Public Function Equals(other As MediaBookmark) As Boolean

Parameters

other: MediaBookmark

The other media bookmark to compare with this media bookmark instance.

Returns

System.Boolean

true if the other MediaBookmark is equal to this MediaBookmark instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this MediaBookmark instance.

C#
VB.NET

public override bool Equals(object obj)

Public Overrides Function Equals(obj As Object) As Boolean

Parameters

obj: System.Object

The System.Object to compare with this media bookmark instance.

Returns

System.Boolean

true if the specified System.Object is a MediaBookmark and is equal to this MediaBookmark instance; otherwise, false.

Overrides

System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this MediaBookmark instance.

C#
VB.NET

public override int GetHashCode()

Public Overrides Function GetHashCode As Integer

Returns

System.Int32

An integer value that specifies a hash value for this MediaBookmark instance.

Overrides

System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this MediaBookmark instance.

C#
VB.NET

public override string ToString()

Public Overrides Function ToString As String

Returns

System.String

A System.String that represents this MediaBookmark instance.

Overrides

System.ValueType.ToString()

Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Operators

Equality(MediaBookmark, MediaBookmark)

Determines whether first and second MediaBookmarks are equal.

C#
VB.NET

public static bool operator ==(MediaBookmark first, MediaBookmark second)

Public Shared Operator =(first As MediaBookmark, second As MediaBookmark) As Boolean

Parameters

first: MediaBookmark

The first media bookmark.

second: MediaBookmark

The second media bookmark.

Returns

System.Boolean

true if first and second media bookmarks are equal; otherwise, false.

GreaterThan(MediaBookmark, MediaBookmark)

Determines whether first MediaBookmark is later than second MediaBookmark.

C#
VB.NET

public static bool operator>(MediaBookmark first, MediaBookmark second)

Public Shared Operator>(first As MediaBookmark, second As MediaBookmark) As Boolean

Parameters

first: MediaBookmark

The first media bookmark.

second: MediaBookmark

The second media bookmark.

Returns

System.Boolean

true if first media bookmark is later than second media bookmark; otherwise, false.

GreaterThanOrEqual(MediaBookmark, MediaBookmark)

Determines whether first MediaBookmark is later than or equal to second MediaBookmark.

C#
VB.NET

public static bool operator >=(MediaBookmark first, MediaBookmark second)

Public Shared Operator >=(first As MediaBookmark, second As MediaBookmark) As Boolean

Parameters

first: MediaBookmark

The first media bookmark.

second: MediaBookmark

The second media bookmark.

Returns

System.Boolean

true if first media bookmark is later than or equal to second media bookmark; otherwise, false.

Inequality(MediaBookmark, MediaBookmark)

Determines whether first and second MediaBookmarks are not equal.

C#
VB.NET

public static bool operator !=(MediaBookmark first, MediaBookmark second)

Public Shared Operator <>(first As MediaBookmark, second As MediaBookmark) As Boolean

Parameters

first: MediaBookmark

The first media bookmark.

second: MediaBookmark

The second media bookmark.

Returns

System.Boolean

true if first and second media bookmarks are not equal; otherwise, false.

LessThan(MediaBookmark, MediaBookmark)

Determines whether first MediaBookmark is earlier than second MediaBookmark.

C#
VB.NET

public static bool operator <(MediaBookmark first, MediaBookmark second)

Public Shared Operator <(first As MediaBookmark, second As MediaBookmark) As Boolean

Parameters

first: MediaBookmark

The first media bookmark.

second: MediaBookmark

The second media bookmark.

Returns

System.Boolean

true if first media bookmark is earlier than second media bookmark; otherwise, false.

LessThanOrEqual(MediaBookmark, MediaBookmark)

Determines whether first MediaBookmark is earlier than or equal to second MediaBookmark.

C#
VB.NET

public static bool operator <=(MediaBookmark first, MediaBookmark second)

Public Shared Operator <=(first As MediaBookmark, second As MediaBookmark) As Boolean

Parameters

first: MediaBookmark

The first media bookmark.

second: MediaBookmark

The second media bookmark.

Returns

System.Boolean

true if first media bookmark is earlier than or equal to second media bookmark; otherwise, false.

Implements

System.IComparable<T>

System.IEquatable<T>