SlideShowTransition Class

Namespace:
GemBox.Presentation
Assembly:
GemBox.Presentation.dll

Represents a slide transition.

public sealed class SlideShowTransition
Public NotInheritable Class SlideShowTransition
Inheritance:
System.Object
SlideShowTransition

Properties

AdvanceAfterTime

Gets or sets the time, in milliseconds, after which the transition should start.

public int AdvanceAfterTime { get; set; }
Public Property AdvanceAfterTime As Integer
Property Value
System.Int32

The time, in milliseconds, after which the transition should start.

Exceptions
System.ArgumentOutOfRangeException

Value is not greater than zero.

AdvanceOnClick

Gets or sets a value indicating whether a mouse click advances the slide.

public bool AdvanceOnClick { get; set; }
Public Property AdvanceOnClick As Boolean
Property Value
System.Boolean

true if a mouse click advances the slide; otherwise, false.

AdvanceOnTime

Gets or sets a value indicating whether the slide advances automatically, after the time specified in the AdvanceAfterTime.

public bool AdvanceOnTime { get; set; }
Public Property AdvanceOnTime As Boolean
Property Value
System.Boolean

true if the slide advances automatically, after the time specified in the AdvanceAfterTime; otherwise, false.

Duration

Gets or sets the transition duration (in milliseconds).

public int Duration { get; set; }
Public Property Duration As Integer
Property Value
System.Int32

The transition duration (in milliseconds).

Exceptions
System.ArgumentOutOfRangeException

Value is not greater or equal to zero.

Effect

Gets or sets the transition effect.

public TransitionEffect Effect { get; set; }
Public Property Effect As TransitionEffect
Property Value
TransitionEffect

The transition effect.

LoopUntilNextSound

Gets or sets a value indicating whether to repeat the current transition sound until the next sound is played.

public bool LoopUntilNextSound { get; set; }
Public Property LoopUntilNextSound As Boolean
Property Value
System.Boolean

true to repeat the current transition sound until the next sound is played; otherwise, false.

Sound

Gets or sets the sound associated with the transition.

public AudioContent Sound { get; set; }
Public Property Sound As AudioContent
Property Value
AudioContent

The sound associated with the transition.

Exceptions
System.ArgumentException

Sound is not embedded WAV.

Speed

Gets or sets the transition speed.

public TransitionSpeed Speed { get; set; }
Public Property Speed As TransitionSpeed
Property Value
TransitionSpeed

The transition speed.

StopPreviousSound

Gets or sets a value indicating whether to stop all previous sounds when this transition is activated.

public bool StopPreviousSound { get; set; }
Public Property StopPreviousSound As Boolean
Property Value
System.Boolean

true to stop all previous sounds when this transition is activated; otherwise, false.

TransitionType

Gets or sets the transition type.

public TransitionType TransitionType { get; set; }
Public Property TransitionType As TransitionType
Property Value
TransitionType

The transition type.

Methods

PlaySound(Stream)

Specifies the sound to be played when the transition is activated.

public AudioContent PlaySound(Stream stream)
Public Function PlaySound(stream As Stream) As AudioContent
Parameters
stream
System.IO.Stream

An audio stream in a Waveform Audio File Format (Wav).

Returns
AudioContent

The sound to be played when the transition is activated.

Remarks

Sound is always stored in a Waveform Audio File Format (Wav) stream that is embedded in the presentation.

Do not set any member on the returned AudioContent because they are not supported in this context (for example, they won't be saved to a PPTX file).

To set a sound for the transition, either use this method or the Sound property.

Exceptions
System.ArgumentNullException

stream is null.

System.ArgumentException

stream is not readable.

PlaySound(Stream, String)

Specifies the sound to be played when the transition is activated.

public AudioContent PlaySound(Stream stream, string soundName)
Public Function PlaySound(stream As Stream, soundName As String) As AudioContent
Parameters
stream
System.IO.Stream

An audio stream in a Waveform Audio File Format (Wav).

soundName
System.String

An original name or a given short name used to distinguish this sound from others by providing a human readable name for the attached sound should the user need to identify the sound among others within the UI.

Returns
AudioContent

The sound to be played when the transition is activated.

Remarks

Sound is always stored in a Waveform Audio File Format (Wav) stream that is embedded in the presentation.

Do not set any member on the returned AudioContent because they are not supported in this context (for example, they won't be saved to a PPTX file).

To set a sound for the transition, either use this method or the Sound property.

Exceptions
System.ArgumentNullException

stream is null.

System.ArgumentException

stream is not readable.

Examples

See Also