Пространство имен: ARO.AIS.API.Revit

Сборка: ARO.AIS.API.dll


Интерфейс описания команд для ПО Revit.

C#
 public interface IRevitCommand : ICommand

Наследование: ICommand → IRevitCommand


Навигация

Свойства

Методы

Примеры

Подробное описание

Свойства

ControlВозвращает объект описывающий элемент управления для Команды
TooltipImageВозвращает пиктограмму/картинку для расширенной подсказки Revit
ReadOnlyФлаг запрещающий изменение данных (только чтение)

Методы

Execute(object)Вызывается в момент запуска команды с панели Revit. 
ForcedStop(object)Вызывается в случаях программного прерывания выполнения команды и выгрузки команды.

Примеры

В этом примере рассматривается создание класса команды.

C#
using ARO.AIS.API;
using ARO.AIS.API.Revit;
using ARO.AIS.API.Utils;
using Autodesk.Revit.UI;
using System;
using System.Windows;

namespace ARO.Commands.Samples
{
    public class SampleCommand : IRevitCommand
    {
        public string Uid => "00000000000000000000000000000000";

        public string Name => "Sample command";

		public string Tooltip => "Short tooltip";

        public string Description => "Show current user login";

        public Version Version => new Version(1, 0);

        public int Product => SupportedProduct.REVIT_2022;

        public byte[] Logo => null;

        public IRevitControl Control => AISTools.RevitTool.CreateButton().AsSingleOnly().SetSize(RevitButtonSize.LARGE).ToGroup("Samples");

		public byte[] TooltipImage => null;

 		public bool ReadOnly => true;

        public byte Execute(object application)
        {
            _ = MessageBox.Show($"Current Username: {(application as UIApplication)?.Application?.Username}");

            return RevitCommandStatus.OK;
        }

        public void ForcedStop(object application) { }
    }
}


Подробное описание

Свойства

Control

Возвращает объект описывающий элемент управления для Команды. Не может быть null.

C#
IRevitControl Control { get; }


TooltipImage

Возвращает пиктограмму/картинку для расширенной подсказки Revit в виде массива байт. Может быть null.

C#
byte[] TooltipImage { get; }


ReadOnly

Флаг отвечающий за запрет изменения данных командой. Если команда содержит функционал работы с транзакциями (внесение изменений) - флаг должен быть установлен в false.

C#
bool ReadOnly { get; }


Методы

Execute(object, IRevitTransaction)

 Вызывается в момент запуска команды с панели Revit.

C#
byte Execute(object application)

Параметры
object application - ссылка на объект UIApplication, который представляет активный сеанс пользовательского интерфейса Revit.

Возвращаемое значение
byte - результат (статус) работы Команды. Допустимые значения могут быть получены из вспомогательного класса по кодированию статуса Команды для Revit (RevitCommandStatus).


ForcedStop(object)

Вызывается в случаях программного прерывания выполнения команды и выгрузки команды.

C#
void ForcedStop(object application)

Параметры
object application - ссылка на объект UIApplication, который представляет активный сеанс пользовательского интерфейса Revit.


  • Нет меток