Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Просмотр файловой системы

Для просмотра файловой системы вам понадобятся следующие компоненты:

  • Компонент Окружение: файлы, который используется для работы с каталогами файловой системы, чтения и записи содержимого файлов.
  • Компонент Окружение: ошибка работы с файлами, который позволяет отслеживать возникающие ошибки при выполнении операций с файловой системой.
  • Компонент Окружение: браузер файлов, который позволяет просматривать содержимое файловой системы.
  • Компонент Текстовый файл, который используется для чтения и записи содержимого текстовых файлов.

Для получения подробной информации о настройке данных компонентов, а также примерах их использования, обратитесь к демонстрационному проекту.

Файлы

Чтобы работать с каталогами файловой системы, читать и записывать содержимое файлов, добавьте на экранную форму компонент Окружение: файлы.

При запуске проекта через Alpha.HMI.WebViewer компонент Окружение: файлы выполняет все операции с файлами на стороне сервера, где запущен Alpha.HMI.WebViewer, а не на компьютере пользователя, открывшего проект в браузере.

Компонент Окружение: файлырасположен в юните Окружениебиблиотеки компонентов.

Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

С помощью данного компонента вы можете проверять существование файлов и папок, управлять путями и корневым путем, создавать новые папки, а также читать и записывать содержимое текстовых файлов.

Текстовый файл

Чтобы считывать и записывать содержимое текстовых файлов, добавьте на экранную форму компонент Текстовый файл.

При запуске проекта через Alpha.HMI.WebViewer компонент Текстовый файл выполняет все операции с текстовыми файлами на стороне сервера, где запущен Alpha.HMI.WebViewer, а не на компьютере пользователя, открывшего проект в браузере.

С помощью этого компонента вы также можете определять размер файла, проверять его кодировку, управлять правами доступа на чтение и запись.

Для получения подробной информации о настройке данного компонента и примерах его использования, обратитесь к демонстрационному проекту.

Компонент Текстовый файл расположен в юните Окружение библиотеки компонентов. Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

Подробнее о свойствах и методах компонента Текстовый файл.

Как выполнять операции с текстовыми файлами (Демо-проект)

Далее кратко описан пример (скачать его можно здесь) использования компонента Текстовый файл в проекте Alpha.HMI с использованием языка Alpha.Om.

В примере показано, как:

  • Прочитать содержимое файла и отобразить его в текстовом поле;
  • Определить текущую позицию и размер файла, статус открытия, доступность для чтения и записи, а также кодировку;
  • Добавить текст в конец файла и показать обновлённые данные в текстовом поле.

В результате будет подготовлена форма, при открытии которой по нажатию одной кнопки можно будет прочитать текстовый файл, а по нажатию другой — добавить текст в файл.

Прочитать содержимое файла и отобразить его в текстовом поле

  1. Добавьте на форму текстовое поле для отображения содержимого файла.

  2. Добавьте компонент Текстовый файл для работы с файлами.

  3. Добавьте на форму кнопку. Настройте обработчик события ButtonPressed для кнопки, чтобы при её нажатии содержимое файла выводилось в текстовое поле. Пример кода:

    // Указываем путь к файлу
    TextFile_1.Path = "C:\\Users\\User1\\Desktop\\1.txt";
    // Доступ на чтение и запись
    TextFile_1.OpenMode = 3;
    // Открываем файл для чтения
    TextFile_1.Open();
    // Читаем содержимое файла и отображаем его в текстовом поле
    Text_1.Text = TextFile_1.ReadAll();
    // Закрываем файл
    TextFile_1.Close();

Отобразить информацию о текстовом файле

  1. Добавьте на форму ещё одно текстовое поле для вывода информации о текстовом файле.

  2. Измените код в обработчике события ButtonPressed кнопки Button_1, чтобы при нажатии дополнительно отобразить текущую позицию, размер файла, статус открытия, доступность для чтения и записи, а также кодировку:

    // Указываем путь к файлу
    TextFile_1.Path = "C:\\Users\\User1\\Desktop\\1.txt";
    // Доступ на чтение и запись
    TextFile_1.OpenMode = 3;
    // Открываем файл для чтения
    TextFile_1.Open();
    // Читаем содержимое файла и отображаем его в текстовом поле
    Text_1.Text = TextFile_1.ReadAll();
    // Отображаем информацию о файле в другом текстовом поле
    Text_2.Text = "Размер файла: " + String.ToString(TextFile_1.Size) + " байт\n" +
    "Текущая позиция: " + String.ToString(TextFile_1.Position) + "\n" +
    "Состояние файла: " + (TextFile_1.Opened ? "Открыт" : "Закрыт") + "\n" +
    "Чтение: " + (TextFile_1.Readable ? "Доступно" : "Недоступно") + "\n" +
    "Запись: " + (TextFile_1.Writable ? "Доступна" : "Недоступна") +"\n" +
    "Кодировка файла: " + TextFile_1.CurrentEncoding;
    // Закрываем файл
    TextFile_1.Close();

