Tree Schema Definition Reference

In this reference, you can learn about the elements you can use to create your console applications. Normally, the description of the elements includes information on its attributes and elements it must or can contain.

Actions

This element defines actions to be added to the parent element. Optional.

It can contain the following elements:

  • AddDataAction
  • WorkflowAction
  • CustomUrlAction
  • ReportFunctionAction
  • MessageBoxAction
  • ConfirmAction

As a child element of DataElements and DataFolderElements, it can also contain:

  • EditDataAction
  • DeleteDataAction

AddDataAction

This element defines a C1-specific Add Data action to attach to a parent element. This element has the following attributes:

  • Type
  • Label
  • ToolTip
  • Icon
  • CustomFormMarkupPath

Type

The data type to add a data item to. Required.

Label

A custom label of the action. Optional. Defaults to the localized version of the "Add" string.

ToolTip

A custom tooltip of the action. Optional. Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

CustomFormMarkupPath

The path to an alternate C1 Form UI XML file. Optional. Defaults to the "Add Data" form used for the datatype.

Children

This element defines what child element the parent element can have.

As a child element of the ElementRoot, Element and DataElements element it can contain one or more elements such as:

  • Element
  • DataElements
  • DataFolderElements

As a child element of the DataFolderElements, it can contain one or more elements such as:

  • DataElements
  • DataFolderElements

ConfirmAction

This element defines an action that shows a standard confirmation box. If the user clicks 'OK', the embedded C1 function is executed.

It has the following attributes:

  • ConfirmTitle
  • ConfirmMessage
  • Label
  • ToolTip
  • Icon
  • RefreshTree
  • PermissionTypes
  • Location

It must contain one f:function element that embeds a C1 function.

ConfirmTitle

The title of the confirmation box. Required.

ConfirmMessage

The message of the confirmation box. Required.

Label

The label of the action. Required.

ToolTip

The tooltip of the action. Optional. Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

RefreshTree

When set to "true", the tree refreshes if the user clicks "OK". Its possible values are:

  • true
  • false

Defaults to "false".

PermissionTypes

A list of permissions on the custom URL action. Optional. The list can include one or more comma-separated values:

  • read
  • edit
  • add
  • delete
  • approve
  • publish
  • administrate

Defaults to "read".

Location

The location of the action's button on the toolbar. Optional. Its possible values are one of the following:

  • Add
  • Edit
  • Delete
  • Other

Defaults to "Other".

CustomUrlAction

This element defines an action to open a custom URL. The URL can include one or more post parameters defined as child elements or appended to the URL itself in the attribute. This element has the following attributes:

  • Url
  • Label
  • Tooltip
  • Icon
  • PermissionTypes
  • ViewType
  • ViewLabel
  • ViewToolTip
  • ViewIcon

It can also contain the PostParameters element.

Url

The URL to open. Required.

It is not intended for external URLs. Internal URLs can only be used. The URL must be relative and start with "~" (resolved by C1 to the current application path). Example: "~/XmlBasedSiteBackup.aspx"

The URL can include one or more post parameters appended to the URL specified in the attribute and make use of the dynamic values. Example: "~/WebForm1.aspx?Id=${C1:Data:Composite.Data.Types.IPage:Id}&ShowPageId=False"

Use the encoded "&" for "&" when appending more than one parameter.

Label

A label of the custom URL action. Required.

ToolTip

A custom tooltip of the custom URL action. Optional.

Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

PermissionTypes

A list of permissions on the custom URL action. Optional. The list can include one or more comma-separated values:

  • read
  • edit
  • add
  • delete
  • approve
  • publish
  • administrate

Defaults to "read".

ViewType

The type of the view to open the URL in. Optional. Its possible values are:

  • genericview
  • documentview
  • pagebrowser
  • filedownload
  • externalview

Defaults to "genericview".

Normally, an ASPX page is expected as the value.

ViewLabel

The label of the view. Optional. Defaults to the value of the Label attribute.

ViewToolTip

The tooltip of the view. Optional. Defaults to the value of the ToolTip attribute.

