3.1.3.1.3 hyperlink (Ruby Hyperlink)

This element specifies the presence of a hyperlink at the current location in the document.

[Example: Consider the following WordprocessingML fragment for a hyperlink:

 <w:hyperlink r:id="rId10">
   <w:r>
     <w:t>Click here</w:t>
   </w:r>
 </w:hyperlink>

The hyperlink element defines a hyperlink whose display text is Click here, and whose target is specified by the relationship with an Id attribute value of rId10. end example]

Parent Elements

customXml3.1.3.1.1, customXml); fldSimple3.1.3.1.2, fldSimple); hyperlink (§3.1.3.1.3, hyperlink); rt ("[ECMA-376] Part 4 §2.3.3.23"); rubyBase ("[ECMA-376] Part 4 §2.3.3.26"); sdtContent3.1.3.1.7, sdtContent)

Child Elements

Subclause

acc (Accent)

"[ECMA-376] Part 4 §7.1.2.1"

bar (Bar)

"[ECMA-376] Part 4 §7.1.2.7"

bookmarkEnd (Bookmark End)

"[ECMA-376] Part 4 §2.13.6.1"

bookmarkStart (Bookmark Start)

"[ECMA-376] Part 4 §2.13.6.2"

borderBox (Border-Box Function)

"[ECMA-376] Part 4 §7.1.2.11"

box (Box Function)

"[ECMA-376] Part 4 §7.1.2.13"

commentRangeEnd (Comment Anchor Range End)

"[ECMA-376] Part 4 §2.13.4.3"

commentRangeStart (Comment Anchor Range Start)

"[ECMA-376] Part 4 §2.13.4.4"

customXml (Ruby Inline-Level Custom XML Element)

§3.1.3.1.1, customXml

customXmlDelRangeEnd (Custom XML Markup Deletion End)

"[ECMA-376] Part 4 §2.13.5.4"

customXmlDelRangeStart (Custom XML Markup Deletion Start)

"[ECMA-376] Part 4 §2.13.5.5"

customXmlInsRangeEnd (Custom XML Markup Insertion End)

"[ECMA-376] Part 4 §2.13.5.6"

customXmlInsRangeStart (Custom XML Markup Insertion Start)

"[ECMA-376] Part 4 §2.13.5.7"

customXmlMoveFromRangeEnd (Custom XML Markup Move Source End)

"[ECMA-376] Part 4 §2.13.5.8"

customXmlMoveFromRangeStart (Custom XML Markup Move Source Start)

"[ECMA-376] Part 4 §2.13.5.9"

customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End)

"[ECMA-376] Part 4 §2.13.5.10"

customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start)

"[ECMA-376] Part 4 §2.13.5.11"

d (Delimiter Function)

"[ECMA-376] Part 4 §7.1.2.24"

del (Deleted Run Content)

"[ECMA-376] Part 4 §2.13.5.12"

eqArr (Equation-Array Function)

"[ECMA-376] Part 4 §7.1.2.34"

f (Fraction Function)

"[ECMA-376] Part 4 §7.1.2.36"

fldSimple (Ruby Simple Field)

§3.1.3.1.2, fldSimple

func (Function Apply Function)

"[ECMA-376] Part 4 §7.1.2.39"

groupChr (Group-Character Function)

"[ECMA-376] Part 4 §7.1.2.41"

hyperlink (Ruby Hyperlink)

§3.1.3.1.3, hyperlink

ins (Inserted Run Content)

"[ECMA-376] Part 4 §2.13.5.20"

limLow (Lower-Limit Function)

"[ECMA-376] Part 4 §7.1.2.54"

limUpp (Upper-Limit Function)

"[ECMA-376] Part 4 §7.1.2.56"

m (Matrix Function)

"[ECMA-376] Part 4 §7.1.2.60"

moveFrom (Move Source Run Content)

"[ECMA-376] Part 4 §2.13.5.21"

moveFromRangeEnd (Move Source Location Container - End)

