SAP ABAP Class /IPRO/CL_DOCX_UTILITIES (Docx utilities)
Hierarchy
SAP_BS_FND (Software Component) SAP Business Suite Foundation
   CA-GTF-DOB (Application Component) Document Builder
     /IPRO/PROGS (Package) programs
Properties
Class /IPRO/CL_DOCX_UTILITIES  
Short Description Docx utilities    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package /IPRO/PROGS   programs 
Created 20100610   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class /IPRO/CL_DOCX_UTILITIES has no forward declaration.
Interfaces
Class /IPRO/CL_DOCX_UTILITIES has no interface implemented.
Friends
Class /IPRO/CL_DOCX_UTILITIES has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 IXML Static Attribute Protected Object reference (TYPE REF TO) IF_IXML IF_IXML 20100610
2 MC_START_ID Constant Private Type reference (TYPE) STRING '900000' 20120502
3 MT_ELM_BASE_LIST_STYLE Static Attribute Public Type reference (TYPE) TTY_ELM_BASE_LISTSTYLE 20120619
4 MT_ELM_LIST_DETAILS Static Attribute Public Type reference (TYPE) TTY_ELM_LIST_DETAILS 20120619
5 MT_HEADFOOT_REL_MAP_TABLE Static Attribute Public Type reference (TYPE) /IPRO/TT_HEADFOOT_REL_MAP Table for header/footer relation mapping tab 20100610
6 MT_HYPERLINK_IDS Static Attribute Public Type reference (TYPE) /IPRO/TT_KEY_VALUE_PAIR Table of key value pairs 20120227
7 MT_LINKED_STYLES Static Attribute Public Type reference (TYPE) TTY_STRING Table for string data 20100610
8 MT_LISTSTYLEIDS Static Attribute Public Type reference (TYPE) /IPRO/TT_KEY_VALUE_PAIR 20120502
9 MT_LISTSTYLENUMIDS Static Attribute Public Type reference (TYPE) /IPRO/TT_KEY_VALUE_PAIR 20120502
10 MT_LISTSTYLE_ABSTRACT_NUMIDS Static Attribute Public Type reference (TYPE) /IPRO/TT_KEY_VALUE_PAIR 20120502
11 MT_OVERLAY_STYLES Static Attribute Private Type reference (TYPE) TTY_STRING Table of key value pairs 20120607
12 MT_STYLE_NAMES Static Attribute Public Type reference (TYPE) /IPRO/TT_KEY_VALUE_PAIR Table for key value pair 20100610
13 MV_ELM_CUSTOMXML Static Attribute Public Type reference (TYPE) XSTRING The custom xml part of current element 20120206
14 M_ADDIN_SCHEMA Static Attribute Public Type reference (TYPE) STRING Addin schema for creating the tree structure in the addin 20111117
15 STREAM_FACTORY Static Attribute Protected Object reference (TYPE REF TO) IF_IXML_STREAM_FACTORY IF_IXML_STREAM_FACTORY 20100610
16 XSLTP Static Attribute Protected Object reference (TYPE REF TO) CL_XSLT_PROCESSOR XSLT processor 20100610
Methods
# Method Level Visibility Method type Description Created on
1 ADD_OVERLAY_CUSTOM_STYLES Static method Public Method Add overlay custom styles 20120611
2 ADD_STYLES_FROM_SYSTEM_OVERLAY Static method Public Method Replace styles in docx document with the overlay styles 20120601
3 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR 20100610
4 CLEAR_BASE_AND_ELM_LISTSTYLES Static method Public Method Clear the base liststyle and element list details table 20120619
5 CLEAR_HYPERLINK_IDS Static method Public Method Clear the hyperlink table 20120227
6 CLEAR_LISTSTYLE_INFO Static method Public Method 20120502
7 CLEAR_OVERLAY_CUSTOM_STYLES Static method Public Method Clear overlay style tables 20120611
8 CLEAR_STYLE_NAMES Static method Public Method clear style names 20100610
9 CLOSE_TAG Static method Public Method Closes the tag 20111117
10 COUNT Static method Public Method count 20100610
11 CREATE_ADDIN_SCHEMA_FROM_SIM Static method Public Method Creates the tags to represent simple in the add-in schema 20111117
12 CREATE_ADDIN_SCHEMA_FROM_STRUC Static method Public Method Creates the tags to represent structure in the add-in schema 20111117
13 CREATE_ADDIN_SCHEMA_FROM_TAB Static method Public Method Creates the tags to represent table in the add-in schema 20111117
14 CREATE_TAG Static method Public Method Creates the tag 20111117
15 GET_ATTRNAME_FOR_UUID Static method Public Method Gets the attribute name for a UUID from the custom xml file 20120206
16 GET_BASE_LIST_NUMID Static method Public Method Gets the numID of the base list style being processed 20120619
17 GET_EMPTY_WORD07_DOC Static method Public Method Get empty docx document 20100610
18 GET_NEW_HYPERLINK_ID Static method Public Method Get the new hyperlink id from the table 20120227
19 GET_NEW_LISTSTYLE_IDS Static method Public Method 20120502
20 GET_NEW_LISTSTYLE_NUMIDS Static method Public Method 20120502
21 GET_NEW_LIST_ABSTRACT_NUMIDS Static method Public Method 20120502
22 GET_NEW_STYLESNAMES Static method Public Method get new stylenames 20100610
23 IS_IN_OVERLAY_CUSTOM_STYLES Static method Public Method Check if style is present in overaly custom styles 20120611
24 SET_BASE_LISTSTYLE Static method Public Method Set base liststyle numid for a list style being used in elem 20120619
25 SET_ELM_LISTABNUMID_IN_DETAILS Static method Public Method Gather styleid, abstract num id of secondary list styles 20120619
26 SET_ELM_LISTNUMID_IN_DETAILS Static method Public Method Gather styleid, num id of secondary list styles 20120619
27 SET_HEADFOOT_RELS Static method Public Method Set header/footer relation mapping table 20100610
28 SET_HYPERLINK_IDS Static method Public Method Collects old hyperlink id/new hyperlink id from element text 20120227
29 SET_LISTSTYLE_ABSTRACT_NUMIDS Static method Public Method 20120502
30 SET_LISTSTYLE_IDS Static method Public Method 20120502
31 SET_LISTSTYLE_NUMIDS Static method Public Method 20120502
32 SET_STYLE_NAMES Static method Public Method Set style names 20100610
33 TRANSFORM Static method Public Method Call transformation 20100610
34 UPDATE_ADDIN_SCHEMA_IN_DOCX Static method Public Method Update the addin schema in the docx document 20120605
Events
Class /IPRO/CL_DOCX_UTILITIES has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LTY_ELM_BASE_LISTSTYLE Public See coding 20120619 BEGIN OF lty_elm_base_liststyle, id TYPE string, base_numid TYPE string, END OF lty_elm_base_liststyle
2 LTY_ELM_LIST_DETAILS Public See coding 20120619 BEGIN OF lty_elm_list_details, id TYPE string, abstract_numid TYPE string, numid TYPE string, END OF lty_elm_list_details
3 LTY_TEXT Public See coding 20120601 BEGIN OF lty_text, rec TYPE /ipro/ttext_t, flag(1) TYPE c, END OF lty_text
4 STRUCT_STRING Public See coding 20100610 BEGIN OF struct_string, str_data TYPE string, END OF struct_string
5 TTY_ELM_BASE_LISTSTYLE Public See coding 20120619 tty_elm_base_liststyle TYPE STANDARD TABLE OF lty_elm_base_liststyle
6 TTY_ELM_LIST_DETAILS Public See coding 20120619 tty_elm_list_details TYPE STANDARD TABLE OF lty_elm_list_details
7 TTY_STRING Public See coding 20100610 tty_string TYPE STANDARD TABLE OF struct_string
Method Signatures

