Home > Class Reference > %SYS namespace > %DeepSee.UserLibrary.WorksheetAxis
Private  

%DeepSee.UserLibrary.WorksheetAxis

serial class %DeepSee.UserLibrary.WorksheetAxis extends %SerialObject, %XML.Adaptor

This class defines a row or column header within a DeepSee Worksheet.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 12

Summary

Properties
format height logicalValue lookupSpec name
priority readOnly style type value
valueList width
Methods
%AddToSaveSet %AddToSyncSet %ClassIsLatestVersion %ClassName
%ConstructClone %Delete %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Extends %GetParameter
%GetSwizzleObject %IsA %IsModified %IsNull
%New %NormalizeObject %ObjectIsNull %ObjectModified
%OnBeforeAddToSync %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %RemoveFromSaveSet %ResolveConcurrencyConflict
%SerializeObject %SetModified %SyncObjectIn %SyncTransport
%ValidateObject LogicalToOdbc OdbcToLogical XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType

Parameters

parameter NAMESPACE = "http://www.intersystems.com/deepsee/library";
NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLIGNORENULL = 1;
XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
parameter XMLNAME = "header";
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 format as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional format to apply to this element.
property height as %ZEN.Datatype.length(XMLPROJECTION="attribute");
Optional height to apply to this element.
property logicalValue as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional logical value to apply to this element.
property lookupSpec as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Optional lookupSpec to apply to this element.
Takes the form:
table:*table name*:*value column*:*display column*:*sort column*
property name as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Logical name of this element.
property priority as %ZEN.Datatype.integer(MAXVAL=2,MINVAL=0,XMLPROJECTION="attribute");
Optional priority to apply to this element.
property readOnly as %ZEN.Datatype.boolean(XMLPROJECTION="attribute");
Optional readOnly attribute to apply to this element.
property style as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional style to apply to this element.
property type as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional type to apply to this element.
property value as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional value to apply to this element.
property valueList as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional valueList to apply to this element.
property width as %ZEN.Datatype.length(XMLPROJECTION="attribute");
Optional width to apply to this element.