Public Member Functions | Properties
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

Adds a color break to the color scheme.

Parameters:
Break
Returns:

Gets a color break from the color scheme.

Parameters:
IndexThe 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:
ErrorCodeThe 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:
PositionThe position to insert color break at.
BreakThe color break to insert.
Returns:
The actual position color break was inserted at.

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:
IndexThe index of the break to remove.

Replaces a color break in the color scheme.

Parameters:
IndexThe index of color break to replace.
pValThe reference to the new color break.

Property Documentation

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

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.

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

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

 All Classes Files Functions Enumerations Properties