OfficeControl Properties 

Properties in the View Designer

·        activateInPlace

Controls whether the document appears in the browser window or the system opens the Office application linked to the document type in a separate window to display the document. If you have assigned the value false to the activateInPlace property and the value ms_word to the documentType property, the Microsoft Word application opens and display the content in the Microsoft Word user interface. The default value for this property is true.

If you have assigned the value false to this property, you should then make sure that you assign small values to the height and width properties, because these values are not ignored and act as placeholders in the view of the Web Dynpro application. In the view, the UI element takes up as much empty space as you have specified for the values of the height and width properties. You should therefore overwrite the default value of 300 with a smaller number, for example, 5.
If you have assigned the value true to this property, you should use suitable values for displaying the document, so that the document is readable and the user does not have to scroll too often, because he or she cannot increase the size of the document in the browser window at runtime.

·        controlId

The value of this property is set automatically. Therefore do not enter anything here.

·        dataSource

Data source. You can use it to specify the path to the context attribute, which makes the data available.

If this property is not bound, a new document is automatically created in the non-expert mode. In the expert mode when the method opendocument is executed an error results.  Only method createdocument can be executed correctly.

Primary Property

·        documentName

Name of the document

·        documentType

Type of document to be displayed.

Value	Description
ms_excel	Microsoft Word document with the xls file extension
ms_word	Microsoft Word document with the doc file extension
star_calc	StarOffice Calculator document with the ods file extension
star_writer	StarOffice Writer document with the odt file extension

·        enableReadWrite

This property is deprecated.

Mode of the document to be opened. Controls whether the user can edit the document and save it back with changed content.

·        expertMode

Expert mode for complex operations such as calling macros from the back end. If you set this property to true, additional method calls become available.

You receive a factory from the OfficeControl:

wd_this->factory ?= office->_method_handler.

This factory is able to create the respective proxies. The required methods can then be called on this proxy.

Application developers work with the interfaces only; classes are created automatically by Web Dynpro.

 

The released interfaces are in the collection sios:

These are generic interfaces for all front ends (SAP GUI for Windows, SAP GUI for HTML, SAP GUI for Java, Web Dynpro ABAP. They are implemented in Web Dynpro Java).

¡        IF_IOS_FACTORY

Factory to create the required proxies.

Not all the methods are available for Web Dynpro. Methods if_ios_factory~set* are called automatically by Web Dynpro which means they cannot be used for Web Dynpro, and in this case an exception is raised.

¡        IF_IOS_DOCUMENT

Basic operations performed on documents.

¡        IF_IOS_ENVIRONMENT

Information on the environment such as inplace, outplace, activate tracing, ascertain available applications in the current client.

Each interface method automatically raises an exception if there is an error.

Each interface is assigned its own exception class: IF_IOS_DOCUMENT : CX_IOS_DOCUMENT.

These all derive from CX_IOS_EXCEPTION. The error text can be found in IF_T100_MESSAGE.  The base class provides methods to read out the text.

·        showDecoration

Show and hide menus.