com.esri.arcgis.output
Interface IOutputPageOptionsAdmin

All Superinterfaces:

Serializable

All Known Implementing Classes:

IOutputPageOptionsAdminProxy

public interface IOutputPageOptionsAdmin
extends Serializable

Private interface to output page options.

Product Availability

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

Method Summary

int	getCurrentIndex() Index of the current page.
int	getPageCount() Indicates the number of pages to the export dialog.
int	getSelectedPageCount() Indicates the number of selected pages to the export dialog.
boolean	isOutputtingPageLayout() Indicates if layout is being output.
boolean	isPageSelectionExists() Indicates if a page selection exists.
void	setCurrentIndex(int index) Index of the current page.
void	setOutputtingPageLayout(boolean flag) Indicates if layout is being output.
void	setPageCount(int count) Indicates the number of pages to the export dialog.
void	setPageSelectionExists(boolean flag) Indicates if a page selection exists.
void	setSelectedPageCount(int count) Indicates the number of selected pages to the export dialog.

Method Detail

isOutputtingPageLayout

boolean isOutputtingPageLayout()
                               throws IOException,
                                      AutomationException

Indicates if layout is being output.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputtingPageLayout

void setOutputtingPageLayout(boolean flag)
                             throws IOException,
                                    AutomationException

Indicates if layout is being output.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPageSelectionExists

boolean isPageSelectionExists()
                              throws IOException,
                                     AutomationException

Indicates if a page selection exists.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageSelectionExists

void setPageSelectionExists(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates if a page selection exists.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageCount

int getPageCount()
                 throws IOException,
                        AutomationException

Indicates the number of pages to the export dialog. Other clients should use the PageIndex.PageCount.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageCount

void setPageCount(int count)
                  throws IOException,
                         AutomationException

Indicates the number of pages to the export dialog. Other clients should use the PageIndex.PageCount.

Product Availability

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

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedPageCount

int getSelectedPageCount()
                         throws IOException,
                                AutomationException

Indicates the number of selected pages to the export dialog. Other clients should use the PageIndex.PageCount.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedPageCount

void setSelectedPageCount(int count)
                          throws IOException,
                                 AutomationException

Indicates the number of selected pages to the export dialog. Other clients should use the PageIndex.PageCount.

Product Availability

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

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentIndex

int getCurrentIndex()
                    throws IOException,
                           AutomationException

Index of the current page.

Product Availability

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

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentIndex

void setCurrentIndex(int index)
                     throws IOException,
                            AutomationException

Index of the current page.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.