ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Core.Data Namespace / QueryFilter Class / Offset Property
Example

In This Topic
    Offset Property (QueryFilter)
    In This Topic
    Gets or sets the positional offset returned by the query.
    Syntax
    public int Offset {get; set;}
    Public Property Offset As Integer
    Remarks
    Some datastores support pagination only through an SQL postfix clause; in these cases, the PostfixClause property should be used in conjunction with Offset.
    Example
    Fulltext search query
    {
      await QueuedTask.Run(() =>
      {
        using (Geodatabase geodatabase = new Geodatabase(new DatabaseConnectionFile(new Uri("path\\to\\sde\\file\\sdefile.sde"))))
        using (Table table = geodatabase.OpenDataset<Table>("WaterPipeInfo"))
        using (TableDefinition tableDefinition = table.GetDefinition())
        {
          bool supportsFullText = geodatabase.GetDatastoreProperties().SupportsFullTextIndex;
          if (!supportsFullText)
          {
            return;
          }
    
          IReadOnlyList<Index> indexes = tableDefinition.GetIndexes();
          IReadOnlyList<Field> fieldsToSearch = indexes.First().GetFields();
    
          FullTextSearchTermExpression searchRepairStatus = new FullTextSearchTermExpression()
          {
            SearchFields = fieldsToSearch[0].Name,
            SearchTerm = "Repaired",
            SearchType = FullTextSearchType.Simple
          };
    
          FullTextSearchTermExpression searchPipeMaterial = new FullTextSearchTermExpression()
          {
            SearchFields = fieldsToSearch[1].Name,
            SearchTerm = "Copper",
            SearchType = FullTextSearchType.Simple
          };
    
          FullTextOrExpression repairedOrCopperEx = new FullTextOrExpression(searchRepairStatus, searchPipeMaterial);
    
          QueryFilter queryfilter = new QueryFilter
          {
            FullTextExpression = repairedOrCopperEx,
            Offset = 1,
            RowCount = 20,
            PostfixClause = "Order By Size"
          };
    
          using (RowCursor rowCursor = table.Search(queryfilter, false))
          {
            // Use row cursor ...
          }
        }
      });
    }
    Pagination in QueryFilter
    {
      Task QueryFilterWithPaginationAsync(Table table, List<long> objectIDs) => QueuedTask.Run(() =>
      {
        int rowsPerBatch = 100;
        int offset = 0;
    
        // Query filter
        // Some datastores support pagination only through an SQL postfix clause
        QueryFilter queryFilter = new QueryFilter()
        {
          ObjectIDs = objectIDs,
          PostfixClause = "ORDER BY OBJECTID"
        };
    
        // Fetch rows in a batch from a table
        for (int index = offset; index <= objectIDs.Count; index += rowsPerBatch)
        {
          // Set number of rows to return from a table
          queryFilter.RowCount = rowsPerBatch;
    
          // Set positional offset to skip number of rows from a table
          queryFilter.Offset = index;
    
          using (RowCursor cursor = table.Search(queryFilter))
          {
            while (cursor.MoveNext())
            {
              using (Row row = cursor.Current)
              {
                Console.WriteLine(row.GetObjectID());
              }
            }
          }
        }
      });
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.3 or higher.
    See Also