com.esri.arcgis.display
Interface IPictureLineSymbol

All Superinterfaces:

ILineSymbol, Serializable

All Known Implementing Classes:

PictureLineSymbol

public interface IPictureLineSymbol
extends ILineSymbol, Serializable

Provides access to members that control the picture line symbol.

Description

IPictureLineSymbol can be used to create a line pattern that consists of either a bitmap image or emf file. Use the Rotate property to control the orientation of the picture. Use the XScale and YScale to adjust the size up or down. Use the ILineSymbol interface to set additional properties for IPictureLineSymbols.

Product Availability

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

See Also:

ILineSymbol

Method Summary

void	createLineSymbolFromFile(int type, String fileName) Create line symbol from picture file.
IColor	getBackgroundColor() Line background color.
IColor	getBitmapTransparencyColor() Color within bitmap indicating transparency.
double	getOffset() Picture offset from center of line.
Picture	getPicture() Picture used for line.
double	getXScale() Scale of picture along X-axis.
double	getYScale() Scale of picture along Y-axis.
boolean	isRotate() Indicates if the picture is rotated to follow the line.
boolean	isSwapForeGroundBackGroundColor() Indicates if the foreground and background colors are swapped on 1 Bit Images Only.
void	setBackgroundColor(IColor color) Line background color.
void	setBitmapTransparencyColor(IColor color) Color within bitmap indicating transparency.
void	setOffset(double offset) Picture offset from center of line.
void	setPictureByRef(Picture pictureDisp) Picture used for line.
void	setRotate(boolean rotate) Indicates if the picture is rotated to follow the line.
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 along X-axis.
void	setYScale(double yScale) Scale of picture along Y-axis.

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

getColor, getWidth, setColor, setWidth

Method Detail

getPicture

Picture getPicture()
                   throws IOException,
                          AutomationException

Picture used for line.

Description

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

Description

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

Line 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

Line 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.

isRotate

boolean isRotate()
                 throws IOException,
                        AutomationException

Indicates if the picture is rotated to follow the line.

Description

Boolean indicator to rotate the picture to follow the orientation of the line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The rotate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotate

void setRotate(boolean rotate)
               throws IOException,
                      AutomationException

Indicates if the picture is rotated to follow the line.

Description

Boolean indicator to rotate the picture to follow the orientation of the line geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rotate - The rotate (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 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 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 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 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.

getOffset

double getOffset()
                 throws IOException,
                        AutomationException

Picture offset from center of line.

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. The Offset can be a positive (above/left) or negative (below/right) number.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(double offset)
               throws IOException,
                      AutomationException

Picture offset from center of line.

Description

Offset is the offset in points (approx. 1/72 inch) the line symbol will be shown away from the geometry it represents. The Offset can be a positive (above/left) or negative (below/right) number.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

offset - The offset (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.

createLineSymbolFromFile

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

Create line 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.