Show TOC

IFrameLocate this document in the navigation structure

UI element IFrame is an internal frame 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 is activated to view the content of this UI element. You can scroll within the frame content.

Note

The IFrame UI element is undeprecated.

Description of Properties
  • border

    This specifies whether the IFrame is displayed with a border.

  • height

    This specifies the height of an internal frame.

  • lifeCycle

    This determines life cycle strategy of IFrame. This attribute is used only if Lightspeed rendering is used.

    • roundtrip : IFrame is recreated on client every time it is rendered by the browser.
    • uielement : IFrame is created once and it is kept alive as long as the IFrame UI element is alive.
  • postParameters

    If this parameter is set, POST will be used instead of GET to load the content of the IFrame.

    This attribute contains the post parameters as URL encoded string, e. g. " style=bis&query=Web%20Dynpro ".

    To ensure that your parameters are properly encoded call following API to compute the post parameters string:

    WDURLGenerator.getQueryString(Map<String, Object> urlParameters, String encoding)
  • scrollingMode

    Specifies how the scroll bar can be displayed within the IFrame UI element container.

    scrollingMode can have the following values and is represented by enumeration type WDScrollingMode.

    auto

    The scroll bar within the container is activated automatically.

    both

    A vertical and horizontal scroll bar are activated.

    none

    Scrolling within the text context is not possible.

  • source

    This specifies the source of the frame content to be displayed in this UI element.

  • supportsResizing

    This specifies whether the height of the IFrame is adjusted automatically on the client to the size of the IFrame's content. This works only if  the embedded content belongs to the same domain due to security restrictions in JavaScript.

  • width

    This specifies the width of the internal frame.

Properties Overview
Name Interface Type Initial Value Bindable
border

IWDIFrame

boolean

false

bindable

enabled

IWDUIElement

boolean

true

bindable

height

IWDIFrame

int

300

bindable

lifeCycle

IWDIFrame

WDIFrameLifeCycle

roundtrip

bindable

postParameters

IWDIFrame

String

 

bindable

scrollingMode

IWDIFrame

WDScrollingMode

auto

bindable

source

IWDIFrame

String

 

bindable

supportsResizing

IWDIFrame

boolean

false

not bindable

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

width

IWDIFrame

int

300

bindable

More information Common UI Element Properties

Note

The inherited properties enabled and tooltip are ignored and do not affect the browser.