SlideShowTransition

SlideShowTransition class

Represents slide show transition.

equals

NameDescription
equals (Object)Determines whether the two SlideShowTransition instances are equal. Read/write boolean.

Parameters:

NameTypeDescription
objObjectThe SlideShowTransition to compare with the current SlideShowTransition.

Returns: boolean


getAdvanceAfter

NameDescription
getAdvanceAfter ()This attribute specifies if the slideshow will move to the next slide after a certain time. Read/write boolean.

Returns: boolean


getAdvanceAfterTime

NameDescription
getAdvanceAfterTime ()Specifies the time, in milliseconds, after which the transition should start. This setting may be used in conjunction with the advClick attribute. If this attribute is not specified then it is assumed that no auto-advance will occur. Read/write long.

Returns: long


getAdvanceOnClick

NameDescription
getAdvanceOnClick ()Specifies whether a mouse click will advance the slide or not. If this attribute is not specified then a value of true is assumed. Read/write boolean.

Returns: boolean


getSound

NameDescription
getSound ()Returns or sets the embedded audio data. Read/write IAudio.

Returns: Audio


getSoundIsBuiltIn

NameDescription
getSoundIsBuiltIn ()Specifies whether or not this sound is a built-in sound. If this attribute is set to true then the generating application is alerted to check the name attribute specified for this sound in it’s list of built-in sounds and can then surface a custom name or UI as needed. Read-write boolean.

Returns: boolean


getSoundLoop

NameDescription
getSoundLoop ()This attribute specifies if the sound will loop until the next sound event occurs in slideshow. Read/write boolean.

Returns: boolean


getSoundMode

NameDescription
getSoundMode ()Set or returns sound mode for slide transition. Read/write TransitionSoundMode.

Returns: int


getSoundName

NameDescription
getSoundName ()Specifies a human readable name for the sound of the transition. The Sound( #getSound/ #setSound(IAudio)) property must be assigned to get or set the sound name. Read-write String.

Returns: String

Exception

ErrorCondition
PptxExceptionWhen {@code Sound}( #getSound/ #setSound(IAudio)) property is not assigned. This name appears in the PowerPoint user interface when configuring the transition sound manually.

getSpeed

NameDescription
getSpeed ()Specifies the transition speed that is to be used when transitioning from the current slide to the next. Read/write TransitionSpeed.

Returns: int


getType

NameDescription
getType ()Type of transition. Read/write TransitionType.

Returns: int


getValue

NameDescription
getValue ()Slide show transition value. Read-only ITransitionValueBase.

Returns: OrientationTransition, OptionalBlackTransition, FlyThroughTransition, LeftRightDirectionTransition, EightDirectionTransition, TransitionValueBase, EmptyTransition, RippleTransition, WheelTransition, RevealTransition, MorphTransition, SplitTransition, InOutTransition, GlitterTransition, SideDirectionTransition, ShredTransition, CornerDirectionTransition


hashCode

NameDescription
hashCode ()Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Returns: int


setAdvanceAfter

NameDescription
setAdvanceAfter (boolean)This attribute specifies if the slideshow will move to the next slide after a certain time. Read/write boolean.

Returns: void


setAdvanceAfterTime

NameDescription
setAdvanceAfterTime (long)Specifies the time, in milliseconds, after which the transition should start. This setting may be used in conjunction with the advClick attribute. If this attribute is not specified then it is assumed that no auto-advance will occur. Read/write long.

Returns: void


setAdvanceOnClick

NameDescription
setAdvanceOnClick (boolean)Specifies whether a mouse click will advance the slide or not. If this attribute is not specified then a value of true is assumed. Read/write boolean.

Returns: void


setSound

NameDescription
setSound (Audio)Returns or sets the embedded audio data. Read/write IAudio.

Returns: void


setSoundIsBuiltIn

NameDescription
setSoundIsBuiltIn (boolean)Specifies whether or not this sound is a built-in sound. If this attribute is set to true then the generating application is alerted to check the name attribute specified for this sound in it’s list of built-in sounds and can then surface a custom name or UI as needed. Read-write boolean.

Returns: void


setSoundLoop

NameDescription
setSoundLoop (boolean)This attribute specifies if the sound will loop until the next sound event occurs in slideshow. Read/write boolean.

Returns: void


setSoundMode

NameDescription
setSoundMode (int)Set or returns sound mode for slide transition. Read/write TransitionSoundMode.

Returns: void


setSoundName

NameDescription
setSoundName (String)Specifies a human readable name for the sound of the transition. The Sound( #getSound/ #setSound(IAudio)) property must be assigned to get or set the sound name. Read-write String.

Returns: void

Exception

ErrorCondition
PptxExceptionWhen {@code Sound}( #getSound/ #setSound(IAudio)) property is not assigned. This name appears in the PowerPoint user interface when configuring the transition sound manually.

setSpeed

NameDescription
setSpeed (int)Specifies the transition speed that is to be used when transitioning from the current slide to the next. Read/write TransitionSpeed.

Returns: void


setType

NameDescription
setType (int)Type of transition. Read/write TransitionType.

Returns: void