Autodesk.Revit.DB.Events.DocumentSaveToCentralProgressChangedEventArgs

该类是Revit API中的一个事件类，用于跟踪文档保存到中央的进展情况。

基本信息

• 命名空间：Autodesk.Revit.DB.Events
• 继承关系：System.EventArgs
• 稳定性：稳定
• 适用版本：Revit 2012及以上版本

构造函数

该类有两个构造函数：

• DocumentSaveToCentralProgressChangedEventArgs(int currentStep, int totalSteps, string currentTask, string progressStatus, bool cancel)

  用于创建一个新的文档保存到中央的进度事件。

• DocumentSaveToCentralProgressChangedEventArgs()

  用于创建一个默认的文档保存到中央的进度事件。

属性

该类有五个只读属性：

• CurrentStep

  获取当前操作的步骤数。

• TotalSteps

  获取操作总的步骤数。

• CurrentTask

  获取当前操作的任务名称。

• ProgressStatus

  获取当前操作的进展状态。

• Cancel

  获取或设置一个值，用于指示是否取消保存操作。默认值为false，表示不取消保存操作。

使用示例

以下示例演示如何捕获文档保存到中央的进度事件。

public void OnDocumentSaveToCentralProgressChanged(object sender, DocumentSaveToCentralProgressChangedEventArgs e)
{
    int currentStep = e.CurrentStep;
    int totalSteps = e.TotalSteps;
    string currentTask = e.CurrentTask;
    string progressStatus = e.ProgressStatus;

    // 显示保存进度
    Console.WriteLine("当前步骤：{0}/{1}", currentStep, totalSteps);
    Console.WriteLine("当前任务：{0}", currentTask);
    Console.WriteLine("进度状态：{0}", progressStatus);

    if (e.Cancel)
    {
        // 取消保存操作
        Console.WriteLine("用户取消了保存操作。");
    }
}

注意事项

• 在使用该事件类时，需要将其与Document.SaveToCentral方法配合使用。

• 该事件类仅适用于Revit 2012及以上版本。