<hyperlink> Configuration Element
Prev Chapter 18. XML Configuration API Next

<hyperlink> Configuration Element

This element allows for the specification of a single hyperlink that the end users of Ephox EditLive! for XML will be provided with via the Insert Hyperlink dialog.

Configuration Element Tree Structure

<editLive>
     ...
     <hyperlinks>
         <hyperlinkList>
              <hyperlink ... />
         </hyperlinkList>
         ...
     </hyperlinks>
     ...
</editLive>

Required Attributes

href

This attribute defines the URL for the hyperlink.

Optional Attributes

description

This attribute specifies the description used for the image in the Insert Hyperlink dialog within EditLive! for XML.

target

This attribute has the same effect as the target property of the <A> HTML tag. This attribute specifies the name of the frame for the hyperlink to jump to.

When inserting the hyperlink defined by this <hyperlink> element into an EditLive! for XML document this attribute will appear in the HTML source code.

title

This attribute has the same effect as the title property of the <A> HTML tag. This attribute provides an advisory title for the document linked to.

When inserting the hyperlink defined by this <hyperlink> element into an EditLive! for XML document this attribute will appear in the HTML source code.

Example

The following example demonstrates how to specify a hyperlink to provide the users of EditLive! for XML with.

<editLive>
    ...
    <hyperlinks>
        <hyperlinkList>
            <hyperlink href="http://www.someserver.com/somepage.html"
                description="This is a hyperlink"
                target="_blank" 
                title="Hyperlink" />
        </hyperlinkList>
        ...
    </hyperlinks>
    ...
</editLive>

Remarks

The <hyperlink> element can appear multiple times within the <hyperlinkList> element.

The <hyperlink> element must be a complete tag, it cannot contain a tag body. Therefore the tag must be closed in the same line. See the example below:

<hyperlink href=... />

Copyright 2001-2004 Ephox Corporation. All Rights Reserved.

Prev Up Next
<hyperlinkList> Configuration Element Home <mailtoList> Configuration Element