Operation Functions

This document introduces functions used in Update Column operations, including Math, Text Processing Functions, and DateTime Processing Functions.

Notes:

Parameter is the target of function operation, which refers to the value of specified field (operation field) participating in building operation expressions during Update Column operations.
otherParameter, otherParameter1, otherParameter2 represent required parameters in functions, to be specified by users through the two text boxes next to the operation function combo box in Update Column dialog.
When target update field is not DataTime type and operation field is DataTime type, supported functions include: DaysInMonth, Second, Minute, Hour, Day, Month, Year, DayOfYear, DayOfWeek.
When target update field is DataTime type and operation field is also DataTime type, supported functions include: AddDays, AddHours, AddMilliseconds, AddMinutes, AddMonths, AddSeconds, AddYears, Date, Now.

Math

Operation Function	Description
Abs Abs (Parameter)	Calculates the absolute value of the parameter, returns positive number or 0.
Sqrt Sqrt (Parameter)	Calculates square root of the parameter, returns numeric value (double precision).
Ln Ln (Parameter)	Calculates natural logarithm of the parameter, returns numeric value (double precision).
Log Log (Parameter)	Calculates logarithm of the parameter, returns numeric value (double precision).
Int Int (Parameter)	Extracts integer part of the parameter, returns integer.
ObjectCenterX ObjectCenterX ()	Retrieves center point's X-coordinate of geometry, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts X-coordinate of geometry center point as updated value.
ObjectCenterY ObjectCenterY ()	Retrieves center point's Y-coordinate of geometry, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts Y-coordinate of geometry center point as updated value.
ObjectLeft ObjectLeft ()	Retrieves left boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts left boundary value of geometry extent as updated value.
ObjectRight ObjectRight ()	Retrieves right boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts right boundary value of geometry extent as updated value.
ObjectTop ObjectTop ()	Retrieves top boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts top boundary value of geometry extent as updated value.
ObjectBottom ObjectBottom ()	Retrieves bottom boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts bottom boundary value of geometry extent as updated value.
ObjectWidth ObjectWidth ()	Retrieves width of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts width value of geometry extent as updated value.
ObjectHeight ObjectHeight ()	Retrieves height of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer. Within specified update scope, for each record containing target cell, extracts height value of geometry extent as updated value.
RGBToInt RGBToInt ()	Converts RGB color field value to integer. E.g., RGB field "255,255,255" or "255;255;255" converts to integer value. Converted integer can be used for setting color field in custom thematic maps.

Operation Function

Description

Abs

Abs (Parameter)

Calculates the absolute value of the parameter, returns positive number or 0.

Sqrt

Sqrt (Parameter)

Calculates square root of the parameter, returns numeric value (double precision).

Ln (Parameter)

Calculates natural logarithm of the parameter, returns numeric value (double precision).

Log

Log (Parameter)

Calculates logarithm of the parameter, returns numeric value (double precision).

Int

Int (Parameter)

Extracts integer part of the parameter, returns integer.

ObjectCenterX

ObjectCenterX ()

Retrieves center point's X-coordinate of geometry, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts X-coordinate of geometry center point as updated value.

ObjectCenterY

ObjectCenterY ()

Retrieves center point's Y-coordinate of geometry, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts Y-coordinate of geometry center point as updated value.

ObjectLeft

ObjectLeft ()

Retrieves left boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts left boundary value of geometry extent as updated value.

ObjectRight

ObjectRight ()

Retrieves right boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts right boundary value of geometry extent as updated value.

ObjectTop

ObjectTop ()

Retrieves top boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts top boundary value of geometry extent as updated value.

ObjectBottom

ObjectBottom ()

Retrieves bottom boundary of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts bottom boundary value of geometry extent as updated value.

ObjectWidth

ObjectWidth ()

Retrieves width of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts width value of geometry extent as updated value.

ObjectHeight

ObjectHeight ()

Retrieves height of geometry extent, returns numeric value (double precision). If target update field is integer type, returns rounded integer.

Within specified update scope, for each record containing target cell, extracts height value of geometry extent as updated value.

RGBToInt

RGBToInt ()

Converts RGB color field value to integer. E.g., RGB field "255,255,255" or "255;255;255" converts to integer value.

Converted integer can be used for setting color field in custom thematic maps.

Text Processing Functions

Operation Function	Description
Left Parameter.Left (otherParameter)	Extracts leftmost otherParameter characters from string Parameter. Returns original string if source length is less than otherParameter. (otherParameter is any positive integer)
Right Parameter.Right (otherParameter)	Extracts rightmost otherParameter characters from string Parameter. Returns original string if source length is less than otherParameter. (otherParameter is any positive integer)
Mid Parameter.Mid (otherParameter1, otherParameter2)	Extracts substring from Parameter starting at otherParameter1 to otherParameter2. Returns remaining characters if source length is less than otherParameter2. (Note: Character position starts at 0, each Chinese character occupies two positions.) (otherParameter1, otherParameter2 are any positive integers)
UCase Parameter.UCase ()	Converts string Parameter to uppercase, returns string.
Lcase Parameter.Lcase ()	Converts string Parameter to lowercase, returns string.
Trim Parameter.Trim ()	Removes all leading and trailing whitespace characters from string Parameter.
TrimEnd Parameter.TrimEnd (otherParameter)	Removes trailing occurrences of characters specified in otherParameter from string Parameter. Example: Parameter ="efgabc", otherParameter="abc", after adjustment expression becomes Parameter.TrimEnd ('a','b','c'), result is "efg". (otherParameter is specified matching characters)
TrimStart Parameter.TrimStart (otherParameter)	Removes leading occurrences of characters specified in otherParameter from string Parameter. Example: Parameter ="efgabc", otherParameter="efg", after adjustment expression becomes Parameter.TrimStart ('e','f','g'), result is "abc". (otherParameter is specified matching characters)
LRemove Parameter.LRemove (otherParameter)	Removes leftmost otherParameter characters from string Parameter. (otherParameter is any positive integer)
RRemove Parameter.RRemove (otherParameter)	Removes rightmost otherParameter characters from string Parameter. (otherParameter is any positive integer)
Replace Parameter.Replace (otherParameter1, otherParameter2)	Replaces all occurrences of otherParameter1 in Parameter with otherParameter2. Example: Parameter ="efgabc", otherParameter1="fga", otherParameter2="jklmn", result is "ejklmnbc". (otherParameter1, otherParameter2 are any strings)

