ShapefileColorScheme Class Reference

A shapefile color scheme defines how a shapefile will be colored. More...

Collaboration diagram for ShapefileColorScheme:

Public Member Functions
int	Add (IShapefileColorBreak Break)
	Adds a color break to the color scheme. More...
IShapefileColorBreak	get_ColorBreak (int Index)
	Gets a color break from the color scheme. More...
string	get_ErrorMsg (int ErrorCode)
	Gets the description of the error code returned by ShapefileColorScheme.LastErrorCode. More...
int	InsertAt (int Position, IShapefileColorBreak Break)
	Insert a color break in the specified position of the scheme. More...
int	NumBreaks ()
	Gets the number of color breaks in the color scheme. More...
void	Remove (int Index)
	Removes specific color break from the scheme. More...
void	set_ColorBreak (int Index, IShapefileColorBreak pVal)
	Replaces a color break in the color scheme. More...

Properties
int	FieldIndex [get, set]
	Gets or sets the index in the attribute table the color scheme is associated with. More...
ICallback	GlobalCallback [get, set]
	Gets or sets callback object to return the information about the errors. More...
string	Key [get, set]
	Gets or sets text string associated with the object. More...
int	LastErrorCode [get]
	Returns the code of the last error which took place inside this instance of class. More...
int	LayerHandle [get, set]
	Gets or sets the layer handle the color scheme is associated with. More...

Detailed Description

A shapefile color scheme defines how a shapefile will be colored.

A shapefile color scheme consists of ShapefileColorBreak objects.

Deprecated:

in v. 4.8. Use ShapefileCategories, ShapefileCategory, ColorScheme instead.

Removed in 4.9.3:

Removed in 4.9.3

Member Function Documentation

Add()

int ShapefileColorScheme.Add

(

IShapefileColorBreak

Break

)

Adds a color break to the color scheme.

Parameters

Break

Returns

get_ColorBreak()

IShapefileColorBreak ShapefileColorScheme.get_ColorBreak

(

int

Index

)

Gets a color break from the color scheme.

Parameters

Index

The index of the break.

Returns

The color break object or NULL reference on failure.

get_ErrorMsg()

string ShapefileColorScheme.get_ErrorMsg

(

int

ErrorCode

)

Gets the description of the error code returned by ShapefileColorScheme.LastErrorCode.

Parameters

ErrorCode

The code of error.

Returns

The description of error.

InsertAt()

int ShapefileColorScheme.InsertAt	(	int	Position,
		IShapefileColorBreak	Break
	)

Insert a color break in the specified position of the scheme.

Parameters

Position	The position to insert color break at.
Break	The color break to insert.

Returns

The actual position color break was inserted at.

NumBreaks()

int ShapefileColorScheme.NumBreaks

(

)

Gets the number of color breaks in the color scheme.

Returns

The number of breaks.

Remove()

void ShapefileColorScheme.Remove

(

int

Index

)

Removes specific color break from the scheme.

Parameters

Index

The index of the break to remove.

set_ColorBreak()

void ShapefileColorScheme.set_ColorBreak	(	int	Index,
		IShapefileColorBreak	pVal
	)

Replaces a color break in the color scheme.

Parameters

Index	The index of color break to replace.
pVal	The reference to the new color break.

Property Documentation

FieldIndex

int ShapefileColorScheme.FieldIndex

getset

Gets or sets the index in the attribute table the color scheme is associated with.

GlobalCallback

ICallback ShapefileColorScheme.GlobalCallback

getset

Gets or sets callback object to return the information about the errors.

Deprecated:

v4.9.3 Use GlobalSettings.ApplicationCallback instead.

Key

string ShapefileColorScheme.Key

getset

Gets or sets text string associated with the object.

LastErrorCode

int ShapefileColorScheme.LastErrorCode

get

Returns the code of the last error which took place inside this instance of class.

LayerHandle

int ShapefileColorScheme.LayerHandle

getset

Gets or sets the layer handle the color scheme is associated with.