FieldProperties Properties

The key to use as a page short/accelerator for this field.

The aggregate function to use when calculating mapper (datasheet) aggregate row values. If not specified, Sum is used. See AggregateType

The column name to use during select. A field may have any number of fields aliased to it.

Options for Bootstrap popup modal dialogs. See BootModalOptions

The button display type.

Attributes specific to button type fields. See CellButtonAttrs

Confirmation message to present to user before taking action.

Detail navigation should be to this pane in the specified LinkMOP.

Semi-colon delimited string of values that cause the field to treat the underlying value as False.

For Icon-style buttons, the path to the icon to use.

The description for the LinkFilterExpr, overriding the standard description. May include field references.

Filter expression to use when LinkBehaviorAttributes.UseLinkFilter is set

The RowKey to the related item.

The Page to which to link.

An expression that resolves to a link for a button.

Javascript placed on the button's onclick event. By default no postback is performed. Set the Postback CellTypeAttribute if a postback is also desired. Note that the script will be resolved for field expressions and embedded functions if, and only if, wrapped in a !fnResolve().

When Popup CellAttribute is set, this specifies how the target page is to be popped up. See PagePopupType

A CSS class to be added to the popup container.

Status text used in pop-up status messages.

Semi-colon delimited string of values that cause the field to treat the underlying value as True.

Options controlling the format of new browser windows. See WindowOpenOptions

Javascript expression that represents the value for this field. (May include field references.)

The field's caption. This value is used as the display text for the label of the field.

Attributes specific to CheckBox fields. See CellCheckBoxAttrs

Semi-colon delimited string of values that cause the checkbox to treat the underlying value as False (NOT checked)

The CSS classes to use with the imageChecked jQuery plugin. The plugin will be used if a value is provided. The checked and unchecked image class names should be separated by a pipe ("|") character. Typically each class should specify a background-image, width, and height.

Text to display when field value is true or false, separated by a pipe ("|") character.

Semi-colon delimited string of values that cause the checkbox to treat the underlying value as True (checked)

Attributes specific to Email Chooser fields. See CellChooserAttrs

Override the default selected item delimiter (";").

Javascript placed on the Chooser's OnClientDeselect event. Supports field references including the [~.] notation to get a reference to the current field.

Javascript placed on the Chooser's OnClientSelect event. Supports field references including the [~.] notation to get a reference to the current field.

Options for affecting code generation for this field. See FieldCodeGenOptions

The actual column name in the underlying table.

Attributes specific to ComboBox fields. See CellComboBoxAttrs

Detail navigation should be to this pane in the specified LinkMOP.

The RowKey to the related item.

The Page to which to link.

An expression that resolves to the URL for the linkable label associated with this ComboBox. Ignored if LinkMOP is specified.

Text to display in field when field value is not set (may use HTML placeholder attribute).

The name of the control in the UserControl that should be bound to this field. By default, the field's KeyName is used.

The CssClass to use.

Attributes specific to Currency fields. See CellCurrencyAttrs

The Windows locale ID (LCID) or culture name (e.g. 2057 and en-GB respectively) for the currency, The value can be specified directly or using a field reference.

Text to display in field when field value is not set (may use HTML placeholder attribute).

Attributes specific to DatePicker fields. See CellDatePickerAttrs

Text to display in field when field value is not set (may use HTML placeholder attribute).

Attributes specific to DateTimePicker fields. See CellDateTimePickerAttrs

The interval, in minutes, between selectable minute values.

The default value for the field.

Specifies how mapper deletions should treat the table for which this field is the PK. Default indicates that the mapper should decide. Normally this property is managed in the Tables subform under Mappers. See FieldDeleteBehavior

The field's description. This value is typically not used in the web application.

The value or field reference to use as the Picklist discriminator.

If true, email addresses can be delimited with a comma (,) or semi-colon (;)

The literal text or field expression ([field name]) to use as the Bcc.

The literal text or field expression ([field name]) (or combination) to use as the Body.

The literal text or field expression ([field name]) (or combination) to use as the Carbon Copy.

