# RichHyperlinkType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Hyperlink with a label, menu and other data that control a rich presentation of the link. Not all parameters that are present in this data structure might be supported in all the places where a link is used. Which parameter will be used depends on where exactly is the link used and how it is rendered (as an menu item, application launch button, etc.)

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
targetUrl | property string | [1,1] | URL of the link target.
label | property string | [0,1] | Human-readable label to display with the link (or a key to the localization file).
description | property string | [0,1] | Human-readable description to display with the link (or a key to the localization file).
documentation | property string | [0,1] | Technical documentation for a particular object or construct.
icon | container IconType | [0,1] | Icon to display for this link.
color | property string | [0,1] | Primary color that will be used to render this link in case that multiple color options are supported.
authorization | property string | [0,-1] | Authorizations needed to display this link.

- ### Items

  - #### targetUrl

    Flags: RAM,runtime

    Multiplicity: [1,1]

    Display order:

    URL of the link target. It can be absolute URL with method specification or it can be relative URL. If the URL is relative, it is assumed that it is relative to the application root URL context.

  - #### label

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Human-readable label to display with the link (or a key to the localization file). The label should be quite short (several words). It is meant to be displayed as a menu item label, launcher label, etc.

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Human-readable description to display with the link (or a key to the localization file). The description can be longer (several sentences). It is mean to be displayed as a multi-line description, tooltip, etc.

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Technical documentation for a particular object or construct.

    The purpose of this element is to document system configuration and behavior. The documentation will not be presented to end users. In fact, it will probably not be presented at all in midPoint user interface. This documentation element is supposed to be a part of the technical documentation of midPoint deployment. The tools than generate deployment configuration will look for these elements and combine them to compiled documentation document.

    AsciiDoc formatting is assumed for this element. Any leading or trailing whitespace is skipped. Indentation equivalent to he indentation of the first non-blank line of text is also skipped.

  - #### icon

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Icon to display for this link.

  - #### color

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Primary color that will be used to render this link in case that multiple color options are supported.

  - #### authorization

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Authorizations needed to display this link. If specified, the the link will be displayed only if the active user has one of the specified the authorizations. If no authorization is specified then the link will be always displayed.