4. Revit API UI: Ribbon(界面)

2024-06-21 05:12
文章标签 ui 界面 api ribbon revit

本文主要是介绍4. Revit API UI: Ribbon(界面),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

4. Revit API UI: Ribbon(界面)

第二篇中,我们提到了IExternalApplication,该接口需要实现两个方法:Revit启动时调用的OnStartup 方法,和Revit关闭时调研的OnShutdown 方法。文中还给了个例子,在工具栏绘制了个简单的按钮,加了一个空闲事件。

回到这里,这一篇呢,就来讲一下Ribbon(界面)相关的类。


Ribbon

Revit API 中并没有叫"Ribbon"的类,而是一系列与界面相关的基本都以Ribbon开头。

  • RibbonPanel:在Revit Tab上添加一个面板
  • RibbonItem:面板上的功能按钮,有一些子类
  • RibbonItemData:包含构造RibbonItem所需的信息。基本就是后面加一个Data
  • ContextualHelp:用于给功能按钮添加一个帮助链接。注意,该类不在UI命名空间中。

在这里插入图片描述

在Revit中展示

我们先来了解一下这些控件在Revit中都长怎么个样子吧,先留下一个印象,后面再对各个类进行介绍。

  1. 按钮样式图
    在这里插入图片描述

  2. PushButton属性与方法效果图
    在这里插入图片描述


RibbonPanel

RibbonPanel没有构造函数,需要使用UIControlledApplicationCreateRibbonPanel(..)方法。该方法有3种重载。

// 默认在"附加模块"下创建
public virtual RibbonPanel CreateRibbonPanel(string panelName);// 在自定义的Tab下创建。Tab名称不可为空,不可重复
public virtual RibbonPanel CreateRibbonPanel(string tabName,string panelName);// 在可选的Tab(附加模型、分析)下创建
public virtual RibbonPanel CreateRibbonPanel(Tab tab,string panelName);

在使用自定义Tab下创建Panel时,需要先创建一个Tab,使用CreateRibbonTab()方法。

如果问,要是我要在其它已有的Tab下创建面板呢?

嘿!这是个问题,现在还做不到,我们得引入一个叫AdWindows.dll的库才行,后面有空再讲。

创建Panel后,就要向其中添加控件,我们看看它的方法:

方法说明
AddItem(RibbonItemData)向Panel中添加一个控件,占一列
AddStackedItems(data,data)
AddStackedItems(data,data,data)
向Panel中多个控件,堆叠在一起,共同占一列
AddSeparator()添加一个分隔符
AddSlideOut()调用后,后续添加的控件,将被放在下滑框中
在这里插入图片描述

Ribbon

RibbonItem 与 RibbonItemData

RibbonItem可以理解为是控件的实体,一些操作都在这上面,是一众控件的基类。

RibbonItemData则是控件的数据信息,一些样式在这里填。

对比这两个类的子类,可以看到是一一对应的,不光如此,类内部的方法和属性也基本一致(当然,RibbonItem会多一些操作)。

对于那些一致的属性,在RibbonItemRibbonItemData上操作都可以。很好理解,后者就是前者的一个私有属性,并将后者的成员暴露出来了而已。

我们简单看看RibbonItem类成员吧。

各子类属性大差不差,效果请参阅上方 “PushButton属性与方法效果图”。

成员说明(可参阅上图)
SetContextualHelp(contextualHelp)设置帮助
Name控件名称
ToolTip控件详情的标题(最上方,大号字体)
LongDescription控件详情的详细内容
ToolTipImage控件详情中,插入的图片

在子类中,还可以设置控件的Icon,通过设置其属性ImageLargeImage来展示。区别在于控件是不是堆叠的,堆叠的用小图,非堆叠的用大图。

ComboBox 与 ConboBoxMember

ComboBox表示下拉框控件,而ConboBoxMember则是下拉框成员。

 ComboBox comboBox = panel.AddItem(comboBoxData) as ComboBox;ComboBoxMemberData memberData1 = new ComboBoxMemberData("选项1", "选项1");ComboBoxMemberData memberData2 = new ComboBoxMemberData("选项2", "选项2");comboBox.AddItem(memberData1);comboBox.AddItem(memberData2);panel.AddSeparator();