Добавить текст в конец файла и показать обновлённые данные в текстовом поле

  1. Добавьте на форму кнопку, по нажатию которой будет производиться добавление текста в файл.

  2. Настройте обработчик события ButtonPressed для кнопки Button_2, чтобы выполнить запись и показать обновлённые данные в текстовом поле. Пример кода:

    // Указываем путь к файлу
    TextFile_1.Path = "C:\\Users\\User1\\Desktop\\1.txt";
    // Доступ на чтение и запись
    TextFile_1.OpenMode = 3;
    // Открываем файл для записи
    TextFile_1.Open();
    // Записываем данные в файл
    TextFile_1.Write("New Data");
    // Обновляем текстовое поле Text_2 с информацией о записанных данных, размере файла и текущей позиции
    Text_2.Text = "Записанные данные: New Data\n" +
    "Размер файла после записи: " + String.ToString(TextFile_1.Size) + " байт\n" +
    "Текущая позиция после записи: " + String.ToString(TextFile_1.Position) + " байт";
    // Обновляем текстовое поле Text_1, добавив новую информацию
    Text_1.Text = "Содержимое файла:\n" + TextFile_1.ReadAll() + "\n\n";
    // Закрываем файл
    TextFile_1.Close();

Ошибка работы с файлами

Чтобы отслеживать ошибки, возникающие при работе с файловой системой, добавьте на экранную форму компонент Окружение: ошибка работы с файлами.

При запуске проекта через Alpha.HMI.WebViewer компонент Окружение: ошибка работы с файлами отслеживает ошибки, возникающие при работе с файлами на сервере, где запущен Alpha.HMI.WebViewer, а не на компьютере пользователя, открывшего проект в браузере.

Компонент Окружение: ошибка работы с файламирасположен в юните Окружение библиотеки компонентов.

Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

С помощью этого компонента вы сможете получить подробные сведения о возникших ошибках.

Браузер файлов

Чтобы просматривать содержимое файловой системы, добавьте на экранную форму компонент Окружение: браузер файлов.

Компонент Окружение: браузер файловрасположен в юните Окружение библиотеки компонентов.

Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

С помощью этого компонента вы сможете настраивать отображение файлов и папок.

Для просмотра содержимого файловой системы подключите Окружение: браузер файлов к одному из компонентов: Дерево или Таблица.

При запуске проекта через Alpha.HMI.WebViewer компонент Окружение: браузер файлов отображает содержимое файловой системы сервера, где запущен Alpha.HMI.WebViewer, а не компьютера пользователя, открывшего проект в браузере.

Какие данные возвращает компонент

Компонент Окружение: браузер файлов возвращает данные в табличном формате. Используя указанные ниже идентификаторы, вы можете обращаться к этим данным в проекте. Например, вывести их значения в виде древовидной структуры на форме, используя компоненты Источник данных дерева, Дерево и Колонка дерева из юнита Визуальные.

Идентификатор колонки Тип колонки Тип возвращаемого значения Описание
name 1 string Имя элемента.
id 2 string Идентификатор элемента.
parent_id 3 string Идентификатор родителя.
type 5 uint1

Тип элемента файловой системы

  • 0 – директория;
  • 1 – файл;
  • 2 – ссылка.
ext 5 string Расширение файла.
size 5 uint8 Размер файла.
created 5 timestamp Время создания.
modified 5 timestamp Время изменения.
expandable 6 bool

Возможность раскрыть элемент и просмотреть его содержимое.

  • true– отображение содержимого элемента доступно;
  • false – отображение содержимого элемента недоступно.

Подключение браузера файлов к дереву (Демо-проект)

В разделе описано, как отобразить содержимое файловой системы в виде древовидной структуры. Для этого представлен проект-пример (скачать его можно здесь ), демонстрирующий совместную работу компонента Окружение: браузер файлов со вспомогательными компонентами Окружение: ошибка работы с файлами и Окружение: файлы. В проекте-примере Demo.hmi будет проверяться содержимое папки проекта FileSystemBrowser.

  1. Добавьте на экранную форму объект типа Дерево.
  2. В Структуре объектов щелкните правой кнопкой мыши по компоненту Дерево → Создать. Откроется мастер создания элементов.

    1. В поле Тип элемента оставьте Экземпляр типа , Базовый тип элемента → Источник данных дерева(раздел Визуальные) → Создать.

    2. В Структуре объектов добавится компонент Источник данных дерева дочерним компоненту Дерево.

  3. Для объекта Источник данных дерева аналогичным образом добавьте Окружение: браузер файлов.


  4. Чтобы работать с каталогами файловой системы, читать и записывать содержимое файлов, добавьте на экранную форму компонент Окружение: файлы.

    1. Укажите корневой путь, с которого начинать просмотр файловой системы. Используйте для этого свойство Корневой путь у объекта Окружение: файлы.

  5. Чтобы иметь доступ к ошибкам, возникшим при выполнении какой-либо операции с файлом, добавьте компонент Окружение: ошибка работы с файлами.

  6. Чтобы выводить текст ошибки (свойство Текст) при выполнении последней операции в Журнал времени исполнения , добавьте на экранную форму компонент Средство отладки.

    1. Выделите компонент Окружение: ошибка работы с файлами, перейдите во вкладку События, нажмите на событие Occured правым кликом мыши→ Добавить обработчик → Выполнить код → Редактировать. В открывшемся окне введите следующий код:

      DebugTool_1.Log(Text);
  7. У объекта Окружение: браузер файлов для свойств Ошибка и Файлы укажите в значении ссылку на добавленные ранее объекты типа Окружение: ошибка работы с файлами и Окружение: файлы. Для это нажмите правой кнопкой мыши по свойству Ошибка → Сослаться → FileSystemError_1. Аналогичным образом для свойства Файлы укажите ссылку на объект FileSystem_1.

    1. У объекта Окружение: файлы для свойства Ошибка также укажите в значении ссылку на добавленный объект типа Окружение: ошибка работы с файлами.

  8. В Источник данных дерева добавьте Колонки дерева с идентификаторами:

    • name
    • id
    • parent_id
    • ext
    • size
    • created
    • expandable
    1. Используйте значения Идентификатора колонки и Тип колонки в соответствии с таблицей возвращаемых значений в разделе Какие данные возвращает компонент, которая поможет правильно настроить свойства для каждой Колонки дерева. Имя колонки указывается в произвольном виде.

      Колонки дерева с идентификаторами name, id и parent_id обязательны для добавления на форму, все остальные добавляются при необходимости.

  9. Начало новой сессии просмотра файловой системы инициируется с помощью функции Browse. Для того чтобы приступить к браузингу сразу после открытия экранной формы в рантайме, воспользуйтесь обработчиком события Opened и пропишите в нем код:

    Tree_1.TreeDataSource_1.FileSystemBrowser_1.Browse(""); // !NB: Браузинг начнется с корневого пути, который был задан на шаге 4.1
  10. Запустите форму в рантайме, чтобы посмотреть содержимое папки проекта FileSystemBrowser.

Архивирование файлов

Чтобы архивировать и распаковывать файлы, воспользуйтесь компонентом Окружение: архиватор. Компонент поддерживает основные форматы архивов, включая zip, 7z, rar и другие.

Компонент Окружение: архиватор расположен в юните Окружение библиотеки компонентов.

Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

При запуске проекта через Alpha.HMI.WebViewer все операции архивирования и распаковки выполняются на сервере, где запущен Alpha.HMI.WebViewer, а не на компьютере пользователя, открывшего проект в браузере.

Демо-пример работы с архивами

Далее кратко описан небольшой пример (скачать его можно здесь) использования компонента Окружение: архиватор в проекте Alpha.HMI с использованием языка Alpha.Om.

В примере показано как:

  • Упаковать файлы в формат zip и сохранить архив в выбранную папку;
  • Распаковать архив в выбранную папку;
  • Посмотреть список файлов и папок в архиве без распаковки.

Упаковать файлы в формат zip и сохранить архив в выбранную папку

  1. Добавьте на форму компонент Окружение: архиватор.

  2. Выберите в свойстве Уровень сжатия желаемую степень сжатия.

  3. Добавьте на форму кнопку, при нажатии на которую будет производиться упаковка файлов в формат zip и сохраняться по указанному пути.

  4. Настройте обработчик события ButtonPressed для кнопки. В обработчике используйте метод AsyncPack компонента Окружение: архиватор, чтобы упаковать файлы в архив и сохранить архив в выбранную папку. Пример кода:

    Archiver_1.AsyncPack("C:/DEMO_PROJECT", "C:/Archive/DEMO_PROJECT.zip");

Распаковать архив в выбранную папку

  1. Добавьте на форму кнопку, при нажатии на которую будет производиться распаковка архива формата zip в выбранную папку.

  2. Настройте обработчик события ButtonPressed для кнопки. В обработчике используйте метод AsyncUnpack компонента Окружение: архиватор, чтобы распаковать архив в выбранную папку. Пример кода:

    Archiver_1.AsyncUnpack("C:/Archive/DEMO_PROJECT.zip", "C:/DEMO_PROJECT");

Посмотреть список файлов и папок в архиве без распаковки

  1. Добавьте на форму кнопку и подготовьте текстовое поле, куда будет выводится список файлов из архива.

  2. Настройте обработчик события ButtonPressed для кнопки. В обработчике используйте метод BrowseAsJSON компонента Окружение: архиватор, чтобы получить список файлов и папок в архиве без распаковки. Пример кода:

    Text_1 = Archiver_1.BrowseAsJSON("C:/Archive/DEMO_PROJECT.zip");