ViewIcon

This attribute specifies the icon of the view. Optional. Defaults to the icon associated with the view set in the ViewType attribute.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

DataElements

This element defines the data type to retrieved data items from. It has the following attributes:

  • Type
  • Label
  • ToolTip
  • ShowForeignItems
  • Display
  • Icon
  • OpenedIcon

It can contain the Children, Actions, OrderBy and Filters elements.

Type

The data interface type name. Required.

The data type name must include namespaces.

Label

A custom label for each data item. Optional. Defaults to the value of the data type's Label field.

Use "${C1:Data:[TypeName]:[FieldName]}" to get a field value of a parent (or self) data element.

ToolTip

A custom tooltip for each data item. Optional. Defaults to the value of the custom Label (if specified) or to the value of the data type's Label field.

Use "${C1:Data:[TypeName]:[FieldName]}" to get a field value of a parent (or self) data element.

ShowForeignItems

When set to "true", data items not yet localized are displayed with a "Localize" action. Optional. Defaults to "true".

Its possible values are "true" or "false".

Display

A mode in which an element that might have child elements is displayed. Is characterized by two aspects:

  • Whether to display the element that has no child elements
  • Whether to show a "plus" sign next to the element to allow expanding it

Optional. Defaults to "Lazy".

Its possible values are:

  • Lazy: Shows all elements even though they might have no child elements and always show the "+" sign next to these elements
  • Compact: Only shows the elements that has child elements; hides all the elements without child elements
  • Auto: Shows all elements even though they might have no child elements, but only shows the "+" sign if the element has child elements.

Icon

The icon of the element when collapsed. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

OpenedIcon

The icon of the element when expanded. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

DataFolderElements

This element defines elements that serve as grouping folders on data elements or other data folder elements. It has the following attributes:

  • Type (parent data folders only)
  • FieldGroupingName
  • DateFormat
  • Range
  • FirstLetterOnly
  • Icon
  • ShowForeignItems (child data folders only)
  • Display

It can contain the Children and Actions elements. The Children element cannot contain the Element element.

Type

The data interface type name. Required.

Not used on the data folder elements nested within the parent data folder element.

The data type name must include namespaces.

FieldGroupingName

The field name of the given data interface (property name). Required.

DateFormat

Date format used when grouping. Optional.

Use the following syntax to format dates:

  • Year: y, yy, yyy, yyyy.
  • Month: M, MM, MMM, MMM.
  • Day: d, dd, ddd, dddd.
  • Hour: h, H, hh, HH.
  • Minute: m, mm.Second: s, ss

Range

Ranges for grouping data folders. Optional.

Use ">" between the starting and ending values of a range and "," between ranges. A single value for a range is also possible.

Ex: "0>10, 11>20, 21>" or "A>F, G>Z"

FirstLetterOnly

When set to "true" the grouping is done with the first letter only. Optional.

Its possible values are "true" and "false".

Icon

The icon of the element. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

ShowForeignItems

When set to "true", data folder items not yet localized are displayed with a "Localize" action.

Only used on the data folder elements nested within the parent data folder element. Not used on the parent data folder element.

Optional. Defaults to "true".

Its possible values are "true" or "false".

Display

A mode in which an element that might have child elements is displayed. Is characterized by two aspects:

  • Whether to display the element that has no child elements
  • Whether to show a "plus" sign next to the element to allow expanding it

Optional. Defaults to "Lazy".

Its possible values are:

  • Lazy: Shows all elements even though they might have no child elements and always show the "+" sign next to these elements
  • Compact: Only shows the elements that has child elements; hides all the elements without child elements
  • Auto: Shows all elements even though they might have no child elements, but only shows the "+" sign if the element has child elements.

DataType

The element defines C1 datatype, the items of which the application is allowed to be attached to. The number of the DataType elements is not limited for one application.

It has two attributes:

  • Type
  • Position

Type

The C1 data type, the items of which the application is allowed to be attached to. Required.

Position

The position in the tree structure the application will appear at. Optional.

Its possible values are:

  • Top
  • Bottom

Defaults to "Top".

DeleteDataAction

This element defines a C1-specific Delete Data action to attach to a tree element. This element has the following attributes:

  • Label
  • ToolTip
  • Icon

Label

A custom label of the action. Optional. Defaults to the localized version of the "Delete" string.

ToolTip

A custom tooltip of the action. Optional. Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

EditDataAction

This element defines a C1-specific Edit Data action to attach to a tree element. This element has the following attributes:

  • Label
  • ToolTip
  • Icon
  • CustomFormMarkupPath

Label

A custom label of the action. Optional. Defaults to the localized version of the "Edit" string.

ToolTip

A custom tooltip of the action. Optional. Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

CustomFormMarkupPath

The path to an alternate C1 Form UI XML file. Optional. Defaults to the "Edit Data" form used for the datatype.

Element

This element defines a simple element or folder. It has the following attributes:

  • Id
  • Label
  • ToolTip
  • Icon
  • OpenedIcon

It can contain the Children and Actions elements.

Id

A unique string in the tree to identify the element. Required.

Changing its value will render any security settings set on the element invalid.

Label

The label of the element. Required.

Use "${C1:Data:[TypeName]:[FieldName]}" to get a field value of a parent (or self) data element.

ToolTip

The tool tip of the element. Optional. Defaults to the Label's value.

Use "${C1:Data:[TypeName]:[FieldName]}" to get a field value of a parent (or self) data element.

Icon

The icon of the element when collapsed. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

OpenedIcon

The icon of the element when expanded. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

ElementRoot

This element defines the starting point (root) of the tree structure. Children of this element are the root children of the points where the tree is attached.

It has one attribute:

  • ShareRootElementById

It can contain one Children and one Actions elements.

ShareRootElementById

When set to "true", the tree will be grouped in one perspective with other tree definitions with the same attribute's value provided they all have the same Id for the Element element, which is a child of ElementRoot. Its possible values are:

  • true
  • false

Defaults to "false".

ElementStructure

This element is the root of the tree definition (tree markup).

It must specify namespaces and contain the ElementRoot element.

It normally contains one of the two elements:

  • ElementStructure.AutoAttachments
  • ElementStructure.AllowedAttachments

ElementStructure.AllowedAttachments

The element defines the application as an allowed attachment. It has one attribute:

  • ApplicationName.

It normally contains one DataType element.

ApplicationName

The name of the application to refer to when adding or removing it. Required.

ElementStructure.AutoAttachments

The element defines the application as an auto attachment. It normally contains the NameParent element.

Field

This element orders the resulting data elements by the given field ascending or descending.

It has the following attributes:

  • FieldName
  • Direction

FieldName

The name of the field used to order data elements by. Required.

Direction

The order to sort data elements by. Optional. Defaults to "ascending".

Two values are possible:

  • ascending
  • descending

FieldFilter

This element defines a filter that selects data elements if a given field contains a value that matches a specific value or a range of values.

It has the following attributes:

  • FieldName
  • FieldValue
  • Operator

FieldName

The name of the field to filter on. Required.

FieldValue

The value of the field for which the elements will be shown. Required.

Operator

The relation between the field and the value to select elements when filtered if they match this relation. Optional. Defaults to "equal".

Its possible values are:

  • equal
  • inequal
  • greater
  • lesser
  • greaterequal
  • lesserequal

Filters

This element defines filters that will filter data elements of the given data type.

It can contain one ParentIdFilter element and/or one or more FieldFilter and FunctionFilter elements.

The DataElements can only contain this element. The DataElements can contain only one Filters element.

FunctionFilter

The element defines a filter that uses a C1 function as a filter function.

This element must contain one f:function element.

MessageBoxAction

This element defines an action that shows a simple message box.

  • Label
  • MessageBoxTitle
  • MessageBoxMessage
  • ToolTip
  • Icon
  • MessageDialogType
  • PermissionTypes
 

Label

A label of the action that shows the message box. Required.

MessageBoxTitle

The title of the message box. Required.

