Defines a group within a ZEN Report. More...

Inheritance diagram for group:

[legend]

Collaboration diagram for group:

[legend]

Public Attributes
	OnCreateResultSet
	Name of callback method to call to create a <class>ResultSet</class> object. More...

	breakOnExpression
	Optional ObjectScript expression that can either be applied. More...

	breakOnField
	Name of field (column) in the base query for this report that. More...

	call
	call that will supply XML More...

	callArgument
	If non-null will provide an argument passed to call. More...

	callClass
	class for call that will supply XML, can be blank in which case current class used More...

	children
	Set of nodes contained within this group. More...

	excelSheetName
	name of worksheet when group represents an Excel worksheet More...

	fields
	Name of fields (columns) in the base query for this report that will. More...

	filter
	When a query is present and expression filter is 0, row is skipped. More...

	ifexpression
	More...

	name
	XML element name used for this group. More...

	orderby
	comma separated list of fields by which the group will be sorted More...

	parameters
	User-defined list of query parameters. More...

	queryClass
	(optional) Name of the class containing the class query that will More...

	queryName
	(optional) Name of the class query that will More...

	removeEmpty
	Remove empty XML elments. More...

	runonce
	Execute elements with report or group once, causes sql, query and resultset to be ignored. More...

	runtimeMode
	(optional) Runtime mode applied to the <class>ResultSet</class> More...

	sql
	(optional) SQL statement that, if present, will be used to More...

	sqlexpression
	(optional) SQL statement in expression form that, if present, will be used to More...

	suppressExcelHeaders
	True if ExcelHeaders are to be suppressed on group or report. More...

	top
	When a query is present this induces effect of "SELECT TOP ..top Query". More...

Private Member Functions
_.Library.Boolean	hasBreakDefined ()
	Test if this group has a break defined.

_.Library.Boolean	hasQueryDefined ()
	Test if this group has a query defined.

Static Private Member Functions
	QuoteValue (_.Library.String pValue)
	Take a value string and return a quoted string.

	QuoteValueL10N (_.Library.String pValue, _.Library.String pDomain)
	Take a value string and return a quoted string wrapped within a. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Attributes inherited from reportNode
	NAMESPACE = None
	Base class for elements within a ZEN XML Report definition. More...

	XMLFORMAT = None
	If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names in Zen Report XML documents.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

Defines a group within a ZEN Report.

Member Function Documentation

◆ QuoteValueL10N()

QuoteValueL10N	(	_.Library.String	pValue,
		_.Library.String	pDomain
	)

staticprivate

Take a value string and return a quoted string wrapped within a.

$$$Text macro.
If value starts and ends with #( )#, then return an expression

Member Data Documentation

◆ OnCreateResultSet

OnCreateResultSet

Name of callback method to call to create a <class>ResultSet</class> object.

This must be the name of an instance method within the report class.
An example callback would look something like this:

ClassMethod RS1(ByRef pSC As Status, ByRef pParms) As ResultSet { Set pSC = $$$OK Set tRS = ##class(ResultSet.SQL).Prepare("SELECT Name FROM Sample.Person WHERE Home_City = ? ORDER BY Name",.tError,"",pParms(1)) If ($IsObject(tError)) { Set pSC = tError.Status } Quit tRS }

◆ breakOnExpression

breakOnExpression

Optional ObjectScript expression that can either be applied.

to the grouping value of this group (as val), or to provide an arbitrary value.

◆ breakOnField

breakOnField

Name of field (column) in the base query for this report that.

supply the value for collecting members of this group.

◆ call

call

call that will supply XML

◆ callArgument

callArgument

If non-null will provide an argument passed to call.

◆ callClass

callClass

class for call that will supply XML, can be blank in which case current class used

if set to 0, call is called as instance method

◆ children

children

Set of nodes contained within this group.

◆ excelSheetName

excelSheetName

name of worksheet when group represents an Excel worksheet

◆ fields

fields

Name of fields (columns) in the base query for this report that will.

supply the values for this item.

◆ filter

filter

When a query is present and expression filter is 0, row is skipped.

◆ ifexpression

ifexpression

◆ name

name

XML element name used for this group.

If not provided a default will be supplied.

◆ orderby

orderby

comma separated list of fields by which the group will be sorted

◆ parameters

parameters

User-defined list of query parameters.

These are used to supply

parameter values for the query associated with this group.

◆ queryClass

queryClass

(optional) Name of the class containing the class query that will

be used to create a <class>ResultSet</class> object.
This property is only used if <property>queryName<property> is defined. If this property is not defined, then it is assumed that the current report class contains the specified query.

◆ queryName

queryName

(optional) Name of the class query that will

be used to create a <class>ResultSet</class> object.

◆ removeEmpty

removeEmpty

Remove empty XML elments.

If not provided a default of -1 (inherit from parent) will be supplied.

◆ runonce

runonce

Execute elements with report or group once, causes sql, query and resultset to be ignored.

◆ runtimeMode

runtimeMode

(optional) Runtime mode applied to the <class>ResultSet</class>

object used to fetch results for this report.

◆ sql

sql

(optional) SQL statement that, if present, will be used to

create a <class>ResultSet</class> object.
If defined, this takes precedence over <property>queryClass</property> and <property>queryName</property> and <property>sqlexpression</property>.

◆ sqlexpression

sqlexpression

(optional) SQL statement in expression form that, if present, will be used to

create a <class>ResultSet</class> object.

◆ suppressExcelHeaders

suppressExcelHeaders

True if ExcelHeaders are to be suppressed on group or report.

◆ top

top

When a query is present this induces effect of "SELECT TOP ..top Query".

Public Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members