wiki:Public/Docs/CinnamonClientRelationsTabControl

Version 1 (modified by Administrator, 5 years ago) ( diff )

The relations tab control

The relations control exposes parents and children of objects:

<tab_control assembly="EnterprisePackage" type="TabControls.RelationsTabControl" display="list">
  <custom>
    <highlight_types>
      <highlight_type sysname="child_content" color="008040" />
      <!-- also supported: backcolor -->
      <highlight_type sysname="rendition" color="800000" />
    </highlight_types>
    <columns>
      <list_view_column type="relationtype" width="150" />
      <!-- currently supported: name, id, format, type, size, owner, locked, lifecycle, path -->
      <list_view_column type="name" width="200" sort="ascending" />
      <list_view_column class="custom" type="title" label="Titel" width="50" />
      <list_view_column type="version" width="50" />
      <list_view_column type="format" width="50" />
      <list_view_column class="custom" type="revision" label="Revision" width="50" />
      <list_view_column type="lifecycle" width="80" />
      <list_view_column type="owner" width="80" />
      <list_view_column type="modifier" width="80" />
      <list_view_column type="path" width="200" />
      <!-- currently supported: name, id, format, type, size, owner, locked, lifecycle, path, or custom fields available from summary -->
    </columns>
    <default_relation_type>child_content</default_relation_type>
    <object_selector>
      <custom>
        <node_data_provider assembly="CinnamonEnterpriseClient" type="DefaultNodeDataProvider" />
        <columns>
          <list_view_column type="name" width="200" sort="ascending" />
          <list_view_column class="custom" type="title" label="Titel" width="50" />
          <list_view_column type="version" width="50" />
          <list_view_column type="format" width="50" />
          <list_view_column class="custom" type="revision" label="Revision" width="50" />
          <list_view_column type="lifecycle" width="80" />
          <list_view_column type="owner" width="80" />
          <list_view_column type="modifier" width="80" />
          <!-- currently supported: name, id, format, type, size, owner, locked, lifecycle, path, or custom fields available from summary -->
        </columns>
      </custom>
    </object_selector>
  </custom>
</tab_control>

All configuration is wrapped in a custom element inside the tab control. The custom element has four sections:

  • highlight_types defining the text and background colors for the different relation types.
  • columns defining the metadata fields that should be shown with the relations.
  • default_relation_type defining the relation type that should be the default selection in the list when users create new relations.
  • object_selector defining the library and name of the class implementing the module allowing users to select objects inside Cinnamon.
Note: See TracWiki for help on using the wiki.