ShapefileColorScheme Class Reference

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

List of all members.

Public Member Functions
int	Add (ShapefileColorBreak Break)
	Adds a color break to the color scheme.
ShapefileColorBreak	get_ColorBreak (int Index)
	Gets a color break from the color scheme.
string	get_ErrorMsg (int ErrorCode)
	Gets the description of the error code returned by ShapefileColorScheme.LastErrorCode.
int	InsertAt (int Position, ShapefileColorBreak Break)
	Insert a color break in the specified position of the scheme.
int	NumBreaks ()
	Gets the number of color breaks in the color scheme.
void	Remove (int Index)
	Removes specific color break from the scheme.
void	set_ColorBreak (int Index, ShapefileColorBreak pVal)
	Replaces a color break in the color scheme.
Properties
int	FieldIndex [get, set]
	Gets or sets the index in the attribute table the color scheme is associated with.
ICallback	GlobalCallback [get, set]
	Gets or sets callback object to return the information about the errors.
string	Key [get, set]
	Gets or sets text string associated with the object.
int	LastErrorCode [get]
	Returns the code of the last error which took place inside this instance of class.
int	LayerHandle [get, set]
	Gets or sets the layer handle the color scheme is associated with.

---

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.

---

Member Function Documentation

int ShapefileColorScheme.Add

(

ShapefileColorBreak

Break

)

Adds a color break to the color scheme.

Parameters:

Break

Returns:

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

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.

int ShapefileColorScheme.InsertAt	(	int	Position,
		ShapefileColorBreak	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.

int ShapefileColorScheme.NumBreaks

(

)

Gets the number of color breaks in the color scheme.

Returns:

The number of breaks.

void ShapefileColorScheme.Remove

(

int

Index

)

Removes specific color break from the scheme.

Parameters:

Index

The index of the break to remove.

void ShapefileColorScheme.set_ColorBreak	(	int	Index,
		ShapefileColorBreak	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

int ShapefileColorScheme.FieldIndex [get, set]

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

ICallback ShapefileColorScheme.GlobalCallback [get, set]

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

string ShapefileColorScheme.Key [get, set]

Gets or sets text string associated with the object.

int ShapefileColorScheme.LastErrorCode [get]

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

int ShapefileColorScheme.LayerHandle [get, set]

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