MessageBoxMessage

The message of the message box. Required.

ToolTip

A custom tooltip of the action that shows the message box. Optional.

Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

MessageDialogType

The type of the message box. Optional. Its possible values are:

  • message
  • question
  • warning
  • error

Defaults to "message".

Each type displays its own icon in the message box.

PermissionTypes

A list of permissions on the message box action. Optional. The list can include one or more comma-separated values:

  • read
  • edit
  • add
  • delete
  • approve
  • publish
  • administrate

Defaults to "read".

NamedParent

The element defines the perspective to attach the application in.

Name

The name of the perspective to attach the application in. Required.

Its possible values are:

  • Content
  • Content.WebsiteItems
  • Media
  • Layout
  • Function
  • Data
  • User
  • System
  • PerspectivesRoot

Position

The position in the tree structure the application should appear at. Optional.

The following two values are possible:

  • Top
  • Bottom

Defaults to "Top".

OrderBy

This element defines how the resulting data elements should be ordered. It has no attributes and should contain one or more Field elements.

This element is optional . The DataElement element can only contain the OrderBy element.

Parameter

This element specifies the "key=value" pair of a single "post" parameter. It has two attributes:

  • Key
  • Value

Key

The key part of the "post" parameter used with a custom URL. Required.

Value

The value part of the "post" parameter used with a custom URL. Required.

ParentIdFilter

This element defines a filter, which specifies that only those data elements that have the parent pointed to in the current tree will be shown.

It has two attributes:

  • ParentType
  • ReferenceFieldName

The Filters element can only have one ParentIdFilter element.

ParentType

The type of the parent element (data type) to filter on. Required.

ReferenceFieldName

The name of the field that is the reference to the parent type. Required.

PostParameters

This optional element of the CustomUrlAction element lists "post" parameters to be used together with the URL. It must contain at least one Parameter element.

ReportFunctionAction

This element defines an action that shows a document with custom content. It has the following attributes:

  • Label
  • Tooltip
  • Icon
  • PermissionTypes
  • DocumentLabel
  • DocumentIcon

It must also contain one <f:function> element. The content of the element must be a C1 function call that returns XHTML.

Label

A label of the custom URL action. Required.

ToolTip

A custom tooltip of the report function action. Optional. Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

PermissionTypes

A list of permissions on the report function action. Optional. The list can include one or more comma-separated values:

  • read
  • edit
  • add
  • delete
  • approve
  • publish
  • administrate

Defaults to "read".

DocumentLabel

The label of the document. Optional.

You can use "${C1:Data:[TypeName]:[FieldName]}" to get a field value of a parent (or self) data element.

Defaults to the value of the Label attribute.

DocumentIcon

The icon of the document. Optional. Defaults to the value of the Icon attribute.

The names of C1 standard icons you can use in your application are listed in ~\Composite\images\icons\StandardIcons.xml

WorkflowAction

This element defines a custom workflow to start. It has the following attributes:

  • WorkflowType
  • Label
  • ToolTip
  • Icon
  • PermissionTypes
  • Location

WorkflowType

The type of the workflow. Required.

Label

A label of the workflow action. Required.

ToolTip

A custom tooltip of the workflow action. Optional. Defaults to the value of the Label attribute.

Icon

The icon of the action. Optional.

PermissionTypes

A list of permissions on the workflow action. Optional.

The list can include one or more comma-separated values:

  • read
  • edit
  • add
  • delete
  • approve
  • publish
  • administrate

Defaults to "read".

Location

The location of the workflow action's button on the toolbar. Optional. Its possible values are one of the following:

  • Add
  • Edit
  • Delete
  • Other

Defaults to "Other".

f:function

This element defines a C1 function. It has the following attribute:

  • name

It can contain one or more f:param elements.

name

The name of the C1 function. Required.

f:param

This element defines a parameter of the C1 function. It has the following attributes:

  • name
  • value

It can contain one f:function element that embeds another C1 function.

name

The name of the C1 function's parameter. Required.

value

The value of the C1 function's parameter. Optional.