ZML tag and its attributes | ManageEngine AppCreator Help

<image>

The <image> tag defines an image.

Parent tag : <pc>

Child tag : --

Attributes

imageType The imageType attribute specifies the type of image to be added.

Possible Values

icon
computer
weburl

Default Values

weburl

value The value attribute specifies the path or name of the image or icon.

Possible Values

The value attribute depends on the imageType.

imageType	value	Example
icon	Specify the icon name using the following syntax: icon-class* <space> icon-name	<image imageType='icon' value='zc-li-solid shopping-tag'>
computer	Specify the name of the image as stored in the image library.	<image imageType='computer' value='product1.jpeg'>
weburl	Specify the image url.	<image imageType='weburl' value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png'>

imageType

value

Example

icon

Specify the icon name using the following syntax:

icon-class* <space> icon-name

computer

Specify the name of the image as stored in the image library.

weburl

Specify the image url.

Note:

*icon-class refers to solid or outline icons.
Use one of the prebuilt icon-class : zc-li-solid or zc-li-outline
Supported image formats: .jpeg, .jpg, .png. Maximum size of upto 2 MB is permissible.

iconsizeThe iconsize attribute specifies the size of the icon.

Possible Values

A number from 1-9.

Default Value

Example

Syntax	<image imageType='icon' value='zc-li-solid weather-fahrenheit' iconsize='4'>
Output

Note:

iconsize attribute is applicable only when imageType='icon'

cornerRadiusThe cornerRadius attribute defines rounded corners for an image or icon.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='icon' value='zc-li-outline travel-world' cornerRadius='5'>
Output

Note:

cornerRadius attribute is optional.

colorThe color attribute specifies a color for the icon.

Possible Values

A hexadecimal color value. Refer this link for hexadecimal color codes.

Example

Syntax	<image imageType='icon' value='zc-li-solid sport-tennis-ball' color='#B3EB31' >
Output

Note:

color attribute is optional.
It is applicable only for <imageType='icon'>

bgColorThe bgColor attribute specifies a background color for the <image> element.

Possible Values

A hexadecimal color value. Refer this link for hexadecimal color codes.

Note:

bgColor attribute is optional.

widthThe width attribute defines a width for the <image>.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='scenary.jpg' width='500px'/>
Output

Note:

width attribute is optional.

height The height attribute defines a height for the <image>.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='eiffel-tower.jpg' height='400px'/>
Output

Note:

height attribute is optional.

padding The padding attribute generates a specified amount of space between the image and it's border.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' padding='10px'/>
Output

Note:

padding attribute is optional.

paddingTop The paddingTop attribute generates a specified amount of space between the image and the top side of it's border.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' paddingTop='10px'/>
Output

Note:

paddingTop attribute is optional.

paddingRight The paddingRight attribute generates a specified amount of space between theimage and the right side of it's border.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' paddingRight='10px'/>
Output

Note:

paddingRight attribute is optional.

paddingBottom The paddingBottom attribute generates a specified amount of space between the image and the bottom side of it's border.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' paddingBottom='10px'/>
Output

Note:

paddingBottom attribute is optional

paddingLeft The paddingLeft attribute generates a specified amount of space between the image and the left side of it's border.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' paddingLeft='10px'/>
Output

Note:

paddingLeft attribute is optional

margin The margin attribute generates a specified amount of space between all foure sides of the image and it's parent container.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' margin='20px'/>
Output

Note:

margin attribute is optional

marginTop The marginTop attribute generates a specified amount of space between the top side of the image and it's parent container.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' marginTop='20px'/>
Output

Note:

marginTop attribute is optional

marginRight The marginRight attribute generates a specified amount of space between the right side of the image and it's parent container.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' marginRight='400px'/>
Output

Note:

marginRight attribute is optional

marginBottom The marginBottom attribute generates a specified amount of space between the bottom side of the image and it's parent container.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' marginBottom='20px'/>
Output

Note:

marginBottom attribute is optional

marginLeft The marginLeft attribute generates a specified amount of space between the left side of the image and it's parent container.

Possible Values

A numeric value in pixels

Example

Syntax	<image imageType='computer' value='Custom-apps.jpg' marginLeft='400px'/>
Output

Note:

marginLeft attribute is optional

action The action attribute specifies the action to be triggered on click of the image..

Possible Values

Link
Form
Report
Page
Function

Example

action	Syntax
Link	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Link' url='A URL to be opened '/>*
Form	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Form' componentLinkName='linkname of the ManageEngine AppCreator form to be opened' appLinkName='linkname of the ManageEngine AppCreator application to which the form belongs' />*
Report	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Report' componentLinkName='linkname of the ManageEngine AppCreator report to be opened' appLinkName='linkname of the ManageEngine AppCreator application to which the report belongs' />*
Page	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Page' componentLinkName='linkname of the ManageEngine AppCreator page to be opened' appLinkName='linkname of the ManageEngine AppCreator application to which the page belongs' />*
Function	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Function' functionName='Name of the custom function to be triggered' />*

