Package org.apache.poi.xwpf.usermodel
Class XWPFHyperlinkRun
java.lang.Object
org.apache.poi.xwpf.usermodel.XWPFRun
org.apache.poi.xwpf.usermodel.XWPFHyperlinkRun
- All Implemented Interfaces:
CharacterRun
,IRunElement
,ISDTContents
A run of text with a Hyperlink applied to it.
Any given Hyperlink may be made up of multiple of these.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.xwpf.usermodel.XWPFRun
XWPFRun.FontCharRange
-
Constructor Summary
ConstructorsConstructorDescriptionXWPFHyperlinkRun
(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHyperlink hyperlink, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR run, IRunBody p) -
Method Summary
Modifier and TypeMethodDescriptionorg.openxmlformats.schemas.wordprocessingml.x2006.main.CTHyperlink
getHyperlink
(XWPFDocument document) If this Hyperlink is an external reference hyperlink, return the object for it.Returns the ID of the hyperlink, if one is set.void
setHyperlinkId
(String id) Methods inherited from class org.apache.poi.xwpf.usermodel.XWPFRun
addBreak, addBreak, addBreak, addCarriageReturn, addChart, addPicture, addTab, getCharacterSpacing, getColor, getCTR, getDocument, getEmbeddedPictures, getEmphasisMark, getFontFamily, getFontFamily, getFontName, getFontSize, getKerning, getLang, getParagraph, getParent, getPhonetic, getPictureText, getSubscript, getText, getTextHightlightColor, getTextPosition, getTextScale, getUnderline, getUnderlineColor, getUnderlineThemeColor, getVerticalAlignment, isBold, isCapitalized, isDoubleStrikeThrough, isEmbossed, isHighlighted, isImprinted, isItalic, isShadowed, isSmallCaps, isStrike, isStrikeThrough, isVanish, removeBreak, removeCarriageReturn, removeTab, setBold, setCapitalized, setCharacterSpacing, setColor, setDoubleStrikethrough, setEmbossed, setEmphasisMark, setFontFamily, setFontFamily, setFontSize, setImprinted, setItalic, setKerning, setShadow, setSmallCaps, setStrike, setStrikeThrough, setStyle, setSubscript, setText, setText, setTextHighlightColor, setTextPosition, setTextScale, setUnderline, setUnderlineColor, setUnderlineThemeColor, setVanish, setVerticalAlignment, text, toString
-
Constructor Details
-
XWPFHyperlinkRun
public XWPFHyperlinkRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHyperlink hyperlink, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR run, IRunBody p)
-
-
Method Details
-
getCTHyperlink
@Internal public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHyperlink getCTHyperlink() -
getAnchor
-
getHyperlinkId
Returns the ID of the hyperlink, if one is set. -
setHyperlinkId
-
getHyperlink
If this Hyperlink is an external reference hyperlink, return the object for it.
-