Class MapSelection.LayerSelection

Represents a layer selection

Inheritance

System.Object

MapSelection.LayerSelection

Implements

System.Collections.Generic.IList<System.Object[]>

System.Collections.Generic.ICollection<System.Object[]>

System.Collections.Generic.IEnumerable<System.Object[]>

System.Collections.IEnumerable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OSGeo.MapGuide.MaestroAPI.Mapping

Assembly: OSGeo.MapGuide.MaestroAPI.dll

Syntax

public class LayerSelection : IList<object[]>, ICollection<object[]>, IEnumerable<object[]>, IEnumerable

Constructors

| Improve this Doc View Source

LayerSelection(RuntimeMapLayer)

Constructs a new LayerSelection with a number of selected featured

Declaration

public LayerSelection(RuntimeMapLayer layer)

Parameters

Type	Name	Description
RuntimeMapLayer	layer	The layer to represent

| Improve this Doc View Source

LayerSelection(RuntimeMapLayer, IEnumerable<Object[]>)

Constructs a new LayerSelection with a number of selected featured

Declaration

public LayerSelection(RuntimeMapLayer layer, IEnumerable<object[]> ids)

Parameters

Type	Name	Description
RuntimeMapLayer	layer	The layer to represent
System.Collections.Generic.IEnumerable<System.Object[]>	ids	The list of composite IDs that the layer supports

Properties

| Improve this Doc View Source

Count

Returns the number of composite keys (and thus selected objects)

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

IsReadOnly

Gets a value indicating if the collection is read-only

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Item[Int32]

Gets or sets the composite key for the specified index

Declaration

public object[] this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index	The index for the composite key

Property Value

Type	Description
System.Object[]	The composite key

| Improve this Doc View Source

Layer

Gets the layer that contains the selected objects

Declaration

public RuntimeMapLayer Layer { get; }

Property Value

Type	Description
RuntimeMapLayer

Methods

| Improve this Doc View Source

Add(Object[])

Adds a composite key to the selection

Declaration

public void Add(object[] values)

Parameters

Type	Name	Description
System.Object[]	values	The composite key

| Improve this Doc View Source

AddFeature(IRecord)

Adds the specified record to the selection

Declaration

public void AddFeature(IRecord record)

Parameters

Type	Name	Description
IRecord	record

| Improve this Doc View Source

AddFeatures(IReader, Int32)

Adds records from the specified reader into this selection

Declaration

public int AddFeatures(IReader reader, int limit)

Parameters

Type	Name	Description
IReader	reader	The reader
System.Int32	limit	The maximum number of records to add. Specify -1 for all

Returns

Type	Description
System.Int32	Number of records added

| Improve this Doc View Source

AddRange(IEnumerable<Object[]>)

Adds a number of composite keys

Declaration

public void AddRange(IEnumerable<object[]> lst)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Object[]>	lst	A list of composite keys

| Improve this Doc View Source

Clear()

Removes all composite keys from the collection

Declaration

public void Clear()

| Improve this Doc View Source

Contains(Object[])

Returns a value indicating if the composite key is contained in the collection

Declaration

public bool Contains(object[] item)

Parameters

Type	Name	Description
System.Object[]	item	The composite key to look for

Returns

Type	Description
System.Boolean	True if the collection contains the composite key, false otherwise

| Improve this Doc View Source

CopyTo(Object[][], Int32)

Not implemented

Declaration

public void CopyTo(object[][] array, int arrayIndex)

Parameters

Type	Name	Description
System.Object[][]	array
System.Int32	arrayIndex

| Improve this Doc View Source

EncodeIDString(Object[])

Encodes the given combined keyset into an ID string for use in the Xml

Declaration

public string EncodeIDString(object[] values)

Parameters

Type	Name	Description
System.Object[]	values	The combined key

Returns

Type	Description
System.String	A base64 encoded ID string

| Improve this Doc View Source

GetEnumerator()

Returns an enumerator for the collection

Declaration

public IEnumerator<object[]> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<System.Object[]>	An enumerator for the collection

| Improve this Doc View Source

IndexOf(Object[])

Returns the index of the given composite key

Declaration

public int IndexOf(object[] item)

Parameters

Type	Name	Description
System.Object[]	item	The composite key to look for

Returns

Type	Description
System.Int32	The index of the composite key or -1 if the key is not found

| Improve this Doc View Source

Insert(Int32, Object[])

Inserts a key at the specified location

Declaration

public void Insert(int index, object[] item)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the key at
System.Object[]	item	The key to insert

| Improve this Doc View Source

ParseIDString(String)

Parses a base64 encoded string with key values

Declaration

public object[] ParseIDString(string id)

Parameters

Type	Name	Description
System.String	id	The base64 encoded ID string

Returns

Type	Description
System.Object[]	The composite value key

| Improve this Doc View Source

Remove(Object[])

Removes the given composite key from the collection

Declaration

public bool Remove(object[] item)

Parameters

Type	Name	Description
System.Object[]	item	The composite key to remove

Returns

Type	Description
System.Boolean	True if the composite key was found and removed, false otherwise

| Improve this Doc View Source

RemoveAt(Int32)

Removes the element at the specified location

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index of the item to remove

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Returns an enumerator for the collection

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	An enumerator for the collection

Implements

System.Collections.Generic.IList<T>

System.Collections.Generic.ICollection<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable