GridColorBreak Class Reference

A grid color break object defines how a specified region of a grid will be colored. More...

Collaboration diagram for GridColorBreak:

Public Member Functions
string	get_ErrorMsg (int ErrorCode)
	Retrieves the error message associated with the specified error code. More...

Properties
string	Caption [get, set]
	Gets or sets the caption to display for the color break More...
ColoringType	ColoringType [get, set]
	Gets or sets the way a break is colored. More...
ICallback	GlobalCallback [get, set]
	The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications. More...
GradientModel	GradientModel [get, set]
	Gets or sets the model used to color the break. More...
uint	HighColor [get, set]
	Gets or sets the color representing the highest value in the color break. More...
double	HighValue [get, set]
	Gets or sets the highest value in the color break. More...
string	Key [get, set]
	The key may be used by the programmer to store any string data associated with the object. More...
int	LastErrorCode [get]
	Retrieves the last error generated in the object. More...
uint	LowColor [get, set]
	Gets or sets the lowest value in the color break. More...
double	LowValue [get, set]
	Gets or sets the lowest value in the color break. More...
bool	Visible [get, set]
	Gets or sets a value indicating whether the break is visible. More...

Detailed Description

A grid color break object defines how a specified region of a grid will be colored.

Represents a part of the GridColorScheme.

Member Function Documentation

get_ErrorMsg()

string GridColorBreak.get_ErrorMsg

(

int

ErrorCode

)

Retrieves the error message associated with the specified error code.

Parameters

ErrorCode

The error code for which the error message is required.

Returns

The error message description for the specified error code.

Property Documentation

Caption

string GridColorBreak.Caption

getset

Gets or sets the caption to display for the color break

ColoringType

ColoringType GridColorBreak.ColoringType

getset

Gets or sets the way a break is colored.

GlobalCallback

ICallback GridColorBreak.GlobalCallback

getset

The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.

Deprecated:

v4.9.3 Use GlobalSettings.ApplicationCallback instead.

GradientModel

GradientModel GridColorBreak.GradientModel

getset

Gets or sets the model used to color the break.

HighColor

uint GridColorBreak.HighColor

getset

Gets or sets the color representing the highest value in the color break.

HighValue

double GridColorBreak.HighValue

getset

Gets or sets the highest value in the color break.

Key

string GridColorBreak.Key

getset

The key may be used by the programmer to store any string data associated with the object.

LastErrorCode

int GridColorBreak.LastErrorCode

get

Retrieves the last error generated in the object.

LowColor

uint GridColorBreak.LowColor

getset

Gets or sets the lowest value in the color break.

LowValue

double GridColorBreak.LowValue

getset

Gets or sets the lowest value in the color break.

Visible

bool GridColorBreak.Visible

getset

Gets or sets a value indicating whether the break is visible.

New API 4.9.4:

Added in version 4.9.4