com.esri.arcgis.display
Interface IPictureFillSymbol

All Superinterfaces:

IFillSymbol, Serializable

All Known Implementing Classes:

PictureFillSymbol

public interface IPictureFillSymbol
extends IFillSymbol, Serializable

Provides access to members that control the picture fill symbol.

Description

IPictureFillSymbol can be used to create a fill pattern that consists of either a bitmap image or emf file. Use the Angle property to control the orientation of the picture. Use the XScale and YScale to adjust the size up or down. Use the IFillSymbol interface to set additional properties for IPictureFillSymbols.

Product Availability

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

Method Summary

void	createFillSymbolFromFile(int type, String fileName) Create fill symbol from picture file.
double	getAngle() Angle of picture fill.
IColor	getBackgroundColor() Fill background color.
IColor	getBitmapTransparencyColor() Color within bitmap indicating transparency.
Picture	getPicture() Picture used for fill.
double	getXScale() Scale of picture fill along X-axis.
double	getYScale() Scale of picture fill along Y-axis.
boolean	isSwapForeGroundBackGroundColor() Indicates if the foreground and background colors are swapped on 1 Bit Images Only.
void	setAngle(double angle) Angle of picture fill.
void	setBackgroundColor(IColor color) Fill background color.
void	setBitmapTransparencyColor(IColor color) Color within bitmap indicating transparency.
void	setPictureByRef(Picture pictureDisp) Picture used for fill.
void	setSwapForeGroundBackGroundColor(boolean swap) Indicates if the foreground and background colors are swapped on 1 Bit Images Only.
void	setXScale(double xScale) Scale of picture fill along X-axis.
void	setYScale(double yScale) Scale of picture fill along Y-axis.

Methods inherited from interface com.esri.arcgis.display.IFillSymbol

getColor, getOutline, setColor, setOutline

Method Detail

getPicture

Picture getPicture()
                   throws IOException,
                          AutomationException

Picture used for fill.

Description

Specifies the bitmap image used for the fill. 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 fill.

Description

Specifies the bitmap image used for the fill. 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

Fill background color.

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

Fill background color.

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.

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.

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.

getAngle

double getAngle()
                throws IOException,
                       AutomationException

Angle of picture fill.

Description

The Angle of the bitmap image or emf file within the fill. Valid ranges are -360 to 360. The default Angle is 0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

void setAngle(double angle)
              throws IOException,
                     AutomationException

Angle of picture fill.

Description

The Angle of the bitmap image or emf file within the fill. Valid ranges are -360 to 360. The default Angle is 0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXScale

double getXScale()
                 throws IOException,
                        AutomationException

Scale of picture fill along X-axis.

Description

The XScale (horizontal) value of the bitmap image or emf file. XScale is specified as a percentage of the original file. The default XScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The xScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXScale

void setXScale(double xScale)
               throws IOException,
                      AutomationException

Scale of picture fill along X-axis.

Description

The XScale (horizontal) value of the bitmap image or emf file. XScale is specified as a percentage of the original file. The default XScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

xScale - The xScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYScale

double getYScale()
                 throws IOException,
                        AutomationException

Scale of picture fill along Y-axis.

Description

The YScale (vertical) value of the bitmap image or emf file. YScale is specified as a percentage of the original file. The default YScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The yScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYScale

void setYScale(double yScale)
               throws IOException,
                      AutomationException

Scale of picture fill along Y-axis.

Description

The YScale (vertical) value of the bitmap image or emf file. YScale is specified as a percentage of the original file. The default YScale is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

yScale - The yScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSwapForeGroundBackGroundColor

boolean isSwapForeGroundBackGroundColor()
                                        throws IOException,
                                               AutomationException

Indicates if the 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 the 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.

createFillSymbolFromFile

void createFillSymbolFromFile(int type,
                              String fileName)
                              throws IOException,
                                     AutomationException

Create fill 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 and a file size of 512 X 512 pixels.

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.