SAP ABAP Class CL_WORD_SAPSCRIPT_EDITOR (CL_WORD_SAPSCRIPT_EDITOR)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-SCR (Application Component) SAPscript
     ⤷ STXD (Package) SAPscript

Properties

Class	CL_WORD_SAPSCRIPT_EDITOR
Short Description
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	STXD	SAPscript
Created	20060922	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SBDST	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	SOI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_WORD_SAPSCRIPT_EDITOR has no interface implemented.

Friends

Class CL_WORD_SAPSCRIPT_EDITOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BDS_CLASSNAME	Instance attribute	Private	☐	Type reference (TYPE)	SBDST_CLASSNAME	'SAPSCRIPTWORDINTEGRATION'		20061115
2	BDS_CLASSTYPE	Instance attribute	Private	☐	Type reference (TYPE)	SBDST_CLASSTYPE	'OT'		20061115
3	BDS_INSTANCE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BDS_DOCUMENT_SET			20061115
4	BDS_OBJECTKEY	Instance attribute	Private	☐	Type reference (TYPE)	SBDST_OBJECT_KEY	'WORDTEMPLATE'		20061115
5	BDS_URI	Instance attribute	Private	☐	Type reference (TYPE)	BDS_URI			20061115
6	CUR_ITF_HEADER	Instance attribute	Private	☐	Type reference (TYPE)	THEAD			20061115
7	CUR_ITF_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	TSFTEXT			20061115
8	CUR_WINDOW_SIZE	Instance attribute	Private	☐	Type reference (TYPE)	SSFWSIZE			20061115
9	C_TOKEN_SYMBOL_BEGIN	Constant	Private	☐	Type reference (TYPE)	TDCODE	'(&'		20061115
10	FALSE	Constant	Private	☐	Type reference (TYPE)	BOOLEAN	SPACE		20061115
11	G_SPLITTER_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER			20061115
12	G_TOOLBAR_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER			20061115
13	G_TOOLBAR_CONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR			20061115
14	MODE	Instance attribute	Public	☐	Type reference (TYPE)	C	' '		20061115
15	OI_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER			20061115
16	OI_CONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_CONTAINER_CONTROL			20061115
17	OI_DOCUMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_DOCUMENT_PROXY			20061115
18	OI_TEMPLATE	Instance attribute	Private	☐	Type reference (TYPE)	SOI_STRING			20061115
19	OI_VERSION	Instance attribute	Private	☐	Type reference (TYPE)	I			20061115
20	REFRESH_DOCUMENT	Instance attribute	Public	☐	Type reference (TYPE)	BOOLEAN			20061115
21	RGB_TABLE	Instance attribute	Private	☐	Type reference (TYPE)	TY_RGB_TABLE			20061115
22	RTF_DATA	Instance attribute	Private	☐	Type reference (TYPE)	TDTAB_C134			20061115
23	RTF_SIZE	Instance attribute	Private	☐	Type reference (TYPE)	I			20061115
24	TRUE	Constant	Private	☐	Type reference (TYPE)	BOOLEAN	'X'		20061115

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BUTTON	Instance method	Public	Method		20061115
2	CHECK_SYMBOL_NAME	Instance method	Private	Method		20061115
3	COMMAND_SYMBOL_INSERT	Instance method	Private	Method		20061115
4	CONSTRUCTOR	Instance method	Public	Constructor		20061115
5	CREATE_TOOLBAR	Instance method	Private	Method		20061115
6	DELETE_BUTTON	Instance method	Public	Method		20061115
7	GET_RGB_VALUES	Instance method	Private	Method		20061115
8	GET_TEXT_FROM_EDITOR	Instance method	Public	Method		20061115
9	HSSF_INSERT	Instance method	Private	Method		20061115
10	HSSF_INSERT_STRING	Instance method	Public	Method		20070105
11	INIT_RGB_TABLE	Instance method	Private	Method		20061115
12	IS_MODIFIED	Instance method	Public	Method	Check and get the actual ITF text from Editor	20061115
13	OI_CLOSE_TEXT	Instance method	Public	Method		20061115
14	OI_CREATEFIELD	Instance method	Private	Method		20061115
15	OI_DESTROY_EDITOR	Instance method	Public	Method		20061115
16	OI_INSERTBLANK	Instance method	Private	Method		20061115
17	ON_TOOLBAR_FUNCTION_SELECTED	Instance method	Private	Event handling method		20061115
18	SEND_TEXT_TO_EDITOR	Instance method	Public	Method	Send ITF text to Word document	20061115
19	SET_BUTTON_STATE	Instance method	Public	Method	Set the state of Toolbar	20061115
20	SET_EDITOR_STATE	Instance method	Public	Method	Set Protect/Unprotect for document	20061115
21	SYMBOL_INSERT	Instance method	Public	Method		20061115

Events

#	Event	Type	Visibility	Description	Created on
1	FUNCTION_SELECTED	Instance Event (0)	Public (2)		20061115

Types

Class CL_WORD_SAPSCRIPT_EDITOR has no local type.

Method Signatures

