com.esri.arcgis.controls
Interface IARConfiguration

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcReaderConfiguration, IARConfigurationProxy

public interface IARConfiguration
extends Serializable

Provides access to members that control the ARConfiguration.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Method Summary

Object	getCustomProperty() A property to associate data with an object.
Object	getSetting(String sName) The configuration setting specified.
String	getTemplateFile() The file name of the configuration file loaded into the control.
boolean	isBoolSetting(String sName) The configuration setting specified, whose value is a boolean.
void	load(String sFilename) Loads each configuration setting from the specified file into the control.
void	save(String sFilename) Saves each of the control's current configuration settings into the specified file.
void	setBoolSetting(String sName, boolean pVal) The configuration setting specified, whose value is a boolean.
void	setCustomProperty(Object pVal) A property to associate data with an object.
void	setDefaults() Set each control configuration setting to its default value.
void	setSetting(String sName, Object pVal) The configuration setting specified.

Method Detail

setDefaults

void setDefaults()
                 throws IOException,
                        AutomationException

Set each control configuration setting to its default value.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

void load(String sFilename)
          throws IOException,
                 AutomationException

Loads each configuration setting from the specified file into the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

sFilename - The sFilename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

void save(String sFilename)
          throws IOException,
                 AutomationException

Saves each of the control's current configuration settings into the specified file.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

sFilename - The sFilename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplateFile

String getTemplateFile()
                       throws IOException,
                              AutomationException

The file name of the configuration file loaded into the control. An empty string is returned is the control is using default configuration settings.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The sFilename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSetting

Object getSetting(String sName)
                  throws IOException,
                         AutomationException

The configuration setting specified.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

sName - The sName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSetting

void setSetting(String sName,
                Object pVal)
                throws IOException,
                       AutomationException

The configuration setting specified.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

sName - The sName (in)

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBoolSetting

boolean isBoolSetting(String sName)
                      throws IOException,
                             AutomationException

The configuration setting specified, whose value is a boolean.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

sName - The sName (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBoolSetting

void setBoolSetting(String sName,
                    boolean pVal)
                    throws IOException,
                           AutomationException

The configuration setting specified, whose value is a boolean.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

sName - The sName (in)

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException

A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.