Search.FindIncremental Method (Document, Boolean)

Returns an enumerable that steps through the items specified by this Search in document.

Namespace: Autodesk.Navisworks.Api
Assembly: Autodesk.Navisworks.Api (in Autodesk.Navisworks.Api.dll)

Syntax

Visual Basic
Public Function FindIncremental ( _
	document As Document, _
	reportProgress As Boolean _
) As IEnumerable(Of ModelItem)
C#
public IEnumerable<ModelItem> FindIncremental(
	Document document,
	bool reportProgress
)
Visual C++
public:
IEnumerable<ModelItem^>^ FindIncremental(
	Document^ document, 
	bool reportProgress
)

Parameters

document
Type: Autodesk.Navisworks.Api..::..Document
Document to search
reportProgress
Type: System..::..Boolean
true if progress should be reported via normal Application progress reporting

Examples

CopyUsing a Search object
//Create a new search
Search s = new Search();

//set the selection to everything
s.Selection.SelectAll();

//Add a search condition
s.SearchConditions.Add(SearchCondition.HasCategoryByName(PropertyCategoryNames.Geometry));

try
{
   //get the first ModelItem found by applying this search
   IEnumerable<ModelItem> searchResults = s.FindIncremental(Autodesk.Navisworks.Api.Application.ActiveDocument, true);

   int i = 1;
   ModelItem requiredModelItem = null;
   foreach (ModelItem result in searchResults)
   {
      //iterate until we get the second item
      if (i == 2)
      {
         requiredModelItem = result;
         break;
      }
      else
      {
         i++;
      }
   }

   //Is there a second model item in the search
   if (requiredModelItem != null)
   {
      //Clear selection first
      Autodesk.Navisworks.Api.Application.ActiveDocument.CurrentSelection.Clear();

      //Select the item in the model
      Autodesk.Navisworks.Api.Application.ActiveDocument.CurrentSelection.Add(requiredModelItem);
   }
}
catch (CanceledOperationException)
{
   //the user cancelled the search
}

Exceptions

ExceptionCondition
System..::..ArgumentNullException Argument 'document' is null
System..::..InvalidOperationException Search Selection contains explicit items from a different document
Autodesk.Navisworks.Api..::..CanceledOperationException End user cancels operation through progress interface

See Also

M:Autodesk.Navisworks.Api.Search.FindIncremental(Autodesk.Navisworks.Api.Document,System.Boolean)