com.esri.arcgis.carto
Interface IHTMLPopupInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface IHTMLPopupInfo
extends Serializable

Provides access to members that control the HTML popup tool.

Product Availability

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

Method Summary

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.
String	getHTMLRedirectField() Indicates the fieldname of the layer that contains the HTML redirect URL values.
String	getHTMLRedirectFieldPrefix() Indicates the text to precede the HTMLRedirectField value for the redirect URL.
String	getHTMLRedirectFieldSuffix() Indicates the text to follow the HTMLRedirectField value for the redirect URL.
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(String pField) Indicates the fieldname of the layer that contains the HTML redirect URL values.
void	setHTMLRedirectFieldPrefix(String pPrefix) Indicates the text to precede the HTMLRedirectField value for the redirect URL.
void	setHTMLRedirectFieldSuffix(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(String pStyleSheet) Indicates the content of the XSL stylesheet to parse the feature attributes through.

Method Detail

isHTMLPopupEnabled

boolean isHTMLPopupEnabled()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Returns:

The pEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLPopupEnabled

void setHTMLPopupEnabled(boolean pEnabled)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Parameters:

pEnabled - The pEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLPresentationStyle

int getHTMLPresentationStyle()
                             throws IOException,
                                    AutomationException

Indicates the content formating style for the HTML Popup tool.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriHTMLPopupStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLPresentationStyle

void setHTMLPresentationStyle(int pStyle)
                              throws IOException,
                                     AutomationException

Indicates the content formating style for the HTML Popup tool.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHTMLHideFieldNameColumn

boolean isHTMLHideFieldNameColumn()
                                  throws IOException,
                                         AutomationException

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

Product Availability

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

Returns:

The pHide

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLHideFieldNameColumn

void setHTMLHideFieldNameColumn(boolean pHide)
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Parameters:

pHide - The pHide (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectField

String getHTMLRedirectField()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Returns:

The pField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectField

void setHTMLRedirectField(String pField)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Parameters:

pField - The pField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldPrefix

String getHTMLRedirectFieldPrefix()
                                  throws IOException,
                                         AutomationException

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

Product Availability

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

Returns:

The pPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldPrefix

void setHTMLRedirectFieldPrefix(String pPrefix)
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Parameters:

pPrefix - The pPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldSuffix

String getHTMLRedirectFieldSuffix()
                                  throws IOException,
                                         AutomationException

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

Product Availability

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

Returns:

The pSufix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldSuffix

void setHTMLRedirectFieldSuffix(String pSufix)
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Parameters:

pSufix - The pSufix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLXSLStylesheet

String getHTMLXSLStylesheet()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Returns:

The pStyleSheet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLXSLStylesheet

void setHTMLXSLStylesheet(String pStyleSheet)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Parameters:

pStyleSheet - The pStyleSheet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHTMLUseCodedDomainValues

boolean isHTMLUseCodedDomainValues()
                                   throws IOException,
                                          AutomationException

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

Product Availability

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

Returns:

The pCodedValues

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHTMLUseCodedDomainValues

void setHTMLUseCodedDomainValues(boolean pCodedValues)
                                 throws IOException,
                                        AutomationException

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

Product Availability

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

Parameters:

pCodedValues - The pCodedValues (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLOutput

String getHTMLOutput(IFeature pFeature)
                     throws IOException,
                            AutomationException

The content is the XML text for the input feature.

Product Availability

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

Parameters:

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

Returns:

The pHtml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.