Задайте компоненты

Необходимые данные компонента

Необходимо указать следующую информацию, когда вы создаете компонент:

  1. Путь, где вы хотите поместить папку, которая содержит все файлы для компонента. Для получения информации о том, как задать эту папку, смотрите, Задают Местоположение Файлов Компонента.

  2. Свойства компонента. Для получения дополнительной информации смотрите, Задают Свойства компонентов.

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

Задайте местоположение файлов компонента

Можно создать компоненты, которые выполняют подобные функции и группируют их в Директориях Пакета. Каждая папка пакета должна иметь Родительский каталог, который находится в пути MATLAB®. Когда вы создаете новый компонент, программное обеспечение MATLAB Report Generator™ создает файлы, которые составляют компонент. Эти файлы хранятся в структуре папок <parent>/@package_name/@class_name.

Задайте эти директории в следующих полях в области Component File Location панели Свойств:

  1. Поле Class Directory. Задайте имя класса для своего компонента. Процесс сборки создает папку с именем, которое вы задаете, и помещает файлы компонента в него. Имя папки класса должно быть уникальным для каждого компонента в пакете. Условно, имена классов компонента начинаются с прописной или строчной буквы c; например, cUserDefinedComponent.

  2. Поле Package Directory. Задайте папку, в которой можно хранить файлы для групп компонентов, которые вы создаете. Файлы для каждого компонента хранятся в подпапке с именем, вы ввели в Class Directory Field.

  3. Поле Parent Directory. Задайте эту папку, когда вы создадите пакет впервые. Эта папка является родительской папкой Директории Пакета.

Установите параметры отображения компонента

Можно задать, как вы хотите, чтобы ваш компонент появился в Report Explorer путем ввода данных в область Component Display Options панели Свойств. Введите следующую информацию:

  1. DisplayName . Задайте имя отображения для компонента, чтобы появиться в списке компонентов для его связанной категории. Категории компонента и имена отображения появляются в панели Options посреди Report Explorer.

    Для получения информации об определении категорий компонента смотрите шаг 3, Category Name.

    Следующий пример показывает, как создать компонент под названием My First Component в категории под названием My Category.

  2. Описание. Введите описание для компонента. Это описание появляется, когда вы кликаете по имени компонента или названию категории в панели Options посреди Report Explorer. Сделайте описание информативным, но кратким.

  3. Category Name. Задайте категорию компонентов, которым принадлежит новый компонент. Компонент появляется под этой категорией в панели Options посреди Report Explorer.

    Предопределенный выбор появляется в списке Category name. Выберите категорию компонента из этого списка.

    Чтобы создать категорию собственного компонента, введите имя для категории в поле Category name. Это название категории появляется в списке доступных категорий в Report Explorer.

  4. child components.

    Установите    флажок Component may contain children, если вы хотите, чтобы компонент имел дочерние компоненты. Дочерние компоненты появляются под компонентом в иерархии Report Explorer. Во время генерации отчета компонент запускает все дочерние компоненты и включает их выход в отчет.

Задайте свойства компонентов

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

Добавьте свойства в компоненты

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

Существует несколько способов добавить свойства в компоненты:

  1. Щелкните правой кнопкой по имени компонента, в который вы хотите добавить свойства в панели Схемы слева. Выберите Add new property из его контекстного меню.

  2. Щелкните правой кнопкой по имени предопределенного свойства в панели Options в середине. Из контекстного меню выберите Add property.

  3. Щелкните левой кнопкой по имени свойства в панели Options, и затем перетащите его сверху компонента в панели Схемы слева.

  4. Дважды кликните имя свойства в панели Options в середине. Свойство добавляется к и значениям свойств компонента, появляются в панели Свойств справа.

  5. Нажмите кнопку Add Property на панели Свойств справа.

Задайте свойства компонентов

  1. PropertyName . Создайте имя для нового свойства. Имя свойства должно быть допустимым именем переменной MATLAB и должно быть уникальным в компоненте.

  2. Тип данных. Задайте тип данных свойства. Опции:

    • Double

    • Enumeration

    • Integer

    • String

    • String Vector

    • %<Parsed String>

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

    • True/False

  3. Default Value. Установите значение по умолчанию для свойства. Значение по умолчанию должно быть совместимо с типом данных. Если несовместимости существуют между значением по умолчанию и типом данных, сила компонента не создают.

  4. Dialog Prompt. Этот текст появляется рядом с виджетом на диалоговом окне компонента. Это указывает на то, что делает свойство и как это влияет на генерацию отчета.

    Примечание

    Когда компонент создает, двоеточие добавлено к вашей записи в поле Dialog prompt. Ваша запись появляется в панели Свойств с добавленным двоеточием.

Измените существующие компоненты

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

Создайте компоненты

После того, как вы ввели все данные, требуемые для определения компонента, вы создаете его путем нажатия кнопки Build Component. Процесс сборки создает все файлы, необходимые для компонента, и хранит их в заданной папке. Для получения дополнительной информации об определении, где компоненты хранятся, смотрите, Задают Местоположение Файлов Компонента.

Примечание

Перезаписываются существующие файлы в этом месте.

Восстановите существующие компоненты

Чтобы добавить, удалите, или свойства изменения существующего компонента, используйте кнопку Rebuild Constructor. Эта кнопка становится активной только после того, как вы ранее создали компонент с помощью кнопки Build Component. Чтобы активировать кнопку Rebuild Constructor, задайте Package name и Class name для существующего компонента. Эти поля расположены в области Component File Location панели Свойств.

Если вы выбираете компонент с помощью Tools> Create component from, поля компонента заполнены в автоматически, и кнопка становится активной.

После того, как вы закончите изменять компонент, нажмите кнопку Rebuild Constructor, чтобы восстановить компонент. Перезаписываемые файлы в местоположении папки компонента не перезаписываются.

Удалите компонент

Удалить компонент:

  1. Удалите его папку класса, <root>/@package_name/@class_name. Если компонент, который вы хотите удалить, является единственным компонентом в пакете, удалите целый пакет.

  2. Отредактируйте <root>/@package_name/rptcomps2.xml удалить элемент XML, который указывает компонент.

Документация MATLAB Report Generator
Поддержка
Для просмотра документации необходимо авторизоваться на сайте