Autodesk.Revit.DB.IFamilyLoadOptions

IFamilyLoadOptions是Revit API中的一个接口，用于控制在加载族文件时的行为。该接口的实现将决定哪些族文件将被加载以及如何加载它们。

方法

IFamilyLoadOptions接口有两个方法，分别如下：

OnFamilyFound Method

当Revit在扫描给定目录中的文件时发现一个族文件时，该方法将被调用。

public bool OnFamilyFound(string familyPath, bool sourceIsRfa, out bool skipThisFile)

参数：

• familyPath（string）：族文件的路径
• sourceIsRfa（bool）：如果族文件是通过插件创建的，则为True，否则为False
• skipThisFile（out bool）：如果希望跳过此族文件，则将此参数设置为True，否则为False

返回值：bool，表示是否加载此文件。如果返回False，Revit将不会加载该族文件。

OnSharedFamilyFound Method

当Revit在扫描给定目录中的文件时发现一个共享族文件时，该方法将被调用。

public bool OnSharedFamilyFound(FamilySource source, string familyName, string familyLocation, FamilyLoadMethod loadType, out FamilySource newSource)

参数：

• source（FamilySource）：文件的来源
• familyName（string）：族文件的名称
• familyLocation（string）：族文件的位置
• loadType（FamilyLoadMethod）：族文件的加载方式
• newSource（out FamilySource）：如果希望从其他地方加载此族文件，则将此参数设置为新的 FamilySource 值

返回值：bool，表示是否加载此文件。如果返回False，Revit将不会加载该共享族文件。

使用

为了使用IFamilyLoadOptions接口，在C#中需要实现该接口，并将实现传递给Family类的Load方法。例如：

public class CustomFamilyLoadOptions : IFamilyLoadOptions
{
    public bool OnFamilyFound(string familyPath, bool sourceIsRfa, out bool skipThisFile)
    {
        // 实现必要的逻辑
        // 返回布尔值，指示是否加载此族文件

        skipThisFile = false; // 例如，这里仅作为示例返回False，表示加载此族文件
        return true;
    }

    public bool OnSharedFamilyFound(FamilySource source, string familyName, string familyLocation, FamilyLoadMethod loadType, out FamilySource newSource)
    {
        // 实现必要的逻辑
        // 返回布尔值，指示是否加载此族文件

        newSource = source; // 例如，这里仅作为示例返回之前的来源
        return true;
    }
}

// 在调用Family.Load方法时，传递该实现
var options = new CustomFamilyLoadOptions();
var family = Family.Load(familyPath, options);

总结

IFamilyLoadOptions是一个重要的Revit API接口，允许控制加载族文件的方式和行为。实现此接口可以为程序开发者提供更多的控制能力，来适应不同的使用情况。