Method ADD_OVERLAY_CUSTOM_STYLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_STYLE_NAME Call by reference Type reference (TYPE) STRING 20120611

Method ADD_OVERLAY_CUSTOM_STYLES on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method ADD_STYLES_FROM_SYSTEM_OVERLAY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CX_DOCX Call by reference Type reference (TYPE) XSTRING Docx document 20120601
2 Importing IV_CONTENT Call by reference Type reference (TYPE) /IPRO/CONTENT Content 20120601
# Exception Resumable Description Created on
1 OPENXML_DOCX_CANNOT_OPEN OpenXML error: Docx document cannot be opened 20120601
2 SYS_OVERLAY_NOT_CONFIGURED System overlay is not configured 20120601
3 SYS_OVERLAY_TEXT_MISSING System overlay text is missing 20120601
4 ZIP_DOCX_CANNOT_OPEN ZIP error: Docx document cannot be opened 20120601

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /IPRO/CL_DOCX_UTILITIES has no parameter.
Method CLASS_CONSTRUCTOR on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CLEAR_BASE_AND_ELM_LISTSTYLES Signature

Method CLEAR_BASE_AND_ELM_LISTSTYLES on class /IPRO/CL_DOCX_UTILITIES has no parameter.
Method CLEAR_BASE_AND_ELM_LISTSTYLES on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CLEAR_HYPERLINK_IDS Signature

