Home > Class Reference > ENSLIB namespace > %ZEN.Component.html

%ZEN.Component.html

class %ZEN.Component.html extends %ZEN.Component.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');

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SYSMODULE = core;
Inherited description: 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 (Including Private)

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 methods: OnDrawContentDisplayToLogical(), OnDrawContentGet(), OnDrawContentIsValid(), OnDrawContentLogicalToDisplay(), OnDrawContentLogicalToOdbc(), OnDrawContentNormalize(), OnDrawContentSet()
property content as %ZEN.Datatype.html (CONTENT = "MIXED", ESCAPE = "HTML", XMLPROJECTION = "content", ZENEXPRESSION = 1);
HTML content to display. This may contain simple expressions.
Property methods: contentDisplayToLogical(), contentGet(), contentIsValid(), contentLogicalToDisplay(), contentLogicalToOdbc(), contentNormalize(), contentSet()
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.
Property methods: seedDisplayToLogical(), seedGet(), seedIsValid(), seedLogicalToDisplay(), seedLogicalToOdbc(), seedNormalize(), seedSet()

Methods (Including Private)

method %DrawContent() as %Status
Invoke user method to provide contents for this HTML component.
method %DrawHTML()
Inherited description: 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.
clientmethod getContent(content) [ Language = javascript ]
Convenient method for getting the content of this component. This is equivalent to calling getProperty('content').
clientmethod setContent(content) [ Language = javascript ]
Convenient method for setting the content of this component. This is equivalent to calling setProperty('content',content).
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)