Get all open Revit Documents

[mcaruso]

Hi,

I'm coming from AutoCAD development background and was looking for a similar method to get all open documents opened in the Revit UI.

Is there something like this for Revit?

Thanks

[ricaun]

The Application class has a Documents method, doc below.

https://www.revitapidocs.com/2022/8a32ffe0-7e80-e85c-78aa-1af48ace4d74.htm

Some like this:

UIApplication uiapp = commandData.Application;
var documents = uiapp.Application.Documents;

See yaa

[perry.swoboda]

You can also use the GetOpenUIViews method from the UIDocument.

IList<UIView> currentOpenViews = uidoc.GetOpenUIViews();

[perry.swoboda]

Oh wait, you wanted documents.  🙂

[mcaruso]

Thanks, everyone! I ended up using:

Autodesk.Revit.ApplicationServices.Application app = cmdData.Application.Application;
DocumentSet ds = app.Documents;

[YorickSOHO]

Hi, I am reopening this thread as my researches keep leading me here.

I feel the app.Documents solution doesn't really answer the question as it was written because it gets all database opened documents not just the ones opened and visible in the UI.

I would like to get only UI opened documents.

I would like my code to close all documents (app.Documents) except for the ones that are opened in the UI. Script should not temper with my user interface and work.
I thought I could do this thanks to UIDocument and GetOpenUIViews() but it only returns the opened UIViews for the UIDocument  passed (logic you may say)
I also tryed to use Application.Documents, go through each Document and get their ActiveView, but it returns null even for documents which are opened in the UI but are not the active document.

I hope someone can get me out of this Ourobos puzzle 

[perry.swoboda]

Maybe try a combination, though I was unaware you could open a document in Revit without opening at least one view.

Go through all the docs, convert them to UIDocuments and then check if they have any open views.

This is untested code but something like this.

var docs = app.Documents;
foreach (var doc in docs)
{
    UIDocument uiDoc = new UIDocument(doc);
    if (uiDoc.GetOpenViews().IsAny())
    {
        // This is a doc with an open view in the UI.
    }
}

[TripleM-Dev.net]

Hi @YorickSOHO ,

What's happening that you need to close documents that aren't visible in the UI?

There can be valid reasons a document is open but not visible in the UI, for instance Linked Revit models opens it as read-only so it can be displayed as link. This is also the reason a document can't be opened in the UI AND linked to a document in the same session. See: Document.Islinked I wouldn't advise closing those (if that's even possible like that)

The only one I can think off is that a addin has opened the document in the background and not closed it properly.

[YorickSOHO]

Thank you @perry.swoboda, it was what I was after. I too often neglect looking at API constructors.

For a bit of context, yes you can open a document without any view opened. For instance, and my specific case, using doc.EditFamily(Family) will open the family document in the background. OpenDocumentFile() will do just that as well,  API documentation says : "This method opens the document into memory but does not make it visible to the user in any way."

What my code does is from a family opened in UI, it goes through the tree of nested families, make changes to all of them and reloads them reversing the tree. I then need to Close these documents to release memory.
I just wanted to prevent closing of all documents but only close the ones opened by my script (without needing to log them in any way).

As for @TripleM-Dev.net fear (?), Close method returns an InvalidOperationException if you try to close a link, or any document you shouldn't close, like the active one,  so we're safe here 😉

Regards,

[TripleM-Dev.net]

Hi,

"I just wanted to prevent closing of all documents but only close the ones opened by my script (without needing to log them in any way)."

I Use the document's hash code as a reference to find the correct document again,

Remarks
The hash code is the same for document instances that represent the same document currently opened in the Revit session. The hash code is generated when a Revit file is opened or created in session. If the same Revit file is opened later (in the same session or a different session) the hash code will not be the same.