Function Class_HMOTenants
Gets a object of data about current HMO Tenants for a Property
Class_HMOTenants([ALIASFROM])Parameters
| # | Type | Passing | Default | Name | Description/Comments |
|---|---|---|---|---|---|
| 1 | string | optional | Blank | ALIASFROM | The PROPERTY alias to get the data from |
Examples
{{Local m.poTenants}}
{{m.poTenants = Class_HMOTenants("PROPERTY")}}
Will get the data and store it in a variable for later use as m.poTenants
{{o.set("poTenants",Class_HMOTenants("PROPERTY"))}}
Will get the data and store it in the o variable as poTenants for later use as m.o.poTenants
Example use
{{o.set("poTenants",Class_HMOTenants("PROPERTY"))}}
<table width="100%" border="0" cellpadding="0" cellspacing="0">
{{IF m.o.poTenants.numberoftenants>0}}
<tr height="30"><td width="110"><b>The Tenant:</b></td><td><b>[[m.o.poTenants.tenants[1].clcodedesc]]</b></td></tr>
<tr height="30"><td width="60" align="center">of</td><td><b>[[m.o.poTenants.tenants[1].address]]</b></td></tr>
{{ENDIF}}
{{IF m.o.poTenants.numberoftenants>1}}
<tr height="30"><td width="110"><b>The Tenant:</b></td><td><b>[[m.o.poTenants.tenants[2].clcodedesc]]</b></td></tr>
<tr height="30"><td width="60" align="center">of</td><td><b>[[m.o.poTenants.tenants[2].address]]</b></td></tr>
{{ENDIF}}
{{IF m.o.poTenants.numberoftenants>2}}
<tr height="30"><td width="110"><b>The Tenant:</b></td><td><b>[[m.o.poTenants.tenants[3].clcodedesc]]</b></td></tr>
<tr height="30"><td width="60" align="center">of</td><td><b>[[m.o.poTenants.tenants[3].address]]</b></td></tr>
{{ENDIF}}
{{IF m.o.poTenants.numberoftenants>3}}
<tr height="30"><td width="110"><b>The Tenant:</b></td><td><b>[[m.o.poTenants.tenants[4].clcodedesc]]</b></td></tr>
<tr height="30"><td width="60" align="center">of</td><td><b>[[m.o.poTenants.tenants[4].address]]</b></td></tr>
{{ENDIF}}
</table>
Method Calls Available
| Name | Returns | Passing | Default | Description/Comments |
|---|---|---|---|---|
| GetEmailAddressList | string | Separator Character | | | Returns a list of unique email addresses from Tenants |
| GetExpressionList | string | Separator Character
Expression String - fields referenced must be prefixed CLIENT. | None | Returns the unique evaluated expression for each Tenant.
Each item except the last with be seperated by the seperator |
| GetExpressionListAll | string | Separator Character
Expression String - fields referenced must be prefixed CLIENT. | None | Returns the evaluated expression for each Tenant.
Each item except the last with be seperated by the seperator |
Examples
m.o.poTenants.GetEmailAddressList(";")
m.o.poTenants.GetExpressionList(", ","alltrim(CLIENT.FNAME)+' '+alltrim(CLIENT.SNAME)")
