GetNxProperties method

Overview

Gets the properties of a variable.

This method is deprecated (not recommended to use). Use GetProperties method instead.

None

The following is returned in the output:

Name	Description	Type
qProperties	Information about the properties of the variable.	NxVariableProperties

Name	Description	Type
qName	Name of the variable.	String
qNumberPresentation	Defines the format of the value of a variable.	FieldAttributes
qIncludeInBookmark	Set this property to true to update the variable when applying a bookmark. The value of a variable can affect the state of the selections. The default value is false.	Boolean
qUsePredefListedValues	The value of a variable can be an enumeration. Set this property to true to reflect the predefined values in an enumeration.	Boolean
qPreDefinedList	List of enumerations. This property is used if qUsePredefListedValues is set to true.	Array of String

Name	Description	Type
qType	Type of the field. Default is U.	One of: • U for UNKNOWN type. • A for ASCII; Numeric fields values contain only standard ASCII characters. • I for INTEGER; Numeric fields values are shown as integer numbers. • R for REAL; Numeric fields values are shown as real numbers. • F for FIX; Numeric fields values are shown as numbers with a fix number of decimals. • M for MONEY; Numeric fields values are shown as in the money format. • D for DATE; Numeric fields values are shown as dates. • T for TIME; Numeric fields values are shown as times. • TS TIMESTAMP; Numeric fields values are shown as time stamps. • IV for INTERVAL; Numeric fields values are shown as intervals.
qnDec	Number of decimals. Default is 10.	Integer between 0 and 15.
qUseThou	Defines whether or not a thousands separator must be used. Default is 0.	One of: 0 for false 1 for true
qFmt	Defines the format pattern that applies to qText. Is used in connection to the type of the field (parameter qType). For more information, see Struct FieldAttributes. Example: YYYY-MM-DD for a date	String
qDec	Defines the decimal separator. Example: .	String
qThou	Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,	String

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!