Home > Class Reference > %SYS namespace > %Studio.Template.HTMLElement

%Studio.Template.HTMLElement

persistent class %Studio.Template.HTMLElement extends %Library.Persistent, %XML.Adaptor

SQL Table Name: %Studio_Template.HTMLElement

Represents an HTML attribute associated with a specific HTML element.
See the Template.HTMLTag class for more information. This class represents one of a list of HTML Tags. This list is used by the Studio CSP Tag Template to provide a list of HTML tags and their associated attributes (which as represented using the related Template.HTMLAttribute).
The data for this set of objects is provided within an XML file, htmltags.xml, that is provided in the dev/studio/templates directory.
To load this file:
Do ##class(%Studio.Template.HTMLElement).Import()

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

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

relationship Attrs as array of HTMLAttribute (XMLITEMNAME = "attr", XMLNAME = "attrs") [ InitialExpression = $listbuild("%Studio.Template.HTMLAttribute","Tag",+$this,"children",1,1) , Transient , Inverse = Tag , Cardinality = children ];
Attributes associated with this tag.
Property methods: AttrsGet(), AttrsGetObject(), AttrsGetObjectId(), AttrsGetSwizzled(), AttrsIsEmpty(), AttrsIsValid(), AttrsNewObject(), AttrsRClose(), AttrsRExec(), AttrsRFetch(), AttrsRelate(), AttrsSQLCompute(), AttrsSet(), AttrsUnRelate()
property Description as %String (MAXLEN = 4000, XMLNAME = "description", XMLPROJECTION = "element");
Description of this element.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property IsEmpty as %Boolean (XMLNAME = "empty", XMLPROJECTION = "attribute");
Is this an empty tag?
Property methods: IsEmptyDisplayToLogical(), IsEmptyGet(), IsEmptyGetStored(), IsEmptyIsValid(), IsEmptyLogicalToDisplay(), IsEmptyLogicalToXSD(), IsEmptyNormalize(), IsEmptySet(), IsEmptyXSDToLogical()
property ShortDescription as %String (MAXLEN = 255, XMLNAME = "edesc", XMLPROJECTION = "attribute");
Description of this element.
Property methods: ShortDescriptionDisplayToLogical(), ShortDescriptionGet(), ShortDescriptionGetStored(), ShortDescriptionIsValid(), ShortDescriptionLogicalToDisplay(), ShortDescriptionLogicalToOdbc(), ShortDescriptionNormalize(), ShortDescriptionSet()
property Tag as %String (MAXLEN = 256, XMLNAME = "ename", XMLPROJECTION = "attribute") [ Required ];
Represents an HTML attribute associated with a specific HTML element.
See the Template.HTMLTag class for more information. Represents an HTML attribute associated with a specific HTML element.
See the Template.HTMLTag class for more information. Name of an HTML tag
Property methods: TagDisplayToLogical(), TagGet(), TagGetStored(), TagIsValid(), TagLogicalToDisplay(), TagLogicalToOdbc(), TagNormalize(), TagSet()

Methods (Including Private)

classmethod GetAttrs(tag As %String, ByRef attrs, ByRef cats) as %Boolean [ Language = objectscript ]
Get list of attributes used by tag.
Returns true if the element is defined.
classmethod Import(filename As %String = "") [ Language = objectscript ]
Load an HTML tags definition file into the HTMLTag extent

Indexes

index (IdIdx on Tag) [IdKey, Type = key, Unique];
Index methods: IdIdxCheck(), IdIdxDelete(), IdIdxExists(), IdIdxOpen(), IdIdxSQLCheckUnique(), IdIdxSQLExists(), IdIdxSQLFindPKeyByConstraint(), IdIdxSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: Storage (%Studio.Template.HTMLElement)

^%qHTMLElementD(ID)
=
%%CLASSNAME
Description
IsEmpty

Storage Model: Storage (%Studio.Template.HTMLElement)

^%qHTMLElementD(ID,"1")
=
ShortDescription