topic Re: Repeat External Command in Revit API Forum

Repeat External Command

Anonymous — Mon, 01 Jun 2015 13:18:45 GMT

I am trying to figure out how to repeat an external command similar to placing elements. I have written an api that placing an object directly on top of door from a linked file. It extracts and stores some information from the door. Currently you have to click the button for the command after every door. I am looking to be able to just click on the doors one right after the other. I have tried a couple of things to keep the command active but as soon as you hit the escape key to stop the command everything disappears. Any ideas would be appreciated.

Re: Repeat External Command

Anonymous — Tue, 02 Jun 2015 15:42:21 GMT

I've actually figured it out myself. I wrapped that part I want to repeat in an endless while statement and I placed the transaction start after picking an element. This avoids the transacation being started but never finished, which causes everything created by the external command to be deleted when the escape key is hit. I also set the catch for the escape key to report back as Result.Succeeded.

public Result Execute(Autodesk.Revit.UI.ExternalCommandData commandData, ref string message, ElementSet elements)
        {
            m_application = commandData.Application;
            m_document = m_application.ActiveUIDocument;

            try
            {
                int linkedFileId = 0;
                int linkedElementId = 0;

                int testInt = -1;
                while(testInt <0)
                {
                    #region Extract Door Information
                    // Selectin filter so that you can only pick doors
                    ISelectionFilter selectionFilter = new SecurityDoorFilter();
                    //Selection. You can only select one linked element at a time
                    Reference linkedDoorRef = m_document.Selection.PickObject(Autodesk.Revit.UI.Selection.ObjectType.LinkedElement, "Please pick a door to tag.");
                    Transaction t = new Transaction(m_document.Document);
                    t.Start("Add Security Door");

                    //Do some stuff                  

                    t.Commit();
                }
                    #endregion
                return Result.Succeeded;
            }
            catch (Autodesk.Revit.Exceptions.OperationCanceledException)
            {
                // Selection Cancelled.
                return Result.Succeeded;
            }
            catch (Exception ex)
            {
                // If any error, give error information and return failed
                            return Result.Failed;
            }

Re: Repeat External Command

arnostlobel — Tue, 02 Jun 2015 16:16:16 GMT

Hello adeuley,

I am afraid I have to tell you that yours is not an solution. Although it works for this particular case, it still suffers from the original problem which is still present in your code: transactions objects (including Transaction, TransactionGroup, and SubTransaction) need to be enclosed in a “using” scope that will guarantee the object are terminated properly.

So, your original code would be implement properly as follows:

using (Transaction trans = new Transaction(m_document.Document))
{
  trans.Start("Add Security Door");
  // Do some stuff
  trans.Commit();
}

That will guarantee that even in the case of an exception from the “doing some stuff” the transaction will get finished properly and in time.

Naturally, since in your case the OperationCanceledException is anticipated (as it often is), you need to account for it in your implementation as well. Therefore, the following will be the correct implementation you need:

using (Transaction trans = new Transaction(m_document.Document))
{
   trans.Start("Add Security Door");
   try
   { 
     // Do some stuff
   }
   catch (OperationCanceledException)
   {     
      // this is anticipated no need to do anything
   }
   trans.Commit();
   return (trans.GetStatus() == TransactionStatus.Committed)
      ? Succeeded
      : Failed;
}

Again, please remember to always enclose your transactions into a "using" scope block. It helps to avoid unexpected behavior due to unfinalized transactions phases.

Thank you

Re: Repeat External Command

Anonymous — Tue, 02 Jun 2015 17:20:46 GMT

I've updated my code as you suggested and now I am back to my original problem. I can't add more than one object without having to click the button for the external command before placing each object. Do you have any suggestions on how I can make your code work for that?

Re: Repeat External Command

arnostlobel — Tue, 02 Jun 2015 18:22:21 GMT

adeuley,

I do not completely understand why my change make your infifite loop to be interupted. However, I think I can suggest some implementation. Here is what I woudl probably use if I were you.

First of all, I'd separate the door-tag-selecting procedure along the following approach:

public ElementId selectDoorTag (Document doc)
{
    try
    {
        // invoke the selection here
        doc.Selection.PickObject(...)
        
        // analyse the selection here to see if any tags were picked
        // if so, return its Id,
        // otherwise return ElementId.InvalidElementId
    }
    catch (OperationCancelledException
    {
        // this is inticipated and indicates the end the iteraction session
    )
    
    return ElementId.InvalidElementId;  // indicates the user did not make a selection
}

Then I would modify the main loop as follows:

using (Transaction trans = new Transaction(document, "Added Security Door")
{
    ElementId tagId = selectDoorTag(document);
    while (tagId != ElementId.InvalidElementId)
    {
        trans.Start();
        // add a security door here
        trans.Commit();
        
        if (trans.GetStatus() != TransactionStatus.Committed)
        {
            // I assume we will not continue in case of a failure
            return Failed;
        }

        // invoke another selecting action
        tagId = selectDoorTag(document);
    }
}

Does that make sense?

Please keep in mind I have typed the code above in Notepad and I might have made a typo here and there. You need to make sure it compiles.

Cheers

Re: Repeat External Command

Aaron.Lu — Wed, 03 Jun 2015 09:59:58 GMT

cool, glad to hear you've found the solution by yourself!