软航科技文档中心

Appearance

在菜单上添加自定义按钮的相关事件 ​

概述 ​

本节介绍软航OFFICE文档控件提供的在菜单上添加自定义按钮的相关事件，这些事件允许开发者在用户与菜单上的自定义按钮交互时进行响应和处理，为文档管理系统提供完整的自定义按钮事件处理能力。

自定义菜单按钮事件 ​

OnCustomButtonOnMenuCmd ​

语法：

javascript
OnCustomButtonOnMenuCmd(btnPos, btnCaption, btnID)

功能：
该事件在用户单击菜单上的自定义按钮时执行。

参数：

名称必选/可选数据类型说明
btnPos必选long自定义菜单按钮位置
btnCaption必选string自定义菜单按钮名称
btnID必选long自定义菜单按钮ID

说明：
各个参数的含义请参考AddCustomButtonOnMenu方法。在事件中可以通过判断btnPos和btnCaption或者btnID，在对点击按钮事件进行相应操作。

使用示例：

javascript
// 基本用法
<script language="JScript" for="TANGER_OCX" event="OnCustomButtonOnMenuCmd(btnPos, btnCaption, btnID)">
    console.log("自定义菜单按钮点击:");
    console.log("按钮位置:", btnPos);
    console.log("按钮名称:", btnCaption);
    console.log("按钮ID:", btnID);
</script>

// 根据按钮ID处理不同操作
<script language="JScript" for="TANGER_OCX" event="OnCustomButtonOnMenuCmd(btnPos, btnCaption, btnID)">
    switch(btnID) {
        case 3001:
            console.log("执行文档保存操作");
            // 执行文档保存
            TANGER_OCX_SaveEditToServerDisk();
            break;
        case 3002:
            console.log("执行文档打印操作");
            // 执行文档打印
            TANGER_OCX_PrintDocument();
            break;
        case 3003:
            console.log("执行文档转换操作");
            // 执行文档转换
            TANGER_OCX_ConvertToPDF();
            break;
        case 3004:
            console.log("执行文档加密操作");
            // 执行文档加密
            TANGER_OCX_EncryptDocument();
            break;
        default:
            console.log("未知按钮操作:", btnID);
    }
</script>

// 根据按钮名称处理操作
<script language="JScript" for="TANGER_OCX" event="OnCustomButtonOnMenuCmd(btnPos, btnCaption, btnID)">
    if (btnCaption === "保存文档") {
        console.log("执行保存文档操作");
        // 执行保存操作
        TANGER_OCX_SaveEditToServerDisk();
    } else if (btnCaption === "打印文档") {
        console.log("执行打印文档操作");
        // 执行打印操作
        TANGER_OCX_PrintDocument();
    } else if (btnCaption === "转换为PDF") {
        console.log("执行转换为PDF操作");
        // 执行转换操作
        TANGER_OCX_ConvertToPDF();
    } else if (btnCaption === "加密文档") {
        console.log("执行加密文档操作");
        // 执行加密操作
        TANGER_OCX_EncryptDocument();
    } else {
        console.log("其他按钮操作:", btnCaption);
    }
</script>

// 根据按钮位置处理操作
<script language="JScript" for="TANGER_OCX" event="OnCustomButtonOnMenuCmd(btnPos, btnCaption, btnID)">
    switch(btnPos) {
        case 1:
            console.log("第一个按钮被点击:", btnCaption);
            // 处理第一个按钮
            break;
        case 2:
            console.log("第二个按钮被点击:", btnCaption);
            // 处理第二个按钮
            break;
        case 3:
            console.log("第三个按钮被点击:", btnCaption);
            // 处理第三个按钮
            break;
        default:
            console.log("其他位置按钮被点击:", btnPos, btnCaption);
    }
</script>

// 记录按钮操作
<script language="JScript" for="TANGER_OCX" event="OnCustomButtonOnMenuCmd(btnPos, btnCaption, btnID)">
    var timestamp = new Date().toISOString();
    console.log("自定义按钮操作记录:");
    console.log("按钮位置:", btnPos);
    console.log("按钮名称:", btnCaption);
    console.log("按钮ID:", btnID);
    console.log("操作时间:", timestamp);
    
    // 可以记录用户按钮操作日志
    // logUserAction('custom_button', btnCaption, timestamp);