"[ECMA-376] Part 4 §2.13.5.23"

moveFromRangeStart (Move Source Location Container - Start)

"[ECMA-376] Part 4 §2.13.5.24"

moveTo (Move Destination Run Content)

"[ECMA-376] Part 4 §2.13.5.26"

moveToRangeEnd (Move Destination Location Container - End)

"[ECMA-376] Part 4 §2.13.5.27"

moveToRangeStart (Move Destination Location Container - Start)

"[ECMA-376] Part 4 §2.13.5.28"

nary (n-ary Operator Function)

"[ECMA-376] Part 4 §7.1.2.70"

oMath (Office Math)

"[ECMA-376] Part 4 §7.1.2.77"

oMathPara (Math Paragraph)

"[ECMA-376] Part 4 §7.1.2.78"

permEnd (Range Permission End)

"[ECMA-376] Part 4 §2.13.7.1"

permStart (Range Permission Start)

"[ECMA-376] Part 4 §2.13.7.2"

phant (Phantom Function)

"[ECMA-376] Part 4 §7.1.2.81"

proofErr (Proofing Error Anchor)

"[ECMA-376] Part 4 §2.13.8.1"

r (Run)

"[ECMA-376] Part 4 §7.1.2.87"

r (Text Run)

"[ECMA-376] Part 4 §2.3.2.23"

rad (Radical Function)

"[ECMA-376] Part 4 §7.1.2.88"

sdt (Ruby Inline-Level Structured Document Tag)

§3.1.3.1.6, sdt

sPre (Pre-Sub-Superscript Function)

"[ECMA-376] Part 4 §7.1.2.99"

sSub (Subscript Function)

"[ECMA-376] Part 4 §7.1.2.101"

sSubSup (Sub-Superscript Function)

"[ECMA-376] Part 4 §7.1.2.103"

sSup (Superscript Function)

"[ECMA-376] Part 4 §7.1.2.105"

Attributes

Description

anchor (Hyperlink Anchor)

Specifies the name of a bookmark in the current document which shall be the target of this hyperlink.

If this attribute is omitted, then the default behavior shall be to navigate to the start of the document. If a hyperlink target is also specified using the r:id attribute, then this attribute shall be ignored. If no bookmark exists in the current document with the given bookmark name, then the default behavior shall be to navigate to the start of the document.

[Example: Consider the following WordprocessingML fragment for a hyperlink:

 <w:hyperlink   w:anchor="chapter3">
     <w:r>
       <w:t>Go to Chapter Three</w:t>
     </w:r>
 </w:hyperlink>

The anchor attribute specifies that the target of the current hyperlink shall be the text contained within the bookmark chapter3 within the document. end example]

The possible values for this attribute are defined by the ST_String255 simple type (§3.1.3.3.9, ST_String255).

docLocation (Location in Target Document)

Specifies a location in the target of the hyperlink that has no bookmarks.

If this attribute is omitted, then no location shall be associated with the parent hyperlink. If the anchor attribute is also specified, then this attribute may be ignored when the hyperlink is invoked.

[Example: Consider the following WordprocessingML fragment for a hyperlink:

 <w:hyperlink   r:id="rId9" w:docLocation="table">
     <w:r>
       <w:t>Click Here</w:t>
     </w:r>
 </w:hyperlink>

The docLocation attribute specifies that the target of the current hyperlink shall be a region targeted by the string table within the target document. end example]

The possible values for this attribute are defined by the ST_String255 simple type (§3.1.3.3.9, ST_String255).

history (Add to Viewed Hyperlinks)

Specifies whether the target of the parent hyperlink (as specified via the r:id attribute) shall be added to a list of viewed hyperlinks when it is invoked.

If this attribute is omitted, then its value shall be assumed to be false.

[Example: Consider the following WordprocessingML fragment for a hyperlink:

 <w:hyperlink   r:id="rId9" w:history="true">
     <w:r>
       <w:t>http://example.com</w:t>
     </w:r>
 </w:hyperlink>

The history attribute value of true specifies that the target of the current hyperlink shall be added to a list of visited hyperlinks when invoked within the document. end example]

The possible values for this attribute are defined by the ST_OnOff simple type (§3.1.3.3.6, ST_OnOff).

id (Hyperlink Target)

Namespace: .../officeDocument/2006/relationships

Specifies the ID of the relationship whose target shall be used as the target for this hyperlink.

If the id attribute is omitted, then there shall be no external target for the current hyperlink, although a location in the current document may still be specified as a target via the anchor attribute. If the id attribute exists, it shall supersede the value in the anchor attribute.

[Example: Consider the following WordprocessingML fragment for a hyperlink:

 <w:hyperlink   r:id="rId9">
     <w:r>
       <w:t>http://example.com</w:t>
     </w:r>
 </w:hyperlink>

An id attribute value of rId9 specifies that the relationship in the associated relationship part item with a corresponding Id attribute value shall be navigated to when this hyperlink is invoked. For example, if the following XML is present in the associated relationship part item:

 <Relationships   xmlns="…">
     <Relationship Id="rId9" Mode="External"   Target=http://www.contoso.com />
 </Relationships>

The target of this hyperlink would therefore be the target of relationship rId9 - in this case, http://www.contoso.com. end example]

The possible values for this attribute are defined by the ST_RelationshipId simple type ("[ECMA-376] Part 4 §7.8.2.1").

tgtFrame (Hyperlink Target Frame)

Specifies a frame within the parent HTML frameset for the target of the parent hyperlink when one exists. Values shall be handled as follows:

_top

Open hyperlink target in the full region of the current window.

_self

Open hyperlink target in the same frame as the hyperlink appears.

_parent

Open hyperlink target in the parent of the current frame, or the current frame if this frame has no parent.

_blank

Open hyperlink target in a new window.

all other values

Open hyperlink target in the frame with the specified name. If no frame exists with this name, open in the current frame.

If this string does not begin with an alphabetic character, it shall be ignored.

If this attribute is omitted, then no target frame information shall be associated with the parent hyperlink. If the current document is not part of a frameset, then this information may be ignored.

[Example: Consider the following WordprocessingML fragment for a hyperlink:

 <w:hyperlink   r:id="rId9" w:tgtFrame="_top">
     <w:r>
       <w:t>http://example.com</w:t>
     </w:r>
 </w:hyperlink>

The tgtFrame attribute value of _top specifies that the target of this hyperlink shall be displayed in the full extents of the current window. end example]

The possible values for this attribute are defined by the ST_String255 simple type (§3.1.3.3.9, ST_String255).

tooltip (Associated String)

Specifies a string that may be surfaced in a user interface as associated with the parent hyperlink.

If this attribute is omitted, then no associated string shall be linked to the parent hyperlink in the document.

[Example: Consider the following WordprocessingML fragment for a hyperlink:

 <w:hyperlink   r:id="rId9" w:tooltip="Click here!">
     <w:r>
       <w:t>http://example.com</w:t>
     </w:r>
 </w:hyperlink>

The value of this attribute specifies that the parent hyperlink has the associated string of Click here!, which may be used as desired. end example]

The possible values for this attribute are defined by the ST_String260 simple type (§3.1.3.3.10, ST_String260).

The following XML Schema fragment defines the contents of this element:

 <complexType name="CT_HyperlinkRuby">
   <group ref="EG_RubyContent" minOccurs="0" maxOccurs="unbounded"/>
   <attribute name="tgtFrame" type="ST_String255" use="optional"/>
   <attribute name="tooltip" type="ST_String260" use="optional"/>
   <attribute name="docLocation" type="ST_String255" use="optional"/>
   <attribute name="history" type="ST_OnOff" use="optional"/>
   <attribute name="anchor" type="ST_String255" use="optional"/>
   <attribute ref="r:id"/>
 </complexType>
Show: