SAP ABAP Class CL_XSL_DOCX (Main class of docx to output)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-I18 (Application Component) Internationalization (I18N)
     ⤷ S_OOXML_XSL_FO (Package) OOXML:XSL-FO related topics

Properties

Class	CL_XSL_DOCX
Short Description	Main class of docx to output
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_OOXML_XSL_FO	OOXML:XSL-FO related topics
Created	20080129	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_XSL_DOCX has no interface implemented.

Friends

Class CL_XSL_DOCX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DOCX_MAP	Static Attribute	Private	☐	Type reference (TYPE)	TY_DOCX_MAP_TABLE			20090109

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_DOCX2HTML	Static method	Public	Method	Convert .docx to HTML format.	20080718
2	CONVERT_DOCX2XSLFO	Static method	Public	Method	Convert .docx to XSL-FO format.	20080617
3	CONVERT_WORDML2XSLFO	Static method	Public	Method	Convert Word 2003 XML to XSL-FO format.	20081030
4	GENERATE_DOCX	Static method	Public	Method		20081218
5	GENERATE_OUTPUT	Static method	Public	Method	Merge customer data and form template.	20080129
6	GENERATE_TESTPAGE	Static method	Public	Method	For testing or demo purpose,gets docx and create a spool id.	20080311
7	GENERATE_TRANSFORM	Static method	Public	Method	Create XSL-FO XSLT based on the form template and its 'sdt'.	20080129
8	SAVE_ACTIVEX_DOCX	Static method	Public	Method		20090430
9	SAVE_AFCHUNK_DOCX	Static method	Public	Method		20090114
10	SAVE_PART_DOCX	Static method	Public	Method		20090109

Events

Class CL_XSL_DOCX has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_DOCX_MAP	Private	See coding			20090109	begin of TY_docx_MAP, xsltname TYPE string, docx TYPE xstring, end of TY_docx_MAP
2	TY_DOCX_MAP_TABLE	Private	See coding			20090109	TY_docx_MAP_TABLE TYPE HASHED TABLE OF TY_docx_MAP WITH UNIQUE KEY xsltname
3	T_RESSOURCE	Public	See coding			20080929	begin of T_RESSOURCE, CID type string, RESSOURCE type xstring, CONTENT_TYPE type string, end of t_ressource
4	T_RESSOURCES_TAB	Public	See coding			20080929	T_RESSOURCES_TAB type standard table of t_ressource

Method Signatures

Method CONVERT_DOCX2HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCX_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080718
2	Exporting	RESSOURCES_TAB	Call by reference	☐	Type reference (TYPE)	T_RESSOURCES_TAB			20080929
3	Exporting	RE_HTML_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20080718

#	Exception	Resumable	Description	Created on
1	CX_MERGE_PARTS	☐	Merge exceptions of parts of the package	20080916
2	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20081009
3	CX_OPENXML_NOT_FOUND	☐	Part not found	20081009
4	CX_TRANSFORMATION_ERROR	☐	Allgemeiner Fehler beim CALL TRANSFORMATION	20080929

Method CONVERT_DOCX2XSLFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCX_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080617
2	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	'DD'		20080729
3	Returning	RE_XSLFO_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20080617

#	Exception	Resumable	Description	Created on
1	CX_MERGE_PARTS	☐	Merge exceptions of parts of the package	20080822
2	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080822

Method CONVERT_WORDML2XSLFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	'DD'		20081030
2	Importing	IM_WORDML_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20081030
3	Returning	RE_XSLFO_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20081030

#	Exception	Resumable	Description	Created on
1	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20081030

Method GENERATE_DOCX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COUNTRY	Call by reference	☑	Type reference (TYPE)	DBCOUNTRY		Country Key	20081218
2	Importing	IM_CUSTOMXML_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20081218
3	Importing	IM_FORMTEMPLATE_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20081218
4	Importing	IM_LANGUAGE	Call by reference	☑	Type reference (TYPE)	DBSPRAS		Language Key	20081218
5	Importing	IM_XSLT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081218
6	Returning	RE_DOCX	Value transfer	☐	Type reference (TYPE)	XSTRING			20081218

