com.esri.arcgis.controls
Interface IARConfiguration

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArcReaderConfiguration, IARConfigurationProxy

public interface IARConfiguration
extends java.io.Serializable

COM Interface 'IARConfiguration'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members that control the ARConfiguration.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_1_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_3_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_5_PUT_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_6_PUT_NAME
static java.lang.String	DISPID_7_GET_NAME
static java.lang.String	DISPID_7_PUT_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID671c12b9_56d0_440a_8cf8_75b9fbd0a65e
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IID671c12b9_56d0_440a_8cf8_75b9fbd0a65e

static final int IID671c12b9_56d0_440a_8cf8_75b9fbd0a65e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_6_PUT_NAME

static final java.lang.String DISPID_6_PUT_NAME

See Also:

Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME

See Also:

Constant Field Values

DISPID_7_PUT_NAME

static final java.lang.String DISPID_7_PUT_NAME

See Also:

Constant Field Values

Method Detail

setDefaults

void setDefaults()
                 throws java.io.IOException,
                        AutomationException

Set each control configuration setting to its default value.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

void load(java.lang.String sFilename)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

sFilename - The sFilename (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

void save(java.lang.String sFilename)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

sFilename - The sFilename (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplateFile

java.lang.String getTemplateFile()
                                 throws java.io.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.

Returns:

The sFilename

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSetting

java.lang.Object getSetting(java.lang.String sName)
                            throws java.io.IOException,
                                   AutomationException

The configuration setting specified.

Parameters:

sName - The sName (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSetting

void setSetting(java.lang.String sName,
                java.lang.Object pVal)
                throws java.io.IOException,
                       AutomationException

The configuration setting specified.

Parameters:

sName - The sName (in)

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBoolSetting

boolean isBoolSetting(java.lang.String sName)
                      throws java.io.IOException,
                             AutomationException

The configuration setting specified, whose value is a boolean.

Parameters:

sName - The sName (in)

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBoolSetting

void setBoolSetting(java.lang.String sName,
                    boolean pVal)
                    throws java.io.IOException,
                           AutomationException

The configuration setting specified, whose value is a boolean.

Parameters:

sName - The sName (in)

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

A property to associate data with an object.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with an object.

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.