2.284 CustomReportItem

The CustomReportItem element defines a report item that is not natively detailed in RDL and that requires additional code to render.

Information that is in addition to information that is specified by using the DataSet in the CustomData element of the CustomReportItem in RDL 2005/01, or information that is in addition to information that is specified by using the CustomData.DataSetName element of the CustomReportItem in RDL 2008/01, RDL 2010/01, or RDL 2016/01, can be specified by using CustomProperty elements that are either children of the CustomReportItem element or children of the DataMember elements that are descendants of the CustomReportItem.

In RDL 2005/01, RDL 2008/01, RDL 2010/01, and RDL 2016/01, a custom report item MUST NOT appear in the page header or page footer of a Page.

Renderers that do not support the specific custom report item render one of the following:

A report item that is specified as a child of the CustomReportItem.AltReportItem element is available as a referenced report item for RDL file validation purposes. The CustomReportItem.Name attribute MUST NOT be the same as the Name attribute of a report item that is specified as a child of an AltReportItem element.

The following are the parent elements of the CustomReportItem element.

Parent elements

ReportItems

The following are additional parent elements of the CustomReportItem element in RDL 2008/01, RDL 2010/01, and RDL 2016/01.

Parent elements

CellContents

The following are the attributes of the CustomReportItem element in RDL 2008/01, RDL 2010/01, and RDL 2016/01.

Attributes

CustomReportItem.Name

The following are the child elements of the CustomReportItem element.

Child elements

CustomReportItem.Type

The following are additional child elements of the CustomReportItem element in RDL 2003/10.

Child elements

CustomReportItem.ReportItems

The following are additional child elements of the CustomReportItem element in RDL 2005/01.

Child elements

CustomReportItem.Label

The following are additional child elements of the CustomReportItem element in RDL 2008/01, RDL 2010/01, and RDL 2016/01.

Child elements

CustomReportItem.ActionInfo

CustomReportItem.AltReportItem

CustomReportItem.Bookmark

CustomReportItem.CustomData

CustomReportItem.CustomProperties

CustomReportItem.DataElementName

CustomReportItem.DataElementOutput

CustomReportItem.DocumentMapLabel

CustomReportItem.Height

CustomReportItem.Left

CustomReportItem.RepeatWith

CustomReportItem.Style

CustomReportItem.ToolTip

CustomReportItem.Top

CustomReportItem.Type

CustomReportItem.Visibility

CustomReportItem.Width

CustomReportItem.ZIndex

The following is the XML Schema definition of the CustomReportItem element in RDL 2003/10.

 <xsd:complexType name="CustomReportItemType">
   <xsd:all>
     <xsd:element name="Style" type="StyleType" minOccurs="0" />
     <xsd:element name="Top" type="SizeType" minOccurs="0" />
     <xsd:element name="Left" type="SizeType" minOccurs="0" />
     <xsd:element name="Height" type="SizeType" minOccurs="0" />
     <xsd:element name="Width" type="SizeType" minOccurs="0" />
     <xsd:element name="ZIndex" type="xsd:unsignedInt" minOccurs="0" />
     <xsd:element name="Visibility" type="VisibilityType" minOccurs="0" />
     <xsd:element name="RepeatWith" type="xsd:string" minOccurs="0" />
     <xsd:element name="ReportItems" type="ReportItemsType" minOccurs="0" />
     <xsd:element name="DataElementName" type="xsd:string" minOccurs="0"/>
     <xsd:element name="DataElementOutput" minOccurs="0">
       <xsd:simpleType>
         <xsd:restriction base="xsd:string">
           <xsd:enumeration value="Output"/>
           <xsd:enumeration value="NoOutput"/>
           <xsd:enumeration value="ContentsOnly"/>
           <xsd:enumeration value="Auto"/>
         </xsd:restriction>
       </xsd:simpleType>
     </xsd:element>
   </xsd:all>
   <xsd:attribute name="Name" type="xsd:normalizedString" use="required" />
   <xsd:attribute name="Type" type="xsd:normalizedString" use="required" />
 </xsd:complexType>

The following is the XML Schema definition of the CustomReportItem element in RDL 2005/01.

 <xsd:complexType name="CustomReportItemType" >
   <xsd:choice minOccurs="0" maxOccurs="unbounded">
     <xsd:element name="Type" type="xsd:string" />
     <xsd:element name="Style" type="StyleType" minOccurs="0" />
     <xsd:element name="Top" type="SizeType" minOccurs="0" />
     <xsd:element name="Left" type="SizeType" minOccurs="0" />
     <xsd:element name="Height" type="SizeType" minOccurs="0" />
     <xsd:element name="Width" type="SizeType" minOccurs="0" />
     <xsd:element name="ZIndex" type="xsd:unsignedInt" minOccurs="0" />
     <xsd:element name="Visibility" type="VisibilityType" minOccurs="0" />
     <xsd:element name="Label" type="xsd:string" minOccurs="0" />
     <xsd:element name="Bookmark" type="xsd:string" minOccurs="0" />
     <xsd:element name="RepeatWith" type="xsd:string" minOccurs="0" />
     <xsd:element name="CustomProperties" type="CustomPropertiesType" 
                  minOccurs="0"/>
     <xsd:element name="AltReportItem" type="ReportItemsType" minOccurs="0" />
     <xsd:element name="CustomData" type="CustomDataType" minOccurs="0" />
     <xsd:element name="DataElementName" type="xsd:string" minOccurs="0"/>
     <xsd:element name="DataElementOutput" minOccurs="0">
       <xsd:simpleType>
         <xsd:restriction base="xsd:string">
           <xsd:enumeration value="Output"/>
           <xsd:enumeration value="NoOutput"/>
           <xsd:enumeration value="ContentsOnly"/>
           <xsd:enumeration value="Auto"/>
         </xsd:restriction>
       </xsd:simpleType>
     </xsd:element>
     <xsd:any namespace="##other" processContents="skip"/>
   </xsd:choice>
   <xsd:attribute name="Name" type="xsd:normalizedString" use="required" />
   <xsd:anyAttribute namespace="##other" processContents="skip" />
 </xsd:complexType>

