2.2.9.1.6 Hyperlink

The Hyperlink complex type specifies a hyperlink associated with a shape (section 1.3.3). One element is returned for each visible hyperlink associated with the shape within a ShapeInfo element (section 2.2.9.1).

 <xs:complexType name="Hyperlink" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:attribute name="Name" type="xs:string" use="required"/>
   <xs:attribute name="Value" type="xs:string" use="optional"/>
   <xs:attribute name="Description" type="xs:string" use="optional"/>
   <xs:attribute name="SubAddress" type="xs:string" use="optional"/>
   <xs:attribute name="SubAddressShape" type="xs:string" use="optional"/>
   <xs:attribute name="Zoom" use="optional">
     <xs:simpleType>
       <xs:union>
         <xs:simpleType>
           <xs:restriction base="xs:int">
             <xs:minExclusive value="0"/>
           </xs:restriction>
         </xs:simpleType>
         <xs:simpleType>
           <xs:restriction base="xs:int">
             <xs:enumeration value="-2"/>
             <xs:enumeration value="-1"/>
           </xs:restriction>
         </xs:simpleType>
       </xs:union>
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute name="Default" type="xs:boolean" use="optional"/>
 </xs:complexType>

Name: A string attribute that specifies an identifier for a hyperlink. It MUST NOT be an empty string, and it MUST be unique among the identifiers specified by the Name attribute of the hyperlink elements in this XML part.

Value: An optional string attribute that specifies the URI of an external resource referenced by the hyperlink. If this attribute exists, it MUST NOT be an empty string, and the SubAddress, SubAddressShape, and Zoom elements MUST be ignored. If this attribute does not exist, SubAddress MUST exist.

Description: An optional string attribute that specifies the description of the hyperlink. If this attribute does not exist, the hyperlink does not have a description.

SubAddress: An optional string attribute that specifies the identifier of the drawing page (section 1.3.2) referenced by this hyperlink within the web drawing (section 1.3.1). If this attribute exists, it MUST NOT be an empty string. If this attribute does not exist, the SubAddressShape and Zoom elements MUST be ignored.

SubAddressShape: An optional string attribute that specifies the identifier of the shape referenced by this hyperlink within the drawing page specified by SubAddress. If this attribute exists, it MUST NOT be an empty string. If this attribute does not exist, the hyperlink references the entire drawing page.

Zoom: An optional integer attribute that specifies the zoom level for the drawing page specified by SubAddress. If this attribute does not exist, the zoom level is 100%. If this attribute does exist, it MUST be a value from the following table.

Value

Description

-2

The drawing page is zoomed to fit the width of the view.

-1

The drawing page is zoomed to fit in the view.

n > 0

The drawing page is zoomed to n%. n MUST be greater than zero.

Default: An optional Boolean attribute that specifies the default hyperlink associated with the shape. It MUST be true if and only if this hyperlink is the default. Each shape MUST NOT have more than one default hyperlink.