com.esri.arcgis.animation
Interface ISequentialImageExporter

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnimationExporterSeqImages

public interface ISequentialImageExporter
extends Serializable

Provides access to members that control the sequential image exporter.

Product Availability

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


Method Summary
 String getFolderName()
          The folder name to be used during sequential image export.
 int getFolderSize()
          The folder size to be written during sequential image export.
 int getImageCount()
          The number of images to be exported during sequential image export.
 String getImageFormat()
          The image format to be used during sequential image export.
 String getImagePrefix()
          The image prefix to be used during sequential image export.
 int getImagesPerSecond()
          The images per second to be exported during sequential image export.
 void setFolderName(String pFolderName)
          The folder name to be used during sequential image export.
 void setImageFormat(String pImageFormat)
          The image format to be used during sequential image export.
 void setImagePrefix(String pImagePrefix)
          The image prefix to be used during sequential image export.
 void setImagesPerSecond(int pImagesPerSecond)
          The images per second to be exported during sequential image export.
 

Method Detail

setFolderName

void setFolderName(String pFolderName)
                   throws IOException,
                          AutomationException
The folder name to be used during sequential image export.

Product Availability

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

Parameters:
pFolderName - The pFolderName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFolderName

String getFolderName()
                     throws IOException,
                            AutomationException
The folder name to be used during sequential image export.

Product Availability

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

Returns:
The pFolderName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImagePrefix

void setImagePrefix(String pImagePrefix)
                    throws IOException,
                           AutomationException
The image prefix to be used during sequential image export.

Product Availability

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

Parameters:
pImagePrefix - The pImagePrefix (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImagePrefix

String getImagePrefix()
                      throws IOException,
                             AutomationException
The image prefix to be used during sequential image export.

Product Availability

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

Returns:
The pImagePrefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImageFormat

void setImageFormat(String pImageFormat)
                    throws IOException,
                           AutomationException
The image format to be used during sequential image export.

Product Availability

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

Parameters:
pImageFormat - The pImageFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageFormat

String getImageFormat()
                      throws IOException,
                             AutomationException
The image format to be used during sequential image export.

Product Availability

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

Returns:
The pImageFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImagesPerSecond

void setImagesPerSecond(int pImagesPerSecond)
                        throws IOException,
                               AutomationException
The images per second to be exported during sequential image export.

Product Availability

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

Parameters:
pImagesPerSecond - The pImagesPerSecond (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImagesPerSecond

int getImagesPerSecond()
                       throws IOException,
                              AutomationException
The images per second to be exported during sequential image export.

Product Availability

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

Returns:
The pImagesPerSecond
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageCount

int getImageCount()
                  throws IOException,
                         AutomationException
The number of images to be exported during sequential image export.

Product Availability

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

Returns:
The pImageCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFolderSize

int getFolderSize()
                  throws IOException,
                         AutomationException
The folder size to be written during sequential image export.

Product Availability

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

Returns:
The pFolderSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.