SlideShowTransition

Inheritance: java.lang.Object, com.aspose.slides.DomObject

All Implemented Interfaces: com.aspose.slides.ISlideShowTransition

public class SlideShowTransition extends DomObject<BaseSlide> implements ISlideShowTransition

Represents slide show transition.

Methods

Method Description
getSound() Returns or sets the embedded audio data.
setSound(IAudio value) Returns or sets the embedded audio data.
getSoundMode() Set or returns sound mode for slide transition.
setSoundMode(int value) Set or returns sound mode for slide transition.
getSoundLoop() This attribute specifies if the sound will loop until the next sound event occurs in slideshow.
setSoundLoop(boolean value) This attribute specifies if the sound will loop until the next sound event occurs in slideshow.
getAdvanceOnClick() Specifies whether a mouse click will advance the slide or not.
setAdvanceOnClick(boolean value) Specifies whether a mouse click will advance the slide or not.
getAdvanceAfter() This attribute specifies if the slideshow will move to the next slide after a certain time.
setAdvanceAfter(boolean value) This attribute specifies if the slideshow will move to the next slide after a certain time.
getAdvanceAfterTime() Specifies the time, in milliseconds, after which the transition should start.
setAdvanceAfterTime(long value) Specifies the time, in milliseconds, after which the transition should start.
getSpeed() Specifies the transition speed that is to be used when transitioning from the current slide to the next.
setSpeed(int value) Specifies the transition speed that is to be used when transitioning from the current slide to the next.
getValue() Slide show transition value.
getType() Type of transition.
setType(int value) Type of transition.
getSoundIsBuiltIn() Specifies whether or not this sound is a built-in sound.
setSoundIsBuiltIn(boolean value) Specifies whether or not this sound is a built-in sound.
getSoundName() Specifies a human readable name for the sound of the transition.
setSoundName(String value) Specifies a human readable name for the sound of the transition.
equals(Object obj) Determines whether the two SlideShowTransition instances are equal.
hashCode() Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

getSound()

public final IAudio getSound()

Returns or sets the embedded audio data. Read/write IAudio.

Returns: IAudio

setSound(IAudio value)

public final void setSound(IAudio value)

Returns or sets the embedded audio data. Read/write IAudio.

Parameters:

Parameter Type Description
value IAudio

getSoundMode()

public final int getSoundMode()

Set or returns sound mode for slide transition. Read/write TransitionSoundMode.

Returns: int

setSoundMode(int value)

public final void setSoundMode(int value)

Set or returns sound mode for slide transition. Read/write TransitionSoundMode.

Parameters:

Parameter Type Description
value int

getSoundLoop()

public final boolean getSoundLoop()

This attribute specifies if the sound will loop until the next sound event occurs in slideshow. Read/write ``` boolean ```.

Returns: boolean

setSoundLoop(boolean value)

public final void setSoundLoop(boolean value)

This attribute specifies if the sound will loop until the next sound event occurs in slideshow. Read/write ``` boolean ```.

Parameters:

Parameter Type Description
value boolean

getAdvanceOnClick()

public final boolean 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

setAdvanceOnClick(boolean value)

public final void setAdvanceOnClick(boolean value)

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 ```.

Parameters:

Parameter Type Description
value boolean

getAdvanceAfter()

public final boolean getAdvanceAfter()

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


Presentation pres = new Presentation("demo.pptx");
 try {
     // Get the first slide Transition
     ISlideShowTransition slideTransition = pres.getSlides().get_Item(0).getSlideShowTransition();

     // Check if the Advance Slide After flag is checked
     if (slideTransition.getAdvanceAfter())
     {
         // Get the Advance Slide After Time value
         long advanceAfterTime = slideTransition.getAdvanceAfterTime();
     }
 } finally {
     if (pres != null) pres.dispose();
 }

Returns: boolean

setAdvanceAfter(boolean value)

public final void setAdvanceAfter(boolean value)

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


Presentation pres = new Presentation("demo.pptx");
 try {
     // Get the first slide Transition
     ISlideShowTransition slideTransition = pres.getSlides().get_Item(0).getSlideShowTransition();

     // Check if the Advance Slide After flag is checked
     if (slideTransition.getAdvanceAfter())
     {
         // Get the Advance Slide After Time value
         long advanceAfterTime = slideTransition.getAdvanceAfterTime();
     }
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter Type Description
value boolean

getAdvanceAfterTime()

public final long 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

setAdvanceAfterTime(long value)

public final void setAdvanceAfterTime(long value)

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 ```.

Parameters:

Parameter Type Description
value long

getSpeed()

public final int getSpeed()

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

Returns: int

setSpeed(int value)

public final void setSpeed(int value)

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

Parameters:

Parameter Type Description
value int

getValue()

public final ITransitionValueBase getValue()

Slide show transition value. Read-only ITransitionValueBase.

Returns: ITransitionValueBase

getType()

public final int getType()

Type of transition. Read/write TransitionType.

Returns: int

setType(int value)

public final void setType(int value)

Type of transition. Read/write TransitionType.

Parameters:

Parameter Type Description
value int

getSoundIsBuiltIn()

public final boolean 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

setSoundIsBuiltIn(boolean value)

public final void setSoundIsBuiltIn(boolean value)

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 ```.

Parameters:

Parameter Type Description
value boolean

getSoundName()

public final String 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: java.lang.String

setSoundName(String value)

public final void setSoundName(String value)

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.

Parameters:

Parameter Type Description
value java.lang.String

equals(Object obj)

public boolean equals(Object obj)

Determines whether the two SlideShowTransition instances are equal. Read/write ``` boolean ```.

Parameters:

Parameter Type Description
obj java.lang.Object The SlideShowTransition to compare with the current SlideShowTransition.

Returns: boolean - ``` true ``` if the specified SlideShowTransition is equal to the current SlideShowTransition; otherwise, ``` false ```.

hashCode()

public int 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 - 23454


Overriden to make compiler happy. Always returns constant because object is mutable.