com.esri.arcgis.trackinganalyst
Interface IEventAttributeProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
EventAttributeProperties

public interface IEventAttributeProperties
extends Serializable

Provides access to members that control text rendering behavior using event attributes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.


Method Summary
 ITextElement createTextElement()
          Creates a new text element generated from the ITextSymbol property.
 IStringArray getFieldNames()
          The eventís field names whose values will be used generate text when rendering.
 int getNumFields()
          The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.
 ITextSymbol getTextSymbol()
          The text symbol for rendering an eventís selective set of attributes.
 boolean isGlobalProperties()
          Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
 void setFieldNamesByRef(IStringArray pVal)
          The eventís field names whose values will be used generate text when rendering.
 void setGlobalProperties(boolean pVal)
          Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
 void setNumFields(int pVal)
          The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.
 void setTextSymbolByRef(ITextSymbol pVal)
          The text symbol for rendering an eventís selective set of attributes.
 

Method Detail

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException
The text symbol for rendering an eventís selective set of attributes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

void setTextSymbolByRef(ITextSymbol pVal)
                        throws IOException,
                               AutomationException
The text symbol for rendering an eventís selective set of attributes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldNames

IStringArray getFieldNames()
                           throws IOException,
                                  AutomationException
The eventís field names whose values will be used generate text when rendering.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldNamesByRef

void setFieldNamesByRef(IStringArray pVal)
                        throws IOException,
                               AutomationException
The eventís field names whose values will be used generate text when rendering.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumFields

int getNumFields()
                 throws IOException,
                        AutomationException
The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumFields

void setNumFields(int pVal)
                  throws IOException,
                         AutomationException
The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createTextElement

ITextElement createTextElement()
                               throws IOException,
                                      AutomationException
Creates a new text element generated from the ITextSymbol property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.carto.ITextElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGlobalProperties

boolean isGlobalProperties()
                           throws IOException,
                                  AutomationException
Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobalProperties

void setGlobalProperties(boolean pVal)
                         throws IOException,
                                AutomationException
Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.