【C#】【EXCEL】BumblebeeComponentsAnalysisGH_Ex_Ana_CondBlank.cs

embedded/2024/10/22 21:40:21/

这段代码定义了一个名为 GH_Ex_Ana_CondBlank 的类,它是一个 Grasshopper 组件,用于在 Excel 工作表中为特定范围添加条件格式。具体功能和介绍如下:

  1. 功能概述:
    这个组件用于在 Excel 中为指定的单元格范围添加基于空白值的条件格式。它允许用户高亮显示空白或非空白的单元格。

  2. 主要特性:

    • 可以设置高亮颜色
    • 可以选择高亮空白或非空白单元格
    • 可以选择清除现有的条件格式
    • 可以控制是否激活条件格式
  3. 输入参数:

    • 工作表和范围(从基类继承)
    • 单元格颜色(用于高亮显示)
    • 翻转选项(决定是高亮空白还是非空白单元格)
    • 清除选项(是否清除现有条件格式)
    • 激活选项(是否应用条件格式)
  4. 输出:

    • 应用了条件格式的 Excel 范围
  5. 使用场景:
    这个组件可以用于数据分析或可视化,帮助用户快速识别 Excel 表格中的空白或填充单元格。例如,在数据清理过程中识别缺失数据,或在数据录入过程中突出显示已填写的字段。

  6. 技术细节:

    • 继承自 GH_Ex_Rng__Base 类,可能是一个自定义的基础 Excel 范围操作组件
    • 使用 Grasshopper 的组件框架
    • 集成了 Excel 操作功能,可能使用了某种 Excel 互操作库
  7. 用户界面:

    • 在 Grasshopper 中作为一个次要(secondary)级别的组件显示
    • 有自定义图标(BB_Cond_Blank_01

总的来说,这是一个专门用于 Excel 数据处理的 Grasshopper 插件组件,为用户提供了一种简单的方式来可视化和分析 Excel 中的空白数据。

Flow diagram

SolveInstance / 解决实例
Yes
Yes
No
No
Get Worksheet / 获取工作表
SolveInstance Method / 解决实例方法
Get Range / 获取范围
Get Color / 获取颜色
Get Flip / 获取翻转状态
Get Clear / 获取清除状态
Get Activate / 获取激活状态
Start / 开始
Initialize Component / 初始化组件
Register Input Parameters / 注册输入参数
Register Output Parameters / 注册输出参数
Activate? / 是否激活?
Clear? / 是否清除?
ClearConditions / 清除条件
AddConditionalBlanks / 添加条件格式
Set Output / 设置输出
End / 结束

这个流程图展示了 GH_Ex_Ana_CondBlank 类的主要执行流程:

  1. Start / 开始: 组件开始执行。
  2. Initialize Component / 初始化组件: 对应构造函数 GH_Ex_Ana_CondBlank()
  3. Register Input Parameters / 注册输入参数: 对应 RegisterInputParams 方法。
  4. Register Output Parameters / 注册输出参数: 对应 RegisterOutputParams 方法。
  5. SolveInstance Method / 解决实例方法: 对应 SolveInstance 方法。
    • Get Worksheet / 获取工作表
    • Get Range / 获取范围
    • Get Color / 获取颜色
    • Get Flip / 获取翻转状态
    • Get Clear / 获取清除状态
    • Get Activate / 获取激活状态
  6. Activate? / 是否激活?: 检查是否应用条件格式。
  7. Clear? / 是否清除?: 如果激活,检查是否需要清除现有条件。
  8. ClearConditions / 清除条件: 如果需要清除,执行 range.ClearConditions()
  9. AddConditionalBlanks / 添加条件格式: 执行 range.AddConditionalBlanks(color, flip)
  10. Set Output / 设置输出: 对应 DA.SetData(0, range)
  11. End / 结束: 组件执行结束。

这个流程图清晰地展示了代码的执行过程,包括主要的决策点和操作步骤。

Description

  1. 构造函数 GH_Ex_Ana_CondBlank()
public GH_Ex_Ana_CondBlank(): base("Conditional Blank", "Blank","Add conditional formatting to a Range based on blank values",Constants.ShortName, Constants.SubAnalysis)
{
}

解释:
这是类的构造函数。它调用基类的构造函数,设置组件的名称、昵称、描述和分类。

  • “Conditional Blank”:组件的全名
  • “Blank”:组件的昵称
  • 描述文本解释了组件的功能
  • Constants.ShortNameConstants.SubAnalysis 可能是定义组件分类的常量
  1. Exposure 属性
public override GH_Exposure Exposure
{get { return GH_Exposure.secondary; }
}

解释:
这个属性定义了组件在 Grasshopper 界面中的显示级别。

  • GH_Exposure.secondary 表示这是一个次要组件,可能在子菜单或高级选项中显示。
  1. RegisterInputParams 方法
protected override void RegisterInputParams(GH_Component.GH_InputParamManager pManager)
{base.RegisterInputParams(pManager);pManager[1].Optional = true;pManager.AddColourParameter("Cell Color", "C", "The cell highlight color", GH_ParamAccess.item, Sd.Color.LightGray);pManager[2].Optional = true;pManager.AddBooleanParameter("Flip", "F", "If true, filled cells will be highlighted", GH_ParamAccess.item, false);pManager[3].Optional = true;pManager.AddBooleanParameter("Clear", "_X", "If true, the existing conditions will be cleared", GH_ParamAccess.item, false);pManager[4].Optional = true;pManager.AddBooleanParameter("Activate", "_A", "If true, the condition will be applied", GH_ParamAccess.item, false);pManager[5].Optional = true;
}

解释:
这个方法注册组件的输入参数。

  • 首先调用基类的 RegisterInputParams 方法注册基本参数。
  • 然后添加特定于此组件的参数:
    • 单元格颜色:用于高亮显示的颜色
    • 翻转选项:决定是高亮空白还是非空白单元格
    • 清除选项:是否清除现有条件格式
    • 激活选项:是否应用条件格式
  • 所有新添加的参数都被设置为可选的(Optional = true)
  1. RegisterOutputParams 方法
protected override void RegisterOutputParams(GH_Component.GH_OutputParamManager pManager)
{base.RegisterOutputParams(pManager);
}

解释:
这个方法注册组件的输出参数。在这里,它只是调用基类的方法,没有添加额外的输出参数。

  1. SolveInstance 方法
protected override void SolveInstance(IGH_DataAccess DA)
{// ... (代码略)
}

解释:
这是组件的核心方法,执行实际的操作。

  • 获取输入数据(工作表、范围、颜色、选项等)
  • 根据输入参数应用条件格式
  • 设置输出数据

Key parts explanation (关键部分解释):

if (activate)
{if (clear) range.ClearConditions();range.AddConditionalBlanks(color, flip);
}

If activated, clear existing conditions if required, then add conditional formatting for blank cells.
如果激活,根据需要清除现有条件,然后为空白单元格添加条件格式。

  1. Icon 属性
protected override System.Drawing.Bitmap Icon
{get{return Properties.Resources.BB_Cond_Blank_01;}
}

解释:
这个属性提供组件的图标。它返回一个名为 “BB_Cond_Blank_01” 的资源图像。

  1. ComponentGuid 属性
public override Guid ComponentGuid
{get { return new Guid("f8e03658-c939-4d29-97a9-58d181a38c08"); }
}

解释:
这个属性返回组件的唯一标识符(GUID)。这个 GUID 在组件发布后不应更改,用于在 Grasshopper 中唯一标识此组件。

总结:
这个类实现了一个 Grasshopper 组件,用于在 Excel 工作表中为空白单元格添加条件格式。它展示了如何创建自定义 Grasshopper 组件,包括参数注册、核心逻辑实现、图标设置等。这种组件可以帮助用户更有效地分析和可视化 Excel 数据中的空白值。

Code

using Grasshopper.Kernel;
using Grasshopper.Kernel.Parameters;
using Grasshopper.Kernel.Types;
using Rhino.Geometry;
using System;
using System.Collections.Generic;
using Sd = System.Drawing;namespace Bumblebee.Components
{// 定义一个用于在Excel中为空白单元格添加条件格式的Grasshopper组件public class GH_Ex_Ana_CondBlank : GH_Ex_Rng__Base{/// <summary>/// 初始化 GH_Ex_An_CondBlank 类的新实例。/// </summary>public GH_Ex_Ana_CondBlank(): base("Conditional Blank", "Blank","Add conditional formatting to a Range based on blank values",Constants.ShortName, Constants.SubAnalysis){// 构造函数调用基类构造函数,设置组件名称、昵称、描述和分类}/// <summary>/// 设置组件的曝光级别。/// </summary>public override GH_Exposure Exposure{// 返回次要曝光级别,表示这是一个不太常用的组件get { return GH_Exposure.secondary; }}/// <summary>/// 注册该组件的所有输入参数。/// </summary>protected override void RegisterInputParams(GH_Component.GH_InputParamManager pManager){// 调用基类方法注册基本参数base.RegisterInputParams(pManager);pManager[1].Optional = true;// 添加单元格颜色参数pManager.AddColourParameter("Cell Color", "C", "The cell highlight color", GH_ParamAccess.item, Sd.Color.LightGray);pManager[2].Optional = true;// 添加翻转选项参数pManager.AddBooleanParameter("Flip", "F", "If true, filled cells will be highlighted", GH_ParamAccess.item, false);pManager[3].Optional = true;// 添加清除现有条件参数pManager.AddBooleanParameter("Clear", "_X", "If true, the existing conditions will be cleared", GH_ParamAccess.item, false);pManager[4].Optional = true;// 添加激活条件参数pManager.AddBooleanParameter("Activate", "_A", "If true, the condition will be applied", GH_ParamAccess.item, false);pManager[5].Optional = true;}/// <summary>/// 注册该组件的所有输出参数。/// </summary>protected override void RegisterOutputParams(GH_Component.GH_OutputParamManager pManager){// 调用基类方法注册输出参数base.RegisterOutputParams(pManager);}/// <summary>/// 这是实际执行工作的方法。/// </summary>/// <param name="DA">DA对象用于从输入检索数据并存储到输出。</param>protected override void SolveInstance(IGH_DataAccess DA){IGH_Goo gooS = null;DA.GetData(0, ref gooS);ExWorksheet worksheet = new ExWorksheet();bool hasWs = gooS.TryGetWorksheet(ref worksheet);IGH_Goo gooR = null;DA.GetData(1, ref gooR);ExRange range = new ExRange();if (!gooR.TryGetRange(ref range, worksheet)) return;if (!hasWs) worksheet = range.Worksheet;// 获取单元格高亮颜色Sd.Color color = Sd.Color.LightGray;DA.GetData(2, ref color);// 获取翻转选项bool flip = false;DA.GetData(3, ref flip);// 获取清除选项bool clear = false;DA.GetData(4, ref clear);// 获取激活选项bool activate = false;DA.GetData(5, ref activate);// 如果激活,则应用条件格式if (activate){// 如果需要清除,则清除现有条件if (clear) range.ClearConditions();// 添加基于空白值的条件格式range.AddConditionalBlanks(color, flip);}// 设置输出数据DA.SetData(0, range);}/// <summary>/// 提供组件的图标。/// </summary>protected override System.Drawing.Bitmap Icon{get{// 返回组件的图标return Properties.Resources.BB_Cond_Blank_01;}}/// <summary>/// 获取此组件的唯一ID。发布后不要更改此ID。/// </summary>public override Guid ComponentGuid{// 返回组件的唯一标识符get { return new Guid("f8e03658-c939-4d29-97a9-58d181a38c08"); }}}
}

这段代码现在包含了详细的中文注释,解释了每个方法和属性的功能。这些注释涵盖了:

  1. 类的整体功能
  2. 构造函数的作用
  3. 各个方法的用途和工作原理
  4. 输入参数和输出参数的含义
  5. SolveInstance 方法中的主要逻辑步骤
  6. 图标和GUID属性的作用

http://www.ppmy.cn/embedded/101540.html

相关文章

Java SpringBoot结合Vue打造法律援助平台,实现高效在线法律咨询服务

✍✍计算机编程指导师 ⭐⭐个人介绍&#xff1a;自己非常喜欢研究技术问题&#xff01;专业做Java、Python、微信小程序、安卓、大数据、爬虫、Golang、大屏等实战项目。 ⛽⛽实战项目&#xff1a;有源码或者技术上的问题欢迎在评论区一起讨论交流&#xff01; ⚡⚡ Java实战 |…

在 Navicat BI 中创建自定义字段:自定义排序顺序

在 Navicat BI 中&#xff0c;数据源引用你连接中的表或文件/ODBC 源中的数据&#xff0c;并可从不同服务器类型的中选择数据。数据集中的字段可用于构建图表。事实上&#xff0c;在构建图表时&#xff0c;你需要指定用于填充图表的数据源。 正如我们在整个系列中所看到的&…

TP5000X 2A 开关型 3.7V/4.2V/4.35V 锂电池充电器

概述 TP5000X 是一款开关降压型单节锂电池充电管理芯片。其 ESOP8 的封装与简 单的外围电路&#xff0c;使得 TP5000X 非常适用于便携式设备的大电流充电管理应用。同 时&#xff0c; TP5000X 内置输入限流、欠压保护、芯片过温保护、短路保护、电池温度监 控、输入电源过高…

mysql regexp匹配多个字符串

项目场景&#xff1a; 数据结构 其中nameArr存储的是名字集合&#xff0c;现在的需求是传入"aaa","fff"&#xff0c;需要把包含这两个name的数据都查出来。 解决方案&#xff1a; 可以使用REGEXP来匹配包含多个特定ID的字符串。使用以下正则表达式&#x…

【设计模式】职责链模式

使多个对象都有机会处理请求&#xff0c;从而避免了请求的发送者与多个接收者直接的耦合关系&#xff0c;将这些接收者连接成一条链&#xff0c;顺着这条链传递该请求&#xff0c;直到找到能处理该请求的对象。 <!DOCTYPE html> <html lang"en"> <he…

【ShuQiHere】从零开始实现线性回归:深入理解反向传播与梯度下降

【ShuQiHere】 线性回归是一种简单但强大的回归分析方法&#xff0c;主要用于预测连续值。它在许多领域都有广泛的应用&#xff0c;尤其是当我们需要根据已有数据来预测未来的趋势时&#xff0c;线性回归显得尤为重要。虽然它是机器学习中最基础的算法之一&#xff0c;但理解其…

vue中使用vue-video-player插件播放视频 以及 audio播放音频

一、使用vue-video-player插件播放视频 安装 npm install vue-video-player --save 在main.js中引用 //引入视频播放插件 // main.js import VueVideoPlayer from vue-video-player import video.js/dist/video-js.css import vue-video-player/src/custom-theme.cssVue.use(V…

CPU、MPU、MCU、SOC分别是什么?

CPU、MPU、MCU和SoC都是与微电子和计算机科学相关的术语&#xff0c;它们在功能定位、应用场景以及处理能力等方面有所区别。具体如下&#xff1a; CPU&#xff1a;CPU是中央处理单元的缩写&#xff0c;它通常指计算机内部负责执行程序指令的芯片。CPU是所有类型计算机&#x…