Loading...

CRM Image

Properties API

Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
imagelogo
The CRM Image is a form widget that allows you to upload an image to an entity in a form. It has the option of determining the max dimensions that the image will appear at on the page as well as a caption for the image that will display in the lightbox and when one hovers their cursor over the image. If an uploaded image has a higher resolution than the defined, maximum resolution, you will be able to click on the image to view it at full size. 

Please note that the maximum allowed filesize is five megabytes by default, the only allowed filetypes are .bmp, .tiff, .tif, .jpeg, .jpg, .gif, .png, and .ico, image transparency is not preserved, and that you may only one image per record. 

Configuration

Basic Setup

  1. From the Portal Connector widget list, click and drag the CRM Image widget into the body of the form.

  2. There are a few options that can be configured. Click on the edit button to display the properties prompt. It should look like this:

    CRM Image Properties

  3. When you are finished configuring the widget, click on the save button to save it.

Widget Properties

Basic Properties

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

Caption

The Caption text field will allow you to enter a short, descriptive text that will accompany an uploaded image.

Image Display Width - image

The Image Width numeric text field allows you to determine the width that an uploaded image will appear at on the page. If the image passes this threshold it will be adjusted accordingly. The minimum value is 32 pixels and maximum value of this property is 144 pixels.

Image Display Height - image

The Image Height numeric text field will allow you to determine the height that an uploaded image will appear at on the page. If this threshold is passed by the uploaded image it will be adjusted accordingly. The minimum value is 32 pixels and the maximum value is 144 pixels.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

Caption

The Caption text field will allow you to enter a short, descriptive text that will accompany an uploaded image.

Image Display Width - image

The Image Width numeric text field allows you to determine the width that an uploaded image will appear at on the page. If the image passes this threshold it will be adjusted accordingly. The minimum value is 32 pixels and maximum value of this property is 144 pixels.

Image Display Height - image

The Image Height numeric text field will allow you to determine the height that an uploaded image will appear at on the page. If this threshold is passed by the uploaded image it will be adjusted accordingly. The minimum value is 32 pixels and the maximum value is 144 pixels.

API

get_dataFieldName()

Returns developer name for the control.

Returns

String

get_txtFileTextbox()

Returns the text input element for the widget. 

Returns

HTML Element 

get_radUpload()

Returns the upload window object for the widget. 

Returns

RadAsyncUpload 

get_linkImage()

Returns the anchor element of the image preview. 

Returns

HTML Element

Full API With Examples

How to's

Examples of CRM Image Configuration