</script>

方法分类总结 ​

分类事件功能说明
自定义按钮OnCustomButtonOnMenuCmd自定义菜单按钮点击时触发自定义按钮操作

使用流程 ​

1. 基本自定义按钮事件处理流程 ​

javascript
// 基本自定义按钮事件处理流程
function basicCustomButtonEventHandling() {
    // 自定义按钮事件处理
    function handleCustomButton(btnPos, btnCaption, btnID) {
        console.log("自定义按钮点击:", btnCaption);
        // 处理自定义按钮
    }
}

2. 高级自定义按钮事件处理流程 ​

javascript
// 高级自定义按钮事件处理流程
function advancedCustomButtonEventHandling() {
    // 自定义按钮事件配置
    var customButtonEventConfig = {
        enableLogging: true,
        enableCustomHandling: true,
        enableButtonValidation: true
    };
    
    // 处理自定义按钮
    function handleAdvancedCustomButton(btnPos, btnCaption, btnID) {
        if (customButtonEventConfig.enableLogging) {
            console.log("自定义按钮日志:", btnCaption);
        }
        
        if (customButtonEventConfig.enableCustomHandling) {
            // 执行自定义处理
        }
    }
}

3. 自定义按钮事件质量控制流程 ​

javascript
// 自定义按钮事件质量控制流程
function customButtonEventQualityControl() {
    // 处理自定义按钮事件质量控制
    function controlCustomButtonEventQuality() {
        var customButtonEventQuality = {
            totalEvents: 0,
            successfulEvents: 0,
            failedEvents: 0,
            qualityScore: 0
        };
        
        // 计算质量分数
        if (customButtonEventQuality.totalEvents > 0) {
            customButtonEventQuality.qualityScore = (customButtonEventQuality.successfulEvents / customButtonEventQuality.totalEvents) * 100;
        }
        
        console.log("自定义按钮事件质量控制:", customButtonEventQuality);
        return customButtonEventQuality;
    }
    
    // 执行质量控制
    var qualityResult = controlCustomButtonEventQuality();
    console.log("自定义按钮事件质量控制结果:", qualityResult);
}

完整示例 ​

1. 基础自定义按钮事件处理 ​

javascript
// 基础自定义按钮事件处理示例
function basicCustomButtonEventHandling() {
    // 自定义按钮处理
    function onCustomButton(btnPos, btnCaption, btnID) {
        console.log("自定义按钮:", btnCaption);
        // 处理自定义按钮
    }
}

2. 高级自定义按钮事件处理 ​

javascript
// 高级自定义按钮事件处理示例
function advancedCustomButtonEventHandling() {
    // 自定义按钮事件管理
    var customButtonEventManager = {
        isButtonEnabled: true,
        isButtonLoggingEnabled: true,
        isButtonValidationEnabled: true
    };
    
    // 处理自定义按钮
    function handleCustomButton(btnPos, btnCaption, btnID) {
        if (customButtonEventManager.isButtonEnabled) {
            console.log("自定义按钮处理:", btnCaption);
            // 处理自定义按钮
        }
    }
}

3. 自定义按钮事件质量控制 ​

javascript
// 自定义按钮事件质量控制示例
function customButtonEventQualityControl() {
    // 自定义按钮事件质量控制
    function controlCustomButtonEventQuality() {
        var customButtonEventQuality = {
            buttonClicks: 0,
            buttonErrors: 0,
            buttonSuccess: 0,
            errors: []
        };
        
        // 监控自定义按钮事件质量
        function monitorCustomButtonEventQuality(eventType, success) {
            if (success) {
                customButtonEventQuality[eventType]++;
            } else {
                customButtonEventQuality.errors.push({
                    event: eventType,
                    timestamp: new Date().toISOString()
                });
            }
        }
        
        console.log("自定义按钮事件质量控制:", customButtonEventQuality);
        return customButtonEventQuality;
    }
    
    // 执行质量控制
    var qualityResult = controlCustomButtonEventQuality();
    console.log("自定义按钮事件质量控制结果:", qualityResult);
}

