revit二次开发API示例 TypeRegeneration族类型再生

应用程序：TypeRegeneration

Revit 平台：所有

Revit 版本：2011.0

首次发布版本：2010.0

编程语言：C#

技能水平：初学者

类别：族

类型：ExternalCommand

主题：族类型再生

摘要：本示例演示了使用 Revit API 进行族类型再生。

相关类：

Autodesk.Revit.UI.IExternalCommand

Autodesk.Revit.UI.UIDocument

Autodesk.Revit.DB.Element

Autodesk.Revit.DB.FamilyManager

Autodesk.Revit.DB.ParameterSet

项目文件：

Command.cs

此文件包含从 IExternalCommand 继承的 Command 类。该类实现了 Execute 方法以调用 API FamilyManager.CurrentType。

MessageForm.cs

此文件包含一个窗体，显示再生结果给用户。

描述：

该示例仅能用于族中。该示例大多使用 FamilyManager 类来实现功能：检查每个类型再生是否有任何错误或警告。Revit 模型将更改为下一个模型。最后，给出一个结论：如果所有再生都进行顺利，用户将收到一条消息，内容为“该族中的所有类型已经成功再生。”如果有任何错误结果，将显示一个消息，其中说明哪些类型存在问题。有一个日志文件，存储在窗体中显示的所有信息。

- 要获取或设置当前类型，请使用 FamilyManager 的 CurrentType 属性。

- 要获取所有族类型，请使用 FamilyManager 的 Types 属性。

说明：

1. 按照以下步骤更新您的 Revit.ini：

[ExternalCommands]

ECCount = 1

ECClassName1 = Revit.SDK.Samples.TypeRegeneration.CS.Command

ECAssembly1 = <你的路径>\TypeRegeneration.dll

2. 启动 Revit。

3. 为了使用族，用户应手动打开族文档。

4. 运行外部命令 TypeRegeneration。

源代码：
完整的源代码请加入QQ群649037449，在群文件中下载RevitSDK.exe，解压后在文件夹中搜索本文中应用程序名称即可获得完整源码

Command.cs

// 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 Autodesk.Revit;

using Autodesk.Revit.DB;

using Autodesk.Revit.UI;

using System.Windows.Forms;

using System.IO;

using System.Reflection;

namespace Revit.SDK.Samples.TypeRegeneration.CS

{

/// <summary>

/// A class inherits IExternalCommand interface.

/// this class controls the class which subscribes handle events and the events' information UI.

/// like a bridge between them.

/// </summary>

[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]

[Autodesk.Revit.Attributes.Regeneration(Autodesk.Revit.Attributes.RegenerationOption.Manual)]

[Autodesk.Revit.Attributes.Journaling(Autodesk.Revit.Attributes.JournalingMode.NoCommandData)]

public class Command : IExternalCommand

{

#region Class Memeber Variables

/// <summary>

/// store family manager

/// </summary>

FamilyManager m_familyManager;

/// <summary>

/// store the log file name

/// </summary>

string m_logFileName;

#endregion

#region Class Interface 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 Autodesk.Revit.UI.Result Execute(ExternalCommandData commandData,

ref string message,

ElementSet elements)

{

Document document;

string assemblyPath;

document = commandData.Application.ActiveUIDocument.Document;

assemblyPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);

m_logFileName = assemblyPath + "\\RegenerationLog.txt";

//only a family document can retrieve family manager

if (document.IsFamilyDocument)

{

m_familyManager = document.FamilyManager;

//create regeneration log file

StreamWriter writer = File.CreateText(m_logFileName);

writer.WriteLine("Family Type Result");

writer.WriteLine("-------------------------");

writer.Close();

using(MessageForm msgForm=new MessageForm())

{

msgForm.StartPosition = FormStartPosition.Manual;

CheckTypeRegeneration(msgForm);

return Autodesk.Revit.UI.Result.Succeeded;

}

else

{

message = "please make sure you have opened a family document!";

return Autodesk.Revit.UI.Result.Failed;

}

#endregion

#region Class Implementation

/// <summary>

/// After setting CurrentType property, the CurrentType has changed to the new one,the Revit model will change along with the current type

/// </summary>

/// <param name="msgForm">the form is used to show the regeneration result</param>

public void CheckTypeRegeneration(MessageForm msgForm)

{

//the list to record the error messages

List<string> errorInfo = new List<string>();

try

{

foreach (FamilyType type in m_familyManager.Types)

{

if (!(type.Name.ToString().Trim()==""))

{

try

{

m_familyManager.CurrentType = type;

msgForm.AddMessage(type.Name+" Successful\n",true);

WriteLog(type.Name + " Successful");

}

catch

{

errorInfo.Add(type.Name);

msgForm.AddMessage(type.Name+" Failed \n",true);

WriteLog(type.Name + " Failed");

}

msgForm.ShowDialog();

}

//add a conclusion regeneration result

string resMsg;

if (errorInfo.Count > 0)

{

resMsg = "\nResult: " + errorInfo.Count + " family types regeneration failed!";

foreach (string error in errorInfo)

{

resMsg += "\n " + error;

}

else

{

resMsg = "\nResult: All types in the family can regenerate successfully.";

}

WriteLog(resMsg.ToString());

resMsg += "\nIf you want to know the detail regeneration result please get log file at "+m_logFileName;

msgForm.AddMessage(resMsg,false);

msgForm.ShowDialog();

}

catch(Exception ex)

{

WriteLog("There is some problem when regeneration:" + ex.ToString());

msgForm.AddMessage("There is some problem when regeneration:"+ex.ToString(),true);

msgForm.ShowDialog();

}

/// <summary>

/// The method to write line to log file

/// </summary>

/// <param name="logStr">the log string</param>

private void WriteLog(string logStr)

{

StreamWriter writer = null;

writer = File.AppendText(m_logFileName);

writer.WriteLine(logStr);

writer.Close();

}

#endregion

}