OfficeControl 

 

The OfficeControl UI element allows you to add an Office document to a view. This means you can display the following Office documents within a Web Dynpro application:

·        Microsoft Word documents

·        Microsoft Excel documents

·        StarOffice Calculator documents

·        StarOffice Writer documents

The OfficeControl UI element is made available as an ActiveX control, so that the UI element can be displayed in browsers that support ActiveX controls.

Note that an applet is used for the StarOffice integration and no ActiveX is needed for this.

For browsers which do not support ActiveX controls, the following runtime exception is raised: Office Integration through Applet is not supported.

The implementation of the OfficeControl UI element supports the following functions for the Office documents mentioned earlier:

·        Open

·        Close

·        Save

·        Create new documents

Note that you can open and close a document by setting the visible property of the OfficeControl UI elements to visible or none.

Also note that the OfficeControl is only active when the visible property is set to visible. Background processing is activated when visible is set and width and height = 0.

In the Expert Mode additional method calls for complex operations are provided.

Examples of the Display

 

When the template is designed there is no check for the tool tip property to guarantee Accessibility.

 

Runtime Class

CL_WD_OFFICE_CONTROL

 

Properties in the View Designer

Name	Type	Initial Value	Bindable
ID	STRING	(automatic)	No
activateInPlace	WDY_BOOLEAN	true	Yes
additionalArchives	STRING		No
archive	STRING		No
classId	STRING		No
codeBase	STRING		No
controlId	STRING		No
dataSource	XSTRING		Yes
documentName	STRING		Yes
documentType	WDUI_OFFICE_DOC_TYPE	ms_word	Yes
enabled	WDY_BOOLEAN	true	Yes
enableReadWrite	WDY_BOOLEAN	true	Yes
expertMode	WDY_BOOLEAN	false	Yes
height	STRING	300px	Yes
showDecoration	WDY_BOOLEAN	true	Yes
tooltip	Text		Yes
type	STRING		No
visible	WDUI_VISIBILITY	visible	Yes
width	STRING	300px	Yes

 

Events in the View Designer

Name

onClose

onSave

Further properties that can be inherited are defined in the associated higher-level class.  The associated interface elements are:

·         AbstractActiveComponent

·         UIElement

·         ViewElement

Dynamic Programming

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

Dynamic Programming of Properties

View Designer Name	Runtime Name	Type
activateInPlace	ACTIVATE_IN_PLACE	WDY_BOOLEAN
additionalArchives	ADDITIONAL_ARCHIVES	STRING
archive	ARCHIVE	STRING
classId	CLASS_ID	STRING
codeBase	CODE_BASE	STRING
controlId	CONTROL_ID	STRING
dataSource	DATA_SOURCE	XSTRING
documentName	DOCUMENT_NAME	STRING
documentType	DOCUMENT_TYPE	WDUI_OFFICE_DOC_TYPE
documentType: ms_excel	CL_WD_OFFICE_CONTROL=>E_DOCUMENT_TYPE-MS_EXCEL
documentType: ms_word	CL_WD_OFFICE_CONTROL=>E_DOCUMENT_TYPE-MS_WORD
documentType: star_calc	CL_WD_OFFICE_CONTROL=>E_DOCUMENT_TYPE-STAR_CALC
documentType: star_writer	CL_WD_OFFICE_CONTROL=>E_DOCUMENT_TYPE-STAR_WRITER
enabled	ENABLED	WDY_BOOLEAN
enableReadWrite	ENABLE_READ_WRITE	WDY_BOOLEAN
expertMode	EXPERT_MODE	WDY_BOOLEAN
height	HEIGHT	STRING
showDecoration	SHOW_DECORATION	WDY_BOOLEAN
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
type	TYPE	STRING
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_OFFICE_CONTROL=>E_VISIBLE-NONE
visible: visible	CL_WD_OFFICE_CONTROL=>E_VISIBLE-VISIBLE
width	WIDTH	STRING

 

Dynamic Programming of Events

View Designer Name	Runtime Name
onClose	ON_CLOSE
onSave	ON_SAVE

Example

You can find examples of this UI element in the system in collection sios.