Start of Content Area

Background documentation IFrame  Locate the document in its SAP Library structure

Caution

This UI element is deprecated and is not to be used.

With the portal, you can integrate applications that are not based on the Web Dynpro programming model. UI elements are provided too embed help texts, for example, Explanation and the explanation property in a range of UI elements (for example, InputField, Button). The OfficeControl is provided for embedding documents and the InteractiveForm is provided for PDF forms.

If you still want to use the UI element, note that when interactive, stateful applications, such as BSP or JSP applications, are embedded, these are always reloaded in connection with navigation steps after each server roundtrip. When IFrame is used, no session handling is supported. In particular, the Web Dynpro framework cannot close existing sessions that were initiated through the use of IFrames.

Note that when you refresh, the IFrame is also updated.

In the portal or in the muse client you should set up a separate iView with a fixed or dynamic URL instead of an IFrame.

Note that Web Dynpro cannot guarantee the accessibility of the content of an IFrame. This means that the project in whose applications the IFrame is used is responsible for the accessibility of the content displayed in the IFrame.

The UI element IFrame represents an area separated by a frame, which contains a separate browser page, within a view. This frame can be used to display external sources like HTML pages within a specific area of the user interface. In general, a vertical and horizontal scroll bar are activated to view the content of this UI element. You can scroll within this frame, as shown in the following graphic:

Note

The content of the IFrame is not affected by each roundtrip. This means, for example, that there are no changes to the scrolling position or to possible entries in input fields of a website which is shown in the IFrame. The IFrame is only completely rebuilt if one of its properties is changed. This is the case, for example, if you attach SPACE to the URL (property source).

Caution

The IFrame may not be used in aScrollContainer with scrollingMode not equal to none.  The ScrollContainer is also deprecated.

Example of the Visual Display:
IFrame in a MatrixLayout with Background Shading

This graphic is explained in the accompanying text

Note

To enable the development of accessible applications, the tooltip property is checked during the syntax check.

 

Runtime Class

CL_WD_IFRAME

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

ID

STRING

(automatic)

No

border

WDY_BOOLEAN

false

Yes

contextMenuBehaviour

WDUI_CONTEXT_MENU_BEHAVIOUR

inherit

No

contextMenuId

WDY_MD_UI_ELEMENT_REFERENCE

 

No

enabled

WDY_BOOLEAN

true

Yes

height

STRING

300

Yes

scrollingMode

WDUI_SCROLLING_MODE

auto

Yes

source

STRING

 

Yes

tooltip

Translatable text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

width

STRING

300

Yes

Note

Other properties that can be inherited are defined in the associated higher-level classes. The associated UI elements are:

        UIElements

        ContextMenuProviders

        ViewElements

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

border

BORDER

WDY_BOOLEAN

contextMenuBehaviour

CONTEXT_MENU_BEHAVIOUR

WDUI_CONTEXT_MENU_BEHAVIOUR

 contextMenuBehaviour: inherit

CL_WD_IFRAME=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT

 contextMenuBehaviour: provide

CL_WD_IFRAME=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE

 contextMenuBehaviour: suppress

CL_WD_IFRAME=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS

contextMenuId

CONTEXT_MENU_ID

WDY_MD_UI_ELEMENT_REFERENCE

enabled

ENABLED

WDY_BOOLEAN

height

HEIGHT

STRING

scrollingMode

SCROLLING_MODE

WDUI_SCROLLING_MODE

scrollingMode: auto

CL_WD_IFRAME=>E_SCROLLING_MODE-AUTO

scrollingMode: both

CL_WD_IFRAME=>E_SCROLLING_MODE-BOTH

scrollingMode: none

CL_WD_IFRAME=>E_SCROLLING_MODE-NONE

source

SOURCE

STRING

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_IFRAME=>E_VISIBLE-NONE

visible: visible

CL_WD_IFRAME=>E_VISIBLE-VISIBLE

width

WIDTH

STRING

 

Example

You can find examples in the system in the Web Dynpro application, WDR_TEST_UI_ELEMENTS.

 

 

 

End of Content Area