RadioButtonGroup 与 ToggleButton

这两者也是一个组合,ToggleButton是单选按钮,RadioButtonGroup 是单选按钮的容器,保证在容器中,只能选中一个。

ToggleButtonData需要的构造器中,需要传入外部命令的地址(第四个参数),创建一个空的命令,将地址传入即可。

RadioButtonGroupData radioButtonGroupData = new RadioButtonGroupData("单选组合");
RadioButtonGroup radioButtonGroup = panel.AddItem(radioButtonGroupData) as RadioButtonGroup;
radioButtonGroup.AddItem(new ToggleButtonData("单选1", "单选1", addInPath, "xxx.nothing"));
radioButtonGroup.AddItem(new ToggleButtonData("单选2", "单选2", addInPath, "xxx.nothing"));

RibbonButton

该类表示的是按钮控件,其子类(的子类)包括PushButton、PulldownButton、SplitButton,还有上面的ToggleButton。

  • PushButton:普通按钮,最为常用,可以到处组合
  • PulldownButton:一个容器,需要向其中添加PushButton,下拉选取,但默认按钮是不变的。
  • SplitButton:一个容器,需要向其中添加PushButton,下拉选取,但是默认按钮为最近一次选取的按钮。

在使用Revit时,我们发现有的按钮有时只有在特定的状态下才能使用,比如“建筑”Tab下的大部分功能,在处于“图纸”视图时,都是不可用的。这是怎么做到的呢?

我们注意到RibbonButton有个叫AvailabilityClassName 1的属性。

AvailabilityClassName :

该属性和一般按钮的构造函数里的addInPath参数一样,不同的是这里传入一个实现了接口IExternalCommandAvailability 的类的地址。返回True表示控件可用(即Enable=True),False则不可以。

public class Availability: IExternalCommandAvailability
{public bool IsCommandAvailable( UIApplication a,  CategorySet b ){return true;}
}

当一个组合控件中的按钮全部不可用时,该组合控件将不可用。

TextBox

文本框,没啥内容,只是需要注意属性ShowImageAsButton和事件EnterPressed

// 伪代码
TextBoxData testBoxData = new TextBoxData("TextBox");
TextBox textBox = (TextBox)(panel.AddItem(testBoxData));
textBox.PromptText = "Set value"
textBox.Image = new BitmapImage(new Uri(Path.Combine(ButtonIconsFolder, "xxx.png"), UriKind.Absolute));
textBox.ToolTip = "Set the mark for new wall";
textBox.ShowImageAsButton = true;
textBox.EnterPressed += new EventHandler<Autodesk.Revit.UI.Events.TextBoxEnterPressedEventArgs>(SetTextBoxValue);// 事件
public void SetTextBoxValue(object sender, TextBoxEnterPressedEventArgs args)
{TaskDialog.Show("TextBox EnterPressed Event", "value changed.");
}

结尾

OK,这一篇就写到这里了,基础的界面API差不多就讲完了,至于其它的,后面再讲吧。

下一篇,大概得写那几个UI打头的类了。


  1. https://thebuildingcoder.typepad.com/blog/2011/02/enable-ribbon-items-in-zero-document-state.html ↩︎

这篇关于4. Revit API UI: Ribbon(界面)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1080296

相关文章

HarmonyOS学习(七)——UI(五)常用布局总结

自适应布局 1.1、线性布局(LinearLayout) 通过线性容器Row和Column实现线性布局。Column容器内的子组件按照垂直方向排列,Row组件中的子组件按照水平方向排列。 属性说明space通过space参数设置主轴上子组件的间距,达到各子组件在排列上的等间距效果alignItems设置子组件在交叉轴上的对齐方式,且在各类尺寸屏幕上表现一致,其中交叉轴为垂直时,取值为Vert

