Interface ISelectionSet
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
Provides access to members that manage a set of selected table rows or features.
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("F7AD47D1-D55E-11D1-8882-0000F877762D")]
public interface ISelectionSet
Remarks
A SelectionSet is used to reference a set of rows or features. This can be used to retrieve, process and select rows or features.
A SelectionSet can be obtained from IFeatureClass::Select or ITable::Select.
If you want to obtain a selection set on a feature layer it is good practice to cast the layer to the ITable interface then use the ITable::Select method. The table that you will obtain this way will mirror the content of the layer even if it has a definition query or a join.
The IFeatureSelection interface contains a SelectionSet property which can be used to access or set the selection on a feature layer. If trying to set the selection with this property you must make sure that the content of the selection set is compatible with the features currently in the layer. It is usually simpler to use IFeatureSelection::SelectFeatures instead.
Selection sets are also used in a number of other interfaces dealing with the selection: ITableSort, IFeatureSelection, ITableSelection, ISelectFeaturesOperation, to name a few.
There are three types of selection sets: ID sets, snapshots, and hybrids. A selection set's type is determined at creation time (for example, by the selType parameter of the IFeatureClass.Select method).
- ID sets are persisted as a list of Object IDs. When a row is requested from this type of selection set, the row is retrieved from the source table. This guarantees the most current version of the row will be retrieved.
- Snapshots are a cache of in-memory row objects. Snapshots will always contain the version of the row as it was when the selection was made.
- Hybrids determine how they are stored based on their current size. Initially, they behave as snapshots, but if they grow beyond a certain point, they will behave like ID sets. Hybrids can be used when the usage pattern isn't dependent on whether the newest version or an older version of a row will be used.
Two of the methods defined by this interface should not be used in .NET or Java applications - AddList and RemoveList. See the IGeoDatabaseBridge2 interface for interop-safe alternatives.
Properties
Count
The number of oids in the selection set.
long Count { get; }
Property Value
FullName
The full name of the selection set.
IName FullName { get; }
Property Value
Remarks
The FullName property has not been implemented.
IDs
Enumerates the object ids in the selection set.
IEnumIDs IDs { get; }
Property Value
Target
The Table or FeatureClass over which the selection set is defined.
ITable Target { get; }
Property Value
Remarks
The Target property returns a reference to the Table or Feature Class from which the Selection Set was constructed.
Methods
Add(long)
Adds an object id to the selection set.
void Add(long OID)
Parameters
OIDlong
AddList(long, ref long)
Adds a list of object id's to the selection set.
void AddList(long Count, ref long OIDList)
Parameters
Remarks
This method should not be called by .NET or Java applications. Instead, call IGeoDatabaseBridge2.AddList.
This method should not be used in .NET. Instead, use IGeoDatabaseBridge2.AddList.
This method should not be used in .NET. Instead, use IGeoDatabaseBridge2.AddList.
Combine(ISelectionSet, esriSetOperation, out ISelectionSet)
Combines this selection set with another selection set using the specified set operation.
void Combine(ISelectionSet otherSet, esriSetOperation setOp, out ISelectionSet resultSet)
Parameters
otherSetISelectionSetsetOpesriSetOperationresultSetISelectionSet
Remarks
Used to combine to SelectionSets. The resultSet parameter must be a third selection set and not any of the ones that are combined. For example, if you want to combine A and B and put the result in A, you must combine A and B into C, and then set A to C.
To combine two selection sets, the sets must be derived from the same table or feature class. Attempting to combine selection sets from different datasets will raise an error.
MakePermanent()
Makes the SelectionSet permanent. By default SelectionSets are deleted when released.
void MakePermanent()
Remarks
This method is not currently implemented.
Refresh()
Refreshes the state of a snapshot selection.
void Refresh()
RemoveList(long, ref long)
Removes a list of object id's from the selection set.
void RemoveList(long Count, ref long OIDList)
Parameters
Remarks
This method should not be called by .NET or Java applications. Instead, call IGeoDatabaseBridge2.RemoveList.
Search(IQueryFilter, bool, out ICursor)
Returns a cursor that can be used to retrieve the objects specified by a query over this selection set.
void Search(IQueryFilter QueryFilter, bool Recycling, out ICursor Cursor)
Parameters
QueryFilterIQueryFilterRecyclingboolCursorICursor
Remarks
Search will return an ICursor with all of the rows that satisfy the constraints specified by a query filter. If a null value is provided for the QueryFilter parameter, the cursor will contain all of the selection set's rows.
The Recycling parameter controls row object allocation behavior.
Recycling cursors rehydrate a single feature/row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a feature/row object returned by a recycling cursor across multiple calls to NextRow on the cursor. Feature/Row objects returned by a recycling cursor should not be modified. Non-recycling cursors return a separate object on each fetch.
The features/rows returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees "unique instance semantics" on non-recycling feature/row objects fetched during an edit session. If the object to be retrieved by a call to search has already been instantiated and is being referenced by the calling application, then a reference to the existing row object is returned.
Select(IQueryFilter, esriSelectionType, esriSelectionOption, IWorkspace)
Returns a new selection That contains the object ids selected by a query over this selection set.
ISelectionSet Select(IQueryFilter QueryFilter, esriSelectionType selType, esriSelectionOption selOption, IWorkspace selectionContainer)
Parameters
QueryFilterIQueryFilterselTypeesriSelectionTypeselOptionesriSelectionOptionselectionContainerIWorkspace