SAP ABAP Class CL_KW_DOCUMENT (Document Class)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-KPR-DMF (Application Component) Document Management Framework
⤷
SKWV (Package) Knowledge Warehouse: Visual Components
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_KW_AUTOMATION_OBJECT_USE | For Internal Use | 20000316 |
Properties
| Class | CL_KW_DOCUMENT | |
| Short Description | Document Class | |
| Super Class | CL_KW_AUTOMATION_OBJECT_USE | For Internal Use |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SKWV | Knowledge Warehouse: Visual Components |
| Created | 19991220 | SAP |
| Last change | 20000620 | 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) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_KW_DOCUMENT has no interface implemented.
Friends
Class CL_KW_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | I | 4 | 20001114 | |||
| 2 | Constant | Public | Type reference (TYPE) | I | 1 | 20001114 | |||
| 3 | Constant | Public | Type reference (TYPE) | I | 2 | 20001114 | |||
| 4 | Constant | Public | Type reference (TYPE) | I | 1 | Dispatch ID of Event on the Client | 19991220 | ||
| 5 | Instance attribute | Public | Type reference (TYPE) | CHAR255 | Complete File Name | 19991220 | |||
| 6 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_KW_HYPERLINKS | Hyperlink Collection | 20000406 | |||
| 7 | Instance attribute | Public | Type reference (TYPE) | CHAR255 | Mimetype of Document | 19991220 | |||
| 8 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_KW_AUTOMATION_OBJECT | Native Document | 19991227 | |||
| 9 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_KW_AUTOMATION_OBJECT | Native Editor | 19991227 | |||
| 10 | Instance attribute | Public | Type reference (TYPE) | I | Open Mode | 19991227 | |||
| 11 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_KW_PROPERTIES | CL_KW_PROPERTIES | 19991228 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Assigns the Document a Document Template | 19991220 | |
| 2 | Instance method | Public | Method | Closes the Document | 19991220 | |
| 3 | Instance method | Public | Method | Closes a Document in Different Ways: Internal! | 20001114 | |
| 4 | Instance method | Public | Method | Checks Whether Document Has Been Changed | 20001020 | |
| 5 | Instance method | Public | Method | Internal - Do Not Use! | 20000810 | |
| 6 | Instance method | Public | Method | Saves the Document | 19991220 | |
| 7 | Instance method | Public | Method | Stores the Document under a New Name | 20000322 | |
| 8 | Instance method | Public | Method | Set Close Behavior | 20001205 | |
| 9 | Instance method | Public | Method | Set Saved Property | 20001205 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | ON_CLOSE | Instance Event (0) |
Public (2) |
Document was Closed | 19991220 |
Types
Class CL_KW_DOCUMENT has no local type.
Method Signatures
Method ATTACH_STYLE_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILENAME | Call by reference | Type reference (TYPE) | STRING | char255 | 19991220 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler beim Zuweisen der Vorlage | 19991220 |
Method CLOSE Signature
Method CLOSE on class CL_KW_DOCUMENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler beim Schließen des Dokuments | 19991220 |
Method CLOSE_BY_CLOSE_BEHAVIOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CLOSE_BEHAVIOR | Call by reference | Type reference (TYPE) | I | 20001114 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | close_by_close_behavior_failed | 20001114 |
Method GET_SAVED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SAVED | Call by reference | Type reference (TYPE) | I | Gesichert (j/n) | 20001020 |
Method GET_SAVED on class CL_KW_DOCUMENT has no exception.
Method RAISE_ON_CLOSE Signature
Method RAISE_ON_CLOSE on class CL_KW_DOCUMENT has no parameter.
Method RAISE_ON_CLOSE on class CL_KW_DOCUMENT has no exception.
Method SAVE Signature
Method SAVE on class CL_KW_DOCUMENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler beim Sichern | 19991220 |
Method SAVE_COPY_AS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILES_CREATED | Call by reference | Type reference (TYPE) | ANY | Namen der erzeugten Files | 20000322 | |||
| 2 | MIMETYPE | Call by reference | Type reference (TYPE) | SKWF_MIME | char255 | 20000322 | |||
| 3 | OUTPATH | Call by reference | Type reference (TYPE) | C | char255 | 20000322 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler beim Sichern | 20000322 |
Method SET_CLOSE_BEHAVIOUR Signature
Method SET_CLOSE_BEHAVIOUR on class CL_KW_DOCUMENT has no parameter.
Method SET_CLOSE_BEHAVIOUR on class CL_KW_DOCUMENT has no exception.
Method SET_SAVED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SAVED | Value transfer | Type reference (TYPE) | I | 20001205 |
Method SET_SAVED on class CL_KW_DOCUMENT has no exception.
Event Signatures
Event ON_CLOSE Signature
Event ON_CLOSE on class CL_KW_DOCUMENT has no parameter.
History
| Last changed by/on | SAP | 20000620 |
| SAP Release Created in | 46C |