SAP ABAP Class CL_DOCX_DOCUMENT (OpenXML/docx Package)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-I18 (Application Component) Internationalization (I18N)
     ⤷ S_OOXML_DOCX (Package) OpenXML/docx support
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_OPENXML_PACKAGE OpenXML Package 20071122
Properties
Class CL_DOCX_DOCUMENT  
Short Description OpenXML/docx Package    
Super Class CL_OPENXML_PACKAGE OpenXML Package 
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_OOXML_DOCX   OpenXML/docx support 
Created 20071122   SAP 
Last change 20090618   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_DOCUMENT has no interface implemented.
Friends
Class CL_DOCX_DOCUMENT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_CONTENT_TYPE Constant Public Type reference (TYPE) OXA_OPC_CONTENT_TYPE 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' Content Type of a Part (e.g application/xml) 20071127
2 CO_CONTENT_TYPE_MACRO Constant Public Type reference (TYPE) OXA_OPC_CONTENT_TYPE 'application/vnd.ms-word.document.macroEnabled.12' 20071127
3 CO_CONTENT_TYPE_MACROTEMPLATE Constant Public Type reference (TYPE) OXA_OPC_CONTENT_TYPE 'application/vnd.ms-word.template.macroEnabled.12' 20071127
4 CO_CONTENT_TYPE_TEMPLATE Constant Public Type reference (TYPE) OXA_OPC_CONTENT_TYPE 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' 20071127
Methods
# Method Level Visibility Method type Description Created on
1 ADD_CUSTOMPROPERTIESPART Instance method Public Method Create the custom properties part 20071123
2 ADD_CUSTOMUIPART Instance method Public Method Create the custom ui part 20080718
3 ADD_EXTENDEDPROPERTIESPART Instance method Public Method Create the extended properties part 20071123
4 ADD_MAINDOCUMENTPART Instance method Public Method Create the main document part and add it to this document 20071122
5 CREATE_DOCUMENT Static method Public Method Create new package 20071122
6 GET_CUSTOMPROPERTIESPART Instance method Public Method Get custom properties part 20071123
7 GET_CUSTOMUIPART Instance method Public Method Get custom ui part 20080718
8 GET_EXTENDEDPROPERTIESPART Instance method Public Method Get extended properties part 20071123
9 GET_MAINDOCUMENTPART Instance method Public Method Get main document part 20071122
10 LOAD_DOCUMENT Static method Public Method Load package 20071122
Events
Class CL_DOCX_DOCUMENT has no event.
Types
Class CL_DOCX_DOCUMENT has no local type.
Method Signatures

Method ADD_CUSTOMPROPERTIESPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_OXML_CUSTOMPROPERTIESPART OpenXML/docx Custom Properties Part 20071123
# Exception Resumable Description Created on
1 CX_OPENXML_NOT_ALLOWED Action is not allowed 20071123

Method ADD_CUSTOMUIPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_OXML_CUSTOMUIPART 20080718
# Exception Resumable Description Created on
1 CX_OPENXML_NOT_ALLOWED 20080718

Method ADD_EXTENDEDPROPERTIESPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_OXML_EXTENDEDPROPERTIESPART OpenXML/docx Extended Properties Part 20071123
# Exception Resumable Description Created on
1 CX_OPENXML_NOT_ALLOWED Action is not allowed 20071123

Method ADD_MAINDOCUMENTPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_DOCX_MAINDOCUMENTPART OpenXML/docx Main Document 20071123
# Exception Resumable Description Created on
1 CX_OPENXML_NOT_ALLOWED There is already a main document part 20071122

Method CREATE_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_EMPTY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20080108
2 Returning RR_DOC Value transfer Object reference (TYPE REF TO) CL_DOCX_DOCUMENT OpenXML/docx package 20071122

Method CREATE_DOCUMENT on class CL_DOCX_DOCUMENT has no exception.

Method GET_CUSTOMPROPERTIESPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_OXML_CUSTOMPROPERTIESPART OpenXML/docx Custom Properties Part 20071123
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT Packaging Error - Invalid Content 20071123
2 CX_OPENXML_NOT_FOUND Part not found 20071123

Method GET_CUSTOMUIPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_OXML_CUSTOMUIPART 20080718
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT 20080718
2 CX_OPENXML_NOT_FOUND 20080718

Method GET_EXTENDEDPROPERTIESPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_OXML_EXTENDEDPROPERTIESPART OpenXML/docx Extended Properties Part 20071123
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT Packaging Error - Invalid Content 20071123
2 CX_OPENXML_NOT_FOUND Part not found 20071123

Method GET_MAINDOCUMENTPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_DOCX_MAINDOCUMENTPART OpenXML/docx Main Document 20071123
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT Not a valid OpenXML/OPC Package 20071123
2 CX_OPENXML_NOT_FOUND Part not found 20071122

Method LOAD_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DATA Call by reference Type reference (TYPE) XSTRING 20071122
2 Returning RR_DOC Value transfer Object reference (TYPE REF TO) CL_DOCX_DOCUMENT OpenXML/docx package 20071122
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT Not a valid OpenXML/OPC Package 20071122
History
Last changed by/on SAP  20090618 
SAP Release Created in 711