SAP ABAP Class CL_XPS_DOCUMENT (OpenXML/xps Package)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-I18 (Application Component) Internationalization (I18N)
     ⤷ S_OOXML_XPS (Package) Support for XML Paper Specification
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_OPENXML_PACKAGE OpenXML Package 20071128
Properties
Class CL_XPS_DOCUMENT  
Short Description OpenXML/xps 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_XPS   Support for XML Paper Specification 
Created 20071128   SAP 
Last change 20090618   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_XPS_DOCUMENT has no forward declaration.
Interfaces
Class CL_XPS_DOCUMENT has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_OPENXML_PART 20071129 OpenXML Part
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.ms-xpsdocument' Content Type of a Part (e.g application/xml) 20071128
2 XPS_DOCREF_TABLE Instance attribute Private Type reference (TYPE) TY_XPS_DOCREF_TABLE 20071217
3 XPS_DOCREF_TABLE_IDX700 Instance attribute Private Type reference (TYPE) TY_XPS_DOCREF_TABLE_IDX700 20071217
Methods
# Method Level Visibility Method type Description Created on
1 ADD_FIXEDDOCSEQUENCEPART Instance method Public Method Create the fixed document sequence part 20071128
2 CREATE_DOCUMENT Static method Public Method Create new package 20071128
3 DELEGATE_ADD_FIXEDDOCUMENTPART Instance method Protected Method (Reuse/Delegation) Create a new fixed document part 20071129
4 DELEGATE_ADD_FIXEDPAGEPART Instance method Protected Method (Reuse/Delegation) Create a new fixed page part 20071129
5 DELEGATE_GET_FIXEDDOCUMENTS Instance method Protected Method (Reuse/Delegation) Get all fixed document parts 20071129
6 DELEGATE_GET_FIXEDPAGEPARTS Instance method Protected Method (Reuse/Delegation) Get all fixed page parts 20071129
7 GET_FIXEDDOCSEQUENCEPART Instance method Public Method Get fixed document sequence part 20071128
8 LOAD_DOCUMENT Static method Public Method Load package 20071128
9 LOAD_XPS_DATA Instance method Protected Method Load xps data (fixed doc seq and fixed doc) 20071128
10 SAVE_XPS_DATA Instance method Protected Method Save xps data (fixed doc seq and fixed doc) 20071129
Events
Class CL_XPS_DOCUMENT has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_XPS_DOCREF Private See coding 20071129 begin of TY_XPS_DOCREF, index TYPE i, partname TYPE oxa_opc_part_name, pages TYPE ty_xps_pageref_table, end of TY_XPS_DOCREF
2 TY_XPS_DOCREF_IDX700 Private See coding 20071217 begin of TY_XPS_DOCREF_IDX700, partname TYPE oxa_opc_part_name, index TYPE i, end of TY_XPS_DOCREF_IDX700
3 TY_XPS_DOCREF_TABLE Private See coding 20071129 TY_XPS_DOCREF_TABLE TYPE SORTED TABLE OF ty_xps_docref WITH UNIQUE KEY index WITH UNIQUE HASHED KEY namekey COMPONENTS partname
4 TY_XPS_DOCREF_TABLE700 Private See coding 20071217 TY_XPS_DOCREF_TABLE700 TYPE SORTED TABLE OF ty_xps_docref WITH UNIQUE KEY index
5 TY_XPS_DOCREF_TABLE_IDX700 Private See coding 20071217 TY_XPS_DOCREF_TABLE_IDX700 TYPE HASHED TABLE OF ty_xps_docref_idx700 WITH UNIQUE KEY partname
6 TY_XPS_PAGELINK Private See coding 20071129 begin of TY_XPS_PAGELINK, name TYPE string, end of TY_XPS_PAGELINK
7 TY_XPS_PAGELINK_TABLE Private See coding 20071129 TY_XPS_PAGELINK_TABLE TYPE SORTED TABLE OF ty_xps_pagelink WITH UNIQUE KEY name
8 TY_XPS_PAGEREF Private See coding 20071129 begin of TY_XPS_PAGEREF, index TYPE i, partname TYPE oxa_opc_part_name, links TYPE ty_xps_pagelink_table, end of TY_XPS_PAGEREF
9 TY_XPS_PAGEREF_TABLE Private See coding 20071129 TY_XPS_PAGEREF_TABLE TYPE SORTED TABLE OF ty_xps_pageref WITH UNIQUE KEY index WITH UNIQUE HASHED KEY namekey COMPONENTS partname
10 TY_XPS_PAGEREF_TABLE700 Private See coding 20071217 TY_XPS_PAGEREF_TABLE700 TYPE SORTED TABLE OF ty_xps_pageref WITH UNIQUE KEY index
Method Signatures

Method ADD_FIXEDDOCSEQUENCEPART 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_XPS_FIXEDDOCSEQUENCEPART 20071128
# Exception Resumable Description Created on
1 CX_OPENXML_NOT_ALLOWED 20071128

Method CREATE_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_DOC Value transfer Object reference (TYPE REF TO) CL_XPS_DOCUMENT OpenXML/docx package 20071128

Method CREATE_DOCUMENT on class CL_XPS_DOCUMENT has no exception.

Method DELEGATE_ADD_FIXEDDOCUMENTPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_PARTURI Call by reference Object reference (TYPE REF TO) CL_OPENXML_PARTURI 20071129
2 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_XPS_FIXEDDOCUMENTPART 20071129
# Exception Resumable Description Created on
1 CX_OPENXML_NOT_ALLOWED 20071129

Method DELEGATE_ADD_FIXEDPAGEPART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_PARTURI Call by reference Object reference (TYPE REF TO) CL_OPENXML_PARTURI 20071129
2 Returning RR_PART Value transfer Object reference (TYPE REF TO) CL_XPS_FIXEDPAGEPART 20071129
# Exception Resumable Description Created on
1 CX_OPENXML_NOT_ALLOWED 20071129

Method DELEGATE_GET_FIXEDDOCUMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_PARTS Value transfer Object reference (TYPE REF TO) CL_OPENXML_PARTCOLLECTION 20071129
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT 20071129

Method DELEGATE_GET_FIXEDPAGEPARTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_PARTURI Call by reference Object reference (TYPE REF TO) CL_OPENXML_PARTURI 20071129
2 Returning RR_PARTS Value transfer Object reference (TYPE REF TO) CL_OPENXML_PARTCOLLECTION 20071129
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT 20071129

Method GET_FIXEDDOCSEQUENCEPART 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_XPS_FIXEDDOCSEQUENCEPART 20071128
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT 20071128
2 CX_OPENXML_NOT_FOUND 20071128

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 20071128
2 Returning RR_DOC Value transfer Object reference (TYPE REF TO) CL_XPS_DOCUMENT OpenXML/docx package 20071128
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT Not a valid OpenXML/OPC Package 20071128

Method LOAD_XPS_DATA Signature

Method LOAD_XPS_DATA on class CL_XPS_DOCUMENT has no parameter.
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT Packaging Error - Invalid Content 20071129

Method SAVE_XPS_DATA Signature

Method SAVE_XPS_DATA on class CL_XPS_DOCUMENT has no parameter.
# Exception Resumable Description Created on
1 CX_OPENXML_FORMAT Packaging Error - Invalid Content 20080102
History
Last changed by/on SAP  20090618 
SAP Release Created in 711