注意事项 ​

  1. 事件顺序：注意自定义按钮事件触发的顺序，确保在正确的时机执行相应操作
  2. 参数验证：验证自定义按钮事件参数的有效性，避免空值或无效值
  3. 错误处理：实现完善的错误处理机制
  4. 性能考虑：避免在自定义按钮事件处理中执行耗时操作
  5. 资源管理：及时清理不需要的资源
  6. 状态同步：保持自定义按钮状态的一致性
  7. 用户体验：确保自定义按钮事件处理不影响用户体验

错误处理 ​

javascript
// 自定义按钮事件错误处理
function handleCustomButtonEventError(eventType, error) {
    console.error("自定义按钮事件处理失败:", eventType, error.message);
    
    switch(eventType) {
        case 'OnCustomButtonOnMenuCmd':
            console.log("自定义按钮事件失败，请检查:");
            console.log("1. 自定义按钮是否正确添加");
            console.log("2. 按钮ID是否正确");
            console.log("3. 按钮事件处理是否正确");
            break;
        default:
            console.log("未知自定义按钮事件处理失败");
    }
}

最佳实践 ​

1. 自定义按钮事件管理最佳实践 ​

javascript
// 自定义按钮事件管理最佳实践
function customButtonEventManagementBestPractice() {
    // 自定义按钮事件配置
    var customButtonEventConfig = {
        enableLogging: true,
        enableCustomHandling: true,
        enableButtonValidation: true,
        enableQualityControl: true
    };
    
    // 应用自定义按钮事件配置
    function applyCustomButtonEventConfig() {
        try {
            // 设置自定义按钮事件处理
            if (customButtonEventConfig.enableLogging) {
                console.log("自定义按钮事件日志已启用");
            }
            
            if (customButtonEventConfig.enableCustomHandling) {
                console.log("自定义按钮处理已启用");
            }
            
            console.log("自定义按钮事件配置应用成功");
        } catch (error) {
            handleCustomButtonEventError('applyCustomButtonEventConfig', error);
        }
    }
    
    // 应用配置
    applyCustomButtonEventConfig();
}

2. 自定义按钮事件质量控制最佳实践 ​

javascript
// 自定义按钮事件质量控制最佳实践
function customButtonEventQualityControlBestPractice() {
    // 自定义按钮事件质量控制
    function controlCustomButtonEventQuality() {
        try {
            // 自定义按钮事件质量控制
            var customButtonEventQuality = {
                totalEvents: 0,
                successfulEvents: 0,
                failedEvents: 0,
                qualityScore: 0
            };
            
            // 计算质量分数
            if (customButtonEventQuality.totalEvents > 0) {
                customButtonEventQuality.qualityScore = (customButtonEventQuality.successfulEvents / customButtonEventQuality.totalEvents) * 100;
            }
            
            console.log("自定义按钮事件质量控制完成:", customButtonEventQuality);
            return customButtonEventQuality;
        } catch (error) {
            console.error("自定义按钮事件质量控制失败:", error.message);
            return null;
        }
    }
    
    // 执行质量控制
    var qualityResult = controlCustomButtonEventQuality();
    console.log("自定义按钮事件质量控制结果:", qualityResult);
}

技术要点 ​

  1. 事件顺序：注意自定义按钮事件触发的顺序，确保在正确的时机执行相应操作
  2. 参数验证：验证自定义按钮事件参数的有效性，避免空值或无效值
  3. 错误处理：完善的错误处理机制
  4. 性能优化：避免在自定义按钮事件处理中执行耗时操作
  5. 资源管理：及时清理不需要的资源
  6. 状态同步：保持自定义按钮状态的一致性
  7. 用户体验：确保自定义按钮事件处理不影响用户体验

Copyright © 2025 软航科技