Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Report.Model.Item
Private  Storage   

%DeepSee.Report.Model.Item


class %DeepSee.Report.Model.Item extends
%DeepSee.Report.Model.Stylable

This class is used by the DeepSee Report Generator.
It represents an item used in the Report Display, most commonly associated with tables.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8


Summary


Properties
caption class elements field htmlstyle
name special style tagBegin tagEnd
value visible xslfostyle

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType

Subclasses
%DeepSee.Report.Model.Caption %DeepSee.Report.Model.Summary

Parameters


• parameter XMLNAME = "item";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties


• property caption as %String(XMLPROJECTION="attribute");
caption used in table
• property elements as list of Element(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE");
Set of captions, summaries within this item
• property field as %String(MAXLEN=255,XMLPROJECTION="attribute");
Name of the field supplying data for this item.
• property special as %String(XMLPROJECTION="attribute");

If the special attribute is specified, the renders a pre-definied piece of dynamic data. Possible values are currently:

  • number : gives the record number within the group.
  • page-number : inserts the page number within a PDF report. Is rendered as '##' in HTML.
  • page-count : inserts the number of pages within a PDF report. It is rendered as '##' in HTML.
  • page-number-of : inserts the page number in the form '2 of 18'. It is rendered as '## of ##' in HTML.
  • page-number-/ : inserts the page number in the form '2/18'. It is rendered as '##/##' in HTML.
• property tagBegin as %String [ InitialExpression = "<item" ];
• property tagEnd as %String [ InitialExpression = "</item>" ];
• property value as %String(XMLPROJECTION="attribute");
literal for display
• property visible as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];
if visible="false" then not included in display but included in Report Definition generated XML