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

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


Интерфейс помогающий выполнить преобразования ресурсов сборки для использования в свойствах ARO API.

 public interface IImageTool


Навигация

Методы

Примеры

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

Методы

GetImageFromResource(string) Подготавливает массив байт на основе указанного ресурса сборки (только для .NET Framework 4.8)
GetImageFromEmbeddedResource(string)Подготавливает массив байт на основе указанного встроенного ресурса сборки
GetImageFromStream(Stream)Подготавливает массив байт на основе потока

Примеры

В примере демонстрируется получение изображения логотипа из ресурса сборки и подготавливает его к использованию в Команде.

Исходное расположение изображения: 

public class SimpleCommand : IRevitCommand
{
    ...

    public byte[] Logo => AISTools.ImageTool?.GetImageFromResource(@"icons\whois_64px.png") ?? null;
    ...
}

Метод GetImageFromResource доступен в ARO API только для .NET Framework 4.8.

В примере демонстрируется получение изображения логотипа из встроенного ресурса сборки и подготавливает его к использованию в Команде.

Исходное расположение изображения: 

public class SimpleCommand : IRevitCommand
{
    ...

    public byte[] Logo => AISTools.ImageTool?.GetImageFromEmbeddedResource("icons.whois_64px.png") ?? null;
    ...
}


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

Методы

GetImageFromResource(string) 

Подготавливает массив байт на основе указанного ресурса сборки.

byte[] GetImageFromResource(string resourceNameWithPath)

Параметры

string resourceNameWithPath - путь и полное имя ресурса разделенные знаком "\" (допускается использование @ в начале строки). Если ресурс размещается в корне проекта, то указывается только полное имя ресурса.

Возвращаемое значение
byte[] - массив байт, представляющий переданный ресурс, готовый для передачи в свойства объектов ARO API. Допускает значение null в случае неудачи преобразования ресурса.

Метод доступен в ARO API только для .NET Framework 4.8


GetImageFromEmbeddedResource(string)

Подготавливает массив байт на основе указанного встроенного ресурса сборки.

byte[] GetImageFromEmbeddedResource(string resourceNameWithPath)

Параметры

string resourceNameWithPath - путь и полное имя ресурса разделенные знаком "." (точка). Если ресурс размещается в корне проекта, то указывается только полное имя ресурса.

Возвращаемое значение
byte[] - массив байт, представляющий переданный ресурс, готовый для передачи в свойства объектов ARO API. Допускает значение null в случае неудачи преобразования ресурса.

byte[]? GetImageFromEmbeddedResource(string? resourceNameWithPath)

Параметры

string? resourceNameWithPath - путь и полное имя ресурса разделенные знаком "." (точка). Если ресурс размещается в корне проекта, то указывается только полное имя ресурса.

Возвращаемое значение
byte[]? - массив байт, представляющий переданный ресурс, готовый для передачи в свойства объектов ARO API. Допускает значение null в случае неудачи преобразования ресурса.


GetImageFromStream(Stream)

Подготавливает массив байт на основе потока.

byte[] GetImageFromStream(Stream stream)

Параметры

Stream stream - ссылка на объект типа Stream, содержащий целевой объект (ресурс).

Возвращаемое значение
byte[] - массив байт, представляющий переданный ресурс, готовый для передачи в свойства объектов ARO API. Допускает значение null в случае неудачи преобразования ресурса.

byte[]? GetImageFromStream(Stream? stream)

Параметры

Stream? stream - ссылка на объект типа Stream, содержащий целевой объект (ресурс).

Возвращаемое значение
byte[]? - массив байт, представляющий переданный ресурс, готовый для передачи в свойства объектов ARO API. Допускает значение null в случае неудачи преобразования ресурса.