com.esri.arcgis.carto
Interface IElementProperties2

All Superinterfaces:
Serializable
All Known Implementing Classes:
BmpPictureElement, CircleElement, EllipseElement, EmfPictureElement, FrameElement, GifPictureElement, GroupElement, ImgPictureElement, InkGraphic, Jp2PictureElement, JpgPictureElement, LineElement, MapFrame, MapSurroundFrame, MarkerElement, MultiPatchElement, ParagraphTextElement, PMFTitleTextElement, PngPictureElement, PolygonElement, RectangleElement, SidPictureElement, Text3DElement, TextElement, TifPictureElement

public interface IElementProperties2
extends Serializable

Provides access to members that control More Element Properties.

Superseded By

IElementProperties3

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean canRotate()
          Indicates if the element can be rotated.
 Object getCustomProperty()
          Custom property.
 String getName()
          Name of the element.
 double getReferenceScale()
          Reference scale of the element.
 String getType()
          Type of the element.
 boolean isAutoTransform()
          Indicates if transform is applied to symbols and other parts of element.
 void setAutoTransform(boolean autoTransform)
          Indicates if transform is applied to symbols and other parts of element.
 void setCustomProperty(Object customProperty)
          Custom property.
 void setName(String name)
          Name of the element.
 void setReferenceScale(double referenceScale)
          Reference scale of the element.
 void setType(String name)
          Type of the element.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getType

String getType()
               throws IOException,
                      AutomationException
Type of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setType

void setType(String name)
             throws IOException,
                    AutomationException
Type of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isAutoTransform

boolean isAutoTransform()
                        throws IOException,
                               AutomationException
Indicates if transform is applied to symbols and other parts of element. False = only apply transform to geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAutoTransform

void setAutoTransform(boolean autoTransform)
                      throws IOException,
                             AutomationException
Indicates if transform is applied to symbols and other parts of element. False = only apply transform to geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException
Custom property.

Remarks

CustomProperty is a place for developers to attach custom objects to an element. Previous versions of the software required that the specified variant implement IUnknown, but that requirement has since been removed.

A custom object must implement a persistence interface, usually IPersistStream or IPersistVariant. Also, one alternative to writing a custom object is to use a PropertySet or XMLPropertySet.

This property is not used by the core ArcObjects functionality, it is strictly for developer use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCustomProperty

void setCustomProperty(Object customProperty)
                       throws IOException,
                              AutomationException
Custom property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

canRotate

boolean canRotate()
                  throws IOException,
                         AutomationException
Indicates if the element can be rotated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getReferenceScale

double getReferenceScale()
                         throws IOException,
                                AutomationException
Reference scale of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setReferenceScale

void setReferenceScale(double referenceScale)
                       throws IOException,
                              AutomationException
Reference scale of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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