COLUMNCAPTION Function

  • Article

Returns the current caption of a query column as a text string.

Caption := Query.COLUMNCAPTION(Column)

Parameters

  • Query
    Type: query A variable that specifies the query object that contains the column.
  • Column
    Type: Text Refers to the name of the query column. The name of a query column is specified by the Name Property of the column in Query Designer.

Property Value/Return Value

Type: Text

The current value of CaptionML Property for the query column.

Remarks

The CaptionML property is multi-language enabled, so it can contain a list of text strings in different languages. The string that is used is selected according to the user's language settings. For more information, see Multilanguage Development.

Example

The following example shows how to get the caption for a column of a query. The query is called My Customer Query and has a column with the name Customer_No.

This example requires that you create the following variables.

Variable name DataType Subtype

Caption

Text

Not applicable

MyQuery

Query

My Customer Query

 
Caption := MyQuery.COLUMNCAPTION("Customer_No");
MESSAGE(Caption);

See Also

Tasks

How to: Create Queries