Attributes specific to Email Address fields. See CellEmailAddrAttrs

The field to use as the from address when sending an email.

The field to use as the display name when sending an email.

The literal text or field expression ([field name]) (or combination) to use as the Subject.

The literal text or field expression ([field name]) (or combination) to use as the To. Note that names should be delimited with semi-colons.

Text to display in field when field value is not set (may use HTML placeholder attribute).

The fully-qualified enum type to use as the value type for this field in its TypedMapper.

Miscellaneous options affecting the behaviour of the field. See FieldBehaviorOptions

Attributes specifying how this field should be handled during export processing (e.g. to Excel). See FieldExportAttrs

Attributes specifying how mapper grouping should be performed on a specific field. See FieldGroupingAttrs

Attributes specifying how this field should be handled during import processing. See FieldImportAttrs

Field-level security options. See FieldSecurityAttrs

Attributes specifying how the corresponding table should be handled. Typically applies to PK fields only. See FieldTableAttrs

Attributes specific to FilePath fields See CellFilePathAttrs

Determines whether a thumbnail should be created for an image. The default is to always create a thumbnail.

Expression to use as the document type optionally including field references.

Don't resize images that are smaller than the given size in kB. Default is 120kB.

Specifies the types of files that the server accepts (that can be submitted through a file upload). Used to set the HTML input ACCEPT attribute on the field's FILE input.

The binary field in the mapper that stores the file.

Expression to use as the document description optionally including field references.

The name of the field specifying the mime type of the content. If not specified, defaults to application/octet-stream.

The name of the field specifying the file name.

The mechanism by which the user provides the upload file. See FileUploadSources

The virtual folder to use to store files.

The binary field in the mapper that stores the resized image.

The format of the output image. The default format is jpg. See ImageFileFormat

The path where converted images are to be located after conversion.

The quality of the converted image. The default quality for images is Medium. See ImageFileQuality

The size of the output image. Small:640, Medium: 800, Large: 1024, Very Large: 1280. The default size is Large. See ImageFileSize

The maximum upload file size, in KBytes.

If a missing file image is desired, the 1-based index into the document service's MissingFileImages list.

The document storage service to use. Requires that the UseDocService attribute be set.

The binary field in the mapper that stores the thumbnail image.

The format of the thumbnail image. The default format is jpg. See ImageFileFormat

The relative path to the output path where thumbnails are created. The default subfolder is called Thumb.

The quality of the generated thumbnail. The default quality for images is High. See ImageFileQuality

The size of the output image. Small:50, Medium: 100, Large: 200, Very Large: 300. The default size is Large. See ImageFileSize

The text or picture to display when no picture value has been set.

Attributes specific to FileUploader fields. See CellFileUploaderAttrs

Specifies the types of files that the server accepts (that can be submitted through a file upload). Used to set the HTML input ACCEPT attribute on the field's FILE input.

The sibling field in the mapper containing the file content. Depending on storage type this could be a document ID, binary data, or a file path. May be omitted if content is stored in this field.

The mechanism(s) provided for the user to upload the file. See FileUploadSources

The maximum upload file size, in KBytes.

If a missing file image is desired, the 1-based index into the document service's MissingFileImages list.

Status text used in pop-up status message during file upload.

The document storage service to use.

Text to display in field when field value is not set (may use HTML placeholder attribute).

Options specifying field filtering availability and behaviour. See FieldFilterOptions

The custom FilterWidget component to use for this field.

A semi-colon separated list of fields in the search mapper against which to search when AutoSuggest is used.

Attributes specific to Find cells. See CellFindAttrs

The caption to use in the Find/MultiFind widget.

A semi-colon separated list of fields=value pairs specifying default search criteria. The values may include field references and/or embedded functions.

The default sort criteria to use when the find results are displayed

A tag string of field in the format <destination field>=[source field];<destination field>=[source field]. If the destination and source are the same, you may omit the source field.

Filter to apply to the find.

The flavor to apply to both the find criteria and find results. See Flavors

