Hierarchy
⤷
⤷
Properties
| Class | /IPRO/CL_DOCB_TEXT | |
| Short Description | Document Builder Element Text Class | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /IPRO/BASIS | Tables, Structures, general Infrastruktur |
| Created | 20040416 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /IPRO/CL_DOCB_TEXT has no forward declaration.
Interfaces
Class /IPRO/CL_DOCB_TEXT has no interface implemented.
Friends
Class /IPRO/CL_DOCB_TEXT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Type reference (TYPE) | /IPRO/S_ELMNT_ID | Structure for element identification | 20061219 | |||
| 2 | Instance attribute | Private | Type reference (TYPE) | /IPRO/RGSET_COMP | Regulation Set Component | 20070316 | |||
| 3 | Instance attribute | Private | Type reference (TYPE) | /IPRO/CONTENT | Content | 20070309 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | /IPRO/CONTENT_TYPE | Content Type | 20040630 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | /IPRO/ENCODING | Encoding name | 20040416 | |||
| 6 | Instance attribute | Private | Type reference (TYPE) | CHAR10 | Text Format | 20040416 | |||
| 7 | Instance attribute | Private | Type reference (TYPE) | /IPRO/FORM_NAME | Form name | 20040920 | |||
| 8 | Instance attribute | Private | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20070316 | |||
| 9 | Instance attribute | Private | Type reference (TYPE) | STRING | String representation of HTML text | 20040504 | |||
| 10 | Instance attribute | Private | Type reference (TYPE) | SY-LANGU | Language Key of Current Text Environment | 20070413 | |||
| 11 | Instance attribute | Private | Type reference (TYPE) | STRING | Plain text | 20061214 | |||
| 12 | Instance attribute | Private | Type reference (TYPE) | XSTRING | Raw data representation of text | 20040416 | |||
| 13 | Instance attribute | Private | Type reference (TYPE) | TEXT255 | Text title | 20040416 | |||
| 14 | Instance attribute | Private | Type reference (TYPE) | /IPRO/TEXTTYP | Text Type | 20040426 | |||
| 15 | Instance attribute | Private | Type reference (TYPE) | SEU_BOOL | Valid HTML | 20040623 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | CONSTRUCTOR | 20040416 | |
| 2 | Static method | Public | Method | Converts HTML String to Raw for storage | 20040628 | |
| 3 | Static method | Public | Method | Converts Raw data to String | 20040707 | |
| 4 | Instance method | Public | Method | Get clause | 20070316 | |
| 5 | Instance method | Public | Method | Get content | 20070309 | |
| 6 | Instance method | Public | Method | Get the content type of the text | 20040630 | |
| 7 | Instance method | Public | Method | Get the encoding of the text | 20040416 | |
| 8 | Instance method | Public | Method | Get the text format | 20040416 | |
| 9 | Instance method | Public | Method | Get the form name | 20040920 | |
| 10 | Instance method | Public | Method | Get guid | 20070316 | |
| 11 | Instance method | Public | Method | Get the string representation of HTML formatted text | 20040504 | |
| 12 | Instance method | Public | Method | Get the Keyfields | 20061219 | |
| 13 | Instance method | Public | Method | Get language | 20070413 | |
| 14 | Instance method | Public | Method | Get the plain text | 20061214 | |
| 15 | Instance method | Public | Method | Get the raw representation of text | 20040416 | |
| 16 | Static method | Public | Method | Get the system codepage | 20050325 | |
| 17 | Instance method | Public | Method | Get the title of the text | 20040527 | |
| 18 | Instance method | Public | Method | Get the text type | 20040730 | |
| 19 | Instance method | Public | Method | Valid HTML | 20040623 | |
| 20 | Static method | Public | Method | Read the content type for a given format | 20040630 | |
| 21 | Instance method | Public | Method | Set clause name | 20070413 | |
| 22 | Instance method | Public | Method | Set content | 20070319 | |
| 23 | Instance method | Public | Method | Set the content type | 20040702 | |
| 24 | Instance method | Public | Method | Set the encoding of the text | 20040622 | |
| 25 | Instance method | Public | Method | Set the text format | 20040625 | |
| 26 | Instance method | Public | Method | Set the form name | 20040920 | |
| 27 | Instance method | Public | Method | Set guid | 20070413 | |
| 28 | Instance method | Public | Method | Set language | 20070510 | |
| 29 | Instance method | Public | Method | Set the raw represenation | 20040416 | |
| 30 | Instance method | Public | Method | Set the title of the text object | 20040615 | |
| 31 | Instance method | Public | Method | Set valid html flag | 20040623 |
Events
Class /IPRO/CL_DOCB_TEXT has no event.
Types
Class /IPRO/CL_DOCB_TEXT has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_ID | Call by reference | Type reference (TYPE) | /IPRO/S_ELMNT_ID | Structure for element identification | 20061219 | |||
| 2 | IV_CLAUSE | Call by reference | Type reference (TYPE) | /IPRO/RGSET_COMP | Regulation Set Component | 20070316 | |||
| 3 | IV_CONTENT | Call by reference | Type reference (TYPE) | /IPRO/CONTENT | Content | 20070309 | |||
| 4 | IV_ENCODING | Call by reference | Type reference (TYPE) | /IPRO/ENCODING | Encoding name | 20040416 | |||
| 5 | IV_FORMAT | Call by reference | Type reference (TYPE) | CHAR10 | Text Format | 20040416 | |||
| 6 | IV_FORM_NAME | Call by reference | Type reference (TYPE) | /IPRO/FORM_NAME | Form name | 20040920 | |||
| 7 | IV_GUID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20070316 | |||
| 8 | IV_LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Language Key of Current Text Environment | 20070413 | |||
| 9 | IV_PLAIN_TEXT | Call by reference | Type reference (TYPE) | STRING | Plain text | 20061214 | |||
| 10 | IV_RAWDATA | Call by reference | Type reference (TYPE) | XSTRING | Raw data representation of string | 20040416 | |||
| 11 | IV_TITLE | Call by reference | Type reference (TYPE) | TEXT255 | Text Title | 20040416 | |||
| 12 | IV_TYPE | Call by reference | Type reference (TYPE) | /IPRO/TEXTTYP | Text Type | 20040426 |
Method CONSTRUCTOR on class /IPRO/CL_DOCB_TEXT has no exception.
Method CONVERT_HTML_TO_RAW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ENCODING | Call by reference | Type reference (TYPE) | /IPRO/ENCODING | Encoding Name | 20040628 | |||
| 2 | IV_HTMLSTRING | Call by reference | Type reference (TYPE) | STRING | HTML String | 20040628 | |||
| 3 | RV_RAWDATA | Value transfer | Type reference (TYPE) | XSTRING | Raw String | 20040628 |
Method CONVERT_HTML_TO_RAW on class /IPRO/CL_DOCB_TEXT has no exception.
Method CONVERT_RAW_TO_HTMLSTRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ENCODING | Call by reference | Type reference (TYPE) | /IPRO/ENCODING | Encoding Name | 20040707 | |||
| 2 | IV_RAWDATA | Call by reference | Type reference (TYPE) | XSTRING | Raw data | 20040707 | |||
| 3 | RV_STRING | Value transfer | Type reference (TYPE) | STRING | HTML String | 20040707 |
Method CONVERT_RAW_TO_HTMLSTRING on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_CLAUSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_CLAUSE | Value transfer | Type reference (TYPE) | /IPRO/RGSET_COMP | Regulation Set Component | 20070316 |
Method GET_CLAUSE on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_CONTENT | Value transfer | Type reference (TYPE) | /IPRO/CONTENT | Content | 20070309 |
Method GET_CONTENT on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_CONTENT_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_CONTENT_TYPE | Value transfer | Type reference (TYPE) | /IPRO/CONTENT_TYPE | Content Type | 20040630 |
Method GET_CONTENT_TYPE on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_ENCODING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_ENCODING | Value transfer | Type reference (TYPE) | /IPRO/ENCODING | Encoding of Text | 20040416 |
Method GET_ENCODING on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_FORMAT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_FORMAT | Value transfer | Type reference (TYPE) | CHAR10 | Text Format | 20040416 |
Method GET_FORMAT on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_FORM_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_FORM_NAME | Value transfer | Type reference (TYPE) | /IPRO/FORM_NAME | Form name | 20040920 |
Method GET_FORM_NAME on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_GUID | Value transfer | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20070316 |
Method GET_GUID on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_HTMLSTRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_HTMLSTRING | Value transfer | Type reference (TYPE) | STRING | String representation of HTML text | 20040504 |
Method GET_HTMLSTRING on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PRS_ID | Value transfer | Type reference (TYPE) | /IPRO/S_ELMNT_ID | Structure for element identification | 20061219 |
Method GET_ID on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_LANGU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PRV_LANGU | Value transfer | Type reference (TYPE) | SY-LANGU | Language Key of Current Text Environment | 20070413 |
Method GET_LANGU on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_PLAIN_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PRV_PLAIN_TEXT | Value transfer | Type reference (TYPE) | STRING | Plain text | 20061214 |
Method GET_PLAIN_TEXT on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_RAWDATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_RAWDATA | Value transfer | Type reference (TYPE) | XSTRING | Raw Data representation of Text | 20040416 |
Method GET_RAWDATA on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_SYSTEM_CODEPAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_CODEPAGE | Value transfer | Type reference (TYPE) | CPCODEPAGE | SAP Character Set Identification | 20050325 |
Method GET_SYSTEM_CODEPAGE on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_TITLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_TITLE | Value transfer | Type reference (TYPE) | STRING | Title | 20040527 |
Method GET_TITLE on class /IPRO/CL_DOCB_TEXT has no exception.
Method GET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_TYPE | Value transfer | Type reference (TYPE) | /IPRO/TEXTTYP | Text Type | 20040730 |
Method GET_TYPE on class /IPRO/CL_DOCB_TEXT has no exception.
Method IS_VALID_HTML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_VALID | Value transfer | Type reference (TYPE) | SEU_BOOL | Valid HTML | 20040623 |
Method IS_VALID_HTML on class /IPRO/CL_DOCB_TEXT has no exception.
Method READ_CONTENT_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FORMAT | Call by reference | Type reference (TYPE) | /IPRO/TXTFMT | Text Format | 20040630 | |||
| 2 | RV_CTYPE | Value transfer | Type reference (TYPE) | /IPRO/CONTENT_TYPE | Content Type | 20040630 |
Method READ_CONTENT_TYPE on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_CLAUSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CLAUSE | Value transfer | Type reference (TYPE) | /IPRO/RGSET_COMP | Regulation Set Component | 20070413 |
Method SET_CLAUSE on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CONTENT | Value transfer | Type reference (TYPE) | STRING | 20070319 |
Method SET_CONTENT on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_CONTENT_TYPE 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) | /IPRO/CONTENT_TYPE | Content Type | 20040702 |
Method SET_CONTENT_TYPE on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_ENCODING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ENCODING | Call by reference | Type reference (TYPE) | STRING | Encoding name | 20040622 |
Method SET_ENCODING on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_FORMAT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FORMAT | Call by reference | Type reference (TYPE) | CHAR10 | Text format | 20040625 |
Method SET_FORMAT on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_FORM_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FORM_NAME | Call by reference | Type reference (TYPE) | /IPRO/FORM_NAME | Form name | 20040920 |
Method SET_FORM_NAME on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_GUID | Value transfer | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20070413 |
Method SET_GUID on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_LANGU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PIV_LANGU | Value transfer | Type reference (TYPE) | SY-LANGU | Language Key of Current Text Environment | 20070510 |
Method SET_LANGU on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_RAWDATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_RAWDATA | Call by reference | Type reference (TYPE) | XSTRING | Raw Data Representation of Text | 20040416 |
Method SET_RAWDATA on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_TITLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TITLE | Call by reference | Type reference (TYPE) | STRING | Text Title | 20040615 |
Method SET_TITLE on class /IPRO/CL_DOCB_TEXT has no exception.
Method SET_VALID_HTML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_VALID | Call by reference | Type reference (TYPE) | SEU_BOOL | Valid HTML | 20040623 |
Method SET_VALID_HTML on class /IPRO/CL_DOCB_TEXT has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 100 |