SlideShowSettings Class

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

Represents a type within which all presentation-wide slide show properties are contained.

public sealed class SlideShowSettings
Public NotInheritable Class SlideShowSettings
Inheritance:
SlideShowSettings

Properties

AdvanceMode

Gets or sets a value indicating how to advance slides when presenting.

public SlideShowAdvanceMode AdvanceMode { get; set; }
Public Property AdvanceMode As SlideShowAdvanceMode
Property Value
SlideShowAdvanceMode

A value indicating how to advance slides when presenting.

CustomShow

Gets the custom slide show from the CustomShows collection.

Applicable only if RangeType has the value CustomShow that can be set with ShowCustomShowSlides(String) method.

public CustomSlideShow CustomShow { get; }
Public ReadOnly Property CustomShow As CustomSlideShow
Property Value
CustomSlideShow

The custom slide show from the CustomShows collection.

CustomShows

Gets the custom shows that are available within the presentation.

public CustomSlideShowCollection CustomShows { get; }
Public ReadOnly Property CustomShows As CustomSlideShowCollection
Property Value
CustomSlideShowCollection

The custom shows that are available within the presentation.

EndingSlide

Gets the index of the show's ending slide from the Slides collection.

Applicable only if RangeType has the value SlideRange that can be set with ShowRangeOfSlides(Int32, Int32) method.

public int EndingSlide { get; }
Public ReadOnly Property EndingSlide As Integer
Property Value
Int32

The index of the show's ending slide from the Slides collection.

LoopContinuously

Gets or sets a value indicating whether the slide show should be set to loop at the end.

public bool LoopContinuously { get; set; }
Public Property LoopContinuously As Boolean
Property Value
Boolean

true if the slide show should loop at the end; otherwise, false.

PenColor

Gets or sets the pen color that should be used to make markings on the slides while presenting.

public Color PenColor { get; set; }
Public Property PenColor As Color
Property Value
Color

The pen color that should be used to make markings on the slides while presenting.

RangeType

Gets the type of the range of slides for the show.

public SlideShowRangeType RangeType { get; }
Public ReadOnly Property RangeType As SlideShowRangeType
Property Value
SlideShowRangeType

Type of the range of slides for the show.

ShowType

Gets or sets the type of the show.

public SlideShowType ShowType { get; set; }
Public Property ShowType As SlideShowType
Property Value
SlideShowType

The type of the show.

ShowWithoutAnimation

Gets or sets a value indicating whether slide show animation should not be shown when presenting.

public bool ShowWithoutAnimation { get; set; }
Public Property ShowWithoutAnimation As Boolean
Property Value
Boolean

true if slide show animation should not be shown when presenting; otherwise, false.

ShowWithoutNarration

Gets or sets a value indicating whether slide show narration should not be played when presenting.

public bool ShowWithoutNarration { get; set; }
Public Property ShowWithoutNarration As Boolean
Property Value
Boolean

true if slide show narration should not be played when presenting; otherwise, false.

StartingSlide

Gets the index of the show's starting slide from the Slides collection.

Applicable only if RangeType has the value SlideRange that can be set with ShowRangeOfSlides(Int32, Int32) method.

public int StartingSlide { get; }
Public ReadOnly Property StartingSlide As Integer
Property Value
Int32

The index of the show's starting slide from the Slides collection.

Methods

ShowAllSlides()

Shows all the slides from the Slides collection when presenting.

public void ShowAllSlides()
Public Sub ShowAllSlides

ShowCustomShowSlides(String)

Shows the slides from the custom show with the specified name.

public void ShowCustomShowSlides(string slideShowName)
Public Sub ShowCustomShowSlides(slideShowName As String)
Parameters
slideShowName
String

Name of the custom show.

Exceptions
ArgumentException

slideShowName is null or Empty or custom show with the specified name does not exist in the CustomShows collection.

ShowRangeOfSlides(Int32, Int32)

Shows the range of slides from the Slides collection when presenting.

public void ShowRangeOfSlides(int startingSlide, int endingSlide)
Public Sub ShowRangeOfSlides(startingSlide As Integer, endingSlide As Integer)
Parameters
startingSlide
Int32

The index of the starting slide from the Slides collection.

endingSlide
Int32

The index of the ending slide from the Slides collection.

Exceptions
ArgumentOutOfRangeException

startingSlide or endingSlide is less than zero.

Examples

See Also