Specifies how Full-Text Search should be handled in Find and MultiFind. Overrides the corresponding UI feature setting. See FindFullTextSearch

The RowKey to the related item. For link navigation only, may be overridden with LinkKey.

The Page to use for the find. For link navigation only, may be overridden with LinkMOP.

A semi-colon separated list of fields, normally searchable in the search mapper, that should not be searchable in Find the UI. Note that each field can include and =<text> qualifier for display purposes.

A semi-colon delimited list of fields that exist on the same page as the find control. The value of these fields on the same page instance will be passed to the find dialog and potentially used for filtering. References to these instance values can be placed on FindFilter criteria using {} braces as the reference indicator. The Find will require that all such values are non-null/non-empty except those marked as optional with angle brackets (e.g. <first_name>). Standard reference syntax applies.

The fixed height and width (in the form "height;width") to use for the datasheet area of an inplace Find widget.

The RowKey to the related item. Overrides FindKey which is otherwise used.

The Page to which to link. Overrides FindMOP which is otherwise used.

By default, the multi-find puts a transaction around the insert of items. Set this value to false to skip this step.

Set this delimiter to use when RepeatedSelect is enabled and selections should append to existing value.

Text to display in field when field value is not set (may use HTML placeholder attribute).

The .Net data format for the field.

Specifies the name of the group to which this field belongs. If the name corresponds to the key of a GroupBox field in this mapper then the fields will be rendered within that GroupBox.

Attributes specific to GroupBoxes. See CellGroupBoxAttrs

The text to use when the field is used for record grouping in a list. At this time field references are *not* supported.

Specifies how rows are to be grouped when grouping in the datasheet.

The image to use as the header picture.

The flavor(s) for which this field should be hidden. See Flavors

Attributes specific to html type fields. See CellHtmlAttrs

The height of the control expressed in HTML units.

The CSS file to use for the HTML editor.

Specifies the HTMLEditor edit modes to be made available to the user when the field is writeable.

The initial height of the control.

Controls the new line behavior in the HtmlEditor at the field level.

The skin to use on the Html editor.

The XML file specifying which tools should be provided on the HTML editor's toolbar(s).

The initial width of the control.

Attributes specific to Icon fields. See CellIconAttrs

Detail navigation should be to this pane in the specified LinkMOP.

The url for the default image (relative to the root). This image will be overridden by any row-specific image.

The RowKey to the related item.

The Page to which to link.

Deprecated. Use IgnoreRowLock FieldBehaviorOptions enumeration. Ignore any mapper-level RowLock (has no effect on field-level RowLock).

URL for additional information about this field.

The .Net data format for the field's key as used in a picklist. Applies only when a picklist is specified.

Label specific attributes. See CellLabelAttrs

The HTML text to show as the label content for the field. Overrides Caption specifically for use on a field label in a detail form.

The CSS class to use for the field's label.

Options controlling the presention of a field's label. See LabelOptions

Attributes specific to Link cells. See CellLinkAttrs

Detail navigation should be to this pane in the specified LinkMOP.

The RowKey to the related item.

The Page to which to link.

An expression that resolves to the URL for the link.

Javascript placed on the link's onclick event. Note that the script will be resolved for field expressions and embedded functions if, and only if, wrapped in a !fnResolve().

The frame/window target in which to display the link.

Options specifying field link behaviour. See LinkBehaviorAttributes

Attributes specific to ListBox fields See CellListBoxAttrs

The number of rows to display in a list box. This can be a non-integer value, e.g. 1.5.

The display text to show as a column header in the datasheet.

The CssClass to use when the field is in the list. This is appended to the CssClass value.

Options affecting behaviour of field in list views. See FieldListOptions

The flavor(s) for which this field should be locked (additive to other reasons for locking). See Flavors

Attributes specific to MapperSummary fields. See CellMapperSummaryAttrs

Optional container element for the summary. For example, use "ul" to wrap the summary content in an HTML UL element.

The semi-colon separated list of mapper field keys of fields to show in the summary. All fields are included if list is empty.

The semi-colon separated list of mapper field keys in the order in which they should be presented in the summary. Other visible fields will follow.

The filter to use on the summary's mapper. The filter may contain references to other instance fields on other pages within the wizard.

The flavor to use on the element's mapper. The Summary flavor will always be ORed in. See Flavors

Options controlling the look and feel of the summary. See HTMLSummaryFlags

The mapper to use for this summary.

The template to use for layout.

Maximum allowed value for the field. (May include field references)

The maxiumn number of characters to accept into the field.

If a MaxLength is specified, the field's value should be truncated to that length automatically.

Minimum allowed value for the field. (May include field references)

Attributes specific to CellType MultiSelect. See CellMultiSelectAttrs

Override the default MultiSelect delimiter (";").

Text to display in field when field value is not set (may use HTML placeholder attribute).

Javascript placed on the control's onchange event. Note that the script will be resolved for field expressions and embedded functions if, and oly if, wrapped in a !fnResolve().

Javascript registered in the page's StartupScript. Supports field references including the [~.] notation to get a reference to the current field.

The name of the field in the parent used when filling default values for fields marked with the DefaultFromParent attribute.

Attributes specific to Password fields. See CellPasswordAttrs

Attributes specific to Picture fields. See CellPictureAttrs

The type of image stored in the database.

The url for the default image (relative to the root). This image will be overridden by any row-specific image.

Number of bytes to ignore when extracting an image stored in the database.

Status text used in pop-up status messages.

The picture to display when no picture value has been set.

An HTML template to be expanded and registered on the page. Typically the template includes script references for 3rd party javascript plug-ins as well as javascript for applying or configuring the plug-in.

Options controlling the positioning of the field in the UI. See FieldPositionOptions

The name to use for the property element in the generated TypedMapper. Normally used where field Key is a .Net reserved word.

Attributes specific to Radio Buttons. See CellRadioButtonsAttrs

Attributes specific to RatingIcon cells. See CellRatingIconAttrs

The relative path to the rating icon image file to use in the "on" state.

The name to use for the property element in the generated RemoteMapper.

Attributes specific to SecureText type fields. See CellSecureTextAttrs

Confirmation message to present to user before retrieving and displaying the secure text.

The Css Class or classes to use when showing decrypted data in-place.

The time, in seconds, that a decrypted value should be visible. Zero indicates no timeout.

The encryption key, may include a field reference, e.g. "[crypt_key]".

A formatting mask where 'a' represents an alphabetic character, '9' represents a digit, and '*' represented an alpha-numeric character. For SecureText fields the ShowInPlace cell attribute must be set.

Text to display in field when field value is not set (may use HTML placeholder attribute).

A SQL expression to use in the mapper's SELECT clause. The results will be aliased to the normal field SELECT name using AS.

Attributes affecting how this field's ShadowColumn is to be used. See ShadowAttrs

Another field, typically a ShadowColumn CellType, that should be used as a shadow for improved filtering.

The algorithm to use when transforming a shadowed field's data into a form more amenable for filtering. See ShadowAlgorithm

Attributes specific to Signature fields. See CellSignatureAttrs

Expression to use as the document type optionally including field references.

Expression to use as the document description optionally including field references.

The height of the control, in pixels. If omitted, height will be calculated as a fraction of the width.

The format of the signature image. The default format is jpg. See ImageFileFormat

The color to use for the signature pen. Color values are RRGGBB format hexadecimal numbers (e.g. "ff0000" for red).

The document storage service to use to store the signature image.

The width of the control, in pixels. This is required for precise sizing since the HTML5 CANVAS element can be sized only in pixels. If omitted, pixel width will be calculated as consistently as possible with other controls.

Deprecated. Use SortInitDesc FieldBehaviorOptions enumeration. Specifies whether the field should sort descending (vs. ascending) upon initial user-initiated sorting of the field.

Another field in the mapper from which to copy the value. The source value is copied on insert and update unless the destination field is dirty. Typically used on a foreign key to identify the corresponding join value.

The HTML style expression to include on the element.

The RowKey for the HoverSummary related item.