* Learn in detail about each of the action types in the following sections.

Note:

action attribute is optional.
The action attribute acts as a source attribute. i.e: One or more of the following attributes viz: url, componentLinkName, appLinkName, functionName, parameters, successMessage, target, popupWidth and popupHeight will be applicable only when an action is specified.

url The url attribute specifies the resource location to be opened on click of the image.

Possible Values

A url pointing to another website
A url pointing to a component within your ManageEngine AppCreator Account

Example

<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Link' url='https://www.zoho.com/creator/'>

Note:

url attribute is optional.
It is applicable only when <action='Link'>

componentLinkName The componentLinkName attribute specifies the link name of the ManageEngine AppCreator component to be opened on click of the image.

Possible Values

Linkname of the ManageEngine AppCreator Application component to be opened.

Example

action	Syntax
Form	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Form' componentLinkName='User_Details'/>
Report	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Report' componentLinkName='User_Details_Report'/
Page	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Page' componentLinkName='User_Dashboard'/>

Note:

componentLinkName attribute is optional.
It is applicable only when <action='Form'/'Report'/'Page'>

appLinkName The appLinkName attribute specifies the name of the ManageEngine AppCreator application to which the associated component belongs.

Possible Values

Linkname of the ManageEngine AppCreator Application to be opened.

Example

action	Syntax
Form	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Form' componentLinkName='User_Details' appLinkName='Resource_management'/>
Report	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Report' componentLinkName='User_Details_Report' appLinkName='Resource_management'/>
Page	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Page' componentLinkName='User_Dashboard' appLinkName='Resource_management'/>

Note:

appLinkName attribute is optional. You do not need to specify appLinkName if the component you are associating to the action, belongs to the same application you are currently in.
It is applicable only when <action='Form'/'Report'/'Page'/'Function'>

functionName The functionName attribute specifies the name of the custom function in the ManageEngine AppCreator application to be triggered on click of the image.

Possible Values

A custom function defined in any of your ManageEngine AppCreator Applications. To get the list of custom functions in your application: Go to Settings -> Extensions -> Custom Functions

Example

<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Function' functionName='send_email'/>

Note:

The functionName can belong to a default namespace or a custom namespace.
If the function belongs to a custom namespace : <functionName='namespace_name.function_name'>
functionName attribute is optional.
It is applicable only when <action='Function'> and a function name must be specified.

parameters The parameters attribute specifies parameter to be associated to an action.

Possible Values

When <action='Form' / 'Report' / 'Page'>, parameters refers to the query string that will be appended to the corresponding component's permalink.
When <action='Function'>, parameters refers to an argument of the selected custom function.

Example

action	Syntax
Form	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Form' componentLinkName='User_Details' appLinkName='Resource_management' parameters='App_name=${name}'/> OR <image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Form' componentLinkName='User_Details' appLinkName='Resource_management' parameters='App_name=Zoho Creator'/>
Report	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Report' componentLinkName='User_Details' appLinkName='Resource_management' parameters='App_name=${name}' /> or <image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Form' componentLinkName='User_Details' appLinkName='Resource_management' parameters='User_Name='Rob'/>
Page	<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Page' componentLinkName='linkname of the ManageEngine AppCreator page to be opened' appLinkName='linkname of the ManageEngine AppCreator application to which the page belongs' parameters='App_name=${name}' />*

action

Syntax

Form

Report

Page

<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Page' componentLinkName='linkname of the ManageEngine AppCreator page to be opened' appLinkName='linkname of the ManageEngine AppCreator application to which the page belongs' parameters='App_name=${name}' />*

Note:

parameter attribute is optional.
It is applicable only when <action='Form'/'Report'/'Page'/'Function'>
parameters can either be a static value like: Name='Rob' or a page parameter.
Page parameter must be specified as : App_name=${name}, where name is the page parameter.

successMessage The successMessage attribute specifies the message to be displayed on successful execution of the specified function.

Possible Values

A string

Example

<image value='https://www.zoho.com/sites/default/files/creator5-logo-2x.png' action='Function' functionName='send_email' successMessage='Sent Successfully!'/>

Note:

successMessage attribute is optional.
It is applicable only when <action='Function'>

target The target attribute specifies the location where the linked action will open on click of the image.

Possible Values

new-window
same-window
popup

Default Value

new-window

Note:

It is applicable only when <action='Link'/'Form'/'Report'/'Page'>

popupWidth The popupWidth attribute specifies a width for the pop-up window where the link will be opened.

Possible Values

A numeric value in percentage or pixels

popupHeight The popupHeight attribute specifies a height for the pop-up window where the link will be opened.

Possible Values

A numeric value in percentage or pixels

Still can't find what you're looking for?

Write to us: appcreator-support@manageengine.com