SAP ABAP Class CL_DOCX_FORM (The docx form class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-I18 (Application Component) Internationalization (I18N)
     ⤷ S_OOXML_DOCX_FORM (Package) Docx and Form related

Properties

Class	CL_DOCX_FORM
Short Description	The docx form class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_OOXML_DOCX_FORM	Docx and Form related
Created	20080109	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_DOCX_FORM has no interface implemented.

Friends

Class CL_DOCX_FORM has no friend class.

Attributes

Class CL_DOCX_FORM has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONTAINS_CUSTOMXML	Static method	Private	Method	Checks docx form for customXML files	20080113
2	CREATE_FORM	Static method	Public	Method	Creates an empty docx form	20080109
3	CREATE_PDFPREVIEW	Static method	Public	Method	PDF preview	20080825
4	EXTRACT_TEXTS	Static method	Public	Method	Extracts all translation relevant texts	20080723
5	GET_XSD_FILE	Static method	Public	Method	Inserts the form context XSD schema as customXML file.	20080116
6	INSERT_XSD_FILE	Static method	Public	Method	Inserts the form context XSD schema as customXML file.	20080114
7	MERGE_DATA	Static method	Public	Method	Static method of merge form and custom XML data	20080110
8	MERGE_TEXTS	Static method	Public	Method	Merges text chunks according to their ID.	20080723
9	PRINT_DOCX	Static method	Public	Method	Print docx	20080825
10	REPLACE_XML_DATA_FILE	Static method	Public	Method	Inserts the data xml as customXML file.	20080114
11	RE_MERGE_DOCUMENT	Static method	Public	Method		20090826
12	SET_SAP_FORM_USER	Static method	Public	Method	Set SAP FORM CREATER USER in SETTINGS.XML	20100706
13	UPDATE_TRANSLATION	Static method	Public	Method	Updates the translated texts of s docx template	20080723
14	UPDATE_TRANSLATION_TAGS	Static method	Public	Method	Tags all translation relevant texts with unique ID.	20080723

Events

Class CL_DOCX_FORM has no event.

Types

Class CL_DOCX_FORM has no local type.

Method Signatures

Method CONTAINS_CUSTOMXML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CUSTOMXML_PROPS	Call by reference	☐	Type reference (TYPE)	XSTRING		The customXML propertoes file	20080113
2	Returning	FOUND	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080113
3	Importing	NAMESPACE	Call by reference	☐	Type reference (TYPE)	STRING		Default/target- namspace	20080113

Method CONTAINS_CUSTOMXML on class CL_DOCX_FORM has no exception.

Method CREATE_FORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOCX	Value transfer	☐	Type reference (TYPE)	XSTRING		The new docx form	20080109
2	Importing	FORM_CONTEXT	Call by reference	☑	Type reference (TYPE)	XSTRING		The form context schema file	20080109

#	Exception	Resumable	Description	Created on
1	CX_DOCX_FORM_NOT_UNICODE	☐	System must be unicode	20080110
2	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080114
3	CX_OPENXML_NOT_ALLOWED	☐	Action is not allowed	20080114
4	CX_OPENXML_NOT_FOUND	☐	Part not found	20080114

Method CREATE_PDFPREVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ERRSTRING	Call by reference	☐	Type reference (TYPE)	STRING		Use export first,later maybe change to one structure	20080825
2	Exporting	EX_NUMPAGES	Call by reference	☐	Type reference (TYPE)	INT4		Use export first,later maybe change to one structure	20080825
3	Exporting	EX_PDF_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING		Use export first,later maybe change to one structure	20080825
4	Importing	IM_DOCX_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080825

#	Exception	Resumable	Description	Created on
1	CX_DOCX_PDF_PREVIEW_ERR	☐	the PDF preview error	20080825

Method EXTRACT_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20080723
2	Returning	TEXTS	Value transfer	☐	Type reference (TYPE)	XSTRING			20080723

#	Exception	Resumable	Description	Created on
1	CX_DOCX_TRANSFORMATION_ERR	☐	XSLT transformation error	20080723
2	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080829
3	CX_OPENXML_NOT_FOUND	☐	Part not found	20080829

Method GET_XSD_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCX	Call by reference	☑	Type reference (TYPE)	XSTRING		DOCX form	20080116
2	Returning	XSD_FILE	Value transfer	☐	Type reference (TYPE)	XSTRING		The embedded form context	20080116

#	Exception	Resumable	Description	Created on
1	CX_DOCX_FORM_NOT_FOUND	☐	Object not found	20080116
2	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080116
3	CX_OPENXML_NOT_ALLOWED	☐	Action is not allowed	20080116
4	CX_OPENXML_NOT_FOUND	☐	Part not found	20080116

Method INSERT_XSD_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCX	Call by reference	☑	Type reference (TYPE)	XSTRING		DOCX form	20080114
2	Returning	DOCX_RESULT	Value transfer	☐	Type reference (TYPE)	XSTRING		Result file with embedded XSD schema	20080114
3	Importing	XSD_FILE	Call by reference	☐	Type reference (TYPE)	XSTRING		The form context or the data xml file	20080114

#	Exception	Resumable	Description	Created on
1	CX_DOCX_FORM_NOT_FOUND	☐	Object not found	20080114
2	CX_DOCX_FORM_NOT_UNICODE	☐	System must be unicode	20080114
3	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080114
4	CX_OPENXML_NOT_ALLOWED	☐	Action is not allowed	20080114
5	CX_OPENXML_NOT_FOUND	☐	Part not found	20080114

Method MERGE_DATA 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			20090826
2	Importing	IM_CUSTOMXML_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080110
3	Importing	IM_DELETE_SDT_TAGS	Call by reference	☐	Type reference (TYPE)	C	'R'	Y:Delete ContentControl; N:Keep them; R:Make them read-only.	20090903
4	Importing	IM_DEVCLASS	Call by reference	☐	Type reference (TYPE)	STRING	'$TMP'		20090826
5	Importing	IM_FORMTEMPLATE_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080110
6	Importing	IM_LANGUAGE	Call by reference	☑	Type reference (TYPE)	DBSPRAS			20090826
7	Returning	RE_MERGED_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20080110

#	Exception	Resumable	Description	Created on
1	CX_MERGE_PARTS	☐		20090826
2	CX_OPENXML_FORMAT	☐		20090826
3	CX_OPENXML_NOT_FOUND	☐		20090826

Method MERGE_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20080723
2	Returning	MERGED_DOCUMENT	Value transfer	☐	Type reference (TYPE)	XSTRING			20080723
3	Importing	TEXTS	Call by reference	☐	Type reference (TYPE)	XSTRING			20080723

#	Exception	Resumable	Description	Created on
1	CX_DOCX_TRANSFORMATION_ERR	☐	XSLT transformation error	20080723
2	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080829
3	CX_OPENXML_NOT_FOUND	☐	Part not found	20080829

Method PRINT_DOCX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ERRSTRING	Call by reference	☐	Type reference (TYPE)	STRING			20080825
2	Exporting	EX_NUMPAGES	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20080825
3	Exporting	EX_SPOOLID	Call by reference	☐	Type reference (TYPE)	RSPOID		Spool request number	20080825
4	Importing	IM_AUTH	Call by reference	☑	Type reference (TYPE)	RSPOAUTH		Department	20080825
5	Importing	IM_COPIES	Call by reference	☑	Type reference (TYPE)	RSPOCOPIES		Spool: Output Device	20080825
6	Importing	IM_COVERPAGE	Call by reference	☑	Type reference (TYPE)	C		Value for authorization check	20080825
7	Importing	IM_DELETE	Call by reference	☐	Type reference (TYPE)	RSPO2DISPO	SPACE	Print immediately or later	20080825
8	Importing	IM_DIVISION	Call by reference	☑	Type reference (TYPE)	RSPODIVISI		Spool: Recipient of spool request	20080825
9	Importing	IM_DOCX_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20080825
10	Importing	IM_FINAL	Call by reference	☐	Type reference (TYPE)	RSPOFINAL	SPACE	Delete spool request automatically	20080825
11	Importing	IM_IMMED	Call by reference	☐	Type reference (TYPE)	RSPO1DISPO	SPACE	Print immediately or later	20080825
12	Importing	IM_LIFETIME	Call by reference	☐	Type reference (TYPE)	C	'8'	Spool request completed	20080825
13	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	RSPO0NAME	'DOCx'	Number of copies	20080825
14	Importing	IM_NEWID	Call by reference	☑	Type reference (TYPE)	C		Spool request: Suffix 2	20080825
15	Importing	IM_PRINTER	Call by reference	☐	Type reference (TYPE)	RSPOPNAME			20080825
16	Importing	IM_RECEIVER	Call by reference	☑	Type reference (TYPE)	RSPORECEIV		Title of a spool request	20080825
17	Importing	IM_SUFFIX1	Call by reference	☑	Type reference (TYPE)	RSPO1NAME		Spool request: Name	20080825
18	Importing	IM_SUFFIX2	Call by reference	☑	Type reference (TYPE)	RSPO2NAME		Spool request: Suffix 1	20080825
19	Importing	IM_TITLE	Call by reference	☑	Type reference (TYPE)	RSPOTITLE		Title of a spool request	20080825

#	Exception	Resumable	Description	Created on
1	CX_DOCX_PRINT_ERROR	☐	print error	20080825

Method REPLACE_XML_DATA_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCX	Call by reference	☐	Type reference (TYPE)	XSTRING		DOCX form	20080114
2	Returning	DOCX_RESULT	Value transfer	☐	Type reference (TYPE)	XSTRING		Result file with embedded XML data	20080114
3	Importing	XML_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING		The xml data	20080114

#	Exception	Resumable	Description	Created on
1	CX_DOCX_FORM_NOT_FOUND	☐	Object not found	20080114
2	CX_DOCX_FORM_NOT_UNICODE	☐	System must be unicode	20080114
3	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080114
4	CX_OPENXML_NOT_FOUND	☐	Part not found	20080114

Method RE_MERGE_DOCUMENT 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			20090826
2	Importing	IM_DOCX_DOCUMENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20090826
3	Importing	IM_DOCX_NEW_CHANGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20090826
4	Importing	IM_LANGUAGE	Call by reference	☑	Type reference (TYPE)	DBSPRAS			20090826
5	Returning	RE_MERGED_DOCUMENT	Value transfer	☐	Type reference (TYPE)	XSTRING			20090826

Method RE_MERGE_DOCUMENT on class CL_DOCX_FORM has no exception.

Method SET_SAP_FORM_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCX	Call by reference	☐	Type reference (TYPE)	XSTRING			20100706
2	Importing	IM_USER	Call by reference	☐	Type reference (TYPE)	STRING	''		20100706
3	Returning	RE_DOCX	Value transfer	☐	Type reference (TYPE)	XSTRING			20100706

#	Exception	Resumable	Description	Created on
1	CX_DOCX_TRANSFORMATION_ERR	☐		20100706

Method UPDATE_TRANSLATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_DOCX_TEMPL	Call by reference	☐	Type reference (TYPE)	XSTRING		Docx template to be updated.	20080811
2	Importing	OLD_DOCX_TEMPL	Call by reference	☐	Type reference (TYPE)	XSTRING		Old translated copy of Docx template in target language	20080724
3	Returning	UPD_DOCX_TEMPL	Value transfer	☐	Type reference (TYPE)	XSTRING		Updated copy of docx template	20080723

#	Exception	Resumable	Description	Created on
1	CX_DOCX_TRANSFORMATION_ERR	☐	XSLT transformation error	20080723
2	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080829
3	CX_OPENXML_NOT_FOUND	☐	Part not found	20080829

Method UPDATE_TRANSLATION_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DOCX_TEMPLATE	Call by reference	☐	Type reference (TYPE)	XSTRING		Docx template in original language to be tagged.	20080723

#	Exception	Resumable	Description	Created on
1	CX_DOCX_TRANSFORMATION_ERR	☐	CX_OPENXML_TRANS_ERR	20080723
2	CX_OPENXML_FORMAT	☐	Packaging Error - Invalid Content	20080829
3	CX_OPENXML_NOT_FOUND	☐	Part not found	20080829

History

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