Method CLEAR_HYPERLINK_IDS on class /IPRO/CL_DOCX_UTILITIES has no parameter.
Method CLEAR_HYPERLINK_IDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CLEAR_LISTSTYLE_INFO Signature

Method CLEAR_LISTSTYLE_INFO on class /IPRO/CL_DOCX_UTILITIES has no parameter.
Method CLEAR_LISTSTYLE_INFO on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CLEAR_OVERLAY_CUSTOM_STYLES Signature

Method CLEAR_OVERLAY_CUSTOM_STYLES on class /IPRO/CL_DOCX_UTILITIES has no parameter.
Method CLEAR_OVERLAY_CUSTOM_STYLES on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CLEAR_STYLE_NAMES Signature

Method CLEAR_STYLE_NAMES on class /IPRO/CL_DOCX_UTILITIES has no parameter.
Method CLEAR_STYLE_NAMES on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CLOSE_TAG Signature

Method CLOSE_TAG on class /IPRO/CL_DOCX_UTILITIES has no parameter.
Method CLOSE_TAG on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method COUNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20100610

Method COUNT on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CREATE_ADDIN_SCHEMA_FROM_SIM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VAR Call by reference Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE Interface to document builder variable 20111117

Method CREATE_ADDIN_SCHEMA_FROM_SIM on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CREATE_ADDIN_SCHEMA_FROM_STRUC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VAR Call by reference Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE Interface to document builder variable 20111117
2 Importing IV_IS_IN_TAB Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20111117
3 Importing IV_IS_ROOT Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20111117

Method CREATE_ADDIN_SCHEMA_FROM_STRUC on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CREATE_ADDIN_SCHEMA_FROM_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VAR Call by reference Object reference (TYPE REF TO) /IPRO/IF_DOCB_VARIABLE Interface to document builder variable 20111117

Method CREATE_ADDIN_SCHEMA_FROM_TAB on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method CREATE_TAG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LABEL Call by reference Type reference (TYPE) STRING 20111117
2 Importing IV_NAME Call by reference Type reference (TYPE) STRING 20111117
3 Importing IV_TYPE Call by reference Type reference (TYPE) STRING 20111117

Method CREATE_TAG on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_ATTRNAME_FOR_UUID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_UUID Call by reference Type reference (TYPE) STRING UUID 20120206
2 Returning RV_ATTR_NAME Value transfer Type reference (TYPE) STRING 20120206

Method GET_ATTRNAME_FOR_UUID on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_BASE_LIST_NUMID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NUMID Call by reference Type reference (TYPE) STRING 20120622
2 Returning RV_BASE_NUMID Value transfer Type reference (TYPE) STRING 20120619

Method GET_BASE_LIST_NUMID on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_EMPTY_WORD07_DOC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DOCX Value transfer Type reference (TYPE) XSTRING 20100610

Method GET_EMPTY_WORD07_DOC on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_NEW_HYPERLINK_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OLD_RID Call by reference Type reference (TYPE) STRING 20120227
2 Returning RV_NEW_RID Value transfer Type reference (TYPE) STRING 20120227

Method GET_NEW_HYPERLINK_ID on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_NEW_LISTSTYLE_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LISTSTYLE_ID Call by reference Type reference (TYPE) STRING 20120502
2 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20120502

Method GET_NEW_LISTSTYLE_IDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_NEW_LISTSTYLE_NUMIDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LISTNUMID Call by reference Type reference (TYPE) STRING 20120502
2 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20120502

Method GET_NEW_LISTSTYLE_NUMIDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_NEW_LIST_ABSTRACT_NUMIDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LISTABNUMID Call by reference Type reference (TYPE) STRING 20120502
2 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20120502

Method GET_NEW_LIST_ABSTRACT_NUMIDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method GET_NEW_STYLESNAMES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_STYLE_NAME Call by reference Type reference (TYPE) STRING 20100610
2 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20100610

Method GET_NEW_STYLESNAMES on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method IS_IN_OVERLAY_CUSTOM_STYLES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_STYLE_NAME Call by reference Type reference (TYPE) STRING 20120611
2 Returning RV_EXISTS Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20120611

