Field Property Setup – Basic Features used within Infigo Designer

In our Infigo Designer plugin, we have two main types of field: Text and Image. These fields subsequently have field properties which allows you to control certain aspects of your fields. However, some of these properties were once used by the system and now no longer have any effect on the fields. 

You can see these properties by clicking on the Properties section of any field's Field Settings, as seen in the screenshot below.

Field_Properties.jpg

Please see below a table listing all of the field properties present on a text field, and a brief description of each of them.

Field Property

Description

AllowAlignmentChange

This enables the Alignment Panel to display on the editor, which displays below the text field when your users select it.

What this will then do is allow your users to change the alignment of the text within the field. 

AllowAllFonts

This enables a dropdown of fonts available by default, allowing the user to change the font of the text they enter. These fonts are a standard set which are installed on the server and cannot be changed.

If you would like to use custom fonts then you will need to add them as alternate fonts.

Please note that Infigo does not take credit for any of the fonts used in your products.

AllowAnyColour

This allows a list of pre-set colours to appear in a grid below the field when the user selects it. This will allow the users to change the font colour of the text within the field to any of the colours displayed.

AllowFontSizeChange

This enables the font size slider to appear on the editor once the user selects the field. This will allow the user to change the font size of the text they enter - limits must be set using the MinFont and MaxFont properties (explained below), else this feature will not work.

BranchMapping

This is a legacy setting to do with a feature which we no longer support. This can be ignored.

CharacterCountdown

This allows you to restrict the number of Characters the user can enter into the field. It will display a live countdown of the number of Characters remaining underneath it once the user has selected the field and started making their changes.

To enable this feature, you will need to set this property to a value larger than 0. This value will become the field's limit.

FieldType

This setting allows you to chose how your field will be displayed in the editor. For Example, by default it is text field, but you could also display a text list (dropdown).

The complete list of types is:

Integer - A whole number

Double - A number with a decimal place

Boolean - True or false (a checkbox)

Text - Text

TextList - Dropdown

ForceServerSidePreview

This is a legacy setting to do with a feature which we no longer support. This can be ignored.

GroupName

You are able to group fields in Infigo designer for various purposes - this property allows you to designate which group the field belongs to.

HelpText

This is a legacy setting to do with a feature which we no longer support. This can be ignored.

LineLimit

This allows you to expand the number of lines the customer can type on. By default it is set to Unlimited (Which means they can keep typing as much as they wish, however the UI only displays 1 line for text input).

For example, if you increase the value from unlimited -> 5, the UI will display a deeper text input box, with room for 5 lines to be typed. It also means you can use carriage returns on the templates.

MaxFont

This allows you to specify the maximum font size used on the font size slider (See AllowFontSizeChange).

MinFont

This allows you to specify the minimum font size used on the font size slider (See AllowFontSizeChange).

NewName

This is a legacy setting to do with a feature which we no longer support. This can be ignored.

PlaceholderText

This property can accept any text as a value, and this text will appear as slightly greyed out 'ghost' text in the input field in the editor. This can be used to provide preview text to give the user an example of what they need to enter, without having to delete what is already present.

PrepopulateDataFrom

This property allows you to prepopulate a field with the data stored in the customer data of the user who has opened the editor (customer name, phone number, address line etc.).

The value to be prepopulated from is selected via a dropdown. Please note that not all values in the dropdown are still supported.

A rule of thumb is that if you cannot see the field when editing the customer's details through Catfish Admin, it's no longer supported.

ReadOnly

If you wish for a field to be seen in the editor, but not populated, then enable this setting.

For example, you may wish to show a non-editable product in the editor to use its zoom functionality as a preview. Simply draw a text or image field out, tick this property and save. Now, the editor will load but the customer cannot edit this field.

Please note that this does not prevent any scripts contained within your PDF from editing the value of this field.

Required

Tick this if it is required for the field to require changes made to it. How strictly this is enforced can be controlled with the RequiredType property.

The system will check if this field has been populated by checking to see if there has been a change made to it at all since the editor session was loaded.

This will take effect when the user attempts to add the product to the basket.

RequiredType

This property is a dropdown that allows you to control whether the required field is strictly enforced, or whether it simply reminds the user that they have not edited it.

Both of these options will utilise a popup which tells the user which fields have not been populated.

RequiredBranchMerge

This is a legacy setting to do with a feature which we no longer support. This can be ignored.

TabID

This is a legacy setting to do with a feature which we no longer support. This can be ignored.

TextListValues

This is the field in which you can populate the values of your dropdown list (Using the FieldType Property, above, when selected a Text List).

Clicking on the ... for this property will open a menu which allows you to edit the values for the dropdown.

UIDescription

This is the ‘label’ which is displayed next to a field in the editor. If you do not populate this field, it will simply use the field name as the label.     

UsePreviewAsDefault

This is a legacy setting which is no longer required. This can be ignored.

UseServerSidePreview

This is a legacy setting to do with a feature which we no longer support. This can be ignored.

ValidationType

This allows you to automatically validate the data entered into the field, forcing the user to enter something which adheres to the requirements of the selected choice.

The options are:

 - UK Postcode

 - UserID

 - Numeric

 - Email

If a user attempts to enter something which does not fit the validation into this field, then they will not be able to add the product to the basket.

 

Image fields share some of these properties, however they do not share all of them and in fact have some unique to them, as seen in the screenshot below.

image_properties.jpg

Please see below a table listing and explaining each of the properties unique to image fields.

 Field Property Description
EmbeddedFileList

If you populate this property's list with the exact filenames of embedded image files, you can restrict which embedded images can be used in this field if the field is set to use embedded images (this is controlled using the ImageUsage property below).

Please be aware that the items of this list must perfectly match the filenames of the embedded images you would like to be used in this field. For example, if you embedded image.jpg and you wanted users to be able to use this image in this field, you will need to add an item to this property list called image.jpg

If this property is empty, then this feature will be ignored and the user will have access to all embedded images (once again depending on the value of ImageUsage)

ImageUsage

This property controls the user's interaction with the image field when in the editor. The options are:

Display embedded images as gallery - This will display all of the images embedded in the PDF as a gallery for the user to choose from.

Display embedded images as gallery with the option for upload - This will display all of the images embedded in the PDF as a gallery for the user to choose from, however it will also allow users to upload and use their own images.

Upload Images Only - This will allow users to upload images to their personal user albums and use the images which have been uploaded.

Not Required - This will act similarly to the 'Read Only' property for image fields and prevent user interaction. However, the user will still be able to select the field in the editor and it will grey the rest of the document out, allowing the user to see the image more clearly.

SharedGalleryName 

This property is used to define the name of the shared gallery/album which this image field has access to. This will allow you to control which images the user can use for this field.

For more information on this feature, please see this article. 

ShowImageLibrary 

This property is used to control whether or not an image field can access the available shared albums (which the user must also have access to). 

This setting is enabled by default.

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk