com.esri.arcgis.display
Interface IPictureMarkerSymbol

All Superinterfaces:
IMarkerSymbol, Serializable
All Known Implementing Classes:
PictureMarkerSymbol

public interface IPictureMarkerSymbol
extends IMarkerSymbol, Serializable

Provides access to members that control the raster (bitmap) marker symbol.

Description

IPictureMarkerSymbol is a marker symbols that uses the contents of either a Windows bitmap (.BMP) file, or an Enhanced MetaFile (.EMF). The latter is an excellent way to get highly polished multi-color artwork into Arc Map as a marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void createMarkerSymbolFromFile(int type, String fileName)
          Create symbol from picture file.
 IColor getBackgroundColor()
          Background color of the picture for 1 bit images.
 IColor getBitmapTransparencyColor()
          Color within bitmap indicating transparency.
 Picture getPicture()
          Picture used for marker symbol.
 boolean isSwapForeGroundBackGroundColor()
          Indicates if foreground and background colors are swapped on 1 Bit Images Only.
 void setBackgroundColor(IColor color)
          Background color of the picture for 1 bit images.
 void setBitmapTransparencyColor(IColor color)
          Color within bitmap indicating transparency.
 void setPictureByRef(Picture pictureDisp)
          Picture used for marker symbol.
 void setSwapForeGroundBackGroundColor(boolean swap)
          Indicates if foreground and background colors are swapped on 1 Bit Images Only.
 
Methods inherited from interface com.esri.arcgis.display.IMarkerSymbol
getAngle, getColor, getSize, getXOffset, getYOffset, setAngle, setColor, setSize, setXOffset, setYOffset
 

Method Detail

getPicture

Picture getPicture()
                   throws IOException,
                          AutomationException
Picture used for marker symbol.

Description

Specifies the bitmap image used for the marker. Use the IPictureDisp interface to specify the image.

Remarks

Only bitmap images may be specified. Use the CreateFillSymbolFromFile method to access emf files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPictureByRef

void setPictureByRef(Picture pictureDisp)
                     throws IOException,
                            AutomationException
Picture used for marker symbol.

Description

Specifies the bitmap image used for the marker. Use the IPictureDisp interface to specify the image.

Remarks

Only bitmap images may be specified. Use the CreateFillSymbolFromFile method to access emf files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pictureDisp - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
Background color of the picture for 1 bit images.

Description

Controls the Background color of the bitmap image or emf file. Any IColor supporting object may be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBackgroundColor

void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException
Background color of the picture for 1 bit images.

Description

Controls the Background color of the bitmap image or emf file. Any IColor supporting object may be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBitmapTransparencyColor

IColor getBitmapTransparencyColor()
                                  throws IOException,
                                         AutomationException
Color within bitmap indicating transparency.

Description

Changes the specified color within the bitmap to be transparent. BitmapTransparencyColor can be specified as any IColor object.

Remarks

BitmapTransparencyColor is only supported by color bitmap files. Emf files and 1-bit bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBitmapTransparencyColor

void setBitmapTransparencyColor(IColor color)
                                throws IOException,
                                       AutomationException
Color within bitmap indicating transparency.

Description

Changes the specified color within the bitmap to be transparent. BitmapTransparencyColor can be specified as any IColor object.

Remarks

BitmapTransparencyColor is only supported by color bitmap files. Emf files and 1-bit bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSwapForeGroundBackGroundColor

boolean isSwapForeGroundBackGroundColor()
                                        throws IOException,
                                               AutomationException
Indicates if foreground and background colors are swapped on 1 Bit Images Only.

Description

Boolean indicator to switch the foreground color with the background color of a 1-bit bitmap image.

Remarks

SwapForeGroundBackGroundColor is only supported by 1-bit bitmap files. Emf files and color bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSwapForeGroundBackGroundColor

void setSwapForeGroundBackGroundColor(boolean swap)
                                      throws IOException,
                                             AutomationException
Indicates if foreground and background colors are swapped on 1 Bit Images Only.

Description

Boolean indicator to switch the foreground color with the background color of a 1-bit bitmap image.

Remarks

SwapForeGroundBackGroundColor is only supported by 1-bit bitmap files. Emf files and color bitmap images are excluded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

createMarkerSymbolFromFile

void createMarkerSymbolFromFile(int type,
                                String fileName)
                                throws IOException,
                                       AutomationException
Create symbol from picture file.

Description

Loads the specified bitmap image or emf file. Use the esriPictureType enumerator to specify the type of picture being loaded. Supported types are esriIPictureBitmap (bitmap images) and esriIPictureEMF (emf files).

Remarks

Bitmap images are limited to a maxiumum of 256 colors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
type - A com.esri.arcgis.display.esriIPictureType constant (in)
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
esriIPictureType