SpatialIndexDescription Constructor(Index,FeatureClassDescription)

In This Topic

Creates a description object of the spatial ArcGIS.Core.Data.Index. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public SpatialIndexDescription( 
   Index spatialIndex,
   FeatureClassDescription featureClassDescription
)

Public Function New( _
   ByVal spatialIndex As Index, _
   ByVal featureClassDescription As FeatureClassDescription _
)

Parameters

spatialIndex: The spatial index the description object is representing
featureClassDescription: The description object representing the ArcGIS.Core.Data.FeatureClass that will hold the index.

Exceptions

Exception	Description
System.ArgumentException	Index contains a non-spatial field
System.ArgumentNullException	spatialIndex cannot be null
System.ArgumentNullException	featureClassDescription cannot be null
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

The spatialIndex parameter must contain a spatial field otherwise an System.ArgumentException will be thrown.

Example

Removing spatial index

public void RemoveSpatialIndex(SchemaBuilder schemaBuilder, FeatureClassDefinition featureClassDefinition)
{
    // Create a spatial description  
    SpatialIndexDescription spatialIndexDescription = new SpatialIndexDescription(new FeatureClassDescription(featureClassDefinition));

    // Enqueue the DDL operation to remove index 
    schemaBuilder.Delete(spatialIndexDescription);

    // Execute the delete index operation
    bool isDeleteIndexSuccess = schemaBuilder.Build();
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.4 or higher.

Reference

SpatialIndexDescription Class
SpatialIndexDescription Members
Overload List

Send feedback