RevitSdkSamples/snapshot/2009/SDK/Samples/BlendVertexConnectTable/CS/Command.cs

//
// (C) Copyright 2003-2008 by Autodesk, Inc.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// AUTODESK SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. AUTODESK, INC.
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
//
// Use, duplication, or disclosure by the U.S. Government is subject to
// restrictions set forth in FAR 52.227-19 (Commercial Computer
// Software - Restricted Rights) and DFAR 252.227-7013(c)(1)(ii)
// (Rights in Technical Data and Computer Software), as applicable.
//

using System;
using System.Collections.Generic;
using System.Windows.Forms;

using Autodesk.Revit; // Revit API namespace
using Autodesk.Revit.Elements; 
using Autodesk.Revit.Geometry; 

namespace Revit.SDK.Samples.BlendVertexConnectTable.CS
{
    /// <summary>
    /// Implements the Revit add-in interface IExternalCommand.
    /// Besides, this class will pop up a form to preview vertex connection edges
    /// and vertexes connection data of blend
    /// </summary>
    class Command : IExternalCommand
    {
        #region IExternalCommand Members Implementation
        /// <summary>
        /// Implement this method as an external command for Revit.
        /// </summary>
        /// <param name="commandData">An object that is passed to the external application 
        /// which contains data related to the command, 
        /// such as the application object and active view.</param>
        /// <param name="message">A message that can be set by the external application 
        /// which will be displayed if a failure or cancellation is returned by 
        /// the external command.</param>
        /// <param name="elements">A set of elements to which the external application 
        /// can add elements that are to be highlighted in case of failure or cancellation.</param>
        /// <returns>Return the status of the external command. 
        /// A result of Succeeded means that the API external method functioned as expected. 
        /// Cancelled can be used to signify that the user cancelled the external operation 
        /// at some point. Failure should be returned if the application is unable to proceed with 
        /// the operation.</returns>
        public IExternalCommand.Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
        {
            try
            {
                // check whether selection is only one element
                if (null == commandData.Application.ActiveDocument.Selection || 
                    1 != commandData.Application.ActiveDocument.Selection.Elements.Size)
                {
                    MessageBox.Show("Please select only one family instance(Blend)", "Revit",
                        MessageBoxButtons.OK, MessageBoxIcon.Warning);
                    return IExternalCommand.Result.Cancelled;
                }

                // check whether view is open
                Autodesk.Revit.Elements.View currentView = commandData.Application.ActiveDocument.ActiveView;
                if (null == currentView)
                {
                    MessageBox.Show("Please open view firstly", "Revit",MessageBoxButtons.OK, MessageBoxIcon.Warning);
                    return IExternalCommand.Result.Cancelled;
                }

                // display form to show vertex connection table and preview all edges
                using (VertexConnectTableForm vertexConnectForm = new VertexConnectTableForm(commandData))
                {
                    vertexConnectForm.ShowDialog();
                }
            }
            catch (Exception ex)
            {
                message = ex.ToString();
                return IExternalCommand.Result.Failed;
            }

            return IExternalCommand.Result.Succeeded;
        }
        #endregion
    }
}