RevitSdkSamples/snapshot/2008/SDK/Samples/DeleteDimensions/CS/DeleteDimesions.cs

//
// (C) Copyright 2003-2007 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;
using System.Collections.Generic;
using System.Text;

using Autodesk;
using Autodesk.Revit;
using Autodesk.Revit.Elements;


namespace Revit.SDK.Samples.DeleteDimensions.CS
{
    /// <summary>
    ///Add a command that given a selection deletes all the unpinned dimensions 
    /// that are found in that selection.
    /// </summary>
    public class Command : IExternalCommand
    {
        /// <summary>
        /// Overload this method to implement the external command within 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)
        {
            //clear the element set
            elements.Clear();
            ElementSet selections = commandData.Application.ActiveDocument.Selection.Elements;

            //if nothing selected
            if (0 == selections.Size)
            {
                message = "Please select dimesions";
                return IExternalCommand.Result.Failed;
            }

            //enumerate the selected elements 
            foreach (Element e in selections)
            {
                //find out dimension
                Dimension dimesionTemp = e as Dimension;
                if (null != dimesionTemp)
                    //if the dimesion is unpinned
                    if (!dimesionTemp.Pinned)
                        elements.Insert(dimesionTemp);
            }

            //can not find out unpined dimesion
            if (0 == elements.Size)
            {
                message = "There are not any unpinned dimesions selected";
                return IExternalCommand.Result.Failed;
            }

            //delete unpinned dimensions
            commandData.Application.ActiveDocument.Delete(elements);
            return IExternalCommand.Result.Succeeded;
        }
    }
}