Operation Function

Description

Left

Parameter.Left (otherParameter)

Extracts leftmost otherParameter characters from string Parameter. Returns original string if source length is less than otherParameter.

(otherParameter is any positive integer)

Right

Parameter.Right (otherParameter)

Extracts rightmost otherParameter characters from string Parameter. Returns original string if source length is less than otherParameter.

(otherParameter is any positive integer)

Mid

Parameter.Mid (otherParameter1, otherParameter2)

Extracts substring from Parameter starting at otherParameter1 to otherParameter2. Returns remaining characters if source length is less than otherParameter2. (Note: Character position starts at 0, each Chinese character occupies two positions.)

(otherParameter1, otherParameter2 are any positive integers)

UCase

Parameter.UCase ()

Converts string Parameter to uppercase, returns string.

Lcase

Parameter.Lcase ()

Converts string Parameter to lowercase, returns string.

Trim

Parameter.Trim ()

Removes all leading and trailing whitespace characters from string Parameter.

TrimEnd

Parameter.TrimEnd (otherParameter)

Removes trailing occurrences of characters specified in otherParameter from string Parameter.

Example: Parameter ="efgabc", otherParameter="abc", after adjustment expression becomes Parameter.TrimEnd ('a','b','c'), result is "efg".

(otherParameter is specified matching characters)

TrimStart

Parameter.TrimStart (otherParameter)

Removes leading occurrences of characters specified in otherParameter from string Parameter.

Example: Parameter ="efgabc", otherParameter="efg", after adjustment expression becomes Parameter.TrimStart ('e','f','g'), result is "abc".

(otherParameter is specified matching characters)

LRemove

Parameter.LRemove (otherParameter)

Removes leftmost otherParameter characters from string Parameter.

(otherParameter is any positive integer)

RRemove

Parameter.RRemove (otherParameter)

Removes rightmost otherParameter characters from string Parameter.

(otherParameter is any positive integer)

Replace

Parameter.Replace (otherParameter1, otherParameter2)

Replaces all occurrences of otherParameter1 in Parameter with otherParameter2.

Example: Parameter ="efgabc", otherParameter1="fga", otherParameter2="jklmn", result is "ejklmnbc".

(otherParameter1, otherParameter2 are any strings)

DateTime Processing Functions

DateTime Function	Description
AddDays Parameter.AddDays (otherParameter)	Adds specified otherParameter days to Parameter date. Returns new date. Negative values result in earlier dates. (otherParameter is any integer)
AddHours Parameter.AddHours (otherParameter)	Adds specified otherParameter hours to Parameter datetime. Returns new datetime. Negative values result in earlier times. (otherParameter is any integer)
AddMilliseconds Parameter.AddMilliseconds (otherParameter)	Adds specified otherParameter milliseconds to Parameter datetime. Returns new datetime. Negative values result in earlier times. (otherParameter is any integer)
AddMinutes Parameter.AddMinutes (otherParameter)	Adds specified otherParameter minutes to Parameter datetime. Returns new datetime. Negative values result in earlier times. (otherParameter is any integer)
AddMonths Parameter.AddMonths (otherParameter)	Adds specified otherParameter months to Parameter date. Returns new date. Negative values result in earlier dates. (otherParameter is any integer)
AddSeconds Parameter.AddSeconds (otherParameter)	Adds specified otherParameter seconds to Parameter datetime. Returns new datetime. Negative values result in earlier times. (otherParameter is any integer)
AddYears Parameter.AddYears (otherParameter)	Adds specified otherParameter years to Parameter date. Returns new date. Negative values result in earlier dates. (otherParameter is any integer)
Date Parameter.Date ()	Extracts date portion from DateTime-type Parameter, returns date with time portion set to zero.
Now Parameter.Now ()	Retrieves current system datetime and returns.
DaysInMonth Parameter.DaysInMonth ()	Returns number of days in the month specified by DateTime-type Parameter.
Second Parameter.Second ()	Extracts seconds portion from DateTime-type Parameter and returns.
Minute Parameter.Minute ()	Extracts minutes portion from DateTime-type Parameter and returns.
Hour Parameter.Hour ()	Extracts hours portion from DateTime-type Parameter and returns.
Day Parameter.Day ()	Returns day of month from DateTime-type Parameter.
Month Parameter.Month ()	Extracts month portion from DateTime-type Parameter and returns.
Year Parameter.Year ()	Extracts year portion from DateTime-type Parameter and returns.
DayOfYear Parameter.DayOfYear ()	Returns day of year from DateTime-type Parameter.
DayOfWeek Parameter.DayOfWeek ()	Returns weekday value from DateTime-type Parameter.

DateTime Function

Description

AddDays

Parameter.AddDays (otherParameter)

Adds specified otherParameter days to Parameter date. Returns new date. Negative values result in earlier dates.