SAP Control Framework
Control Framework Architecture
Event Handling
Registering and Processing Events
Context Menu
Drag and Drop
Process Flow of a Drag and Drop Operation
Drag and Drop Events
Example of Drag and Drop Programming
Drag and Drop in WAN Environments
Lifetime Management
Automation Queue
Synchronizing the Automation Queue
Error Handling in Synchronization
Automation Queue Services
Using Controls in a WAN
Creating a Control: SAP Picture Example
Methods of the Control Framework
Methods of Class CL_GUI_CFW
dispatch
flush
get_living_dynpro_controls
set_new_ok_code
update_view
Methods of Class CL_GUI_OBJECT
is_valid
free
Methods of Class CL_GUI_CONTROL
constructor
finalize
set_name
get_name
set_registered_events
get_registered_events
get_path
is_alive
set_alignment
set_position
get_visible
set_visible
get_focus
set_focus
get_height
get_width
Methods of the Class CL_DRAGDROP
constructor
add
clear
destroy
get
get_handle
modify
remove
Methods of the Class CL_DRAGDROPOBJECT
set_flavor
abort
Controls Tutorial
Component Integration: Controls Tutorial
Notes to the User
Prerequisites
System Configuration
Architecture
Lesson 1: Creating a Custom Control
Introduction
Exercise 1: Reserving an Area for a Control
Exercise 2: Creating a Control and its Container
Exercise 3: Calling Methods of the Control
Summary
Lesson 2: Event Handling
Introduction
Exercise 1: Writing an Event Handler Method
Exercise 2: Registering an Application Event
Exercise 3: Registering a System Event
Exercise 4: Responding to an Event
Summary
Lesson 3: Flush Optimization
Introduction
Exercise 1: Using Imported Values
Exercise 2: Value Passing Between Methods
Exercise 3: Control Methods in Subroutines
Exercise 4: Using Multiple Controls
Summary
Lesson 4: Testing and Error Handling
Introduction
Exercise 1: Activating the Trace Mode
Exercise 2: Synchronous Method Processing
Summary
Additional Sources of Information
ALV Grid Control
Instance for ALV Grid Control
Working with the ALV Grid Control
First Steps
Application-Specific Programming
Layouts
Saving Layouts
Integration of Self-Defined Functions
Changing Standard Functions
Defining GUI Elements in the Toolbar
Defining a Context Menu
Defining a Menu in the Toolbar
Special Aspects for Menus with a Default Button
Hiding Standard Functions
Drag & Drop With the ALV Grid Control
D&D Behavior for all Rows/Columns
D&D Behavior for Special Columns
D&D Behavior for Special Rows/Cells
Elements in the Grid
Output of Exceptions
Coloring Rows
Coloring Cells
Displaying Cells as Pushbuttons
Including Hyperlinks
Grouping Fields for Field Selection
Using the Conversion Exit
Using the ALV Grid Control in WANs
The Field Catalog
Generating the Field Catalog
Generating the Field Catalog Automatically
Generating the Field Catalog Manually
Generating the Field Catalog Semi-Automatically
Fields of the Field Catalog
Reference to the Output Table
Reference to the Data Dictionary
Value Display with Currency/Quantity Unit
Output Options of Columns
Formatting Column Contents
Identifying Rows in the ALV Grid Control
Texts
Texts in the Field Catalog
Parameters for Fields Without DDIC Reference
Other Fields
Fields of the Sort Table
The Layout Structure
Properties of the ALV Grid Control
Exceptions
Colors
Totals Options
Interaction Control
The Print Structure
The Consistency Check
SAP Container
Displaying and Relinking Containers
Methods
CLASS_CONSTRUCTOR
CONSTRUCTOR
LINK
Instance Attributes
Static Attributes
SAP Custom Container
CONSTRUCTOR
SAP Dialog Box Container
Methods
CONSTRUCTOR
SET_CAPTION
Events
CLOSE
SAP Docking Container
Methods
CONSTRUCTOR
DOCK_AT
FLOAT
GET_EXTENSION
SET_CAPTION
SET_EXTENSION
Static Constants
SAP Splitter Container
Methods
ADD_CONTROL
ADD_CONTROL_HANDLE
CONSTRUCTOR
GET_CONTAINER
GET_COLUMNS
GET_COLUMN_MODE
GET_COLUMN_WIDTH
GET_COLUMN_SASH
GET_ROWS
GET_ROW_HEIGHT
GET_ROW_MODE
GET_ROW_SASH
REMOVE_CONTROL
SET_BORDER
SET_COLUMN_MODE
SET_COLUMN_WIDTH
SET_COLUMN_SASH
SET_GRID
SET_ROW_HEIGHT
SET_ROW_MODE
SET_ROW_SASH
SAP Easy Splitter Container
Methods
CONSTRUCTOR
SET_SASH_POSITION
Static Attributes
Instance Attributes
SAP Calendar Control
Instance for the SAP Calendar Control
Creating a Control: SAP Picture Example
Working With the SAP Calendar Control
Registering and Processing Events
Events of the SAP Calender Control
Methods of Class CL_GUI_CALENDAR
Constructor
go_to_date
set_day_info
reset_day_info
reset_selection
track_context_menu
set_today
set_selection
get_selection
get_navigator_height
get_navigator_width
SAP HTML Viewer
Instance for the SAP HTML Viewer
Using the SAP HTML Viewer
Registering and Processing Events
navigate_complete
sapevent
Using Controls in a WAN
Special Considerations for the SAP HTML Viewer
Methods of Class CL_GUI_HTML_VIEWER
constructor
show_url
stop
go_back
go_forward
go_home
do_refresh
get_current_url
load_html_document
load_mime_object
load_data
show_data
show_url_in_browser
SAP Picture
SAP Picture Instance
Creating a Control: SAP Picture Example
Using the SAP Picture
Registering and Processing Events
SAP Picture Events
Using Controls in a WAN
Special Considerations for the SAP Picture
Methods of Class CL_GUI_PICTURE
constructor
load_picture_from_url
load_picture_from_sap_icons
clear_picture
set_display_mode
display_context_menu
set_tooltip
SAP TextEdit
Using Controls in a WAN
Special Considerations for the SAP Textedit
Overview of GUI Dependencies
Methods
Alphabetical Listing
AUTO_REDRAW
COMMENT_LINES
COMMENT_SELECTION
CONSTRUCTOR
DELETE_TEXT
EMPTY_UNDO_BUFFER
FIND_AND_REPLACE
FIND_AND_SELECT_TEXT
GET_FIRST_VISIBLE_LINE
GET_LINE_TEXT
GET_PATH_OF_DROPPED_FILES
GET_SELECTED_TEXT_AS_R3TABLE
GET_SELECTED_TEXT_AS_STREAM
GET_SELECTION_INDEXES
GET_SELECTION_POS
GET_TEXTMODIFIED_STATUS
GET_TEXT_AS_R3TABLE
GET_TEXT_AS_STREAM
GET_TEXTSTREAM
GO_TO_LINE
HIGHLIGHT_BREAKPOINT_LINE
HIGHLIGHT_LINES
HIGHLIGHT_SELECTION
INDENT_LINES
INDENT_SELECTION
MAKE_SELECTION_VISIBLE
OPEN_LOCAL_FILE
PROTECT_LINES
PROTECT_SELECTION
REGISTER_EVENT_CONTEXT_MENU
REGISTER_EVENT_DBLCLICK
REGISTER_EVENT_F1
REGISTER_EVENT_F4
REGISTER_EVENT_FILEDROP
REPLACE_ALL
SAVE_AS_LOCAL_FILE
SELECT_LINES
SET_AUTOINDENT_MODE
SET_COMMENTS_STRING
SET_DRAGDROP
SET_FILEDROP_MODE
SET_FIRST_VISIBLE_LINE
SET_HIGHLIGHT_BREAKPOINTS_MODE
SET_HIGHLIGHT_COMMENTS_MODE
SET_LOCAL_CONTEXTMENU_MODE
SET_NAVIGATE_ON_DBLCLICK
SET_READONLY_MODE
SET_SELECTED_TEXT_AS_R3TABLE
SET_SELECTED_TEXT_AS_STREAM
SET_SELECTION_INDEXES
SET_SELECTION_POS
SET_SELECTION_POS_IN_LINE
SET_SPACES_ON_INDENT
SET_STATUSBAR_MODE
SET_STATUS_TEXT
SET_TEXTMODIFIED_STATUS
SET_TEXT_AS_R3TABLE
SET_TEXT_AS_STREAM
SET_TEXTSTREAM
SET_TOOLBAR_MODE
SET_WORDBREAK_PROCEDURE
SET_WORDWRAP_BEHAVIOR
UNCOMMENT_LINES
UNCOMMENT_SELECTION
UNINDENT_LINES
UNINDENT_SELECTION
Functional Listing
Creating Controllers
Setting and Getting Text
Setting and Getting Text Positions
Highlighting and Protecting Text
Finding and Replacing Text
Status Bar
Toolbar
Other Functions
Events
Class Constants
Instance Attributes
Keyboard and Mouse Control in the Editor Window
SAP Toolbar
Using the SAP Toolbar
Using Static Dropdown Menus
Events for the SAP Toolbar
Registering and Handling Events
Coding Example
Using Controls in a WAN
Special Considerations for the SAP Toolbar
Methods of Class CL_GUI_TOOLBAR
Constructor
add_button
add_button_group
fill_buttons_data_table
delete_button
delete_all_buttons
set_button_state
set_button_info
set_static_ctxmenu
assign_static_ctxmenu_table
track_context_menu
SAP Tree and Tree Model
The Tree Controls in SAPGUI for HTML
SAP Tree
Programming the SAP Tree
Overview of SAP Tree Classes
The Inheritance Hierarchy
Finding Errors
Important Notes
Example Programs
Using Controls in a WAN
Special Considerations for the SAP Tree
Incremental Tree Construction
The Simple Tree
Creating a Control: SAP Picture Example
Using the Simple Tree
Changing the Attributes of the Control
Finding Out the Attributes of the Control
Registering and Processing Events
Events of the Simple Tree
Drag and Drop
Process Flow of a Drag and Drop Operation
Drag and Drop Events
Defining Drag and Drop Events in the SAP Tree
Example of Drag and Drop Programming
The Column Tree
Creating a Control: SAP Picture Example
Using the Column Tree
Changing the Attributes of the Control
Finding Out the Attributes of the Control
Registering and Processing Events
Events of the Column Tree and List Tree
Drag and Drop
Process Flow of a Drag and Drop Operation
Drag and Drop Events
Defining Drag and Drop Events in the SAP Tree
Example of Drag and Drop Programming
The List Tree
Creating a Control: SAP Picture Example
Using the List Tree
Changing the Attributes of the Control
Finding Out the Attributes of the Control
Registering and Processing Events
Events of the Column Tree and List Tree
Drag and Drop
Process Flow of a Drag and Drop Operation
Drag and Drop Events
Defining Drag and Drop Events in the SAP Tree
Example of Drag and Drop Programming
Methods of Class CL_TREE_CONTROL_BASE
add_key_stroke
collapse_all_nodes
collapse_nodes
collapse_subtree
delete_all_nodes
delete_node
delete_nodes
ensure_visible
expand_node
expand_nodes
expand_root_nodes
get_expanded_nodes
get_selected_node
get_selected_nodes
get_top_node
move_node
node_set_disabled
node_set_dragdropid
node_set_expander
node_set_exp_image
node_set_hidden
node_set_is_folder
node_set_no_branch
node_set_n_image
node_set_style
remove_all_key_strokes
scroll
select_nodes
set_default_drop
set_disable_sel_change_ctx_men
set_folder_show_exp_image
set_has_3d_frame
set_screen_update
set_selected_node
set_top_node
unselect_all
unselect_nodes
set_ctx_menu_select_event_appl
Methods of Class CL_ITEM_TREE_CONTROL
add_nodes_and_items
delete_all_items_of_nodes
delete_items
get_selected_item
item_set_chosen
item_set_disabled
item_set_editable
item_set_font
item_set_hidden
item_set_style
item_set_text
item_set_t_image
select_item
set_min_node_height
update_nodes_and_items
Methods of Class CL_GUI_SIMPLE_TREE
constructor
add_nodes
node_set_text
update_nodes
Methods of Class CL_GUI_LIST_TREE
constructor
node_set_last_hierarchy_item
hierarchy_header_set_t_image
list_header_set_t_image
hierarchy_header_set_text
list_header_set_text
hierarchy_header_set_width
hiearchy_header_get_width
hierarchy_header_adjust_width
item_set_alignment
item_set_length
hierarchy_header_set_tooltip
list_header_set_tooltip
Methods of Class CL_GUI_COLUMN_TREE
constructor
add_column
add_hierarchy_column
adjust_column_width
column_get_width
column_set_disabled
column_set_heading_image
column_set_heading_text
column_set_heading_tooltip
column_set_hidden
column_set_width
delete_column
get_column_order
hierarchy_header_adjust_width
hierarchy_header_get_width
hierarchy_header_set_text
hierarchy_header_set_tooltip
hierarchy_header_set_t_image
hierarchy_header_set_width
insert_column
insert_hierarchy_column
set_column_order
update_column
SAP Data Provider
Description of Functions
Function Modules
DataProvider Object
Technical References
Interface ISAPDataProvider : IDispatch
Interface ISAPDataProviderFormats : IDispatch
Interface ISAPDataProviderFormat: IDispatch
Interface ISAPDataProviderEvents : IDispatch
Interface ISAPDPR3Table : IDispatch
Standard Medium Conversions
Desktop Office Integration
Desktop Office Integration
Desktop Office Integration - Architecture
Instances for SAP Desktop Office Integration
Office Integration Programming
Using Controls in a WAN
Special Considerations for Desktop Office Integration
Error Handling after Calling a Method
Error Messages and Their Meanings
raise_message
get_message
Central Instance for Managing SAP DOI
Office Integration Implementation
Generic Parameters
init_control
destroy_control
link_control
release_all_documents
set_window_properties
set_inplace_border_space
get_document_proxy
get_registered_doc_types
check_registered_doc_types
get_link_server
get_table_collection
get_extensions
set_focus
get_control_object
Documents
Working With Documents
Methods of the Interface i_oi_document_proxy
Generic Parameters
create_document
view_document
view_document_from_table
open_document
open_document_from_table
reopen_document
open_activex_document
play_document
play_document_from_table
save_document_to_url
save_document_to_table
save_as
save_copy_as
close_document
close_activex_document
has_changed
release_document
is_open
is_destroyed
has_standard_interface
add_menu_bar
add_menu_popup
add_menu_item
delete_menu_item
select_all
clear_selection
cut_selection
copy_selection
paste_clipboard
paste_special
page_setup
print_document
execute_macro
has_wordprocessor_interface
get_wordprocessor_interface
get_document_type
get_document_handle
get_application_property
update_document_links
has_spreadsheet_interface
get_spreadsheet_interface
has_form_interface
get_form_interface
has_mail_merge_interface
get_mail_merge_interface
has_pivot_interface
get_pivot_interface
get_script_collection
get_document_cookie
Processing Office Application Events
Event Handling Using Static Methods
Event Handling Using Instance Methods
Exchanging Data Between the SAP System and the Desktop Application
The Link Server
Working With the Link Server
Generic Parameters
start_link_server
stop_link_server
add_string_item
add_table_item2
add_table_item
add_binary_item
remove_link_item
copy_link_item_to_clipboard
execute_copy_link_dialog
Strategies for Working with the Link Server
The Table Collection
Using the Table Collection
Generic Parameters
add_table
add_table_by_url
get_table
get_table_by_url
remove_table
remove_all_tables
The Word Processor Interface
Working With The Word Processor Interface
Generic Parameters
get_version
install_template
set_template
get_template_info
remove_template
search
replace
insert_table
insert_table2
get_table_info
clear_table
The Form Interface
Working With The Form Interface
Generic Parameters
set_data
get_data
add_field
delete_fields
disconnect_fields
get_form_fields
protect
set_modus
The Mail Merge Interface
Using the Mail Merge Interface
Generic Parameters
set_data_source
get_fields
merge_one
merge_range
print
view
shutdown
view_field_codes
The Script Collection
Using the Script Collection
Generic Parameters
add_script
add_script_from_table
remove_all_scripts
remove_script
The Spreadsheet Interface
Using the Spreadsheet Interface
Generic Parameters
The Updating Parameter
get_active_sheet
get_dimension
get_protection
get_sheets
get_ranges_data
get_ranges_names
get_cell_format
get_cell_formats_table
get_selection
get_selected_areas
select_range
set_selection
select_sheet
set_color
set_font
set_format
set_format_string
set_frame
set_ranges_format
cell_format
protect
protect_range
add_sheet
set_sheet_name
delete_sheet
insert_range_dim
change_range
insert_ranges
insert_one_table
set_ranges_data
clear_range
clear_all_ranges
delete_content_ranges
delete_ranges
hide_columns
show_columns
hide_rows
show_rows
set_hierarchy
set_hierarchy_table
clear_hierarchy
print
set_zoom
fit_widest
screen_update
load_lib
version
Important Table Structures
The Pivot Interface
Using the Pivot Interface
Generic Parameters
set_source_table
set_fieldtype
get_allfields
get_allpivottables
drill_down
drill_up
Important Table Structures
Test Tools for Desktop Office Integration
DOI Installation Test Using a Standalone Executable Program
DOI Installation Test Within Word
DOI Installation Test Within Excel
Test for the TableFactory OCX
The Document Viewer
Using the Document Viewer
Coding Example
Methods of the Document Viewer
init_viewer
view_document_from_url
view_document_from_table
close_document
destroy_viewer
Dynamic Documents
Dynamic Document
Creating a Dynamic Document
Performance Note
Filling Dynamic Documents
Adding Simple Elements to a Dynamic Document
Setting Links
Adding Complex Elements to a Dynamic Document
Creating a Form
Using Pushbuttons
Using Input Fields
Using Dropdown List Boxes
Tables
Creating Standard Tables
Creating a Quick Table
Displaying a Dynamic Document
Printing a Dynamic Document
Programming Reference
Class CL_DD_AREA
add_text
add_icon
add_picture
add_link
add_table
add_form
add_gap
new_line
underline
line_with_layout
Class CL_DD_DOCUMENT
vertical_split
horizontal_split
merge_document
display_document
export_document
print_document
initialize_document
add_text
add_icon
add_picture
add_link
add_table
add_form
add_gap
new_line
underline
line_with_layout
Class CL_DD_FORM_AREA
add_button
add_input_element
add_select_element
disable_button
enable_button
add_text
add_icon
add_picture
add_link
add_table
add_form
add_gap
new_line
underline
line_with_layout
Class CL_DD_TABLE_ELEMENT
add_column
new_row
set_column_style
set_row_style
span_columns
span_rows
Class CL_DD_TABLE_AREA
add_heading
add_text
add_icon
add_link
new_row
span_columns
span_rows
Class CL_DD_BUTTON_ELEMENT
disable_button
enable_button
set_display
Class CL_DD_INPUT_ELEMENT
set_value
set_display
set_focus
Class CL_DD_SELECT_ELEMENT
set_value
set_display
Type Group SDYDO: Frequently-Used Types