Web
Dynpro IFrame API - IWDIFrame 
Definition
The 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 are activated to view the content of this UI element. You can scroll within the frame content, as is shown in the following graphic:
Description of the UI Element Properties
·
border
Specifies whether or not the IFrame UI element is displayed with
borders.
·
height
Specifies the height of an
internal frame.
·
scrollingMode
Specifies how the scroll bar can be displayed within the IFrame UI
element container.
The scrollingMode property can be filled with the following
values and is represented by the 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
Specifies the source of the
frame content to be displayed in this UI element.
·
width
Specifies the width of an
internal frame.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
border |
IWDIFrame |
boolean |
false |
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
height |
IWDIFrame |
int |
300 |
bindable |
No |
scrollingMode |
IWDIFrame |
WDScrollingMode |
auto |
bindable |
No |
source |
IWDIFrame |
String |
|
bindable |
Yes |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
width |
IWDIFrame |
int |
300 |
bindable |
No |
The inherited properties enabledand tooltipare ignored and do not affect the browser.
Methods in the Web Dynpro IWDIFrame API
Method Name |
Parameter |
Return Value |
Short Description |
bindBorder |
(String path) |
|
Binds the border property to the context node specified by a path. |
bindHeight |
(String path) |
|
Binds the height property to the context node specified by a path. |
bindingOfBorder |
|
String |
Returns the path of the context element to which the border property is bound. Returns NULL if no binding exists. |
bindingOfHeight |
|
String |
Returns the path of the content element to which the height property is bound. Returns NULL if no binding exists. |
bindingOfScrollingMode |
|
String |
Returns the path of the context element to which the scrollingMode property is bound. Returns NULL if no binding exists. |
bindingOfSource |
|
String |
Returns the path of the context element to which the source property is bound. Returns NULL if no binding exists. |
bindingOfWidth |
|
String |
Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists. |
bindScrollingMode |
(String path) |
|
Binds the value of the scrollingMode property to the context element specified by the path. |
bindSource |
(String path) |
|
Binds the value of the source property to the context element specified by the path. |
bindWidth |
(String path) |
|
Binds the value of the width property to the context element specified by the path. |
getBorder |
|
boolean |
Returns the value of the border property. |
getHeight |
|
String |
Returns the value of the height property. |
getScrollingMode |
|
WDScrollingMode |
Returns the value of the scrollingMode property. |
getSource |
|
String |
Returns the value of the source property. |
getWidth |
|
String |
Returns the value of the width property. |
setBorder |
(boolean value) |
|
Sets the value of the border property. |
setHeight |
(String value) |
|
Sets the value of the height property. |
setScrollingMode |
(WDScrollingMode value) |
|
Sets the value of the scrollingMode property. |
setSource |
(String value) |
|
Sets the value of the source property. |
setWidth |
(String value) |
|
Sets the value of the width property. |
Additional methods are available using inheritance: IWDUIElement, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.