com.esri.arcgis.schematic
Interface INgDirectProperty

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgDirectPropertyProxy, NgDirectProperty

public interface INgDirectProperty
extends Serializable

Provides access to members that control the direct property.

Description

Along with the textual, discrete, and bounded properties, the direct property, is used for directly applying a given graphic effect, depending on the values taken up by the property itself—that is, scale factor and symbology.

Product Availability

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

See Also:

INgDiscreteProperty, INgTextualProperty, INgBoundedProperty, INgProperty, INgElementType.createProperty(String, int, int, int)

Method Summary

INgElementType	getElementType() Element type the direct property applies to.
String	getName() Name of the direct property.
int	graphicEffect() Returns the graphic effect applied by the direct property.
void	setName(String pVal) Name of the direct property.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the direct property.

Description

This name is defined when the direct property is created:

- either by calling the INgElementType CreateProperty method in the program code

- or through ArcGIS Schematics Designer, when the direct property has been created.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the direct property.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementType

INgElementType getElementType()
                              throws IOException,
                                     AutomationException

Element type the direct property applies to.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.INgElementType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

graphicEffect

int graphicEffect()
                  throws IOException,
                         AutomationException

Returns the graphic effect applied by the direct property.

Description

This graphic effect is defined when the property is created (see the INgElementType CreateProperty method). The attribute that will be associated with the direct property (see the INgElementType AssociateProperty method) will directly provide the effect value taken by this graphic effect.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriNgDirectPropertyEffect constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.