Hierarchy
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_OPENXML_PART | OpenXML Part | 20071122 |
Properties
| Class | CL_DOCX_MAINDOCUMENTPART | |
| Short Description | OpenXML/docx Main Document | |
| Super Class | CL_OPENXML_PART | OpenXML Part |
| 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 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_DOCX_MAINDOCUMENTPART has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_OPENXML_PACKAGE | 20071122 | OpenXML Package | |
| 2 | CL_OPENXML_PART | 20071127 | OpenXML Part |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml' | Open Packaging Conventions - Content Type of a Part | 20071123 | ||
| 2 | Constant | Public | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | 'application/vnd.ms-word.document.macroEnabled.main+xml' | 20071127 | |||
| 3 | Constant | Public | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | 'application/vnd.ms-word.template.macroEnabledTemplate.main+xml' | 20071127 | |||
| 4 | Constant | Public | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | 'application/vnd.openxmlformats-officedocument.wordprocessingml.template.main+xml' | 20071127 | |||
| 5 | Constant | Public | Type reference (TYPE) | STRING | 'xml' | 20071123 | |||
| 6 | Constant | Public | Type reference (TYPE) | STRING | 'document' | 20071123 | |||
| 7 | Constant | Public | Type reference (TYPE) | STRING | 'word/' | 20071123 | |||
| 8 | Constant | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20071123 | |||
| 9 | Constant | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20071123 | |||
| 10 | Constant | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20071123 | |||
| 11 | Constant | Public | Type reference (TYPE) | OXA_OPC_RELATION_TYPE | 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' | 20071123 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | 20090109 | ||
| 2 | Instance method | Public | Method | Create the comments part and add it | 20071127 | |
| 3 | Instance method | Public | Method | Create a new customXml part and add it to this main document | 20071123 | |
| 4 | Instance method | Public | Method | Create the document settings part and add it | 20071123 | |
| 5 | Instance method | Public | Method | Create the endnotes part and add it | 20071126 | |
| 6 | Instance method | Public | Method | Create the font table part and add it | 20071126 | |
| 7 | Instance method | Public | Method | Create a new footer part and add it to this main document | 20071123 | |
| 8 | Instance method | Public | Method | Create the footnotes part and add it | 20071126 | |
| 9 | Instance method | Public | Method | Create the glossary document part and add it | 20071126 | |
| 10 | Instance method | Public | Method | Create a new header part and add it to this main document | 20071123 | |
| 11 | Instance method | Public | Method | Create a new image part and add it to this main document | 20071126 | |
| 12 | Instance method | Public | Method | Create the numbering definitions part and add it | 20071126 | |
| 13 | Instance method | Public | Method | Create the styles part and add it | 20071123 | |
| 14 | Instance method | Public | Method | Create the theme part and add it | 20071123 | |
| 15 | Instance method | Public | Method | Create the websettings part and add it | 20071126 | |
| 16 | Instance method | Public | Method | 20090109 | ||
| 17 | Instance method | Public | Method | Get comments part | 20071127 | |
| 18 | Instance method | Public | Method | Get all customXml parts | 20071123 | |
| 19 | Instance method | Public | Method | Get document settings part | 20071123 | |
| 20 | Instance method | Public | Method | Get endnotes part | 20071126 | |
| 21 | Instance method | Public | Method | Get font table part | 20071126 | |
| 22 | Instance method | Public | Method | Get all footer parts | 20071123 | |
| 23 | Instance method | Public | Method | Get footnotes part | 20071126 | |
| 24 | Instance method | Public | Method | Get glossary document part | 20071126 | |
| 25 | Instance method | Public | Method | Get all header parts | 20071123 | |
| 26 | Instance method | Public | Method | Get all image parts | 20071126 | |
| 27 | Instance method | Public | Method | Get numbering definitions part | 20071126 | |
| 28 | Instance method | Public | Method | Get styles part | 20071123 | |
| 29 | Instance method | Public | Method | Get theme part | 20071123 | |
| 30 | Instance method | Public | Method | Get web settings part | 20071126 |
Events
Class CL_DOCX_MAINDOCUMENTPART has no event.
Types
Class CL_DOCX_MAINDOCUMENTPART has no local type.
Method Signatures
Method ADD_ALTERNATIVEFORMATPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CONTENT_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | 20090109 | ||||
| 2 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_ALTERNATIVEFORMATPART | 20090109 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090109 |
Method ADD_COMMENTSPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_COMMENTSPART | 20071127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071127 |
Method ADD_CUSTOMXMLPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OXML_CUSTOMXMLPART | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 |
Method ADD_DOCUMENTSETTINGSPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_DOCUMENTSETTINGSPART | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 |
Method ADD_ENDNOTESPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_ENDNOTESPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method ADD_FONTTABLEPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_FONTTABLEPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method ADD_FOOTERPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_FOOTERPART | OpenXML/docx Footer Part | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Action is not allowed | 20071123 |
Method ADD_FOOTNOTESPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_FOOTNOTESPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method ADD_GLOSSARYPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_GLOSSARYPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method ADD_HEADERPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_HEADERPART | OpenXML/docx Header Part | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Action is not allowed | 20071123 |
Method ADD_IMAGEPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CONTENT_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | 20071126 | ||||
| 2 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OXML_IMAGEPART | OpenXML/docx Header Part | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method ADD_NUMBERINGPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_NUMBERINGPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method ADD_STYLESPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_STYLESPART | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 |
Method ADD_THEMEPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OXML_THEMEPART | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 |
Method ADD_WEBSETTINGSPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_WEBSETTINGSPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method GET_ALTERNATIVEFORMATPARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PARTS | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PARTCOLLECTION | 20090109 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090109 |
Method GET_COMMENTSPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_COMMENTSPART | 20071127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071127 | |||
| 2 | 20071127 |
Method GET_CUSTOMXMLPARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PARTS | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PARTCOLLECTION | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 |
Method GET_DOCUMENTSETTINGSPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_DOCUMENTSETTINGSPART | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 | |||
| 2 | 20071123 |
Method GET_ENDNOTESPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_ENDNOTESPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 | |||
| 2 | 20071126 |
Method GET_FONTTABLEPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_FONTTABLEPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 | |||
| 2 | 20071126 |
Method GET_FOOTERPARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PARTS | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PARTCOLLECTION | OpenXML Part Collection | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Packaging Error - Invalid Content | 20071123 |
Method GET_FOOTNOTESPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_FOOTNOTESPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 | |||
| 2 | 20071126 |
Method GET_GLOSSARYPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_GLOSSARYPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 | |||
| 2 | 20071126 |
Method GET_HEADERPARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PARTS | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PARTCOLLECTION | OpenXML Part Collection | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Packaging Error - Invalid Content | 20071123 |
Method GET_IMAGEPARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PARTS | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PARTCOLLECTION | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 |
Method GET_NUMBERINGPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_NUMBERINGPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 | |||
| 2 | 20071126 |
Method GET_STYLESPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_STYLESPART | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 | |||
| 2 | 20071123 |
Method GET_THEMEPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OXML_THEMEPART | 20071123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071123 | |||
| 2 | 20071123 |
Method GET_WEBSETTINGSPART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_DOCX_WEBSETTINGSPART | 20071126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20071126 | |||
| 2 | 20071126 |
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in | 711 |