DocBook|Search
Class Reference
%ZEN.Component.html
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%ZEN] >  [Component] >  [html]
Private  Storage  

class %ZEN.Component.html extends component

HTML component.
This component lets you inject HTML content within a ZEN page.
Note that the content of this component is HTML and cannot include ZEN components.
The original content of this component can contain server-side property expressions. These are placed within #( )#. On the client, you can change the contents of the component by setting its "content" property:

html.setProperty('content','Some new content');

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 5


Summary

Properties
%condition %import %includeFiles %page
%resource OnDrawContent align aux
composite containerStyle content dragEnabled
dropEnabled enclosingClass enclosingStyle error
height hidden hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelStyle name
onafterdrag onbeforedrag ondrag ondrop
onhide onrefresh onshow onupdate
parent seed showLabel slice
title tuple valign visible
width window

Methods
%%OIDGet %AddToSaveSet %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawComponentHTML %DrawContent
%DrawHTML %DrawJSStrings %EnclosingDivId %Eval
%Extends %ForceClientRender %GetEventHandlers %GetParameter
%GetXMLName %IsA %IsModified %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent getContent
getEnclosingDiv getHidden getHintElement getLabelElement
getProperty getSettings getType invokeSuper
isOfType makeId onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onloadHandler onunloadHandler
onupdateHandler refreshContents render renderContents
renderSVG setContent setHidden setOverlayMode
setProperty startProgressBar stopProgressBar


Parameters

• parameter SYSMODULE = "core";
If set, this indicates that this system component should be placed in the given "module". A module is a grouping of components within the same class package that share common include (js or css) files. Note that certain root classes are implicitly placed within the "core" module.
Classes outside of the Zen library should not set this, they should use the MODULE instead.

Properties

• property OnDrawContent as %ZEN.Datatype.delegator(FORMALSPEC="seed:%ZEN.Datatype.string",RETURNTYPE="%Status");
Optional. Name of Server-side callback method that provides HTML content for this component.
If defined, this callback is invoked on the server when this component is drawn. It provides HTML content by using &html or by using the WRITE command.
This must be the name of a server-only method in the page class that contains this view component.
• property content as %ZEN.Datatype.html(CONTENT="MIXED",ESCAPE="HTML",XMLPROJECTION="content",ZENEXPRESSION=1);
HTML content to display. This may contain simple expressions.
• property seed as %ZEN.Datatype.string(ZENEXPRESSION=1);
Optional. User-defined seed value. This is an optional parameter that is passed on to the OnDrawContent callback method.

Methods

• method %DrawContent() as %Status
Invoke user method to provide contents for this HTML component.
• method %DrawHTML()
Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
• method getContent(content) [ Language = javascript ]
Convenient method for getting the content of this component. This is equivalent to calling getProperty('content').
• method setContent(content) [ Language = javascript ]
Convenient method for setting the content of this component. This is equivalent to calling setProperty('content',content).
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.