API:Data.DB.TAggregateField.DisplayName

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property DisplayName: string read FDisplayName write FDisplayName;

C++

__property System::UnicodeString DisplayName = {read=FDisplayName, write=FDisplayName};

Properties

Type Visibility Source Unit Parent
property published
Data.DB.pas
Data.DB.hpp
Data.DB TAggregateField

Description

Represents the name of the field for display purposes.

Data.DB.TAggregateField.DisplayName inherits from Data.DB.TField.DisplayName. All content below this line refers to Data.DB.TField.DisplayName.

Represents the name of the field for display purposes.

Use DisplayName when displaying a string that represents the field to the user. For example, when raising an exception concerning the field, format an error string that includes the DisplayName to refer to the field. DisplayName is a read-only property. To change the value of DisplayName, use the DisplayLabel property.

If DisplayLabel is defined, DisplayName is the same as DisplayLabel. Otherwise, DisplayName is the same as the FieldName property.

See Also

Code Examples