com.esri.arcgis.carto
Interface IHTMLPopupInfo

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CadAnnotationLayer, CadastralFabricSubLayer, CadFeatureLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, IHTMLPopupInfoProxy, IMSSubFeatureLayer, MapServerIdentifySublayer, MapServerLayer, MapServerQuerySublayer, TemporalFeatureLayer

public interface IHTMLPopupInfo
extends java.io.Serializable

COM Interface 'IHTMLPopupInfo'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the HTML popup tool.' 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	IID Deprecated. Internal use only
static int	IID742678bc_aff5_41da_a523_36a8bd4e2c8b
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getHTMLOutput(IFeature pFeature) The content is the XML text for the input feature.
int	getHTMLPresentationStyle() Indicates the content formating style for the HTML Popup tool.
java.lang.String	getHTMLRedirectField() Indicates the fieldname of the layer that contains the HTML redirect URL values.
java.lang.String	getHTMLRedirectFieldPrefix() Indicates the text to precede the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLRedirectFieldSuffix() Indicates the text to follow the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLXSLStylesheet() Indicates the content of the XSL stylesheet to parse the feature attributes through.
boolean	isHTMLHideFieldNameColumn() Indicates if Field name column will be output to the HTML Popup tool.
boolean	isHTMLPopupEnabled() Indicates if this layer currently responds to the HTML Popup tool.
boolean	isHTMLUseCodedDomainValues() Indicates whether to use coded values (rather than literal stored values) for feature values.
void	setHTMLHideFieldNameColumn(boolean pHide) Indicates if Field name column will be output to the HTML Popup tool.
void	setHTMLPopupEnabled(boolean pEnabled) Indicates if this layer currently responds to the HTML Popup tool.
void	setHTMLPresentationStyle(int pStyle) Indicates the content formating style for the HTML Popup tool.
void	setHTMLRedirectField(java.lang.String pField) Indicates the fieldname of the layer that contains the HTML redirect URL values.
void	setHTMLRedirectFieldPrefix(java.lang.String pPrefix) Indicates the text to precede the HTMLRedirectField value for the redirect URL.
void	setHTMLRedirectFieldSuffix(java.lang.String pSufix) Indicates the text to follow the HTMLRedirectField value for the redirect URL.
void	setHTMLUseCodedDomainValues(boolean pCodedValues) Indicates whether to use coded values (rather than literal stored values) for feature values.
void	setHTMLXSLStylesheet(java.lang.String pStyleSheet) Indicates the content of the XSL stylesheet to parse the feature attributes through.

Field Detail

IID742678bc_aff5_41da_a523_36a8bd4e2c8b

static final int IID742678bc_aff5_41da_a523_36a8bd4e2c8b

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

Method Detail

isHTMLPopupEnabled

boolean isHTMLPopupEnabled()
                           throws java.io.IOException,
                                  AutomationException

Indicates if this layer currently responds to the HTML Popup tool.

Returns:

The pEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPopupEnabled

void setHTMLPopupEnabled(boolean pEnabled)
                         throws java.io.IOException,
                                AutomationException

Indicates if this layer currently responds to the HTML Popup tool.

Parameters:

pEnabled - The pEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLPresentationStyle

int getHTMLPresentationStyle()
                             throws java.io.IOException,
                                    AutomationException

Indicates the content formating style for the HTML Popup tool.

Returns:

A com.esri.arcgis.carto.esriHTMLPopupStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPresentationStyle

void setHTMLPresentationStyle(int pStyle)
                              throws java.io.IOException,
                                     AutomationException

Indicates the content formating style for the HTML Popup tool.

Parameters:

pStyle - A com.esri.arcgis.carto.esriHTMLPopupStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLHideFieldNameColumn

boolean isHTMLHideFieldNameColumn()
                                  throws java.io.IOException,
                                         AutomationException

Indicates if Field name column will be output to the HTML Popup tool.

Returns:

The pHide

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLHideFieldNameColumn

void setHTMLHideFieldNameColumn(boolean pHide)
                                throws java.io.IOException,
                                       AutomationException

Indicates if Field name column will be output to the HTML Popup tool.

Parameters:

pHide - The pHide (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectField

java.lang.String getHTMLRedirectField()
                                      throws java.io.IOException,
                                             AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Returns:

The pField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectField

void setHTMLRedirectField(java.lang.String pField)
                          throws java.io.IOException,
                                 AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Parameters:

pField - The pField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldPrefix

java.lang.String getHTMLRedirectFieldPrefix()
                                            throws java.io.IOException,
                                                   AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Returns:

The pPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldPrefix

void setHTMLRedirectFieldPrefix(java.lang.String pPrefix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Parameters:

pPrefix - The pPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldSuffix

java.lang.String getHTMLRedirectFieldSuffix()
                                            throws java.io.IOException,
                                                   AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Returns:

The pSufix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldSuffix

void setHTMLRedirectFieldSuffix(java.lang.String pSufix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Parameters:

pSufix - The pSufix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLXSLStylesheet

java.lang.String getHTMLXSLStylesheet()
                                      throws java.io.IOException,
                                             AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Returns:

The pStyleSheet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLXSLStylesheet

void setHTMLXSLStylesheet(java.lang.String pStyleSheet)
                          throws java.io.IOException,
                                 AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Parameters:

pStyleSheet - The pStyleSheet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLUseCodedDomainValues

boolean isHTMLUseCodedDomainValues()
                                   throws java.io.IOException,
                                          AutomationException

Indicates whether to use coded values (rather than literal stored values) for feature values.

Returns:

The pCodedValues

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLUseCodedDomainValues

void setHTMLUseCodedDomainValues(boolean pCodedValues)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to use coded values (rather than literal stored values) for feature values.

Parameters:

pCodedValues - The pCodedValues (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLOutput

java.lang.String getHTMLOutput(IFeature pFeature)
                               throws java.io.IOException,
                                      AutomationException

The content is the XML text for the input feature.

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.