Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.11

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: ui :: dialogs ::

constants group ControlActions
Description
Control actions for common and extended controls of a FilePicker.
See also
XFilePickerControlAccess, CommonFilePickerElementIds, ExtendedFilePickerElementIds

Constants
ADD_ITEM Adds an item to the content of the listbox. The given item has to be a string.  
ADD_ITEMS Adds a sequence of strings to the content of the listbox.  
DELETE_ITEM Removes an item from a listbox. The given value has to be a position. If the position is invalid an exception will be thrown. The index of the first position is 0. The value should be a sal_Int32.  
DELETE_ITEMS Removes all items from the listbox.  
SET_SELECT_ITEM Selects an item in a listbox. The given value has to be a position. The index of the first position is 0. A value of -1 removes the selection. If the given position is invalid an exception will be thrown. The value should be a sal_Int32.  
GET_ITEMS Returns all items of the listbox as a sequence of strings.  
GET_SELECTED_ITEM Returns the currently selected item. The returned item is an empty string if the listbox is empty or no item is selected.  
GET_SELECTED_ITEM_INDEX Returns the zero based index of the currently selected item. If the listbox is empty or there is no item selected -1 will be returned. The returned value is a sal_Int32.  
SET_HELP_URL Sets the help URL of a control.  
GET_HELP_URL Retrieves the help URL of a control.  
Constants' Details
ADD_ITEM
const short ADD_ITEM = 1;
Description
Adds an item to the content of the listbox. The given item has to be a string.
ADD_ITEMS
const short ADD_ITEMS = 2;
Description
Adds a sequence of strings to the content of the listbox.
DELETE_ITEM
const short DELETE_ITEM = 3;
Description
Removes an item from a listbox. The given value has to be a position. If the position is invalid an exception will be thrown. The index of the first position is 0. The value should be a sal_Int32.
DELETE_ITEMS
const short DELETE_ITEMS = 4;
Description
Removes all items from the listbox.
SET_SELECT_ITEM
const short SET_SELECT_ITEM = 5;
Description
Selects an item in a listbox. The given value has to be a position. The index of the first position is 0. A value of -1 removes the selection. If the given position is invalid an exception will be thrown. The value should be a sal_Int32.
GET_ITEMS
const short GET_ITEMS = 6;
Description
Returns all items of the listbox as a sequence of strings.
GET_SELECTED_ITEM
const short GET_SELECTED_ITEM = 7;
Description
Returns the currently selected item. The returned item is an empty string if the listbox is empty or no item is selected.
GET_SELECTED_ITEM_INDEX
const short GET_SELECTED_ITEM_INDEX = 8;
Description
Returns the zero based index of the currently selected item. If the listbox is empty or there is no item selected -1 will be returned. The returned value is a sal_Int32.
SET_HELP_URL
const short SET_HELP_URL = 100;
Description
Sets the help URL of a control.
GET_HELP_URL
const short GET_HELP_URL = 101;
Description
Retrieves the help URL of a control.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.