SelectionList Class Reference

Holds list of shapes and pixels which where identified by user with Identify tool. More...

Collaboration diagram for SelectionList:

Public Member Functions
void	AddPixel (int LayerHandle, int Column, int Row)
	Adds a pixel to the list. Updated in v4.9.5 More...
void	AddShape (int LayerHandle, int ShapeIndex)
	Adds the shape from the specified layer to the list. More...
void	Clear ()
	Clears all the shapes and pixels from the list. More...
int	get_Column (int Index)
	Gets the column. More...
int	get_LayerHandle (int Index)
	Gets the layer handle for the item with specified pixel. More...
tkLayerType	get_LayerType (int Index)
	Gets the type of the layer for the specified pixel. More...
int	get_RasterX (int Index)
	Gets X coordinate pixel. More...
int	get_RasterY (int Index)
	Gets Y coordinate pixel. More...
int	get_Row (int Index)
	Gets the row. More...
int	get_ShapeIndex (int Index)
	Gets the index of the shape for the specified item. More...
void	RemoveByLayerHandle (int LayerHandle)
	Removes all items from the list which belong to specified layer. More...
void	TogglePixel (int LayerHandle, int Column, int Row)
	Toggles the state of the specified pixel (add it to the list if it is not present there, and removes otherwise). Updated in v4.9.5 More...

Properties
int	Count [get]
	Gets the count. More...

Detailed Description

Holds list of shapes and pixels which where identified by user with Identify tool.

New API 4.9.4:

Added in version 4.9.4

Member Function Documentation

AddPixel()

void SelectionList.AddPixel	(	int	LayerHandle,
		int	Column,
		int	Row
	)

Adds a pixel to the list. Updated in v4.9.5

Parameters

LayerHandle	The layer handle.
Column	The column.
Row	The row.

AddShape()

void SelectionList.AddShape	(	int	LayerHandle,
		int	ShapeIndex
	)

Adds the shape from the specified layer to the list.

Parameters

LayerHandle	The layer handle.
ShapeIndex	Index of the shape.

Clear()

void SelectionList.Clear

(

)

Clears all the shapes and pixels from the list.

get_Column()

int SelectionList.get_Column

(

int

Index

)

Gets the column.

Parameters

Index

The index of the item.

Returns

Column index or -1 if the specified item is a shape.

New API 4.9.5:

Added in version 4.9.5

get_LayerHandle()

int SelectionList.get_LayerHandle

(

int

Index

)

Gets the layer handle for the item with specified pixel.

Parameters

Index

The index of the item (either shape or pixels).

Returns

The layer handle.

get_LayerType()

tkLayerType SelectionList.get_LayerType

(

int

Index

)

Gets the type of the layer for the specified pixel.

Parameters

Index

The index of the item.

Returns

The type of the layer.

get_RasterX()

int SelectionList.get_RasterX

(

int

Index

)

Gets X coordinate pixel.

Parameters

Index

The index of the item.

Returns

X coordinate or -1 if the specified item is a shape.

get_RasterY()

int SelectionList.get_RasterY

(

int

Index

)

Gets Y coordinate pixel.

Parameters

Index

The index of the item.

Returns

Y coordinate or -1 if the specified item is a shape.

get_Row()

int SelectionList.get_Row

(

int

Index

)

Gets the row.

Parameters

Index

The index of the item.

Returns

Row index or -1 if the specified item is a shape.

New API 4.9.5:

Added in version 4.9.5

get_ShapeIndex()

int SelectionList.get_ShapeIndex

(

int

Index

)

Gets the index of the shape for the specified item.

Parameters

Index

The index of the item.

Returns

The index of the shape or -1, if this item is a pixel.

Exceptions

System.NotImplementedException

RemoveByLayerHandle()

void SelectionList.RemoveByLayerHandle

(

int

LayerHandle

)

Removes all items from the list which belong to specified layer.

Parameters

LayerHandle

The layer handle.

TogglePixel()

void SelectionList.TogglePixel	(	int	LayerHandle,
		int	Column,
		int	Row
	)

Toggles the state of the specified pixel (add it to the list if it is not present there, and removes otherwise). Updated in v4.9.5

Parameters

LayerHandle	The layer handle.
Column	The column.
Row	The row.

Property Documentation

Count

int SelectionList.Count

get

Gets the count.