//
// (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 Autodesk.Revit;
using Autodesk.Revit.Elements;
namespace Revit.SDK.Samples.VisibilityController.CS
{
///
/// Implements the Revit add-in interface IExternalCommand
///
public class Command : IExternalCommand
{
///
/// Implement this method as an external command for Revit.
///
/// An object that is passed to the external application
/// which contains data related to the command,
/// such as the application object and active view.
/// 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.
/// A set of elements to which the external application
/// can add elements that are to be highlighted in case of failure or cancellation.
/// 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.
public virtual IExternalCommand.Result Execute(ExternalCommandData commandData
, ref string message, ElementSet elements)
{
try
{
if (null == commandData)
{
throw new ArgumentNullException("commandData");
}
// create an instance of VisibilityCtrl
VisibilityCtrl visiController = new VisibilityCtrl(commandData.Application.ActiveDocument);
commandData.Application.ActiveDocument.BeginTransaction();
// create a user interface form
using (VisibilityCtrlForm dlg = new VisibilityCtrlForm(visiController))
{
// show dialog
System.Windows.Forms.DialogResult result = dlg.ShowDialog();
if (result == System.Windows.Forms.DialogResult.OK)
{
commandData.Application.ActiveDocument.EndTransaction();
return IExternalCommand.Result.Succeeded;
}
else if (result == System.Windows.Forms.DialogResult.Yes)
{
// isolate the selected element(s)
visiController.Isolate();
commandData.Application.ActiveDocument.EndTransaction();
return IExternalCommand.Result.Succeeded;
}
}
commandData.Application.ActiveDocument.AbortTransaction();
return IExternalCommand.Result.Cancelled;
}
catch (Exception ex)
{
message = ex.Message;
return IExternalCommand.Result.Failed;
}
}
}
}