Autodesk.Revit.DB.DocumentSetIterator

The Autodesk.Revit.DB.DocumentSetIterator is a class in the Revit API that is used for iterating over a set of Autodesk.Revit.DB.Document objects. The iterator is used when a collection of documents needs to be processed iteratively.

Properties

The Autodesk.Revit.DB.DocumentSetIterator has the following properties:

• Current: The current Autodesk.Revit.DB.Document object in the collection.
• Index: The index of the current Autodesk.Revit.DB.Document object in the collection.
• Total: The total number of Autodesk.Revit.DB.Document objects in the collection.

Methods

The Autodesk.Revit.DB.DocumentSetIterator has the following methods:

• HasNext(): Returns true if there is another Autodesk.Revit.DB.Document object in the collection, otherwise returns false.
• Next(): Moves the iterator to the next Autodesk.Revit.DB.Document object in the collection and returns it.

Example Usage

Here is an example of how to use the Autodesk.Revit.DB.DocumentSetIterator:

// Get a collection of document objects
IEnumerable<Autodesk.Revit.DB.Document> documents = GetAllDocuments();

// Create a new iterator
Autodesk.Revit.DB.DocumentSetIterator iterator = new Autodesk.Revit.DB.DocumentSetIterator(documents);

// Loop through the collection of documents using the iterator
while (iterator.HasNext())
{
    Autodesk.Revit.DB.Document doc = iterator.Next();
    // Process the document
}

In this example, the GetAllDocuments() method returns a collection of Autodesk.Revit.DB.Document objects. The Autodesk.Revit.DB.DocumentSetIterator is then created using this collection, and is used to iterate over each document in the collection.

Conclusion

The Autodesk.Revit.DB.DocumentSetIterator is a useful class for iterating over a collection of Autodesk.Revit.DB.Document objects. It provides an efficient and effective way of processing documents that are stored in a collection.