Method ADD_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUTN_TYPE	Call by reference	☐	Type reference (TYPE)	TB_BTYPE			20061115
2	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC			20061115
3	Importing	ICON	Call by reference	☐	Type reference (TYPE)	C			20061115
4	Importing	QUICKINFO	Call by reference	☑	Type reference (TYPE)	ICONQUICK			20061115
5	Importing	TEXT	Call by reference	☑	Type reference (TYPE)	TEXT40			20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method CHECK_SYMBOL_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_ERROR	Value transfer	☐	Type reference (TYPE)	BOOLEAN			20061115
2	Importing	P_NAME	Value transfer	☐	Type reference (TYPE)	TDSFSYM			20061115

Method CHECK_SYMBOL_NAME on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method COMMAND_SYMBOL_INSERT Signature

Method COMMAND_SYMBOL_INSERT on class CL_WORD_SAPSCRIPT_EDITOR has no parameter.
Method COMMAND_SYMBOL_INSERT on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EDITOR_CONTAINER	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER			20061115
2	Importing	TOOLBAR_VISIBLE	Value transfer	☑	Type reference (TYPE)	BOOLEAN	'X'		20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method CREATE_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER			20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method DELETE_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC			20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method GET_RGB_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_BLUE	Call by reference	☐	Type reference (TYPE)	I			20061115
2	Exporting	EX_GREEN	Call by reference	☐	Type reference (TYPE)	I			20061115
3	Exporting	EX_RED	Call by reference	☐	Type reference (TYPE)	I			20061115
4	Importing	IM_CODE	Call by reference	☐	Type reference (TYPE)	TDCODE			20061115

Method GET_RGB_VALUES on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method GET_TEXT_FROM_EDITOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FORMAT_WIDTH	Call by reference	☐	Type reference (TYPE)	I			20061115
2	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	TSFTEXT			20061115
3	Importing	TEXT_HEADER	Call by reference	☐	Type reference (TYPE)	THEAD			20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method HSSF_INSERT Signature

Method HSSF_INSERT on class CL_WORD_SAPSCRIPT_EDITOR has no parameter.
Method HSSF_INSERT on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method HSSF_INSERT_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20070105

Method HSSF_INSERT_STRING on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method INIT_RGB_TABLE Signature

Method INIT_RGB_TABLE on class CL_WORD_SAPSCRIPT_EDITOR has no parameter.
Method INIT_RGB_TABLE on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method IS_MODIFIED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	MODIFIED	Call by reference	☐	Type reference (TYPE)	BOOLEAN			20061115

Method IS_MODIFIED on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method OI_CLOSE_TEXT Signature

Method OI_CLOSE_TEXT on class CL_WORD_SAPSCRIPT_EDITOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method OI_CREATEFIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CODE	Call by reference	☐	Type reference (TYPE)	TDCODE			20061115
2	Importing	IM_VALUE	Call by reference	☐	Type reference (TYPE)	TDSFSYM			20061115

Method OI_CREATEFIELD on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method OI_DESTROY_EDITOR Signature

Method OI_DESTROY_EDITOR on class CL_WORD_SAPSCRIPT_EDITOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method OI_INSERTBLANK Signature

Method OI_INSERTBLANK on class CL_WORD_SAPSCRIPT_EDITOR has no parameter.
Method OI_INSERTBLANK on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method ON_TOOLBAR_FUNCTION_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Value transfer	☐	Attribute reference (LIKE)				20061115

Method ON_TOOLBAR_FUNCTION_SELECTED on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method SEND_TEXT_TO_EDITOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISP_MODE	Call by reference	☐	Type reference (TYPE)	C			20061115
2	Importing	FORM_PAGE	Call by reference	☑	Type reference (TYPE)	TDPAGE			20061115
3	Importing	FORM_WINDOW	Call by reference	☑	Type reference (TYPE)	TDWINDOW			20061115
4	Importing	LINES	Call by reference	☐	Type reference (TYPE)	TSFTEXT			20061115
5	Importing	TEXT_HEADER	Call by reference	☐	Type reference (TYPE)	THEAD			20061115
6	Importing	WINDOW_SIZE	Call by reference	☑	Type reference (TYPE)	SSFWSIZE			20061115
7	Importing	WITH_COLOR	Call by reference	☑	Type reference (TYPE)	BOOLEAN			20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method SET_BUTTON_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENABLED	Value transfer	☑	Type reference (TYPE)	BOOLEAN	'X'		20061115

Method SET_BUTTON_STATE on class CL_WORD_SAPSCRIPT_EDITOR has no exception.

Method SET_EDITOR_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISP_MODE	Call by reference	☐	Type reference (TYPE)	BOOLEAN			20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Method SYMBOL_INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_NAME	Value transfer	☐	Type reference (TYPE)	TDSFSYM			20061115

#	Exception	Resumable	Description	Created on
1	CX_WORD_SAPSCRIPT_EDITOR	☐		20061115

Event Signatures

Event FUNCTION_SELECTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	UI_FUNC			20061115

History

Last changed by/on	SAP	20130531
SAP Release Created in	703