com.esri.arcgis.systemUI
Interface IComboBoxHook

All Superinterfaces:

Serializable

All Known Implementing Classes:

IComboBoxHookProxy

public interface IComboBoxHook
extends Serializable

Provides methods to program system provided combo boxes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

int	add(String str) Add an element to the combo box.
void	clear() Clear the combo box of all items.
Object	getHook() Get Application hook.
int	getSelected() GetThe currently selected item in the combo box.
String	getValue() Set the value for the edit control.
void	remove(int cookie) Remove an element from the combo box.
void	select(int cookie) Select an Item in the combo box.
void	setValue(String value) Set the value for the edit control.

Method Detail

getHook

Object getHook()
               throws IOException,
                      AutomationException

Get Application hook.

Description

Returns the hook to the application.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

int add(String str)
        throws IOException,
               AutomationException

Add an element to the combo box.

Description

Add an item to the combo box.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

str - The str (in)

Returns:

The cookie

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int cookie)
            throws IOException,
                   AutomationException

Remove an element from the combo box.

Description

Removes the item that corresponds to the provided cookie.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cookie - The cookie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(String value)
              throws IOException,
                     AutomationException

Set the value for the edit control.

Description

Sets the string that will show in the editbox.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

String getValue()
                throws IOException,
                       AutomationException

Set the value for the edit control.

Description

Gets the string that will show in the editbox.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException

Clear the combo box of all items.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

select

void select(int cookie)
            throws IOException,
                   AutomationException

Select an Item in the combo box.

Description

Selects a combo box item based on the provided cookie.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cookie - The cookie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelected

int getSelected()
                throws IOException,
                       AutomationException

GetThe currently selected item in the combo box.

Description

Returns the cookie of the current selected item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The cookie

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.