Force.com SOQL and SOSL Reference

Introduction to SOQL and SOSL
Salesforce Object Query Language (SOQL)
Salesforce Object Search Language (SOSL)
Typographical Conventions in This Document
SOSL Limits
SOSL Limits on External Objects
SOSL Syntax
Example Text Searches
convertCurrency()
FIND {SearchQuery}
FORMAT()
IN SearchGroup
LIMIT n
OFFSET n
ORDER BY Clause
RETURNING FieldSpec
toLabel(fields)
Update an Article’s Keyword Tracking with SOSL
Update an Article’s Viewstat with SOSL
WHERE conditionExpression
WITH DATA CATEGORY DataCategorySpec
WITH DivisionFilter
WITH HIGHLIGHT
WITH METADATA
WITH NETWORK NetworkIdSpec
WITH PricebookId
WITH SNIPPET
PDF

Newer Version Available

This content describes an older version of this product. View Latest

toLabel(fields)

Use toLabel(fields) to translate SOSL query results into the user’s language.

A client application can have results from a query returned that are translated into the user’s language, using toLabel():

For example:

This query returns lead records with the record type name translated into the language for the user who issued the query.

You cannot filter on the translated name value from a record type. Always filter on the master value or the ID of the object for record types.

Note

You can use toLabel() to filter records using a translated picklist value. For example:

Lead records are returned where the picklist value for Status is 'le Draft.' The comparison is made against the value for the user’s language. If no translation is available for the user’s language for the specified picklist, the comparison is made against the master values.

The toLabel() method cannot be used with the ORDER BY Clause. Salesforce always uses the order defined in the picklist, just like reports.

Note

The toLabel function supports aliasing. In addition, aliasing is required when the query includes the same field multiple times. For example: