The Sub Document element is used as a placeholder for sub documents. It is a bindable element which means that when it is placed on a template, it can also be bound to binary data representing a sub document. Currently sub documents can be either MS Word documents (.docx) or HTML. The Sub Document element will simply be replaced with the content of the sub document it is bound to when the report enginine will process it.

This element has several properties that can be set in the Property Grid:

  • Name: Name of the element. You will only want to set the name when this is an unbound Sub Document element. The name of an element provides a means of referencing an element from code when setting the value manually for it programmatically.
  • Bound: If checked, this element is a bound element which means the value will be provided in code.
  • Value: This must be a valid binding. The value this element is bound to will replace the element at Report Generation Time (the concept of Binding is discussed here). This binding must always result in a value of type byte[] when binding to a .Net object or a Base64 string when binding to XML fragment. In all cases the resulting data must contain binary data representing a sub document.
  • DocumentFormat: Determines the format of the sub-document. Supperted formats are Word Document (.docx) and HTML.
SubDocument Element