Entering content frame

Object documentation Web Dynpro LinkToURL API - IWDLinkToURL Locate the document in its SAP Library structure

Definition

The LinkToURL UI element is a hypertext link. The navigation to this link leads to a user-defined Web resource (URL).

Description of the UI Element Properties

·        reference
Describes the address of the Web page to be opened.

·         target
Specifies the browser window in which the page is to be opened. You can specify the name of the target window yourself or use the following values, which comply with the W3C-HTML standard:

-         _blank
The page is opened in a new window without a name. This is the default value.

-         _self
The page is displayed in the same window as the link.

-         _parent
The page is displayed in the superordinate browser window. If there is no superordinate window, the page is displayed in the same window as the link.

-         _top
The page is opened in the original window of a frame hierarchy. If there is no frame hierarchy, the page is displayed in the same window as the link.

·        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

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.

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

reference

IWDLinkToURL

String

 

bindable

Yes

target

IWDLinkToURL

String

_BLANK

bindable

No

text

IWDLink

String (TranslatableText)

 

bindable

No

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

No

type

IWDLinkToURL

WDLinkType

navigation

bindable

No

visible

IWDUIElement

WDVisibility

visible

bindable

No

wrapping

IWDLink

boolean

false

bindable

No

Mobile Characteristics

The UI element LinkToURL supports the development of mobile applications for pocket PCs (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 IWDLinkToURL API

Method Name

Parameter

Return Value

Short Description

bindingOfReference

 

String

Returns the path of the context element to which the reference property is bound. Returns NULL if no binding exists.

bindingOfTarget

 

String

Returns the path of the context element to which the target property is bound. Returns NULL if no binding exists.

bindingOfType

 

String

Returns the path of the context element to which the type property is bound. Returns NULL if no binding exists.

bindReference

(String path)

 

Binds the reference property to the context node specified by a path.

bindTarget

(String path)

 

Binds the target property to the context node specified by a path.

bindType

(String path)

 

Binds the type property to the context node specified by a path.

getReference

 

String

Returns the value of the reference property.

getTarget

 

String

Returns the value of the target property.

getType

 

WDLinkType

Returns the value of the type property.

setReference

(String value)

 

Sets the value of the reference property.

setTarget

(String value)

 

Sets the value of the target property.

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.

Note

For detailed documentation of all inherited methods, see the documentation for the relevant APIs.

  

  

 

Leaving content frame