ICommand

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

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

Общий интерфейс для описания всех типов команд.

 public partial interface ICommand

Производные: IRevitCommand

Свойства

Примеры

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.AIS.Revit.Commands
{
    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 byte Execute(object application, IRevitTransaction transaction)
        {
            _ = MessageBox.Show($"Current Username: {(application as UIApplication)?.Application?.Username}");

            return RevitCommandStatus.OK;
        }

        public void ForcedStop(object application) { }
    }
}

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

Свойства

Uid

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

string Uid { get; }

Name

Возвращает имя команды. Данное имя отображается в тексте (подсказке) кнопки/пункта меню. Имя может быть не уникальным. Не может быть пустой строкой или null.

 string Name { get; }

Description

Возвращает описание команды. Описание отображается в расширенной и/или составной подсказке для кнопки/пункта меню. Допускает пустую строку или null.

 string Description { get; }

Version

Возвращает версию команды. При первичной публикации команды считается начальной версией. Не может быть меньше или равна, чем ранее опубликованная версия команды (текущую опубликованную версию можно узнать в ЛК).

 Version Version { get; }

Product

Возвращает код продукта, для которого предназначена команда. Для быстрого кодирования продукта можно воспользоваться вспомогательным классом SupportedProduct.

 int Product { get; }

Logo

Возвращает пиктограмму/картинку для кнопки/пункта меню, в виде массива байт. Допускает null. Обрабатываемые форматы изображения: PNG, ICO, JPG, BPM - корректное отображение других форматов изображения не гарантируется. Для упрощения получения массива байт можно воспользоваться функцией GetEmbeddedImageAsArray.

 byte[] Logo { get; }