Start of Content Area

Object documentation LinkToAction API  Locate the document in its SAP Library structure

Definition

The LinkToAction UI element is a hypertext link. The navigation to this link triggers a Web Dynpro action. You can assign a popup menu to LinkToAction which the user can recognize by this symbol: This graphic is explained in the accompanying text.

Description of UI Element Properties

·        imageAlt
This property is deprecated and can no longer be used.

·        imageFirst
Defines the position of the icon in relation to the corresponding text. If the value of this property is true, the icon is displayed to the left of the text.

·        imageHeight
Specifies the height of the graphic next to the link. You can specify the height in CSS units like em, ex, pixels, or percentage.

·        imageSource
Specifies the Web address (URL) of the icon to be displayed. You can assign an absolute Web address – http:// … to this property.
If you store the icons in the directory mimes/Components/<component class> of the Web Dynpro project in the Navigator using the menu item Import, you only have to enter the icon name - for example, icon.gif. The URL Generation Service automatically determines the URL of the icon (see also URL Generation Service).
You can also store the icons in directory mimes/Applications/<application class>. In this case, you must create the URL manually using the URL Generation Service.
If you use the SAP icons and want to refer to them, you can use the alias ~sapicons. If you assign the alias ~sapicons/<name>.gif to the imageSource property, refer to an icon called <name>.gif of the SAP icons. For a description and a listing of all possible SAP icons, see the SAP Design Guild under http://www.sapdesignguild.org/. Select the following path:
Sitemap → Resources  → Visual Design & Icons → SAP R/3 Icons → R/3 Icon Lists. 
The filename of the icon consists of the bitmap name entered in the table and the prefix “s_”. If the bitmap name in the table is F_CUTO, you need to enter ~sapicons/s_f_cuto.gif to reference to the SAP icon This graphic is explained in the accompanying text.

·        imageWidth
Specifies the width of the graphic next to the link. You can specify the width in CSS units like em, ex, pixel, or percentage.

·        size
Specifies the size of the LinkToAction UI element. The size property can take the following values and is represented by the enumeration type WDLinkSize.

small

The UI element is displayed with a small font.

standard

A default size is displayed.

·        text

Determines the text

·        textDirection
Specifies the text direction and allows you to use a LinkToAction element for texts in languages that require a specific text direction. The textDirection property can be filled with the following values and is represented by the enumeration type WDTextDirection.

inherit

The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.

ltr

The text runs from left to right.

rtl

The text runs from right to left.

The default value for this property is inherit.

·        design
Specifies the graphical design of the UI element. The typeproperty can be filled with the following values and is represented by the enumeration type WDLinkType.

function

This graphic is explained in the accompanying text

Link is displayed underlined in the standard design.

navigation

This graphic is explained in the accompanying text

Link is displayed underlined and with a font color that is used for links already visited.

reporting

This graphic is explained in the accompanying text

Link is displayed not underlined in the standard design.

result

This graphic is explained in the accompanying text

Link is displayed not underlined.

·        wrapping
Indicates whether or not the link text is wrapped. If the initial value is false, the link text is not wrapped.

Overview of Inherited and Additional Properties

Name

Interface

Type

Initial Value

Bindable

Value Required

enabled

IWDUIElement

boolean

true

bindable

No

imageAlt

IWDAbstractCaption

String (TranslatableText)

 

bindable

No

imageFirst

IWDAbstractCaption

boolean

true

bindable

No

imageHeight

IWDLink

String (CSS size)

 

bindable

No

imageSource

IWDAbstractCaption

String

 

bindable

No

imageWidth

IWDLink

String (CSS size)

 

bindable

No

size

IWDLink

WDLinkSize

standard

bindable

No

text

IWDLink

String (TranslatableText)

 

bindable

No

textDirection

IWDAbstractCaption

WDTextDirection

inherit

bindable

No

type

IWDLinkToAction

WDLinkType

function

bindable

No

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

No

visible

IWDUIElement

WDVisibility

visible

bindable

No

wrapping

IWDLink

boolean

false

bindable

No

 Events

·        onAction
This attribute can assign the action that is to be executed when the user navigates to the link.

 

End of Content Area