Element.getFieldMappings (Method)

Returns one or more structures, each containing information about mapping of the custom element's field to the render handler.

Returns:

Element_GetFieldMappings_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
description PlainText String indicating the description for the source field name.
destinationFieldName PlainText String indicating the destination mapping field name.
destinationFieldType MappingFieldType_EmptyString String indicating the destination mapping field type.
isRequired Boolean Boolean value indicating if the field is required or not.
sourceFieldName PlainText_NonNull String indicating the source mapping field name.

Arguments:

Name Type Required Description
elementID ElementTypeID Required An element's ID.
moduleID RenderHandlerID Required ID of the render handler module.

Context:

License Requirements None
Permission Requirements (none)
Deny Context None
Require Context None
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

Code Error Message
15013 The element you specified does not support render handlers.
15026 The specified layout is not valid for the specified element.
15036 The specified layout does not support field mappings.

Notes:

None