Home > Class Reference > ENSLIB namespace > %ZEN.Mojo.Plugin.baseHelperDocumentation
Private  Storage   

%ZEN.Mojo.Plugin.baseHelperDocumentation


abstract class %ZEN.Mojo.Plugin.baseHelperDocumentation extends
%ZEN.Component.object

Superclass for all classes that provide documentation for subclasses of baseHelperPlugin. The classname needs to be the same as the classname of the helper plugin with "Documentation" as postfix. If the helper plugin classname is "chuiHelper", the documentation classname needs to be "chuiHelperDocumentation".

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1


Summary


Properties
%condition %import %includeFiles %page %resource
aux composite id index name
onupdate parent tuple visible window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawHTML %DrawJSStrings %Eval
%EvalC %Extends %ForceClientRender %GetEventHandlers
%GetParameter %GetXMLName %IsA %IsModified
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnDrawObjectProperties %OnObjectSynch
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType findElement fireOnUpdateEvent
getDocumentation getProperty getSettings getType
invokeSuper isOfType makeId onCreate
onDelete onSerialize onloadHandler onunloadHandler
onupdateHandler render renderContents renderSVG
setProperty

Subclasses
%ZEN.Mojo.Plugin.HTML5HelperDocumentation %ZEN.Mojo.Plugin.bootstrap33xHelperDocumentation %ZEN.Mojo.Plugin.charts101HelperDocumentation
%ZEN.Mojo.Plugin.chui352HelperDocumentation %ZEN.Mojo.Plugin.chuiHelperDocumentation %ZEN.Mojo.Plugin.dojo1912DChartHelperDocumentation
%ZEN.Mojo.Plugin.dojo191DijitHelperDocumentation %ZEN.Mojo.Plugin.dojo2DChartHelperDocumentation %ZEN.Mojo.Plugin.dojoDijitHelperDocumentation
%ZEN.Mojo.Plugin.dojoGridX130HelperDocumentation %ZEN.Mojo.Plugin.dojoGridXHelperDocumentation %ZEN.Mojo.Plugin.googleMaps3HelperDocumentation
%ZEN.Mojo.Plugin.googleMapsHelperDocumentation %ZEN.Mojo.Plugin.highCharts401HelperDocumentation %ZEN.Mojo.Plugin.highCharts404HelperDocumentation
%ZEN.Mojo.Plugin.jQM132HelperDocumentation %ZEN.Mojo.Plugin.jQM143HelperDocumentation %ZEN.Mojo.Plugin.jQM145HelperDocumentation
%ZEN.Mojo.Plugin.jQMHelperDocumentation %ZEN.Mojo.Plugin.mojoDefaultHelperDocumentation

Parameters


• parameter NAMESPACE = "http://www.intersystems.com/zen/mojo";
This is the XML namespace used for library components.

Methods


• method getDocumentation(identifier) [ Language = javascript ]
returns an object containing information about the requested identifier (e.g. $loop). The object contains an array holding an object for each supported attribute and a documentation EXAMPLE: { description: 'Description of the identifier e.g. $loop', attributes: [ {name:'value',type:'string',description:'Holds the value of the html element'} ] } Valid types are: string,number,boolean,date,object,array and function