com.esri.arcgis.display
Interface IStyleGalleryItem

All Superinterfaces:

Serializable

All Known Subinterfaces:

IStyleGalleryItem2

All Known Implementing Classes:

IStyleGalleryItem2Proxy, IStyleGalleryItemProxy, ServerStyleGalleryItem, StyleGalleryItem

public interface IStyleGalleryItem
extends Serializable

Provides access to members that define items in the Style Gallery.

Description

Symbols and map elements are stored in the Style Gallery. Each symbol or map element has a unique ID that can be read from the item within the style gallery. A Name and Category are also properties of the items within the style gallery. These two fields, along with the Item itself, can be updated and changed as necessary.

Product Availability

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

Method Summary

String	getCategory() The category of the item.
int	getID() Id for the item in the Style Gallery.
Object	getItem() The symbol or map element to be stored in the Style Gallery item.
String	getName() The name of the item in the Style Gallery.
void	setCategory(String category) The category of the item.
void	setItem(Object item) The symbol or map element to be stored in the Style Gallery item.
void	setName(String name) The name of the item in the Style Gallery.

Method Detail

getID

int getID()
          throws IOException,
                 AutomationException

Id for the item in the Style Gallery.

Description

Returns the internal ID number for the item within the style gallery. This is a read-only value that cannot be changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItem

Object getItem()
               throws IOException,
                      AutomationException

The symbol or map element to be stored in the Style Gallery item.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItem

void setItem(Object item)
             throws IOException,
                    AutomationException

The symbol or map element to be stored in the Style Gallery item.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

item - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The name of the item in the Style Gallery.

Description

Name is the name of the symbol or map element for the item stored in the style gallery.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The name of the item in the Style Gallery.

Description

Name is the name of the symbol or map element for the item stored in the style gallery.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The category of the item.

Description

Category is a user defined field for organizing symbols and map elements into logical groupings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(String category)
                 throws IOException,
                        AutomationException

The category of the item.

Description

Category is a user defined field for organizing symbols and map elements into logical groupings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.