1. 项目概述
在机械设计领域，SolidWorks作为主流的三维CAD软件，其二次开发能力一直是工程师们提升工作效率的利器。今天要分享的是如何通过C#调用CustomPropertyManager的GetAll3方法，实现批量获取模型自定义属性的高效解决方案。
这个技术点看似简单，但在实际工程应用中却能解决大问题。想象一下，当你需要处理上百个模型文件的属性信息时，手动逐个查看不仅耗时费力，还容易出错。而通过API编程获取这些数据，不仅速度提升数十倍，还能直接对接其他系统实现数据自动化流转。
2. 核心需求解析
2.1 为什么需要获取自定义属性
在机械设计流程中，自定义属性承载着关键元数据：
- 零件编号、版本号等标识信息
- 材料、重量等物理特性
- 供应商、成本等采购信息
- 设计者、审核状态等流程信息
这些属性通常被用于：
- 生成BOM（物料清单）报表
- 驱动工程图标题栏自动更新
- 与PDM/ERP系统进行数据交互
- 批量修改同类零件的参数
2.2 GetAll3方法的优势
相比早期版本的GetAll方法，GetAll3提供了更完善的特性：
- 支持获取配置特定属性（Configuration-specific）
- 返回属性值的解析状态（是否有效）
- 统一处理自定义和标准属性
- 性能优化，特别适合大批量操作
3. 开发环境准备
3.1 基础工具链
csharp复制// 必需组件清单
- Visual Studio 2019/2022（需安装.NET桌面开发工作负载）
- SolidWorks 2018 SP5及以上版本（建议使用最新LTS版本）
- SolidWorks API帮助文档（SDK中提供）
- SwDocumentMgr库（用于独立应用程序）
3.2 项目引用配置
在VS解决方案中需要添加以下COM引用：
- SolidWorks Interop.sldworks（主接口）
- SolidWorks Interop.swconst（常量定义）
- SolidWorks Interop.swpublished（高级API）
提示：建议将"嵌入互操作类型"设为False，避免后期类型转换问题
4. 核心代码实现
4.1 基础访问流程
csharp复制// 获取当前活动文档
ModelDoc2 doc = swApp.ActiveDoc;
// 获取属性管理器
CustomPropertyManager propMgr = doc.Extension.CustomPropertyManager[""];
// 调用GetAll3方法
object[] propNames = null;
object[] propValues = null;
object[] resolvedValues = null;
object[] wasResolved = null;
bool success = propMgr.GetAll3(
out propNames,
out propValues,
out resolvedValues,
out wasResolved
);
4.2 返回值处理技巧
GetAll3返回四个数组，需要特别注意：
- propNames：属性名数组
- propValues：原始表达式（如"=Material"）
- resolvedValues：解析后的实际值
- wasResolved：布尔数组，标记是否解析成功
典型处理方式：
csharp复制if(success && propNames != null)
{
for(int i=0; i<propNames.Length; i++)
{
string status = (bool)wasResolved[i] ? "已解析" : "未解析";
Console.WriteLine($"{propNames[i]}: {resolvedValues[i]} ({status})");
}
}
5. 高级应用场景
5.1 多配置属性处理
对于多配置模型，需要遍历所有配置：
csharp复制string[] configNames = doc.GetConfigurationNames();
foreach(string config in configNames)
{
propMgr = doc.Extension.CustomPropertyManager[config];
// 处理每个配置的属性...
}
5.2 批量导出到Excel
结合EPPlus库实现自动化报表：
csharp复制using(var package = new ExcelPackage())
{
var sheet = package.Workbook.Worksheets.Add("属性报表");
// 写入表头
sheet.Cells[1,1].Value = "属性名";
sheet.Cells[1,2].Value = "表达式";
sheet.Cells[1,3].Value = "解析值";
// 填充数据
for(int i=0; i<propNames.Length; i++)
{
int row = i + 2;
sheet.Cells[row,1].Value = propNames[i];
sheet.Cells[row,2].Value = propValues[i];
sheet.Cells[row,3].Value = resolvedValues[i];
}
package.SaveAs(new FileInfo(@"D:\属性报表.xlsx"));
}
6. 性能优化技巧
6.1 批量操作建议
- 对于大批量文件，使用SwDocumentMgr避免启动GUI
- 预先获取所有需要的属性名，减少重复调用
- 对频繁访问的属性考虑缓存机制
6.2 异常处理要点
必须处理的典型异常：
- 文件只读时的访问冲突
- 属性表达式循环引用
- 用户取消操作时的中断
推荐的处理模式：
csharp复制try
{
// 属性操作代码...
}
catch(COMException ex) when(ex.ErrorCode == -2147221164)
{
MessageBox.Show("SolidWorks未启动或版本不匹配");
}
catch(NullReferenceException)
{
MessageBox.Show("未打开有效文档");
}
7. 常见问题排查
7.1 属性获取为空的情况
可能原因及解决方案：
| 现象 | 可能原因 | 解决方案 |
|---|---|---|
| 返回空数组 | 当前配置无属性 | 检查默认配置或指定配置 |
| wasResolved全为false | 表达式错误 | 验证属性表达式语法 |
| 部分属性缺失 | 属性作用域限制 | 检查属性是否属于当前配置 |
7.2 性能瓶颈分析
通过Stopwatch诊断耗时环节：
csharp复制var watch = System.Diagnostics.Stopwatch.StartNew();
// 第一次调用（包含COM初始化）
propMgr.GetAll3(...);
watch.Stop();
Console.WriteLine($"首次调用: {watch.ElapsedMilliseconds}ms");
watch.Restart();
// 后续调用
propMgr.GetAll3(...);
watch.Stop();
Console.WriteLine($"缓存后调用: {watch.ElapsedMilliseconds}ms");
8. 工程实践建议
8.1 属性命名规范
推荐采用分级命名法：
- "PDM.Number" - PDM系统相关
- "BOM.Weight" - 物料清单相关
- "DRAW.Revision" - 工程图相关
避免使用特殊字符：
- 禁止：空格、引号、运算符
- 建议：用下划线替代空格
8.2 版本兼容性处理
针对不同SolidWorks版本的适配策略：
csharp复制if(swApp.RevisionNumber >= 280000) // SW2018+
{
// 使用GetAll3
}
else if(swApp.RevisionNumber >= 250000) // SW2015+
{
// 回退到GetAll2
}
else
{
// 使用传统GetAll
}
9. 扩展应用方向
9.1 与PDM系统集成
典型集成场景：
- 自动同步签入时的属性
- 根据工作流状态更新属性
- 批量修改项目所有文件的版本号
9.2 参数化设计支持
通过属性驱动设计变更：
csharp复制// 读取控制参数
string lengthExpr = propMgr.Get("控制长度");
// 更新模型尺寸
Dimension dim = part.Parameter("D1@草图1");
dim.Value = double.Parse(lengthExpr);
10. 调试与测试建议
10.1 单元测试框架
推荐使用NUnit构建测试用例：
csharp复制[Test]
public void GetAll3_ShouldReturnProperties_WhenFileHasCustomProps()
{
// 准备测试文档
var doc = OpenTestDocument("带有属性的零件.SLDPRT");
// 执行测试
var props = GetAll3Properties(doc);
// 验证结果
Assert.That(props, Has.Count.GreaterThan(0));
Assert.That(props["Material"], Is.EqualTo("AISI 304"));
}
10.2 交互式调试技巧
- 在VS中启用"非托管代码调试"
- 设置SolidWorks为调试启动程序
- 使用Immediate Window实时查看属性值
- 通过DebuggerDisplayAttribute优化对象查看
11. 安全与错误预防
11.1 输入验证策略
对所有外部输入进行严格验证：
csharp复制bool IsValidPropertyName(string name)
{
if(string.IsNullOrWhiteSpace(name)) return false;
if(name.Contains("=")) return false;
if(name.Length > 256) return false;
return true;
}
11.2 资源释放规范
必须释放的COM对象：
- 属性管理器实例
- 文档对象（非活动文档）
- 临时创建的配置对象
推荐使用模式：
csharp复制using(var doc = swApp.OpenDoc(...))
{
var propMgr = doc.Extension.CustomPropertyManager[""];
try {
// 使用属性管理器...
}
finally {
Marshal.ReleaseComObject(propMgr);
}
}
12. 最佳实践总结
经过多个项目的实际验证，以下实践最为可靠：
- 批量操作前先采样：随机检查几个文件的属性结构，确认数据一致性
- 采用渐进式加载：对于超大规模文件集，分批次处理并保存中间结果
- 记录操作日志：详细记录每个文件的处理状态，便于问题追踪
- 提供用户反馈：长时间操作时显示进度条，允许取消操作
最终实现的典型性能指标：
- 单个零件属性获取：50-100ms
- 百级文件批量处理：2-5分钟
- 内存占用：平均每个文件约200KB
在实际项目中，这套方案成功将原本需要数小时的手工操作缩短到10分钟以内，且实现了100%的数据准确性。特别在系列化产品设计中，通过属性驱动实现了"修改一处，全局更新"的高效工作流。