Kurzbeschreibung

Das XML-Element <Hyperlink> erzeugt einen anklickbaren Verweis innerhalb eines Dokuments.

Der sichtbare Linktext wird innerhalb des <Hyperlink> definiert, während das Ziel über Attribute angegeben wird.

Einordnung

Bereich: Inhalte

Schwierigkeitsgrad: ⭐⭐☆☆☆

Vorkenntnisse: Block · Content · Text · TextProperties

Siehe auch

• Block
• Content
• Text
• TextProperties
• Setter

Zweck

Mit <Hyperlink> können anklickbare Verweise innerhalb eines Dokuments erzeugt werden.

Dabei werden

• der anzuzeigende Text,
• das Ziel des Links und
• dessen Darstellung

voneinander getrennt.

Dadurch kann beispielsweise ein kurzer Linktext auf eine lange Internetadresse verweisen.

Position innerhalb der Dokumentvorlage

<Hyperlink> wird innerhalb eines <Block> verwendet.

Der eigentliche Linktext wird innerhalb eines <Content> definiert.

<Block>

    <Hyperlink
        IsExternal="true"
        Link="https://www.hc-vision.de">

        <Content>

            <Text Content="hc:VISION">
            </Text>

        </Content>

    </Hyperlink>

</Block>

Ein <Block> kann sowohl normalen Inhalt als auch Hyperlinks enthalten.

Dadurch lassen sich Fließtexte und Links problemlos miteinander kombinieren.

Attribute

Hinweis

Die IntelliSense bietet zusätzlich das Attribut RelationshipType an.

Die konkrete fachliche Bedeutung beziehungsweise die möglichen Werte sind derzeit nicht bekannt.

Link oder LinkPath

Für das Linkziel stehen zwei Möglichkeiten zur Verfügung.

Link

Soll das Ziel fest innerhalb der Dokumentvorlage hinterlegt werden, wird Link verwendet.

<Hyperlink
    IsExternal="true"
    Link="https://www.hc-vision.de">

    <Content>

        <Text Content="hc:VISION">
        </Text>

    </Content>

</Hyperlink>

LinkPath

Soll das Linkziel erst während der Dokumenterzeugung bestimmt werden, kann LinkPath verwendet werden.

Hierzu wird meist zuvor über einen <Setter> eine interne Variable aufgebaut.

<Hyperlink
    IsExternal="true"
    LinkPath="MeinLink">

    <Content>

        <Text Content="Zum Portal">
        </Text>

    </Content>

</Hyperlink>

Dadurch kann das Linkziel dynamisch bestimmt werden.

Linktext gestalten

Der sichtbare Linktext befindet sich innerhalb eines <Content>.

Für dessen Darstellung können sämtliche Möglichkeiten von <TextProperties> genutzt werden.

Beispiel:

<Hyperlink
    IsExternal="true"
    Link="https://hkk.de/kontaktformular">

    <Content>

        <Text Content="Bitte hier klicken">
        </Text>

        <TextProperties
            Color="black"
            TemplateStyle="Hyperlink">

            <Font>
            </Font>

            <IsBold>true</IsBold>

        </TextProperties>

    </Content>

</Hyperlink>

Damit kann beispielsweise

• die Schriftfarbe,
• die Schriftart,
• die Schriftgröße oder
• die Schriftstärke

individuell angepasst werden.

Hyperlink innerhalb eines Fließtextes

Ein Hyperlink muss nicht den gesamten Inhalt eines Blocks bilden.

Er kann zwischen normalen Textabschnitten stehen.

Hier steht normaler Text.

↓

Hyperlink

↓

Hier geht der Satz weiter.

Dadurch lassen sich Links problemlos in Fließtexte integrieren.

Typische Einsatzgebiete

<Hyperlink> wird häufig verwendet für

• Internetseiten,
• Kontaktformulare,
• Kundenportale,
• Downloadseiten,
• Dokumentationen,
• interne Portale.

Best Practices

• Aussagekräftige Linktexte verwenden.
• Lange Internetadressen nicht als sichtbaren Text ausgeben.
• Für dynamische Ziele LinkPath verwenden.
• Für feste Ziele Link verwenden.
• Die Darstellung des Linktextes einheitlich gestalten.

Developer-Tipp

Der sichtbare Text eines Hyperlinks muss nicht mit der eigentlichen Internetadresse übereinstimmen.

Verwenden Sie daher möglichst kurze und verständliche Linktexte.

XML-Wissen

Ein <Hyperlink> trennt

• den sichtbaren Linktext und
• das eigentliche Linkziel.

Dadurch kann derselbe Linktext auf unterschiedliche Ziele verweisen oder unterschiedliche Linktexte auf dieselbe Zieladresse zeigen.

Der sichtbare Text wird innerhalb des <Content> definiert.

Das Ziel wird ausschließlich über die Attribute des <Hyperlink> festgelegt.

Typische Fehler

Link und LinkPath gleichzeitig verwenden

Für das Linkziel sollte entweder Link oder LinkPath verwendet werden.

Fehlender Linktext

Ein Hyperlink ohne Inhalt erzeugt keinen sichtbaren anklickbaren Text.

Ungeeignete Linktexte

Bezeichnungen wie

Hier klicken

sind wenig aussagekräftig.

Besser sind beispielsweise

Zum Kundenportal

oder

Kontaktformular öffnen

Dadurch bleibt das Dokument auch bei mehreren Hyperlinks übersichtlich.