Method IS_IN_OVERLAY_CUSTOM_STYLES on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_BASE_LISTSTYLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BASE_NUMID Call by reference Type reference (TYPE) STRING 20120619
2 Importing IV_STYLE_NAME Call by reference Type reference (TYPE) STRING 20120619

Method SET_BASE_LISTSTYLE on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_ELM_LISTABNUMID_IN_DETAILS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ABNUMID Call by reference Type reference (TYPE) STRING 20120619
2 Importing IV_STYLE_NAME Call by reference Type reference (TYPE) STRING 20120619

Method SET_ELM_LISTABNUMID_IN_DETAILS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_ELM_LISTNUMID_IN_DETAILS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ABNUMID Call by reference Type reference (TYPE) STRING 20120622
2 Importing IV_NUMID Call by reference Type reference (TYPE) STRING 20120619
3 Importing IV_STYLE_NAME Call by reference Type reference (TYPE) STRING 20120619

Method SET_ELM_LISTNUMID_IN_DETAILS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_HEADFOOT_RELS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CATEGORY Call by reference Type reference (TYPE) STRING Relation category 20100610
2 Importing IV_OLD_RLD Call by reference Type reference (TYPE) STRING Old relation id 20100610
3 Importing IV_TYPE Call by reference Type reference (TYPE) STRING relation type 20100610
4 Exporting RV_VALUE Call by reference Type reference (TYPE) STRING new relation id 20100610

Method SET_HEADFOOT_RELS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_HYPERLINK_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ELM_NAME Call by reference Type reference (TYPE) STRING 20120406
2 Importing IV_OLD_RID Call by reference Type reference (TYPE) STRING 20120227
3 Returning RV_NEW_RID Value transfer Type reference (TYPE) STRING 20120406

Method SET_HYPERLINK_IDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_LISTSTYLE_ABSTRACT_NUMIDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INDEX Call by reference Type reference (TYPE) STRING 20120502
2 Importing IV_LISTSTYLE_ABSTRACT_NUMID Call by reference Type reference (TYPE) STRING 20120502
3 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20120502

Method SET_LISTSTYLE_ABSTRACT_NUMIDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_LISTSTYLE_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INDEX Call by reference Type reference (TYPE) STRING 20120502
2 Importing IV_LISTSTYLE_ID Call by reference Type reference (TYPE) STRING 20120502
3 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20120502

Method SET_LISTSTYLE_IDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_LISTSTYLE_NUMIDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INDEX Call by reference Type reference (TYPE) STRING 20120502
2 Importing IV_LISTSTYLE_NUMID Call by reference Type reference (TYPE) STRING 20120502
3 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20120502

Method SET_LISTSTYLE_NUMIDS on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method SET_STYLE_NAMES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INDEX Call by reference Type reference (TYPE) STRING 20100610
2 Importing IV_IS_LINK Call by reference Type reference (TYPE) STRING 20100610
3 Importing IV_STYLE_NAME Call by reference Type reference (TYPE) STRING 20100610
4 Returning RV_VALUE Value transfer Type reference (TYPE) STRING 20100610

Method SET_STYLE_NAMES on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method TRANSFORM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_MESSAGE Call by reference Type reference (TYPE) STRING 20100610
2 Exporting EV_RESULT Call by reference Type reference (TYPE) XSTRING 20100610
3 Exporting EV_RET Call by reference Type reference (TYPE) I 20100610
4 Importing IT_PARAMETERS Call by reference Type reference (TYPE) /IPRO/TT_KEY_VALUE_PAIR Table of key value pairs 20100610
5 Importing IV_INPUT_STRING Call by reference Type reference (TYPE) STRING 20100610
6 Importing IV_INPUT_XSTRING Call by reference Type reference (TYPE) XSTRING 20100610
7 Importing IV_TRANSFORM_NAME Call by reference Type reference (TYPE) STRING 20100610

Method TRANSFORM on class /IPRO/CL_DOCX_UTILITIES has no exception.

Method UPDATE_ADDIN_SCHEMA_IN_DOCX Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CX_DOCX_DOC Call by reference Type reference (TYPE) XSTRING Docx document 20120605
2 Importing IV_CONTENT Call by reference Type reference (TYPE) /IPRO/CONTENT Content 20120605
# Exception Resumable Description Created on
1 CONTENT_CONTROLS_NOT_UPDATED Error while updating the content controls 20120605
History
Last changed by/on SAP  20130531 
SAP Release Created in 703