com.esri.arcgis.display
Interface IStyleGalleryStorage

All Superinterfaces:

Serializable

All Known Implementing Classes:

ServerStyleGallery, StyleGallery

public interface IStyleGalleryStorage
extends Serializable

Provides access to members that manage the files used in the Style Gallery.

Description

IStyleGalleryStorage is used to manage the styles that can then be edited using the IStyleGallery interface. Use the CanUpdate property to determine if the TargetFile is editable. Use AddFile and RemoveFile to move styles in and out of the gallery.

Product Availability

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

Method Summary

void	addFile(String path) Adds a file to the Style Gallery.
String	getDefaultStylePath() The default file path for searching for standard styles.
String	getFile(int index) The file at the given index.
int	getFileCount() The number of files in the Style Gallery.
String	getTargetFile() The target output file for adding, updating and removing items.
boolean	isCanUpdate(String path) Indicates if the specified file can be updated.
void	removeFile(String path) Removes a file from the Style Gallery.
void	setTargetFile(String path) The target output file for adding, updating and removing items.

Method Detail

getFileCount

int getFileCount()
                 throws IOException,
                        AutomationException

The number of files in the Style Gallery.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFile

String getFile(int index)
               throws IOException,
                      AutomationException

The file at the given index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanUpdate

boolean isCanUpdate(String path)
                    throws IOException,
                           AutomationException

Indicates if the specified file can be updated.

Product Availability

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

Parameters:

path - The path (in)

Returns:

The canUpdate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetFile

String getTargetFile()
                     throws IOException,
                            AutomationException

The target output file for adding, updating and removing items.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetFile

void setTargetFile(String path)
                   throws IOException,
                          AutomationException

The target output file for adding, updating and removing items.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFile

void addFile(String path)
             throws IOException,
                    AutomationException

Adds a file to the Style Gallery.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFile

void removeFile(String path)
                throws IOException,
                       AutomationException

Removes a file from the Style Gallery.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultStylePath

String getDefaultStylePath()
                           throws IOException,
                                  AutomationException

The default file path for searching for standard styles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.