The Page to use for HoverSummary information.

The underlying table for this field. Enter '+' for an unlocked field, no storage. Enter '-' for a locked field, no storage.

HTML tag attributes to be added literally to the tag -- use with care.

Attributes specific to TextBox fields. See CellTextBoxAttrs

Detail navigation should be to this pane in the specified LinkMOP.

The encryption key, may include a field reference, e.g. "[crypt_key]". Applied only if the Encrypted cell attribute is set.

Override type for the TYPE attribute of HTML5 INPUT tags. This provides for enhanced features on supporting browsers degrading to basic textbox support on older browsers. Note that by default this is applied only to mobile/tablet devices and you must set the FieldBehaviourAttribute.ForceInputTagType bit for other devices. See InputTagTypes

The RowKey to the related item.

The Page to which to link.

An expression that resolves to the URL for the linkable label associated with this TextBox. Ignored if LinkMOP is specified.

A formatting mask where 'a' represents an alphabetic character, '9' represents a digit, and '*' represented an alpha-numeric character.

The number of rows to display in a multi-line text box. This can be a non-integer value, e.g. 1.5.

Text to display in field when field value is not set (may use HTML placeholder attribute).

Attributes specific to TextWithWidget fields. See CellTextWithWidgetAttrs

The enumeration type to use as the source for the popup dialog for TextWithWidget fields.

The url for the icon button image (relative to the root).

Javascript placed on the widget button's onclick event. Note that the script will always be resolved for field expressions and embedded functions.

Text to display in field when field value is not set (may use HTML placeholder attribute).

Path to the widget content HTML (relative to root).

Attributes specific to TimeDuration fields. See CellTimeDurationAttrs

The interval, in minutes, between selectable minute values.

Attributes specific to TimePicker fields See CellTimePickerAttrs

The date field in this mapper associated with this time field.

The interval between minute selections presented in the TimePicker minute selector.

Text to display in field when field value is not set (may use HTML placeholder attribute).

The timezone format. Leave blank to store as written, use 0,. to store GMT, display local.

The field's tooltip.

Options specifying how the field's tooltip is to be presented. See ToolTipOptions

Attributes specific to Tree fields. See CellTreeAttrs

The CSS class to use as the style for rendering a tree node when the mouse pointer is positioned over it, default is TreeHover.

The CSS class to use as the style for rendering leaf nodes, default is TreeLeaf.

The CSS class to use as the default style for rendering tree nodes, default is TreeNode.

The CSS class to use as the style for rendering parent nodes, default is TreeParent.

The CSS class to use as the style for rendering the root node, default is TreeRoot.

The CSS class to use as the style for rendering selected nodes, default is TreeSelected.

The group of images to use for the TreeView control. See TreeViewImageSet in the .Net documentation.

The amount of vertical spacing between adjacent nodes in the tree, default is 1px.

The amount of space to the left and right of the text in the node, default is 5px.

The amount of space above and below the text for a node, default is 2px.

Attributes specific to Url fields. See CellUrlAttrs

An expression that resolves to the URL.

Link text to use in LinkOnly mode. This overrides the caption and may include field references.

The root path to prepend (if not present) to the link.

The frame/window target in which to display the link.

Text to display in field when field value is not set (may use HTML placeholder attribute).

Options controlling the format of new browser windows. See WindowOpenOptions

A regular expression used to validate the field value. The field will be considered valid if the expression matches.

Specifies a data-specific field validation rule to apply. See FieldValidationRule

A custom javascript validation function for the field of the form func(fld, val, full, caption) returning an error message string if validation failed else a null or blank string.

The text to display in the case of a field value validation failure.

Attributes specific to fields as they are generated in RemoteMappers for the purposes of a WebService. See WebServiceFieldAttrs

Attributes specific to WebSite fields. See CellWebSiteAttrs

The frame/window target in which to display the link.

The literal text or field expression ([field name]) (or combination) to use as the URL. The default is to use the contents of the field.

Text to display in field when field value is not set (may use HTML placeholder attribute).