Partager via


HyperlinkOnHover Class

Hyperlink for Hover.When the object is serialized out as xml, its qualified name is a:hlinkHover.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Drawing.HyperlinkType
        DocumentFormat.OpenXml.Drawing.HyperlinkOnHover

Namespace:  DocumentFormat.OpenXml.Drawing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class HyperlinkOnHover _
    Inherits HyperlinkType
'Usage
Dim instance As HyperlinkOnHover
public class HyperlinkOnHover : HyperlinkType

Remarks

The following table lists the possible child types:

  • HyperlinkSound <a:snd>

  • ExtensionList <a:extLst>

[ISO/IEC 29500-1 1st Edition]

20.1.2.2.23 hlinkHover (Hyperlink for Hover)

This element specifies the hyperlink information to be activated when the user's mouse is hovered over the corresponding object. The operation of the hyperlink is to have the specified action be activated when the mouse of the user hovers over the object. When this action is activated then additional attributes can be used to specify other tasks that should be performed along with the action.

Parent Elements

cNvPr (§21.3.2.7); cNvPr (§20.1.2.2.8); cNvPr (§20.2.2.3); cNvPr (§20.5.2.8); cNvPr (§19.3.1.12); docPr (§20.4.2.5)

Child Elements

Subclause

extLst (Extension List)

§20.1.2.2.15

snd (Hyperlink Sound)

§20.1.2.2.32

Attributes

Description

action (Action Setting)

Specifies an action that is to be taken when this hyperlink is activated. This can be used to specify a slide to be navigated to or a script of code to be run.

The possible values for this attribute are defined by the W3C XML Schema string datatype.

endSnd (End Sounds)

Specifies if the URL in question should stop all sounds that are playing when it is clicked.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

highlightClick (Highlight Click)

Specifies if this attribute has already been used within this document. That is when a hyperlink has already been visited that this attribute would be utilized so the generating application can determine the color of this text. If this attribute is omitted, then a value of 0 or false is implied.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

history (Add Hyperlink to Page History)

Specifies whether to add this URI to the history when navigating to it. This allows for the viewing of this presentation without the storing of history information on the viewing machine. If this attribute is omitted, then a value of 1 or true is assumed.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

id (Drawing Object Hyperlink Target)

Namespace: .../officeDocument/2006/relationships

Specifies the relationship id that when looked up in this slides relationship file contains the target of this hyperlink. This attribute cannot be omitted.

The possible values for this attribute are defined by the ST_RelationshipId simple type (§22.8.2.1).

invalidUrl (Invalid URL)

Specifies the URL when it has been determined by the generating application that the URL is invalid. That is the generating application can still store the URL but it is known that this URL is not correct.

The possible values for this attribute are defined by the W3C XML Schema string datatype.

tgtFrame (Target Frame)

Specifies the target frame that is to be used when opening this hyperlink. When the hyperlink is activated this attribute is used to determine if a new window is launched for viewing or if an existing one can be used. If this attribute is omitted, than a new window is opened.

The possible values for this attribute are defined by the W3C XML Schema string datatype.

tooltip (Hyperlink Tooltip)

Specifies the tooltip that should be displayed when the hyperlink text is hovered over with the mouse. If this attribute is omitted, than the hyperlink text itself can be displayed.

The possible values for this attribute are defined by the W3C XML Schema string datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_Hyperlink) is located in §A.4.1. end note]

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

HyperlinkOnHover Members

DocumentFormat.OpenXml.Drawing Namespace