Documentation Center

GUI Model Extension

A Model represents a data model for a GUI extension to Content Manager. The extension point for a Model is called UIModel.

Each Model has the following custom properties, configured in its properties section in the manifest file, manifest.json:
Property nameProperty description
nameThe name of the Model.
contentFolderThe name of the folder inside the Add-on package (ZIP file) containing the Model's resources.
configurationPathThe relative path to, and filename of, the configuration file that defines this Model. This path is relative to the root folder of the ZIP file.
assembliesFolderOptional: the relative path to the folder containing any .NET assemblies (.dll files) needed by the Model. This path is relative to the root folder of the ZIP file.
globalResourcesFolderOptional: the relative path to the folder containing any string resources (.resx files) needed by the Model. This path is relative to the root folder of the ZIP file.
Here are the contents of a GUI Model Extension as configured in the manifest file:
{
  "name":"MyGUIExtensionModel",
  "type": "UIModel",
  "properties": {
    "name": "MyGUIExtensionModel",
    "contentFolder": "MyGUIExtension\\Model",
    "configurationPath": "MyGUIExtension\\Model\\Configuration\MyGUIExtensionModel.config",
    "assembliesFolder": "MyGUIExtension\\Model\\Assemblies",
    "globalResourcesFolder": "MyGUIExtension\\Model\\Resources",
  }
}
This configuration assumes that the Add-on package (ZIP file) contains the following folders:
  • MyGUIExtension\Model\, containing the necessary resources for this Model
  • MyGUIExtension\Model\Configuration\, containing a configuration file called MyGUIExtensionModel.config
  • MyGUIExtension\Model\Assemblies\, containing one or more .NET assemblies for this Model
  • MyGUIExtension\Model\Resources\, containing one or more string resource files for this Model

The name of the Model will be MyGUIExtensionModel.