The following is the XML Schema definition of the CustomReportItem element in RDL 2008/01.

 <xsd:complexType name="CustomReportItemType">
   <xsd:choice minOccurs="0" maxOccurs="unbounded">
     <xsd:element name="Type" type="xsd:string" />
     <xsd:element name="Style" type="StyleType" minOccurs="0" />
     <xsd:element name="ActionInfo" type="ActionInfoType" minOccurs="0" />
     <xsd:element name="Top" type="SizeType" minOccurs="0" />
     <xsd:element name="Left" type="SizeType" minOccurs="0" />
     <xsd:element name="Height" type="SizeType" minOccurs="0" />
     <xsd:element name="Width" type="SizeType" minOccurs="0" />
     <xsd:element name="ZIndex" type="xsd:unsignedInt" minOccurs="0" />
     <xsd:element name="Visibility" type="VisibilityType" minOccurs="0" />
     <xsd:element name="ToolTip" type="StringLocIDType" minOccurs="0" />
     <xsd:element name="DocumentMapLabel" type="StringLocIDType" minOccurs="0" />
     <xsd:element name="Bookmark" type="xsd:string" minOccurs="0" />
     <xsd:element name="RepeatWith" type="xsd:string" minOccurs="0" />
     <xsd:element name="CustomProperties" type="CustomPropertiesType" 
                  minOccurs="0" />
     <xsd:element name="AltReportItem" type="ReportItemsType" minOccurs="0" />
     <xsd:element name="CustomData" type="CustomDataType" minOccurs="0" />
     <xsd:element name="DataElementName" type="xsd:string" minOccurs="0" />
     <xsd:element name="DataElementOutput" minOccurs="0">
       <xsd:simpleType>
         <xsd:restriction base="xsd:string">
           <xsd:enumeration value="Output" />
           <xsd:enumeration value="NoOutput" />
           <xsd:enumeration value="ContentsOnly" />
           <xsd:enumeration value="Auto" />
         </xsd:restriction>
       </xsd:simpleType>
     </xsd:element>
     <xsd:any namespace="##other" processContents="skip" />
   </xsd:choice>
   <xsd:attribute name="Name" type="xsd:normalizedString" use="required" />
   <xsd:anyAttribute namespace="##other" processContents="skip" />
 </xsd:complexType>

The following is the XML Schema definition of the CustomReportItem element in RDL 2010/01 and RDL 2016/01.

 <xsd:complexType name="CustomReportItemType">
   <xsd:choice minOccurs="0" maxOccurs="unbounded">
     <xsd:element name="Type" type="xsd:string" />
     <xsd:element name="Style" type="StyleType" minOccurs="0" />
     <xsd:element name="ActionInfo" type="ActionInfoType" minOccurs="0" />
     <xsd:element name="Top" type="SizeType" minOccurs="0" />
     <xsd:element name="Left" type="SizeType" minOccurs="0" />
     <xsd:element name="Height" type="SizeType" minOccurs="0" />
     <xsd:element name="Width" type="SizeType" minOccurs="0" />
     <xsd:element name="ZIndex" type="xsd:unsignedInt" minOccurs="0" />
     <xsd:element name="Visibility" type="VisibilityType" minOccurs="0" />
     <xsd:element name="ToolTip" type="StringLocIDType" minOccurs="0" />
     <xsd:element name="DocumentMapLabel" type="StringLocIDType" minOccurs="0" />
     <xsd:element name="Bookmark" type="xsd:string" minOccurs="0" />
     <xsd:element name="RepeatWith" type="xsd:string" minOccurs="0" />
     <xsd:element name="CustomProperties" type="CustomPropertiesType" 
                  minOccurs="0" />
     <xsd:element name="AltReportItem" type="ReportItemsType" minOccurs="0" />
     <xsd:element name="CustomData" type="CustomDataType" minOccurs="0" />
     <xsd:element name="DataElementName" type="xsd:string" minOccurs="0" />
     <xsd:element name="DataElementOutput" minOccurs="0">
       <xsd:simpleType>
         <xsd:restriction base="xsd:string">
           <xsd:enumeration value="Output" />
           <xsd:enumeration value="NoOutput" />
           <xsd:enumeration value="ContentsOnly" />
           <xsd:enumeration value="Auto" />
         </xsd:restriction>
       </xsd:simpleType>
     </xsd:element>
     <xsd:any namespace="##other" processContents="lax" />
   </xsd:choice>
   <xsd:attribute name="Name" type="xsd:normalizedString" use="required" />
   <xsd:anyAttribute namespace="##other" processContents="lax" />
 </xsd:complexType>