com.esri.arcgis.system
Interface IPropertySupport

All Superinterfaces:

Serializable

All Known Implementing Classes:

AlternatingScaleBar, ArrowMarkerSymbol, BmpPictureElement, CadAnnotationLayer, CadastralFabricSubLayer, CadFeatureLayer, CartographicLineSymbol, CharacterMarker3DSymbol, CharacterMarkerSymbol, CircleElement, ColorRampSymbol, ColorSymbol, CoTrackSymbologyRenderer, CoverageAnnotationLayer, DataGraphTElement, DimensionLayer, DotDensityFillSymbol, DoubleAlternatingScaleBar, EllipseElement, EmfPictureElement, FDOGraphicsLayer, FeatureLayer, FrameElement, GdbRasterCatalogLayer, GifPictureElement, GradientFillSymbol, GroupElement, HashLineSymbol, HollowScaleBar, ImgPictureElement, InkGraphic, IPropertySupportProxy, Jp2PictureElement, JpgPictureElement, Legend, LineElement, LineFillSymbol, MapFrame, MapSurroundFrame, Marker3DSymbol, MarkerElement, MarkerFillSymbol, MarkerLineSymbol, MarkerNorthArrow, MultiLayerFillSymbol, MultiLayerLineSymbol, MultiLayerMarkerSymbol, MultiPatchElement, MxDocument, NAStopRenderer, NetworkDirtyAreaRenderer, NetworkLayer, NetworkTrafficRenderer, OleFrame, Page, ParagraphTextElement, PictureElement, PictureFillSymbol, PictureLineSymbol, PictureMarkerSymbol, PMFTitleTextElement, PngPictureElement, PolygonElement, RasterRGBSymbol, RectangleElement, ScaleLine, ScaleText, SidPictureElement, SimpleFillSymbol, SimpleLine3DSymbol, SimpleLineSymbol, SimpleMarker3DSymbol, SimpleMarkerSymbol, SimpleNetworkRenderer, SimpleRenderer, SingleDivisionScaleBar, SteppedScaleLine, TemporalFeatureLayer, TerrainDirtyAreaRenderer, TerrainPointAttributeRenderer, Text3DElement, TextElement, TextMarkerSymbol, TextSymbol, TextureFillSymbol, TextureLineSymbol, TifPictureElement, TinEdgeRenderer, TinFaceRenderer, TinNodeRenderer

public interface IPropertySupport
extends Serializable

Provides access to members that set a default property on an object.

Remarks

For FeatureLayer objects, the ArcGIS framework uses this interface to check to see if the specified display filter object can be applied to the layer. Applies indicates whether the specified display filter object can be applied generally, while CanApply indicates whether the specified display filter object can be applied at that particular moment. Current returns the current display filter. FeatureLayer objects also uses IPropertySupport to manage some renderer objects.

When To Use

IPropertySupport is a generic interface implemented by most graphic elements and few other objects. IPropertySupport is used for updating generic properties of an object; it can be used by a client without the client needing to know the exact nature of the underlying class. Through IPropertySupport you can ask an object if another object applies to it (for instance, a color object). If the object does apply, you can apply a new object of that type or ask for the current object.

Product Availability

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

Method Summary

boolean	applies(Object pUnk) Indicates if the receiver can apply the given object at any given time.
Object	apply(Object newObject) Applies the given property to the receiver and returns the old object.
boolean	canApply(Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
Object	getCurrent(Object pUnk) The object currently being used.

Method Detail

applies

boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

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

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.