【LabVIEW学习篇 - 21】:DLL与API的调用

文章目录 DLL与API调用DLLAPIDLL的调用 DLL与API调用 LabVIEW虽然已经足够强大,但不同的语言在不同领域都有着自己的优势,为了强强联合,LabVIEW提供了强大的外部程序接口能力,包括DLL、CIN(C语言接口)、ActiveX、.NET、MATLAB等等。通过DLL可以使用户很方便地调用C、C++、C#、VB等编程语言写的程序以及windows自带的大

如何更优雅地对接第三方API

如何更优雅地对接第三方API 本文所有示例完整代码地址:https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/third 我们在日常开发过程中,有不少场景会对接第三方的API,例如第三方账号登录,第三方服务等等。第三方服务会提供API或者SDK,我依稀记得早些年Maven还没那么广泛使用,通常要对接第三方

Java基础回顾系列-第五天-高级编程之API类库

Java基础回顾系列-第五天-高级编程之API类库 Java基础类库StringBufferStringBuilderStringCharSequence接口AutoCloseable接口RuntimeSystemCleaner对象克隆 数字操作类Math数学计算类Random随机数生成类BigInteger/BigDecimal大数字操作类 日期操作类DateSimpleDateForma

Restful API 原理以及实现

先说说API 再说啥是RESRFUL API之前,咱先说说啥是API吧。API大家应该都知道吧,简称接口嘛。随着现在移动互联网的火爆,手机软件,也就是APP几乎快爆棚了。几乎任何一个网站或者应用都会出一款iOS或者Android APP,相比网页版的体验,APP确实各方面性能要好很多。 那么现在问题来了。比如QQ空间网站,如果我想获取一个用户发的说说列表。 QQ空间网站里面需要这个功能。

京东物流查询|开发者调用API接口实现

快递聚合查询的优势 1、高效整合多种快递信息。2、实时动态更新。3、自动化管理流程。 聚合国内外1500家快递公司的物流信息查询服务,使用API接口查询京东物流的便捷步骤,首先选择专业的数据平台的快递API接口:物流快递查询API接口-单号查询API - 探数数据 以下示例是参考的示例代码: import requestsurl = "http://api.tanshuapi.com/a

Golang GUI入门——andlabs ui

官方不提供gui标准库,只好寻求第三方库。 https://github.com/google/gxui 这个gui库是谷歌内部人员提供的,并不是谷歌官方出品,现在停止维护,只好作罢。 第三方gui库 找了好多,也比较了好多,最终决定使用的是还是 https://github.com/andlabs/ui 相信golang gui还会发展的更好,期待更优秀的gui库 由于andlabs

一款支持同一个屏幕界面同时播放多个视频的视频播放软件

GridPlayer 是一款基于 VLC 的免费开源跨平台多视频同步播放工具,支持在一块屏幕上同时播放多个视频。其主要功能包括: 多视频播放:用户可以在一个窗口中同时播放任意数量的视频,数量仅受硬件性能限制。支持多种格式和流媒体:GridPlayer 支持所有由 VLC 支持的视频格式以及流媒体 URL(如 m3u8 链接)。自定义网格布局:用户可以配置播放器的网格布局,以适应不同的观看需求。硬

WordPress开发中常用的工具或api文档

http://php.net/ http://httpd.apache.org/ https://wordpress.org/ https://cn.wordpress.org/ https://core.svn.wordpress.org/ zh-cn:开发者文档: https://codex.wordpress.org/zh-cn:%E5%BC%80%E5%8F%91%E8%80%

Java后端微服务架构下的API限流策略:Guava RateLimiter

Java后端微服务架构下的API限流策略:Guava RateLimiter 大家好,我是微赚淘客返利系统3.0的小编,是个冬天不穿秋裤,天冷也要风度的程序猿! 在微服务架构中,API限流是保护服务不受过度使用和拒绝服务攻击的重要手段。Guava RateLimiter是Google开源的Java库中的一个组件,提供了简单易用的限流功能。 API限流概述 API限流通过控制请求的速率来防止