Listing the layout names

By Balaji Ramamoorthy

The layouts are stored in the dictionary “ACAD_LAYOUT”. To find the available layouts in a drawing one has to iterate the dictionary “ACAD_LAYOUT” available in Root dictionary.

To manage and access the layouts, like making them active etc. AcApLayoutManager class should be used. To add and delete the layouts you can use AcDbLayoutManager class. The sample code below lists the number & names of all layouts in the drawing and also the active layout.

From Lisp you may list all the layouts in a drawing by calling (LayoutList) function.

Here is the ObjectARX sample code :

static void ADSProjectListLayouts(void)
{
    // A project created using the ObjectARX wizard 
    // will already have this included.
    //#include "acaplmgr.h"
    //#include "dblayout.h"
 
    Acad::ErrorStatus es;
    AcDbDatabase *pDb 
        = acdbHostApplicationServices()->workingDatabase();
 
    AcApLayoutManager *pLayoutMngr =
        dynamic_cast
            (
                acdbHostApplicationServices()->layoutManager()
            );
 
    //print the active layout
    acutPrintf(
                ACRX_T("nActive Layout is : %s"),
                pLayoutMngr->findActiveLayout(Adesk::kTrue)
              );
 
    acutPrintf(
                ACRX_T("nNumber of Layouts: %inList of Layouts:"),
                pLayoutMngr->countLayouts()
              );
 
    //print rest of the layouts. First get the layout dictionary
    AcDbDictionary *pDict = NULL;
    if (Acad::eOk 
                == pDb->getLayoutDictionary(pDict,AcDb::kForRead))
    {           
        AcDbObject *pObj;
        ACHAR *pLayName;
        AcDbDictionaryIterator *pIter = pDict->newIterator();
 
        //Iterate through all the items in the dictionary
        for(;!pIter->done();pIter->next())
        {
            pIter->getObject(pObj,AcDb::kForRead);
            AcDbLayout *pLayout = AcDbLayout::cast(pObj);
 
            //The caller should not free the returned string.
            // Refer to ObjectARX documentation for getLayoutName
            es = pLayout->getLayoutName(pLayName);
 
            acutPrintf(ACRX_T("n --> %s"),pLayName);
 
            pLayout->close();
        }
        //clean up
        delete pIter;
        pDict->close();
    }
}

Here is the .Net sample code :

[CommandMethod("ListLayouts")]
public static void ListLayoutsMethod()
{
    Document doc 
        = Application.DocumentManager.MdiActiveDocument;
    Database db = doc.Database;
    Editor ed = doc.Editor;
 
    LayoutManager layoutMgr = LayoutManager.Current;
 
    ed.WriteMessage 
    (
        String.Format
        (
            "{0}Active Layout is : {1}", 
            Environment.NewLine, 
            layoutMgr.CurrentLayout
        )
    );
 
    ed.WriteMessage
    (
        String.Format
        (
            "{0}Number of Layouts: {1}{0}List of all Layouts:",
            Environment.NewLine, 
            layoutMgr.LayoutCount
        )
    );
 
    using (Transaction tr 
        = db.TransactionManager.StartTransaction())
    {
        DBDictionary layoutDic 
            = tr.GetObject(
                            db.LayoutDictionaryId, 
                            OpenMode.ForRead, 
                            false
                          ) as DBDictionary;
 
        foreach (DBDictionaryEntry entry in layoutDic)
        {
            ObjectId layoutId = entry.Value;
 
            Layout layout 
                = tr.GetObject(
                                layoutId, 
                                OpenMode.ForRead
                              ) as Layout;
 
            ed.WriteMessage(
                String.Format(
                                "{0}--> {1}", 
                                Environment.NewLine, 
                                layout.LayoutName
                             )
                           );
        }
        tr.Commit();
    }
}