com.aspose.slides
Class Link

java.lang.Object
  extended by com.aspose.slides.Link

public final class Link
extends java.lang.Object

Represents the hyperlink in a text.


Method Summary
 int getActionType()
          Returns action type of a link.
 int getBegin()
          Returns the beginning of a link in a text.
 int getEnd()
          Returns the end of a link in a text.
 java.lang.String getExternalHyperlink()
          Returns an external hyperlink as String or null if type of link is not ExternalHyperlink.
 int getInternalHyperlink()
          Returns Id of a slide for internal hyperlink or -1 if type of link is not InternalHyperlink.
 int getJumpType()
          Returns jump type of a link if ActionType is JumpAction.
 int getPageNumber()
          Returns SlidePosition of a slide for internal hyperlink or -1 if type of a link is not InternalHyperlink.
 void setBegin(int value)
          Sets the beginning of a link in a text.
 void setEnd(int value)
          Sets the end of a link in a text.
 void setExternalHyperlink(java.lang.String hyperlink)
          Sets link destination to a custom URL and changes action type to HyperlinkAction.
 void setInternalHyperlink(long slideId)
          Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.
 void setInternalHyperlink(Slide slide)
          Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.
 void setJump(int jumpType)
          Sets the jump destination and changes action type to the JumpAction.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getBegin

public int getBegin()
Returns the beginning of a link in a text.


setBegin

public void setBegin(int value)
Sets the beginning of a link in a text.

Parameters:
value - new beginning of a link.

getEnd

public int getEnd()
Returns the end of a link in a text.


setEnd

public void setEnd(int value)
Sets the end of a link in a text.

Parameters:
value - new end of a link.

getActionType

public int getActionType()
Returns action type of a link. See LinkActionType.


getJumpType

public int getJumpType()
Returns jump type of a link if ActionType is JumpAction. See LinkJumpType.


setJump

public void setJump(int jumpType)
Sets the jump destination and changes action type to the JumpAction.

Parameters:
jumpType - new jump type. See LinkJumpType.

getInternalHyperlink

public int getInternalHyperlink()
Returns Id of a slide for internal hyperlink or -1 if type of link is not InternalHyperlink.


getPageNumber

public int getPageNumber()
Returns SlidePosition of a slide for internal hyperlink or -1 if type of a link is not InternalHyperlink.


getExternalHyperlink

public java.lang.String getExternalHyperlink()
Returns an external hyperlink as String or null if type of link is not ExternalHyperlink.


setInternalHyperlink

public void setInternalHyperlink(long slideId)
                          throws PptPropertyException
Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.

Parameters:
slideId - Id of a slide.
Throws:
PptPropertyException

setInternalHyperlink

public void setInternalHyperlink(Slide slide)
Sets link destination to a slide inside presentation and changes action type to HyperlinkAction.

Parameters:
slide - slide object.

setExternalHyperlink

public void setExternalHyperlink(java.lang.String hyperlink)
Sets link destination to a custom URL and changes action type to HyperlinkAction.

Parameters:
hyperlink - URL string.