#	Exception	Resumable	Description	Created on
1	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20090116
2	CX_OPENXML_NOT_FOUND	☐	Part not found	20090116
3	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20090115

Method GENERATE_OUTPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COUNTRY	Call by reference	☑	Type reference (TYPE)	DBCOUNTRY		Country Key	20080729
2	Importing	IM_CUSTOMXML_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080129
3	Importing	IM_LANGUAGE	Call by reference	☑	Type reference (TYPE)	DBSPRAS		Language Key	20080729
4	Importing	IM_XSLT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080129
5	Importing	IO_XSLFO_RENDERER	Call by reference	☐	Object reference (TYPE REF TO)	CL_XSLFO_OUTPUT_ADAPTER		Output adapter base class for XSL formatter	20080220

#	Exception	Resumable	Description	Created on
1	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080822
2	CX_XSLFO_ERROR	☐	XSL-FO exception root class	20080220

Method GENERATE_TESTPAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DELETE	Call by reference	☑	Type reference (TYPE)	RSPO2DISPO		Delete spool request automatically	20080311
2	Importing	IM_DOCX_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080311
3	Importing	IM_IMMED	Call by reference	☑	Type reference (TYPE)	RSPO1DISPO		Character Field Length 1	20080311
4	Importing	IM_PRINTER	Call by reference	☐	Type reference (TYPE)	RSPOPNAME	'LOCL'	Spool: Output Device	20080311
5	Returning	RE_SPOOLID	Value transfer	☐	Type reference (TYPE)	RSPOID		Spool request number	20080311

Method GENERATE_TESTPAGE on class CL_XSL_DOCX has no exception.

Method GENERATE_TRANSFORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DELETE_SDT_TAGS	Call by reference	☐	Type reference (TYPE)	C	'Y'	Y:Delete ContentControl; N:Keep them; R:Make them read-only.	20090826
2	Importing	IM_FORMTEMPLATE_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080129
3	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	C			20080130
4	Returning	RE_XSLT_TAB	Value transfer	☐	Type reference (TYPE)	O2PAGELINE_TABLE		O2: Oxygen Page Table	20080130

#	Exception	Resumable	Description	Created on
1	CX_MERGE_PARTS	☐	Merge exceptions of parts of the package	20080822
2	CX_TRANSFORMATION_ERROR	☐	General Error When Performing CALL TRANSFORMATION	20080822

Method SAVE_ACTIVEX_DOCX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_GROUP_POS	Call by reference	☐	Type reference (TYPE)	STRING			20090430
2	Importing	IM_RID	Call by reference	☐	Type reference (TYPE)	STRING			20090430
3	Importing	IM_XSLT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20090430
4	Returning	RE_RID	Value transfer	☐	Type reference (TYPE)	STRING			20090430

Method SAVE_ACTIVEX_DOCX on class CL_XSL_DOCX has no exception.

Method SAVE_AFCHUNK_DOCX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MAIN_RID	Call by reference	☑	Type reference (TYPE)	STRING			20090121
2	Importing	IM_PART	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE_COLLECTION		IF_IXML_NODE_COLLECTION	20090115
3	Importing	IM_XSLT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20090115
4	Returning	RE_RID	Value transfer	☐	Type reference (TYPE)	STRING			20090115

Method SAVE_AFCHUNK_DOCX on class CL_XSL_DOCX has no exception.

Method SAVE_PART_DOCX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_HEIGHT	Call by reference	☐	Type reference (TYPE)	STRING			20090115
2	Exporting	EX_RID	Call by reference	☐	Type reference (TYPE)	STRING			20090115
3	Exporting	EX_WIDTH	Call by reference	☐	Type reference (TYPE)	STRING			20090115
4	Importing	IM_MAIN_RID	Call by reference	☑	Type reference (TYPE)	STRING			20090121
5	Importing	IM_PART	Call by reference	☐	Type reference (TYPE)	STRING			20090109
6	Importing	IM_PART_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20090109
7	Importing	IM_XSLT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20090109

Method SAVE_PART_DOCX on class CL_XSL_DOCX has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	711