Specifies whether to use display names for columns instead of their API names when listing metadata and querying data.

Data Type

bool

Default Value

false

Remarks

By default, the component surfaces column names using the Salesforce API names, which are static and developer-focused. When UseDisplayNames is set to true, the component uses the display names for columns, matching what users see in the Salesforce UI. This can make working with queries and metadata more intuitive for users who are familiar with the Salesforce interface rather than the underlying API terminology.

Use this property if you are building reports or queries intended for end users or business users who expect to see field names as they appear in the Salesforce UI.

Enabling UseDisplayNames may slightly increase metadata processing time due to the additional handling required to map API names to display names. However, it does not increase the number of metadata API calls. Because display names can be modified by Salesforce administrators, using them may reduce query stability over time. For long-term integrations, API names are recommended due to their consistency.

This property is useful for improving readability and user-friendliness when building UI-based reports or business-facing queries.