GetFieldDescription method

Overview

Retrieves the description of a field.

Parameters

Name	Description	Type
qFieldName	Name of the field This parameter is mandatory.	String

Name

Description

Type

qFieldName

Name of the field

This parameter is mandatory.

String

Outputs

The following is returned in the output:

Name	Description	Type
qReturn	Information about the field This parameter is mandatory.	FieldDescription

Name

Description

Type

qReturn

Information about the field

This parameter is mandatory.

FieldDescription

Name	Description	Type
qInternalNumber	Internal number of the field.	Integer
qName	Name of the field.	String
qSrcTables	List of table names.	Array of String
qIsSystem	If set to true, it means that the field is a system field. The default value is false.	Boolean
qIsHidden	If set to true, it means that the field is hidden. The default value is false.	Boolean
qIsSemantic	If set to true, it means that the field is a semantic. The default value is false.	Boolean
qDistinctOnly	If set to true, only distinct field values are shown. The default value is false.	Boolean
qCardinal	Number of distinct field values.	Integer
qTotalCount	Total number of field values.	Integer
qIsLocked	If set to true, it means that the field is locked. The default value is false.	Boolean
qAlwaysOneSelected	If set to true, it means that the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.	Boolean
qAndMode	If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.	Boolean
qIsNumeric	Is set to true if the value is a numeric. The default value is false.	Boolean
qComment	Field comment.	String
qTags	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII	Array of String
qIsDefinitionOnly	If set to true, it means that the field is a field on the fly. The default value is false.	Boolean

Learn more

Get the description of a field

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here