AVEVA Plant / AVEVA Marine
Справочник
Адаптация интерфейса PDMS/Everything3D
с помощью инструмента Customization и UIC файлов
Основные принципы работы UIC файлов
Для адаптации интерфейса (меню, тулбаров и лент) в большинстве продуктов AVEVA Plant и AVEVA
Marine возможно использовать инструмент Customization и UIC файлы.
UIC файл представляет собой XML файл с описанием элементов интерфейса, таких как:
- элементы управления (кнопки, чекбоксы, текстовые поля, выпадающие списки и др.);
- описание элементов меню;
- описание панелей инструментов (тулбаров);
- описание лент и их элементов.
Каждый модуль может загружать несколько UIC файлов. Перечень UIC файлов, которые будут
подгружены при запуске модуля можно найти в файле [Link], где XXX – имя модуля. К
примеру:
[Link] Модуль Design (Aveva PDMS или Aveva Everything3D)
[Link] Модуль Diagrams (Aveva Diagrams)
[Link] Модуль Tags (Aveva Engineering)
И т.д.
К примеру файл [Link] имеет следующее содержимое:
<?xml version="1.0" encoding="utf-8"?>
<UICustomizationSet xmlns:xsd="[Link]
xmlns:xsi="[Link]
<UICustomizationFiles>
<CustomizationFile Name="Module" Path="[Link]" />
<CustomizationFile Name="Project" Path="$[Link]" />
<CustomizationFile Name="SchematicExplorerAddin" Path="[Link]" />
<CustomizationFile Name="SVGCompare" Path="[Link]" />
<CustomizationFile Name="Integrator" Path="[Link]"/>
</UICustomizationFiles>
</UICustomizationSet>
Как видно при запуске модуля Design загружается пять UIC файлов. Данные файлы находятся в корне
установки модуля. Следует обратить внимание на UIC с именем Project и путем $[Link] – это файл адаптации
проекта. При загрузке, вместо $1 будет подставлен код проекта и будет подгружен соответствующий файл. К
примеру, для проекта Sample (код SAM) при запуске будет произведена попытка загрузить файл [Link].
Создание корпоративных UIC файлов
Перед тем как приступать к адаптации интерфейса имеет смысл создать собственные UIC файлы,
чтобы не смешивать собственные настройки с настройками модулей по умолчанию
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
ПРЕДПРЕЖДЕНИЕ. Недопустимо редактировать системные UIC файлы, так как это может
привести к ошибкам в работе модулей.
Для создания собственного UIC файла достаточно создать пустой файл с расширением .uic и вставить в
него следующий текст:
<?xml version="1.0" encoding="utf-8"?>
<UserInterfaceCustomization xmlns:xsi="[Link]
xmlns:xsd="[Link] xmlns="[Link]">
<Version>1.0</Version>
<Tools/>
<InstanceTools />
<MenuBar/>
<CommandBars/>
<TaskPanes />
<ContextMenus />
<AreaLeftTools />
<AreaRightTools />
<FooterTools />
<NavigationMenuTools />
<QATTools />
<ContextualTabGroups />
<TabToolbarTools />
<Tabs />
<MiniToolbarTools />
<Namespace>CompanyRegularUic</Namespace>
</UserInterfaceCustomization>
При этом в элементе Namespace необходимо указать уникальное пространство имен для данного UIC
файла. В данном случае это CompanyRegularUic.
После этого следует прописать путь к данному файлу в файл [Link]
<?xml version="1.0" encoding="utf-8"?>
<UICustomizationSet xmlns:xsd="[Link]
xmlns:xsi="[Link]
<UICustomizationFiles>
<CustomizationFile Name="Module" Path="[Link]" />
<CustomizationFile Name="Project" Path="$[Link]" />
<CustomizationFile Name="SchematicExplorerAddin" Path="[Link]" />
<CustomizationFile Name="SVGCompare" Path="[Link]" />
<CustomizationFile Name="Integrator" Path="[Link]"/>
<!-- Company customization -->
<CustomizationFile Name="CompanyRegularUic" Path="[Link]" />
</UICustomizationFiles>
</UICustomizationSet>
Для того, чтобы не редактировать файл [Link] на каждом компьютере для
подключения uic файла и не копировать uic файл на каждый компьютер возможно централизовать данные
настройки.
Для этого необходимо определить переменную окружения CAF_UIC_PATH в пакетном файле запуска
приложения AVEVA Plant / AVEVA Marine
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
SET CAF_UIC_PATH=\\pdmsserver\path_to_uic\
После этого необходимо скопировать в указанную папку все файлы *[Link] всех модулей.
Теперь перечни подгружаемых UIC файлов для каждого модуля будут браться с сетевого диска, а
значит централизовано для всех пользователей.
ПРЕДПРЕЖДЕНИЕ. Хотя файлы содержимое *[Link] обновляется режем, чем
содержимое UIC файлов, после обновления версий не забывайте проверять их
содержимое в папке приложения на предмет возможных изменений. Оптимальным
является хранение своих версий файлов *[Link] для каждой версии AVEVA
Plant / AVEVA Marine.
Далее копируем файл [Link] на сетевой диск и редактируем
[Link], заменяя путь к файлу [Link] на новый путь.
Разделение файлов адаптации для модулей с классическим интерфейсом и
ленточным интерфейсом
Различные модули используют различные виды интерфейса. К примеру, Design версии 12.1.SP4
использует классический интерфейс (меню и панели инструментов), тогда как Diagrams использует
ленточных.
Для того, чтобы не дублировать одинаковые наборы команд для приложений с разными видами
интерфейса возможно использовать следующую организацию файлов адаптации (см. рисунок 1).
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
ПРЕДПРЕЖДЕНИЕ. Вы можете не использовать подход, описанный в данном разделе, но в
обязательном порядке следует придерживаться правила не редактировать системные UIC
файлы, а всю адаптацию производить в своих UIC файлах.
CompanyCommands
CompanyRegularUic CompanyRibbonUic
Рисунок 1. Организация файлов адаптации
При данной организации общие для классического и ленточного интерфейсов команды будут хранится
в файле CompanyCommands, тогда как определения меню, панелей инструментов и лент будут хранится в
файле классического инетерфейса CompanyRegularUic и файле ленточного интерфейса CompanyRibbonsUic.
В файлах модулей будут соответственно прописаны UIC файлы только применимые к типу интерфейса
модуля. К примеру, [Link]
<?xml version="1.0" encoding="utf-8"?>
<UICustomizationSet xmlns:xsd="[Link]
xmlns:xsi="[Link]
<UICustomizationFiles>
<CustomizationFile Name="Module" Path="[Link]" />
<CustomizationFile Name="Project" Path="$[Link]" />
<CustomizationFile Name="SchematicExplorerAddin" Path="[Link]" />
<CustomizationFile Name="SVGCompare" Path="[Link]" />
<CustomizationFile Name="Integrator" Path="[Link]"/>
<!-- Company customization -->
<CustomizationFile Name="CompanyCommands"
Path="\\pdmsserver\path_to_uic\[Link]" />
<CustomizationFile Name="CompanyRegularUic"
Path="\\pdmsserver\path_to_uic\[Link]" />
</UICustomizationFiles>
</UICustomizationSet>
Файл [Link]
<?xml version="1.0" encoding="utf-8" ?>
<UICustomizationSet xmlns:xsd="[Link]
xmlns:xsi="[Link]
<UICustomizationFiles>
<CustomizationFile Name="DatasheetAddin" Path="[Link]" />
<CustomizationFile Name="DiagramsCompareUpdateAddin"
Path="[Link]" />
<CustomizationFile Name="DiagramsSVGCompareAddin"
Path="[Link]" />
<CustomizationFile Name="DiagramsDiagramViewerAddin"
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
Path="[Link]" />
<CustomizationFile Name="Module" Path="[Link]" />
<CustomizationFile Name="CoreMenu" Path="[Link]" />
<CustomizationFile Name="AIAddin" Path="[Link]" />
<CustomizationFile Name="ConnectionMap" Path="[Link]" />
<CustomizationFile Name="SCMVModuleGeneral" Path="[Link]" />
<CustomizationFile Name="SCMVModuleDiagrams" Path="[Link]" />
<CustomizationFile Name="DWGExport"
Path="AddinsData\Diagrams\[Link]" />
<CustomizationFile Name="DGNExport"
Path="AddinsData\Diagrams\[Link]" />
<CustomizationFile Name="SVGCompare" Path="[Link]" />
<CustomizationFile Name="CatalogSearchAddin" Path="[Link]" />
<CustomizationFile Name="CoreConnectionsDiagramAddin"
Path="[Link]" />
<!-- Company customization -->
<CustomizationFile Name="CompanyCommands"
Path="\\pdmsserver\path_to_uic\[Link]"
/>
<CustomizationFile Name="CompanyRibbonsUic"
Path="\\pdmsserver\path_to_uic\[Link]" />
</UICustomizationFiles>
</UICustomizationSet>
Работа с инструментом Customize
Для редактирования UIC файлов адаптации существует инструмент Customize. Чтобы открыть окно
Customize необходимо щёлкнуть правой кнопкой по ленте или панели инструментов и в выпавшем списке
выбрать пункт Customize…
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
Откроется основное окно Customize.
Окно поделено на три основные части:
- дерево элементов интерфейса (панели инструментов, меню, ленты и др.);
- список доступных элементов управления (кнопки, тестовые поля, чекбоксы и др.)
- свойства выбранного элемента.
Также в верхней части есть выпадающий список, где можно выбрать активный файл адаптации. Чтобы
посмотреть, где он расположен, следует выбрать элемент Active Customization File:
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
Создание кнопок
Для создания кнопки выберите нужный файл адаптации и нажмите на кнопку Button для добавления
элемента управления кнопка:
После этого в средней части в конце списка появится кнопка, выбрав её, можно увидеть её свойства в
крайней правой колонке окна:
Можно задать следующие основные свойства:
Caption Наименование кнопки
Command Какую команду выполнить (рассмотрено ниже)
Icon Назначение графической иконки
Name Уникальное имя элемента управления
Shortcut Сочетание клавиш быстрого вызова
Tooltip Подсказка
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
При выборе пункта Command справка поля появляется кнопка для вызова окна настройки выполнения
команды. Возможно задание двух видов команд: Macro или PML команда и Command или .Net команда1 .
В первом случае можно написать любую PML команду для выполнения. К примеру:
Show !!componentCreation $*открытие окна Pipe Component Creation
$M %pdmsui%/des/hvacadv/mweight $*запуск макроса пересчета веса HVAC элемента
При выборе типа Command, появляется дерево с доступными командами .net сгруппированными по
пространствам имен.
1
Вариант Command Class является подвидом .Net команды.
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
Давайте создадим простейшую команду отображающую сообщение «Hello, World!»
СОВЕТ. Большую коллекцию бесплатных иконок вы можете скачать по ссылке
[Link] – FamFamFam Silk
Icons.
Создание панели инструментов и меню
Для классического интерфейса стандартными верхнеуровневыми элементами интерфейса являются
меню и панели инструментов.
Для создания меню, выберем соответствующий UIC файл – CompanyRegularUic. После этого щелкнув
правой кнопкой по пункту Menubar, выберите пункт New Menu
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
Отредактируйте заголовок меню.
После чего создам подменю
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
Добавим созданное подменю в основное меню комании, для этого перетащим элемент «Подменю» из
среднего окна в левое на пункт «Меню компании»
После этого точно таким же образом, перетащим кнопку «Сказать «Hello, World!» на пункт
«Подменю».
Аналогичным образом создается панель инструментов.
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
В результате получим следующие меню и панель инструментов:
Создание лент
Процесс создания лент аналогичен процессу создания меню и панелей инструментов. Лента состоит из
групп, в которые в свою очередь добавляются элементы управления (кнопки, кнопки меню и др.).
Для создания ленты выберите группу Tabs и щелкнув правой кнопкой выберите команду New Tab.
После, выбрав созданную вкладку, также щелкните по ней и выберите команду New Group.
Далее, аналогично тому, как мы размещали кнопки в элементы меню и панели инструментов,
переносим кнопку «Сказать «Hello, World!» в указанную группу.
E-Mail: [Link]@[Link]
AVEVA Plant / AVEVA Marine
Справочник
Для настройки вида кнопки на ленте доступно контекстное меню по правому щелчку на кнопке в
группе.
К примеру, в нашем случае, выберем пункт Large Image, для отображения кнопки в виде большой
кнопки.
После сохранения настроек появится новая лента с нашей кнопкой:
E-Mail: [Link]@[Link]