Web Dynpro LinkToAction API –
IWDLinkToAction 
Definition
The LinkToAction UI element is a hypertext link. The navigation to this link triggers a Web Dynpro action.
Description of the UI Element Properties
·
design
Specifies the graphical
design of the UI element. The type property can be filled with the following
values and is represented by the enumeration type WDLinkType.
function |
|
Link is displayed underlined in the standard design. |
navigation |
|
Link is displayed underlined and with a font color that is used for links already visited. |
reporting |
|
Link is displayed not underlined in the standard design. |
result |
|
Link is displayed not underlined. |
Events
·
onAction
This attribute can assign the
action that is to be executed when the user navigates to the link.
Additional
properties are defined in the corresponding superior interfaces. Refer to:
IWDLink,
IWDAbstractCaption,
IWDUIElement, IWDViewElement.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
IWDUIElement |
boolean |
true |
bindable |
No |
|
IWDAbstractCaption |
String (TranslatableText) |
|
bindable |
No |
|
IWDAbstractCaption |
boolean |
true |
bindable |
No |
|
IWDLink |
String (CSS size) |
|
bindable |
No |
|
IWDAbstractCaption |
String |
|
bindable |
No |
|
IWDLink |
String (CSS size) |
|
bindable |
No |
|
IWDLink |
WDLinkSize |
standard |
bindable |
No |
|
IWDLink |
String (TranslatableText) |
|
bindable |
No |
|
type |
IWDLinkToAction |
WDLinkType |
function |
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
IWDLink |
boolean |
false |
bindable |
No |
Mobile Characteristics
The UI element LinkToAction supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds (see Mobile Web Dynpro).
However, several properties supported in the desktop browser cannot be used. These include:
Variances of the properties
Properties |
Pocket PC |
BlackBerry wireless handheld |
enabled |
ignored |
ignored |
imageAlt |
ignored |
ignored |
imageFirst |
ignored |
ignored |
imageHeight |
ignored |
ignored |
imageSource |
ignored |
ignored |
imageWidth |
ignored |
ignored |
tooltip |
ignored |
ignored |
type |
ignored |
ignored |
wrapping |
ignored |
ignored |
Methods in the Web Dynpro IWDLinkToAction API
Method Name |
Parameter |
Return Value |
Short Description |
bindingOfType |
|
String |
Returns the path of the content element to which the type property is bound. Returns NULL if no binding exists. |
bindType |
(String path) |
|
Binds the value of the type property to the content element specified by the path. |
getOnAction |
|
IWDAction |
Returns the action that is executed when the onAction event is triggered. |
getType |
|
WDLinkType |
Returns the value of the type property. |
mappingOfOnAction |
|
IWDParameterMapping |
Returns the parameter mapping for the onAction action. |
setOnAction |
(IWDAction action) |
|
Sets the action that is executed if the onAction event is raised. |
setType |
(WDLinkType value) |
|
Sets the value of the type property. |
Additional methods described in the following APIs are available using inheritance: IWDLink, IWDAbstractCaption, IWDUIElement, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.