FileMaker Pro 13 ® Functions Reference
© 2007–2013 FileMaker, Inc. All Rights Reserved. FileMaker, Inc. 5201 Patrick Henry Drive Santa Clara, California 95054 FileMaker and Bento are trademarks of FileMaker, Inc. registered in the U.S. and other countries. The file folder logo, FileMaker WebDirect, and the Bento logo are trademarks of FileMaker, Inc. All other trademarks are the property of their respective owners. FileMaker documentation is copyrighted.
Contents Contents Functions reference (alphabetical list) . . . . . . . . . . . . . . . . . . . . . . . . 10 About functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Aggregate functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Average . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Count . . . . . . . . . . . . . . . . . . . . . .
Contents FieldRepetitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 FieldStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 FieldType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 GetNextSerialValue . . . . . . . . . . . . . . . . . . . . . .
Contents Get(CurrentTimestamp) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Get(CurrentTimeUTCMilliseconds) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Get(CustomMenuSetName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Get(DesktopPath) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Get(StatusAreaState) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Get(SystemDrive) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Get(SystemIPAddress) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Get(SystemLanguage) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Mobile functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 LocationValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Number functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Abs . .
Contents KanjiNumeral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 Katakana . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 Left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 LeftValues . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Acos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 Asin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 Atan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344 Cos . . . . . . . . . . . . . . . . . . . . . . . . . .
Functions reference (alphabetical list) Functions reference (alphabetical list) A, B, C Abs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Acos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 Asin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Functions reference (alphabetical list) Floor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 FV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 G Get(AccountExtendedPrivileges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Get(AccountName) . . . . . . . . .
Functions reference (alphabetical list) Get(LayoutName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Get(LayoutNumber) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Get(LayoutTableName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Get(LayoutViewState) . . . . . . . . . . . . . . . . . . .
Functions reference (alphabetical list) Get(WindowMode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Get(WindowName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Get(WindowOrientation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Get(WindowStyle) . . . . . . . . . . . . . . . . . . . . .
Functions reference (alphabetical list) Let . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Lg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Ln . . . . . . . .
Functions reference (alphabetical list) SetPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Sin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 Sqrt . . . . . . . . . . .
About functions About functions Working with formulas and functions A function is a predefined, named formula that performs a specific calculation and returns a single, specific value. Most functions include three basic parts: • the function • a set of parentheses, if the function takes parameters • the parameters required by the function Each function returns a result of field type text, number, date, time, timestamp, or container. A formula calculates a single value, based on constants (such as 1.
Aggregate functions Alphabetical headings for functions reference: A, B, C D E F G H, I, J, K L, M, N, O P, Q R S T, U V, W, X, Y, Z Aggregate functions Aggregate functions perform statistical analysis on numbers (and also dates or times for some functions) in: • several fields in a record. • related fields whether displayed in a portal or not. • repeating fields.
Aggregate functions Average Purpose Returns a value that is the average of all valid, non-blank values in field. Format Average(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 6.
Aggregate functions Note When a referenced field is a repeating field, the Average function returns the average of the values in the first repetition field, then the average of the values in the second repetition field, and so on. Therefore, (1+5+6)/3=4;(2+6)/2=4;7/1=7;8/1=8.
Aggregate functions Count Purpose Returns the number of valid, non-blank values in field. Format Count(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Field can be any of the following: • a repeating field (repeatingField).
Aggregate functions Note When a referenced field is a repeating field, the Count function returns the total number of valid, non-blank values in the first repetition field, then the number of valid, non-blank values in the second repetition field, and so on.
Aggregate functions List Purpose Returns a concatenated list of non-blank values (separated by carriage returns) for a field or fields. Format List(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; an expression that returns a field, repeating field, or set of non-repeating fields, or a variable. Parameters in curly braces { } are optional. Data type returned text Originated in FileMaker Pro 8.
Aggregate functions Example 1 List (Field1; Field2) returns: • white • black Example 2 List(Field3) returns: • red • green • blue Example 3 List (Field1; Field2; Field3) returns: in calculation repetition 1: • white • black • red in calculation repetition 2: • green in calculation repetition 3: • blue Example 4 List(Related::Field4) returns: • 100 • 200 • 300 Example 5 List ($f1; Field2) returns: • orange • black FILEMAKER FUNCTIONS REFERENCE 23
Aggregate functions Max Purpose Returns the highest valid value in field. Format Max(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned text, number, date, time, timestamp Originated in FileMaker Pro 6.0 or earlier Description Field can be any of the following: • a repeating field (repeatingField).
Aggregate functions Notes • When a referenced field is a repeating field, the Max function returns the maximum value in the first repetition field, then the maximum value in the second repetition field, and so on. • Aggregate functions such as Min or Max use the data type of the first parameter to perform all comparisons. For example, if the first parameter’s data type is text, all other parameters are converted to text and then compared.
Aggregate functions Min Purpose Returns the smallest valid non-blank value in field. Format Min(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned text, number, date, time, timestamp Originated in FileMaker Pro 6.
Aggregate functions Notes • When a referenced field is a repeating field, the Min function returns the minimum value in the first repetition field, then the minimum value in the second repetition field, and so on. • Aggregate functions such as Min or Max use the data type of the first parameter to perform all comparisons. For example, if the first parameter’s data type is text, all other parameters are converted to text and then compared.
Aggregate functions StDev Purpose Returns the standard deviation of the sample represented by a series of non-blank values in field. Format StDev(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 6.
Aggregate functions StDev(Field4) results in an error because standard deviation of a single number is not defined. StDev(Field1;Field2;Field3) returns 2.64575131..., 3.05505046..., 2.12132034..., 2.82842712... for a repeating field. Note When a referenced field is a repeating field, the StDev function returns the standard deviation in the first repetition fields, then the standard deviation in the second repetition fields, and so on.
Aggregate functions StDevP Purpose Returns the standard deviation of a population represented by a series of non-blank values in field. Format StDevP(field{;field... }) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 6.
Aggregate functions • Field4 contains one repetition with a value of 3. StDevP(Field4) results in an error because the population standard deviation of a single number is not defined. StDevP(Field2) returns 1.11803398... for a non-repeating field. StDevP(Field1;Field2;Field3) returns 2.16024689..., 2.49443825..., 1.5, 2 for repeating fields.
Aggregate functions Sum Purpose Returns the total of all valid, non-blank values in field. Format Sum(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Field can be any of the following: • a repeating field (repeatingField).
Aggregate functions If the calculation result isn’t a repeating field: • Sum(Field2) returns 26. • Sum(Field1;Field2;Field3) returns 12. If the calculation result is a repeating field: • Sum(Field2) returns a repeating field with 26 in the first repetition. • Sum(Field1;Field2;Field3) returns a repeating field with 12, 8, 7, 8. Note When a referenced field is a repeating field, the Sum function returns the sum of the first repetition field, then the sum of the second repetition field, and so on.
Aggregate functions Variance Purpose Returns the variance of a sample represented by a series of non-blank values in field. Format Variance(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 7.
Aggregate functions • Field4 contains one repetition with a value of 3. Variance(Field4) results in an error since the variance of a single value is not defined. Variance(Field1;Field2;Field3) returns 7, 9.33333333..., 4.5, 8 if the calculation is a repeating field. Student example Two classes of students take an exam. Class 1 has scores of 70, 71, 70, 74, 75, 73, 72 and Class 2 has scores of 55, 80, 75, 40, 65, 50, 95. The variance for each class is: Class 1: 3.80952380... Class 2: 361.90476190...
Aggregate functions VarianceP Purpose Returns the variance of a population represented by a series of non-blank values in field. Format VarianceP(field{;field...}) Parameters field - any related field, repeating field, or set of non-repeating fields; or an expression that returns a field, repeating field, or set of non-repeating fields. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 7.
Aggregate functions • Field4 contains one repetition with a value of 3. VarianceP(Field4) results in an error since the variance of a single value is not defined. VarianceP(Field1;Field2;Field3) returns 4.66666666..., 6.22222222..., 2.25, 4 if the calculation is a repeating field. Student example Two classes of students take an exam. Class 1 has scores of 70, 71, 70, 74, 75, 73, 72 and Class 2 has scores of 55, 80, 75, 40, 65, 50, 95. The population variance for each class is: Class 1: 3.26530612...
Container functions Container functions Container functions calculate, manipulate, and report on data in container fields. Click a function name for details. This function Returns Base64Decode Container content from text encoded in Base64 format. Base64Encode The contents of the specified container field as text in Base64 format. GetContainerAttribute The file metadata of a container field. GetHeight The height of the image in a container field that holds images.
Container functions Base64Decode Purpose Returns container content from text encoded in Base64 format. Format Base64Decode(text{;fileNameWithExtension}) Parameters text - Base64 text to decode. fileNameWithExtension - the filename and extension for the file created from the decoded Base64 text. Data type returned container Originated in FileMaker Pro 13.0 Description Base64 encoding does not retain the filename or extension of encoded content.
Container functions Base64Encode Purpose Returns the contents of the specified container field as text in Base64 format. Format Base64Encode(sourceField) Parameters sourceField - the name of a container field. Data type returned text Originated in FileMaker Pro 13.0 Description Base64 encoding does not retain the filename or extension of encoded content. Base64Encode adds a line break after every 76 characters.
Container functions GetContainerAttribute Purpose Returns the file metadata of the specified container field. Format GetContainerAttribute(sourceField;attributeName) Parameters sourceField - the name of a container field. attributeName - the name of a supported attribute (see below). Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 13.0 Description Some attributes may not return a result.
Container functions Attribute Returns Data type returned width A number representing the width of the image in pixels. number height A number representing the height of the image in pixels. number dpiWidth A number representing the horizontal DPI of the image. number dpiHeight A number representing the vertical DPI of the image. number transparency 1 if the image has an alpha channel, otherwise returns 0.
Container functions Attribute Returns Data type returned duration The duration of the audio. For example, 0:03:16. time bitRate The number of kilobits per second (kbps) used in the audio. number barcodeText The content of the bar code. text barcodeType The type of the bar code. text The timestamp when the signature was inserted. timestamp general Attributes listed in the General category above pertaining to the container field.
Container functions • year. Date information may be returned in parentheses after the year. For example: Year: 2014 (11/10/2014). Examples Notice that the attributes in the following examples are enclosed in quotation marks. GetContainerAttribute(Image;"all") returns: [General] Filename: IMG_003.
Container functions GetHeight Purpose Returns the height in pixels of the content in a container field that holds images. Format GetHeight(field) Parameters field - any text, number, date, time, timestamp, or container field; or any text expression or numeric expression. Data type returned number Originated in FileMaker Pro 12.0 Description Returns the height in pixels of images in a container field that holds images. Otherwise, GetHeight returns 0. Examples GetHeight(product) returns 768.
Container functions GetThumbnail Purpose Returns a thumbnail image of the content in a container field, according to specified values for width and height. Format GetThumbnail(field;width;height) Parameters field - any text, number, date, time, timestamp, or container field; or any text expression or numeric expression. width - the width for the thumbnail. height - the height for the thumbnail. Data type returned container Originated in FileMaker Pro 12.
Container functions GetWidth Purpose Returns the width in pixels of the content in a container field that holds images. Format GetWidth(field) Parameters field - any text, number, date, time, timestamp, or container field; or any text expression or numeric expression. Data type returned number Originated in FileMaker Pro 12.0 Description Returns the width in pixels of images in a container field that holds images. Otherwise, GetWidth returns 0. Examples GetWidth(Product) returns 1024.
Container functions VerifyContainer Purpose Returns a Boolean value representing the validity of data stored externally in a container field. Format VerifyContainer(field) Parameters field - any text, number, date, time, timestamp, or container field; or any text expression or numeric expression. Data type returned text Originated in FileMaker Pro 12.0 Description Returns a Boolean value representing the validity of data stored externally in a container field.
Date functions Date functions Date functions calculate dates and manipulate date information. Important To avoid errors when using dates, always use four-digit years. For more information about how FileMaker Pro handles two-digit dates, see Conversion of dates with two-digit years. Note System formats affect the way dates are displayed. See Opening files with different system formats. Tip You can use zero (0) and negative numbers as Date function arguments.
Date functions Date Purpose Returns the calendar date for month, day, and year. Format Date(month;day;year) Parameters month - the month of the year (a one-digit or two-digit number; see note). day - the day of the month (a one-digit or two-digit number; see note). year - the year (four digits between 0001 and 4000. For example, 2014 but not 14).
Date functions “Bill Due by: ” & Date(Month(DateSold) + 1;Day(DateSold);Year(DateSold)) returns Bill Due by: followed by a value that is one month later than DateSold.
Date functions Day Purpose Returns a number in the range 1 through 31, representing the day of the month on which date occurs. Format Day(date) Parameters date - any calendar date Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use Day, for example, to identify the day of the month on which payments are due. Important To avoid errors when using dates, always use four-digit years.
Date functions DayName Purpose Returns a text string that is the full name of the weekday for date. Format DayName(date) Parameters date - any calendar date Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples DayName(Date(10;7;2014)) returns Tuesday. DayName(ProjectDue) returns Tuesday when ProjectDue is 10/7/2014. DayName(“10/7/2014”) returns Tuesday.
Date functions DayNameJ Purpose Returns a text string in Japanese that is the full name of the weekday for date. Format DayNameJ(date) Parameters date - any calendar date Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples DayNameJ(Date(4;4;2014)) returns . Important To avoid errors when using dates, always use four-digit years. For more information about how FileMaker Pro handles two-digit dates, see Conversion of dates with two-digit years.
Date functions DayOfWeek Purpose Returns a number representing the day of the week that date falls on. Format DayOfWeek(date) Parameters date - any calendar date Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The number 1 represents Sunday, 2 represents Monday, 3 represents Tuesday, and so on. For example, you can find out on what day of the week a holiday occurs. Important To avoid errors when using dates, always use four-digit years.
Date functions DayOfYear Purpose Returns a number equal to the number of days from the beginning of the year of date. Format DayOfYear(date) Parameters date - any calendar date Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples DayOfYear(Billing Date) returns 32, when Billing Date is 2/1/2014.
Date functions Month Purpose Returns a number in the range 1 through 12, representing the number of the month of the year in which date occurs. Format Month(date) Parameters date - any calendar date Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Month(“3/19/2014”) returns 3. This example assumes that the operating system date format is set to MM/DD/YYYY. Month(Payment) returns 3, where Payment contains March 19, 2014. (The Payment field must be of type date.
Date functions MonthName Purpose Returns the full name of the month for date. Format MonthName(date) Parameters date - any calendar date Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples MonthName(“6/6/2014”) returns June. “Payment due by the end of: ” & MonthName(Date(Month(InvoiceDate) + 1;Day(InvoiceDate);Year(InvoiceDate))) returns Payment due by the end of May, where InvoiceDate is 4/4/2014.
Date functions MonthNameJ Purpose Returns the name of the month of date in Japanese. Format MonthNameJ(date) Parameters date - any calendar date Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples MonthNameJ(“6/6/2014”) returns Important To avoid errors when using dates, always use four-digit years. For more information about how FileMaker Pro handles two-digit dates, see Conversion of dates with two-digit years.
Date functions WeekOfYear Purpose Returns the number of weeks after January 1 of the year of date. Format WeekOfYear(date) Parameters date - any calendar date Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Fractions of weeks occurring at the beginning or end of the year count as full weeks, so the WeekOfYear function returns values 1 through 54. Important To avoid errors when using dates, always use four-digit years.
Date functions WeekOfYearFiscal Purpose Returns a number between 1 and 53 representing the week containing date, figured according to startingDay. Format WeekOfYearFiscal(date;startingDay) Parameters date - any calendar date startingDay - any number between 1 and 7, where 1 represents Sunday Data type returned number Originated in FileMaker Pro 6.0 or earlier Description startingDay indicates which day is considered the first day of the week.
Date functions Year Purpose Returns a number representing the year in which date occurs. Format Year(date) Parameters date - any calendar date Data type returned number Originated in FileMaker Pro 6.0 or earlier Description You can, for example, extract the year from a field containing the date an item was sold. Important To avoid errors when using dates, always use four-digit years. For more information about how FileMaker Pro handles two-digit dates, see Conversion of dates with two-digit years.
Date functions YearName Purpose Returns the Japanese year name of date, provided in the specified format. Format YearName(date;format) Parameters date - any calendar date format - a number (0, 1, or 2) that describes the display format Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If the value for format is blank or other than 0, 1, or 2, then 0 is used. 08 (Meiji 8), [before 1868.9.
Design functions Design functions Design functions return information about the structure of open database files. For example, you could determine the names of all the layouts or fields in an open database file. Note FileMaker Pro limits the information returned by a design function, according to the privilege set in effect when the function evaluates a database file. See Creating and managing privilege sets for more information about granting access to database files.
Design functions This function Returns TableNames A list of the names of all defined tables in the specified database file, separated by carriage returns. ValueListIDs A list of all value list IDs in the specified database file, separated by carriage returns. ValueListItems A list of the values in the specified value list, separated by carriage returns. ValueListNames A list of the names of all value lists in the specified database file, separated by carriage returns.
Design functions DatabaseNames Purpose Returns a list of the names of all database files open on the computer, separated by carriage returns. Format DatabaseNames Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description The names returned do not include file extensions. Note If your database is hosted on another computer, DatabaseNames returns a list of the names of local client and remote database files open only on the client computer.
Design functions FieldBounds Purpose Returns the location in points of each field boundary and the field’s rotation in degrees. Format FieldBounds(fileName;layoutName;fieldName) Parameters fileName - the name of an open database file (local or remote). layoutName - the name of a layout in the specified database file. fieldName - the name of a field on the specified layout. Important See Design functions for information about literal text parameters.
Design functions FieldComment Purpose Returns the specified field’s comment. Format FieldComment(fileName;fieldName) Parameters fileName - the name of an open database file (local or remote). fieldName - the name of a field in the specified database file. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 7.
Design functions FieldIDs Purpose Returns a list of all field IDs in fileName and layoutName, separated by carriage returns. Format FieldIDs(fileName;layoutName) Parameters fileName - the name of an open database file (local or remote). layoutName - the name of a layout or table in the specified database file. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.
Design functions FieldNames Purpose Returns a list of the names of all fields on layoutName, in fileName file, separated by carriage returns. Format FieldNames(fileName;layoutName) Parameters fileName - the name of an open database file (local or remote). layoutName - the name of a layout or table in the specified database file. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.
Design functions FieldRepetitions Purpose Returns the number of repetitions of the repeating field fieldName as it is currently formatted on layoutName (which could be different from the number of repetitions when the field was defined), and the orientation of the field repetitions (horizontal or vertical) on the layout. Format FieldRepetitions(fileName;layoutName;fieldName) Parameters fileName - the name of an open database file (local or remote).
Design functions FieldStyle Purpose Returns the field formatting applied to fieldName on layoutName in the fileName file. Format FieldStyle(fileName;layoutName;fieldName) Parameters fileName - the name of an open database file (local or remote). layoutName - the name of a layout in the specified database file. fieldName - the name of a field on the specified layout. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.
Design functions FieldType Purpose Returns information about fieldName. Format FieldType(fileName;fieldName) Parameters fileName - the name of an open database file (local or remote). fieldName - the name of a field in the specified database file. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.
Design functions GetNextSerialValue Purpose Returns the next serial number of fieldName in fileName. Format GetNextSerialValue(fileName;fieldName) Parameters fileName - the name of an open database file (local or remote). fieldName - the name of the field whose next serial number you want to determine. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.
Design functions LayoutIDs Purpose Returns a list of all layout IDs in fileName, separated by carriage returns. Format LayoutIDs(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If no parameter is specified for fileName, FileMaker returns results for the current file.
Design functions LayoutNames Purpose Returns a list of the names of all layouts in fileName, separated by carriage returns. Format LayoutNames(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples LayoutNames(“Customers”) returns a list of all the layouts in the Customers database file.
Design functions LayoutObjectNames Purpose Returns a list of the names of all named objects on layoutName in fileName, separated by carriage returns. Format LayoutObjectNames(fileName;layoutName) Parameters fileName - the name of an open database file (local or remote). layoutName - the name of a layout in the specified database file. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 8.
Design functions RelationInfo Purpose Returns a list of four values for each relationship directly related to tableName. Format RelationInfo(fileName;tableName) Parameters fileName - the name of an open database file (local or remote). tableName - the name of a table in the specified database file. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.
Design functions • You can create records in all tables. • You cannot delete records in all tables. • A sort was specified for the Addresses table for the Employees<-->Addresses relationship.
Design functions ScriptIDs Purpose Returns a list of all script IDs in fileName, separated by carriage returns. Format ScriptIDs(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples ScriptIDs(“Customers”) returns a list of all the script IDs in the Customers database file.
Design functions ScriptNames Purpose Returns a list of the names of all scripts in fileName, separated by carriage returns. Format ScriptNames(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If no parameter is specified for fileName, FileMaker returns results for the current file.
Design functions TableIDs Purpose Returns a list of all table IDs in fileName, separated by carriage returns. Format TableIDs(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Each table ID is unique.
Design functions TableNames Purpose Returns a list of all table occurrences in the relationships graph for fileName, separated by carriage returns. Format TableNames(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If no parameter is specified for fileName, FileMaker returns results for the current file.
Design functions ValueListIDs Purpose Returns a list of all value list IDs in fileName, separated by carriage returns. Format ValueListIDs(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If no parameter is specified for fileName, FileMaker returns results for the current file.
Design functions ValueListItems Purpose Returns a list of the values in valuelist, separated by carriage returns. Format ValueListItems(fileName;valuelist) Parameters fileName - the name of an open database file (local or remote). valuelist - the name of a value list in the specified database file. Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.
Design functions ValueListNames Purpose Returns a list of the names of all value lists in fileName, separated by carriage returns. Format ValueListNames(fileName) Parameters fileName - the name of an open database file (local or remote). Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If no parameter is specified for fileName, FileMaker returns results for the current file.
Design functions WindowNames Purpose Returns a list of the names of windows that are currently open. Format WindowNames{(fileName)} Parameters {fileName} - the name of an open database file (local or remote). Parameters in curly braces { } are optional. Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Use the optional fileName parameter to only return windows that are based on the specified file. The window could be visible, hidden, or minimized.
External functions External functions Use external functions to access FileMaker Pro plug-ins. Plug-ins add features to FileMaker Pro. For more information, see Setting plug-in preferences. External functions are only available if FileMaker Pro plug-ins are installed and enabled on your computer. If no FileMaker Pro plug-ins are installed, you see only the generic external function definition in the Specify Calculation dialog box: External (nameOfFunction; parameter) Plug-ins written for version 7.
External functions External Purpose Accesses plug-ins created for versions of FileMaker Pro prior to 7.0 and uses the syntax External(“function name”, parameter), where function name is in quotes and is the name of an external function. Format External(nameOfFunction;parameter) Parameters nameOfFunction - the name of the external function parameter - the parameter(s) required by the external function. A parameter is required, even if it’s only 0.
Financial functions Financial functions Financial functions calculate financial information, such as net present value and payments. For example, you can calculate the monthly payments required to buy a car at a certain loan rate using the PMT function. Click a function name for details. This function Returns FV The future value of an initial investment, based on a constant interest rate and payment amount for the number of periods in months.
Financial functions FV Purpose Returns the future value (FV) of an initial investment, based on a constant interestRate and payment amount for the number of periods in months. Format FV(payment;interestRate;periods) Parameters payment - payment to be made per period interestRate - interest rate per period periods - number of periods Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use this function to calculate FV.
Financial functions NPV Purpose Returns the net present value (NPV) of a series of unequal payments made at regular intervals, assuming a fixed interestRate per interval. Format NPV(payment;interestRate) Parameters payment - a repeating field containing unequal payment amounts, or an expression that returns a reference to one. interestRate - interest rate. Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use this function to calculate NPV.
Financial functions PMT Purpose Returns the payment (PMT) required by the term, interestRate, and principal. Format PMT(principal;interestRate;term) Parameters principal - principal amount. interestRate - interest rate. If the interest rate is annual, divide the rate by 12. term - length of time, expressed in number of months. Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use this function to calculate PMT.
Financial functions PV Purpose Returns the present value (PV) of a series of equal payments made at regular intervals (periods), assuming a fixed interestRate per interval. Format PV(payment;interestRate;periods) Parameters payment - payment amount to be made per period. Type a negative number for money you pay and a positive number for money you receive. interestRate - interest rate per period. periods - number of periods (intervals between payments).
Get functions Get functions Use Get functions in scripts for error checking and prevention, or to capture information about the status of a database file or elements in it, or an action being performed. Many Get functions return information that changes on a regular basis. For example, when the Get(CurrentTime) function is placed in a stored calculation field, the time will only update when a new record is created.
Get functions This function Returns Get(ApplicationVersion) Text representing the FileMaker application version. Get(CalculationRepetitionNumber) A number representing the repetition of the calculation field that is currently being calculated. Get(ConnectionAttributes) The name of the current file’s host and the name of the certificate authority that issued the SSL certificate used to secure the connection.
Get functions This function Returns Get(HostApplicationVersion) The version of FileMaker Pro or FileMaker Server running on the computer that is hosting the current database. Get(HostIPAddress) The IP address of the host machine for the current database. Get(HostName) The registered name of the computer that is hosting the database file. Get(InstalledFMPlugins) The display name, version number (if available), and enabled state of installed plug-ins.
Get functions This function Returns Get(RecordOpenCount) The total number of open records in the current found set that haven’t yet been saved. Get(RecordOpenState) A number representing the state of the current record. Get(RequestCount) The total number of find requests currently defined for the current table. Get(RequestOmitState) A Boolean value representing the state of the Omit checkbox in Find mode.
Get functions This function Returns Get(TriggerModifierKeys) The state of the keyboard modifier keys as they were when the script trigger was activated. Get(TriggerTargetPanel) The index number and object name of the tab panel or slide panel to be switched to when the OnPanelSwitch script trigger is activated. Get(UserCount) The number of users who are currently accessing the file. Get(UserName) The name of the FileMaker Pro user, as specified in the General tab of the Preferences dialog box.
Get functions based on the user's response, the script performs an action: it cancels the rest of the script, prints a "payment is late" letter, or sends email to the associated account.
Get functions Get(AccountExtendedPrivileges) Purpose Returns a list of keywords, separated by carriage returns, for the enabled extended privileges. The list that is returned is based on the account used to open the database file. See also Get(CurrentExtendedPrivileges) function. Format Get(AccountExtendedPrivileges) Parameters None Data type returned text Originated in FileMaker Pro 11.0 Description Extended privileges are additional access rights assigned to an account’s privilege set.
Get functions Get(AccountName) Purpose Returns the name of the authenticated account being used by the current user of the database file. Format Get(AccountName) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description Use this function for FileMaker authentication. If a user is using the default Admin account, Get(AccountName) returns Admin. If a user is using the FileMaker Pro guest account then [Guest] will be returned.
Get functions Get(AccountPrivilegeSetName) Purpose Returns the name of the privilege set that is being used by the account used to open the database. See also Get(CurrentPrivilegeSetName) function. Format Get(AccountPrivilegeSetName) Parameters None Data type returned text Originated in FileMaker Pro 11.0 Description If a user is using the default Admin account and you haven’t modified access privileges for the database file, this function returns [Full Access].
Get functions Get(ActiveFieldContents) Purpose Returns the contents of the field that has the focus. Format Get(ActiveFieldContents) Parameters None Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 6.0 or earlier Description When the focus is in a repeating field, this function returns the contents of the active repetition.
Get functions Get(ActiveFieldName) Purpose Returns the name of the field that has the focus. Format Get(ActiveFieldName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com. Examples Returns Country, when the focus is in the Country field.
Get functions Get(ActiveFieldTableName) Purpose Returns the name of the table that contains the active field (the field that has the focus). Format Get(ActiveFieldTableName) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description If there is no active field, this function returns an empty string. Note For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com.
Get functions Get(ActiveLayoutObjectName) Purpose Returns the object name of the active layout object in the calculation's current window; otherwise, returns an empty string. Format Get(ActiveLayoutObjectName) Parameters None Data type returned text Originated in FileMaker Pro 8.5 Description For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com.
Get functions Get(ActiveModifierKeys) Purpose Returns a number representing the keyboard modifier keys (for example, Control+Shift) that are being pressed. Format Get(ActiveModifierKeys) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The number returned is calculated by summing numbers representing each modifier key being pressed.
Get functions Get(ActivePortalRowNumber) Purpose Returns the number of the portal row containing the focus. Format Get(ActivePortalRowNumber) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description When no portal row contains the focus, this function returns 0. If there are multiple windows open in the current database file, each window can have its own portal row number value, but results are returned for only the foreground window.
Get functions Get(ActiveRepetitionNumber) Purpose Returns a number representing the active repetition of a repeating field (the repetition that has the focus). Format Get(ActiveRepetitionNumber) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The first repetition returns 1. If the current field isn’t a repeating field, this function returns 1.
Get functions Get(ActiveSelectionSize) Purpose Returns a number representing how many characters are selected. Format Get(ActiveSelectionSize) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description Returns 0 if there is no selection. Notes • In FileMaker WebDirect, this function is not supported and returns an empty string. • For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.
Get functions Get(ActiveSelectionStart) Purpose Returns a number representing the starting character of the selected text. Format Get(ActiveSelectionStart) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description Returns the cursor's current position if no text is selected. If there are multiple windows open in the current database file, a result is returned for only the foreground window.
Get functions Get(AllowAbortState) Purpose Returns 1 if Allow user abort script step is on; otherwise, returns 0. Format Get(AllowAbortState) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com. Examples Returns 1 if Allow user abort script step is on.
Get functions Get(AllowFormattingBarState) Purpose Returns a Boolean value representing whether the formatting bar is allowed to be visible. Format Get(AllowFormattingBarState) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Description Returns 1 if the formatting bar is allowed; otherwise, returns 0. The Allow Formatting Bar script step sets the formatting bar state. For more information, see Allow Formatting Bar script step.
Get functions Get(ApplicationLanguage) Purpose Returns text representing the current application language. Format Get(ApplicationLanguage) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description The text that is returned by this function is in the English language. For hosted databases, Get(ApplicationLanguage) returns the client’s current language. Note In FileMaker WebDirect, Get(ApplicationLanguage) returns the web browser’s current language.
Get functions Get(ApplicationVersion) Purpose Returns text representing the FileMaker application and version. Format Get(ApplicationVersion) Parameters None Data type returned text Originated in FileMaker Pro 6.
Get functions Get(CalculationRepetitionNumber) Purpose Returns a number representing the repetition of the calculation field that is currently being calculated. Format Get(CalculationRepetitionNumber) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The first repetition returned is 1. If the current field isn’t a repeating field, the function returns 1.
Get functions Get(ConnectionAttributes) Purpose Returns the name of the current file’s host and the name of the certificate authority that issued the SSL certificate used to secure the connection. Format Get(ConnectionAttributes) Parameters None Data type returned text Originated in FileMaker Pro 13.
Get functions Get(ConnectionState) Purpose Returns a number representing the security state of the network connection for the current file. Format Get(ConnectionState) Parameters None Data type returned number Originated in FileMaker Pro 12.0 Description Returns a value indicating whether the FileMaker Pro or FileMaker Go connection to the host uses SSL, including whether the Server name matches the Server-side certificate (providing the highest security).
Get functions Get(CurrentDate) Purpose Returns the current date according to the system calendar. Format Get(CurrentDate) Parameters None Data type returned date Originated in FileMaker Pro 6.0 or earlier Description The format of the result of this function varies based on the date format that was in use when the database file was created. In the United States, dates are generally in the format MM/DD/YYYY. You can change the date and time formats in your operating system.
Get functions Get(CurrentExtendedPrivileges) Purpose Returns a list of keywords, separated by carriage returns, for the enabled extended privileges. The list that is returned is based on the account that is being used to evaluate this calculation. See also Get(AccountExtendedPrivileges) function. Format Get(CurrentExtendedPrivileges) Parameters None Data type returned text Originated in FileMaker Pro 6.
Get functions Get(CurrentHostTimestamp) Purpose Returns the host’s current date and time (to the nearest second) according to the system clock. Format Get(CurrentHostTimestamp) Parameters None Data type returned timestamp Originated in FileMaker Pro 7.0 Description The format of the value returned is determined by the database file’s settings. You can use your client system’s settings in the operating system.
Get functions Get(CurrentPrivilegeSetName) Purpose Returns the name of the privilege set that is being used to evaluate this calculation in the database file. See also Get(AccountPrivilegeSetName) function. Format Get(CurrentPrivilegeSetName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If a user is using the default Admin account and you haven’t modified access privileges for the database file, this function returns [Full Access].
Get functions Get(CurrentTime) Purpose Returns CurrentTime (to the nearest second) according to the system clock. Format Get(CurrentTime) Parameters None Data type returned time Originated in FileMaker Pro 6.0 or earlier Description The format of the value returned is determined by the operating system settings. Notes • If the calculation result for this script step is set to integer format, it will return the total number of seconds elapsed since the start of the current day.
Get functions Get(CurrentTimestamp) Purpose Returns the current date and time (to the nearest second) according to the system clock. Format Get(CurrentTimestamp) Parameters None Data type returned timestamp Originated in FileMaker Pro 7.0 Description The format of the value returned is determined by the operating system settings. Note In client/server and peer-to-peer environments, Get(CurrentTimestamp) evaluates the status of the client machine running the script (not the host machine).
Get functions Get(CurrentTimeUTCMilliseconds) Purpose Returns the current time in Coordinated Universal Time (UTC) to the nearest millisecond. Format Get(CurrentTimeUTCMilliseconds) Parameters None Data type returned number, time Originated in FileMaker Pro 13.0 Description Returns the current time without time zone adjustments in the form of the number of milliseconds since 1/1/0001. UTC time zone adjustments must be applied to get your local time.
Get functions Get(CustomMenuSetName) Purpose Returns the name of the active custom menu set. Format Get(CustomMenuSetName) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description If the active menu set isn’t a custom menu set, an empty string is returned. Notes • In FileMaker WebDirect, this function is not supported and returns an empty string.
Get functions Get(DesktopPath) Purpose Returns the path to the desktop folder for the current user. Format Get(DesktopPath) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description In Windows, the path format is /Drive:/Users/UserName/Desktop/. In OS X, the path format is /DriveName/Users/username/Desktop/. Notes • In FileMaker WebDirect, this function is not supported and returns an empty string.
Get functions Get(Device) Purpose Returns a number indicating the type of computer that is currently running FileMaker Pro or FileMaker WebDirect, or the type of iOS device that is currently running FileMaker Go. Format Get(Device) Parameters None Data type returned number Originated in FileMaker Pro 13.
Get functions Get(DocumentsPath) Purpose Returns the path to the Documents folder for the current user. Format Get(DocumentsPath) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description In Windows, the path format is /Drive:/Users/UserName/Documents/. In OS X, the path format is /DriveName/Users/username/Documents/.
Get functions Get(DocumentsPathListing) Purpose Returns a list of all the files and folders in the Documents folder returned by the Get(DocumentsPath) function. Format Get(DocumentsPathListing) Parameters None Data type returned text Originated in FileMaker Pro 10.0 Description Each pathname in the Documents folder is listed separated by a line break. Files and folders are named according to FileMaker Pro naming conventions.
Get functions Get(EncryptionState) Purpose Returns a value representing the file’s current encryption state. Format Get(EncryptionState) Parameters None Data type returned text Originated in FileMaker Pro 13.
Get functions Get(ErrorCaptureState) Purpose Returns 1 if the Set Error capture script step is on; otherwise, returns 0. Format Get(ErrorCaptureState) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com. Examples Returns 1 if the Set Error capture script step is on.
Get functions Get(FileMakerPath) Purpose Returns the path to the folder of the currently running copy of FileMaker Pro. Format Get(FileMakerPath) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description In Windows, the path format is /Drive:/Program Files/FileMaker/FileMaker Pro 13/. In OS X, the path format is /DriveName/Applications/FileMaker Pro 13/. Notes • In FileMaker WebDirect, this function is not supported and returns an empty string.
Get functions Get(FileName) Purpose Returns the name of the currently active database file, without the filename extension. Format Get(FileName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If the current calculation is stored and you specify its context, this function will be evaluated based on that context; otherwise, it will be evaluated based on the context of the current window.
Get functions Get(FilePath) Purpose Returns the full path indicating the location of the currently active database file. Format Get(FilePath) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description In Windows, the full path is file:/drive:/folder/filename for local files. For remote files, the full path is file://volume/folder/filename. In OS X, the full path is file:/volume/folder/filename for local and remote files.
Get functions Get(FileSize) Purpose Returns the size (in bytes) of the currently active database file. Format Get(FileSize) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description If the current calculation is stored and you specify its context, this function will be evaluated based on that context; otherwise, it will be evaluated based on the context of the current window.
Get functions Get(FoundCount) Purpose Returns a number that represents the number of records in the current found set. Format Get(FoundCount) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description If there are multiple windows open in the current database file, each window can have its own found count value, but results are returned for only the foreground window.
Get functions Get(HighContrastColor) Purpose Returns the name of the current high contrast default color scheme if high contrast is enabled in the Windows Ease of Access Center and high contrast color scheme is active. Format Get(HighContrastColor) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Returns an empty string if Turn high contrast is unavailable, inactive, or if this function is used in OS X.
Get functions Get(HighContrastState) Purpose Returns a Boolean value representing the state of the Turn high contrast option in the Windows Ease of Access Center. Format Get(HighContrastState) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Returns: • 0 if Use High Contrast is unavailable, inactive, or if the function is used in OS X. • 1 if Use High Contrast is available and active.
Get functions Get(HostApplicationVersion) Purpose Returns the version of FileMaker Pro or FileMaker Server running on the computer that is hosting the current database. Format Get(HostApplicationVersion) Parameters None Data type returned text Originated in FileMaker Pro 9.0 Description Displays a value when used with the same or higher version of FileMaker Pro or FileMaker Server software. If the current database is not shared or hosted, this function returns an empty string.
Get functions Get(HostIPAddress) Purpose Returns the IP address of the host machine for the current database. Format Get(HostIPAddress) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description Returns the IP address used to connect to the host machine for the current database. If the current database isn’t being hosted, an empty string is returned. Note In FileMaker WebDirect, returns the physical IP address of the host machine.
Get functions Get(HostName) Purpose Returns the registered name of the computer that is hosting the database file. Format Get(HostName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description On the computer that is hosting the database file: • Windows 7: Choose Start menu > Control Panel > System and Security > System > and then click See the name of this computer. Computer name displays the current registered name.
Get functions Get(InstalledFMPlugins) Purpose Returns the name, version number (if available), and enabled state of installed plug-ins. Format Get(InstalledFMPlugins) Parameters None Data type returned text Originated in FileMaker Pro 12.0 Description The Get(InstalledFMPlugins) function is useful for determining whether an installed plug-in is newer or older than a plug-in required by a file.
Get functions Get(LastError) Purpose Returns a number representing the error, if any, in the execution of the most recently executed script step. Format Get(LastError) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use this function to detect and control the outcome of errors. See FileMaker Pro error codes.
Get functions Get(LastMessageChoice) Purpose Returns a number corresponding to the button clicked in an alert message that is displayed by the Show Custom Dialog script step. Format Get(LastMessageChoice) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(LastODBCError) Purpose Returns a string that shows the error state published by ODBC standards, based on ISO/IEF standards. Format Get(LastODBCError) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description • For ODBC imports and Execute SQL script steps, returns a detailed, textual ODBC error message. • For working with ODBC data sources in the relationships graph, returns the readable error string that is generated by the ODBC driver.
Get functions Get(LayoutAccess) Purpose Returns a number based on record access privileges available through the current layout. Format Get(LayoutAccess) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description You assign the privileges in the Custom Layout Privileges dialog box.
Get functions Get(LayoutCount) Purpose Returns the total number of layouts in the database file. Format Get(LayoutCount) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com. Examples Returns 3 when the file has three layouts.
Get functions Get(LayoutName) Purpose Returns the name of the layout currently displayed. Format Get(LayoutName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If there are multiple windows open in the current database file, each window can have its own layout name value, but results are returned for only the foreground window.
Get functions Get(LayoutNumber) Purpose Returns the number of the layout currently displayed, according to the list in the Manage Layouts dialog box. Format Get(LayoutNumber) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description If there are multiple windows open in the current database file, each window can have its own layout number value, but results are returned for only the foreground window.
Get functions Get(LayoutTableName) Purpose Returns the name of the table from which the current layout is displaying records. Format Get(LayoutTableName) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description If no windows are open, an empty string is returned. Note For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com.
Get functions Get(LayoutViewState) Purpose Returns a number indicating the currently active database file view. Format Get(LayoutViewState) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(ModifiedFields) Purpose Returns a list of fields that have been modified in the current record of the current table. Format Get(ModifiedFields) Parameters None Data type returned text Originated in FileMaker Pro 13.0 Description This function returns a list of carriage return-delimited values.
Get functions Get(MultiUserState) Purpose Returns a number representing the level of sharing for the database file using FileMaker Network. Format Get(MultiUserState) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(NetworkProtocol) Purpose Returns the name of the network protocol (TCP/IP) that FileMaker Pro is using on this machine. Format Get(NetworkProtocol) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com. Examples Returns TCP/IP.
Get functions Get(NetworkType) Purpose In FileMaker Go, returns a number indicating the type of network being used to access the current file. Format Get(NetworkType) Parameters None Data type returned number Originated in FileMaker Pro 13.
Get functions Get(PageNumber) Purpose Returns a number representing the current page being printed or previewed. Format Get(PageNumber) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description If nothing is being printed or previewed, 0 is returned. Notes • In FileMaker WebDirect, this function is not supported and returns an empty string.
Get functions Get(PersistentID) Purpose Returns text representing a unique identifier of the computer or device on which FileMaker is running. Format Get(PersistentID) Parameters None Data type returned text Originated in FileMaker Pro 12.0 Description Returns a unique, unchanging identifier for the computer on which FileMaker Pro is running, the device on which FileMaker Go is running, or the current FileMaker WebDirect session in the form of a 32-digit hexadecimal string.
Get functions Get(PreferencesPath) Purpose Returns the path to the preferences and default options folder for the current user. Format Get(PreferencesPath) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description In Windows, the path format is /Drive:/Users/UserName/AppData/Local/. In OS X, the path format is /DriveName/Users/UserName/Library/Preferences/. Notes • In FileMaker WebDirect, this function is not supported and returns an empty string.
Get functions Get(PrinterName) Purpose Returns a string identifying the default printer name. Format Get(PrinterName) Parameters None Data type returned text Originated in FileMaker Pro 6.
Get functions Get(QuickFindText) Purpose Returns the text that was entered in the Quick Find box. Format Get(QuickFindText) Parameters None Data type returned text Originated in FileMaker Pro 11.0 Description Returns the text that was entered the last time quick find was performed. Examples Returns New York if the last search that was entered in the Quick Find box was for New York.
Get functions Get(RecordAccess) Purpose Returns a number based on the current record’s access privileges, assigned through the Custom Record Privileges dialog box. Format Get(RecordAccess) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(RecordID) Purpose Returns the unique ID number of the current record. Format Get(RecordID) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The number returned is a decimal value (an integer) generated by FileMaker Pro when the record is created. It does not change.
Get functions Get(RecordModificationCount) Purpose Returns the total number of times changes to the current record have been committed. Format Get(RecordModificationCount) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description To commit changes, you can, for example: • click out of all fields (exit the record) • go to a different record • enter Find mode If multiple windows are open, clicking in another window does not commit the record.
Get functions Get(RecordNumber) Purpose Returns the number of the current record in the current found set. Format Get(RecordNumber) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The value returned is determined by the relative place of the record in the found set, and it changes depending on the find criteria and the sort order. Notes • To return a value that uniquely and permanently identifies a record in this table, use Get(RecordID).
Get functions Get(RecordOpenCount) Purpose Returns the total number of open records in the current found set that haven’t been saved. Format Get(RecordOpenCount) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Description If you specify the context for the current calculation, this function will be evaluated based on that context; otherwise, it will be evaluated based on the context of the current window.
Get functions Get(RecordOpenState) Purpose Returns a number representing the state of the current record. Format Get(RecordOpenState) Parameters None Data type returned number Originated in FileMaker Pro 8.
Get functions Get(RequestCount) Purpose Returns the total number of find requests defined for the current table. Format Get(RequestCount) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description If there are multiple windows open in the current database file, then results are returned for only the top-most window of the file in which the calculation is defined.
Get functions Get(RequestOmitState) Purpose Returns a Boolean value representing the state of the Omit checkbox in Find mode. Format Get(RequestOmitState) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Description Returns 1 if the Omit checkbox is selected; otherwise, returns 0. Note For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com.
Get functions Get(ScreenDepth) Purpose Returns the number of bits needed to represent the color or shade of gray of a pixel on the main screen. Format Get(ScreenDepth) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description A value of 8 represents 256 (equal to 28) colors or shades of gray. Notes • In FileMaker WebDirect, this function is not supported and returns 32.
Get functions Get(ScreenHeight) Purpose Returns the height, in points, of the screen in which the window of the current file is open. Format Get(ScreenHeight) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description When the window spans more than one screen, this function uses the screen that contains the largest percentage of the window.
Get functions Get(ScreenWidth) Purpose Returns the width, in points, of the screen in which the window of the current file is open. Format Get(ScreenWidth) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description When the window spans more than one screen, this function uses the screen that contains the largest percentage of the window.
Get functions Get(ScriptAnimationState) Purpose Indicates whether or not animations are enabled for the current script. Format Get(ScriptAnimationState) Parameters None Data type returned number Originated in FileMaker Pro 13.0 Description Returns 0 if animations are disabled for the current script. Returns 1 if animations are enabled for the current script. Animations are off by default while a script is running. Note In FileMaker WebDirect, this function is not supported and returns an empty string.
Get functions Get(ScriptName) Purpose Returns the name of the script currently running (or paused). Format Get(ScriptName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com. Examples Returns Print Report when the Print Report script is running.
Get functions Get(ScriptParameter) Purpose Returns the script parameter passed into the current script. Format Get(ScriptParameter) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description Use this function as part of a calculation evaluated within a script. Note For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com.
Get functions Get(ScriptResult) Purpose Returns the script result from a performed subscript. Format Get(ScriptResult) Parameters None Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 8.0 Description Use this function as part of a calculation evaluated within a script. If a subscript doesn’t return a result, then the content of the script result will be empty.
Get functions Get(SortState) Purpose Returns a value representing the current sort state. Format Get(SortState) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Returns: • 0 if the records in the active table are not sorted • 1 if the records in the active table are sorted • 2 if the records in the active table are partially sorted (semi-sorted) Each window has its own sort state.
Get functions Get(StatusAreaState) Purpose Returns a number indicating the current status toolbar state. Format Get(StatusAreaState) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(SystemDrive) Purpose Returns the drive letter (Windows) or volume name (OS X) where the currently running operating system is located. Format Get(SystemDrive) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description In FileMaker WebDirect, this function is not supported and returns an empty string. Note For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.
Get functions Get(SystemIPAddress) Purpose Returns a list of the IP addresses of all computers connected to an active NIC (Network Interface Controller) card. Format Get(SystemIPAddress) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description IP addresses are separated by carriage returns. In FileMaker WebDirect, Get(SystemIPAddress) returns the IP address of the interface used to connect to the host.
Get functions Get(SystemLanguage) Purpose Returns the language currently set on the current system. Format Get(SystemLanguage) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Get(SystemLanguage) is evaluated on the system preference that is set for Region on the Formats tab. The text that is returned is in the English language. For hosted databases, Get(SystemLanguage) returns the client’s current system language.
Get functions Get(SystemNICAddress) Purpose Returns a list of the hardware addresses of all NIC (Network Interface Controller) cards connected to the computer. Format Get(SystemNICAddress) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description Values in the list returned by this function are separated by carriage returns. The address consists of 6 bytes displayed in hexadecimal separated by colons.
Get functions Get(SystemPlatform) Purpose Returns a number indicating the current platform. Format Get(SystemPlatform) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(SystemVersion) Purpose Returns the version of the current operating system. Format Get(SystemVersion) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Returns: • 6.1 for Windows 7 • 6.2 for Windows 8 • 10.7 for OS X version 10.7 • 10.8 for OS X version 10.
Get functions Note For information on how functions evaluate differently on the host versus the client, search the FileMaker Knowledge Base available at http://help.filemaker.com. Examples Returns 10.8 when the current operating system is OS X version 10.8. Returns iPad Safari 6.0 for an iPad using FileMaker WebDirect in Safari version 6.0. Returns Win Chrome 25 for a Windows computer using FileMaker WebDirect in Chrome version 25.
Get functions Get(TemporaryPath) Purpose Returns the path to the temporary folder that FileMaker Pro uses for the current user, or the path that FileMaker Server uses on the system. Format Get(TemporaryPath) Parameters None Data type returned text Originated in FileMaker Pro 9.0 Description The temporary folder name begins with S, followed by a number representing the session of the database engine during which the operation took place.
Get functions In OS X, returns: //private/var/folders/<2 characters>/<20 characters>++++TI/Cleanup at Startup/S/ where DriveName is the name of your hard disk. S is the name of the folder in which the temporary files are placed (for example, S1); is a number representing the database engine session during which the operation took place. The location may vary due to different variables on the OS, but should follow a similar pattern.
Get functions Get(TextRulerVisible) Purpose Returns a Boolean value representing whether or not the text ruler is visible. Format Get(TextRulerVisible) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Description Returns 1 if the text ruler is displayed; otherwise, returns 0. Notes • In FileMaker WebDirect, this function is not supported and returns 0.
Get functions Get(TotalRecordCount) Purpose Returns the total number of records in the current table. Format Get(TotalRecordCount) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description If the current calculation is stored and you specify its context, this function will be evaluated based on that context; otherwise, it will be evaluated based on the context of the current window.
Get functions Get(TriggerCurrentPanel) Purpose Returns the index and the object name of the current tab panel or slide panel (the panel to be switched from) when the OnPanelSwitch script trigger is activated. Format Get(TriggerCurrentPanel) Parameters None Data type returned text Originated in FileMaker Pro 12.0 Description Use with the Get(TriggerTargetPanel) function.
Get functions Get(TriggerGestureInfo) Purpose In FileMaker Go, returns details about the gesture that activated an OnGestureTap trigger. Format Get(TriggerGestureInfo) Parameters None Data type returned text Originated in FileMaker Pro 13.
Get functions Get(TriggerKeystroke) Purpose Returns a string containing the characters that activated an OnObjectKeystroke or OnLayoutKeystroke script trigger. Multiple characters may be returned when the input comes from an input method editor (IME). Format Get(TriggerKeystroke) Parameters None Data type returned text Originated in FileMaker Pro 10.
Get functions Get(TriggerModifierKeys) Purpose Returns the state of the keyboard modifier keys as they were when a script trigger was activated. Format Get(TriggerModifierKeys) Parameters None Data type returned number Originated in FileMaker Pro 10.0 Description Returns a value only when called from a script activated by a script trigger or from a sub-script called from the triggered script; otherwise returns an empty string.
Get functions Get(TriggerModifierKeys) returns 9, regardless of which modifier keys have been pressed between when the trigger was activated and when the script runs.
Get functions Get(TriggerTargetPanel) Purpose Returns the index and the object name of the target tab panel or slide panel (the panel to be switched to) when the OnPanelSwitch script trigger is activated. Format Get(TriggerTargetPanel) Parameters None Data type returned text Originated in FileMaker Pro 12.0 Description Use with the Get(TriggerCurrentPanel) function.
Get functions Get(UserCount) Purpose Returns the number of clients currently accessing the file. Format Get(UserCount) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Returns: • 1 if FileMaker network sharing is turned off • 1 + the number of clients if FileMaker network sharing is turned on This function does not count clients accessing the database file via ODBC or JDBC.
Get functions Get(UserName) Purpose Returns the name of the FileMaker Pro user, as specified in the General tab of the Preferences dialog box. Format Get(UserName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description The returned name is user-specified. Important For greater security, use Get(AccountName) to track and manage user access: a user cannot change the account name used to log in to a database file.
Get functions Get(UseSystemFormatsState) Purpose Returns a Boolean value representing the state of the Use System Formats command in the Format menu. Format Get(UseSystemFormatsState) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Description Returns 1 if Use System Formats is on; otherwise, returns 0. Notes • In FileMaker WebDirect, this function is not supported and returns 0.
Get functions Get(UUID) Purpose Returns text representing a Universally Unique Identifier (UUID). Format Get(UUID) Parameters None Data type returned text Originated in FileMaker Pro 12.0 Description Returns a unique 16-byte (128-bit) string. For example, you can use this function to generate a unique ID of a record. For unstored calculations, returns a new string each time Get(UUID) is evaluated.
Get functions Get(WindowContentHeight) Purpose Returns the height, in points, of the FileMaker Pro content area. Format Get(WindowContentHeight) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The content area depends on the current size of the active window but doesn’t include the title bar, scroll bars, zoom controls, and page margins. The content area is the space inside these controls. It does not include the status toolbar if it is currently showing.
Get functions Get(WindowContentWidth) Purpose Returns the width, in points, of the FileMaker Pro content area. Format Get(WindowContentWidth) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The content area depends on the current size of the active window but doesn’t include the title bar, scroll bars, zoom controls, or page margins. The content area is the space inside these controls.
Get functions Get(WindowDesktopHeight) Purpose Returns the height, in points, of the desktop space. Format Get(WindowDesktopHeight) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description In Windows, the desktop space is the area inside the MDI window (sometimes referred to as the client area). This doesn’t include any virtual space available through the scrolling of the MDI window.
Get functions Get(WindowDesktopWidth) Purpose Returns the width, in points, of the desktop space. Format Get(WindowDesktopWidth) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description In Windows, the desktop space is the space inside the MDI window (sometimes referred to as the client area). In OS X, the desktop space is the area on the monitor in which the active window is located excluding menu bars.
Get functions Get(WindowHeight) Purpose Returns the height, in points, of the window on which the script is acting (not necessarily the foreground window). Format Get(WindowHeight) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The height of the window is calculated from the top to bottom outer edges of the window. This position doesn’t include shadows or other effects applied to windows.
Get functions Get(WindowLeft) Purpose Returns the horizontal distance, in points, of the outer edge of the window on which the script is acting (not necessarily the foreground window) relative to the left-most edge of the screen. Format Get(WindowLeft) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The origin of the reference coordinate system is at the left-most corner below the menu bar.
Get functions Get(WindowMode) Purpose Returns a number representing the mode FileMaker Pro is in at the time the function is evaluated. Format Get(WindowMode) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(WindowName) Purpose Returns the name of the window on which the script is acting (not necessarily the foreground window). Format Get(WindowName) Parameters None Data type returned text Originated in FileMaker Pro 7.0 Description Returns an empty string if there is no window. Notes • You can set the window name with the Set Window Title script step.
Get functions Get(WindowOrientation) Purpose Returns a value indicating the orientation of the window on which the script is acting (not necessarily the foreground window). Format Get(WindowOrientation) Parameters None Data type returned number Originated in FileMaker Pro 13.
Get functions Get(WindowStyle) Purpose Returns the style of the window on which the script is acting. Format Get(WindowStyle) Parameters None Data type returned number Originated in FileMaker Pro 12.0 Description Returns: • 0 (zero) if the window is a document window • 1 if the window is a floating document window • 2 if the window is a dialog window Examples Returns 0 if the current window is a document window when the function is evaluated.
Get functions Get(WindowTop) Purpose Returns the vertical distance, in points, of the outer edge of the window on which the script is acting (not necessarily the foreground window) relative to the bottom edge of the menu bar. Format Get(WindowTop) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The origin of the reference coordinate system is at the left-most corner below the menu bar.
Get functions Get(WindowVisible) Purpose Returns a number representing whether or not the current window is visible. Format Get(WindowVisible) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The current window is the window on which the script is acting (not necessarily the foreground window). Returns 1 if the window is visible. Returns 0 if the window is hidden using the Hide Window command.
Get functions Get(WindowWidth) Purpose Returns the width, in points, of the window on which the script is acting (not necessarily the foreground window). Format Get(WindowWidth) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The width of the window is calculated from the left-most to right-most outer edge of the window. This position doesn’t include shadows or other effects applied to windows.
Get functions Get(WindowZoomLevel) Purpose Returns the zoom percentage of the current window. Format Get(WindowZoomLevel) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description In Windows, an asterisk appears next to the zoom percentage when Enlarge window contents to improve readability is selected in the General tab of the Preferences dialog box. Notes • In FileMaker WebDirect, this function is not supported and returns 100.
Logical functions Logical functions Logical functions test for a condition to evaluate it as true or false. This is known as a Boolean value. If the condition is true, FileMaker Pro returns a 1; if the condition is false, FileMaker Pro returns a 0. You can use the keywords True and False with logical functions and operators when a Boolean value is needed. Keyword True returns 1 and keyword False returns 0.
Logical functions Case Purpose Returns one of several possible results based on a series of tests. Format Case(test1;result1{;test2;result2;...;defaultResult}) Parameters test - any text or numeric expression. result - result corresponding to the expression. Parameters in curly braces { } are optional. Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 6.
Logical functions Choose Purpose Returns one result value, according to the integer value of test. Format Choose(test;result0{;result1;result2...}) Parameters test - Any integer calculation. The calculation result of test must be a number that indexes into the list that follows. Because the index is a 0-based index, the test result must be 0 to access the first result. result - one or more results. Parameters in curly braces { } are optional.
Logical functions Evaluate Purpose Evaluates expression as a calculation. Format Evaluate(expression{;[field1;field2;field3;...]}) Parameters expression - any text expression or text field. fields - a list of fields that this function is dependent on. When these fields are modified, the calculation will update its result. Parameters in curly braces { } are optional. Notice that the optional field list is enclosed in square brackets [ ].
Logical functions The following example shows how to pass named parameters, while keeping the ability to check the syntax of the second parameter of the Let function (the example returns 6, 12): ScriptParameter = "a = 5; b = 10" Let( [a = Evaluate("Let( [" & Get(ScriptParameter) & "]; a )"), b = Evaluate("Let( [" & Get(ScriptParameter) & "]; b )")]; a + 1 & ", " & b + 2 ) Note The Evaluate function evaluates an expression, including field values to be evaluated as a calculation formula.
Logical functions EvaluationError Purpose Returns an error code, if any, from expression. Format EvaluationError(expression) Parameters expression - any calculation expression Data type returned number Originated in FileMaker Pro 7.0 Description There are two types of errors: syntax and runtime. A syntax error indicates an invalid calculation. A runtime error, such as Field missing or Record missing, occurs when the calculation currently being run is valid but cannot properly execute.
Logical functions ExecuteSQL Purpose Executes an SQL query statement for the specified table occurrence within a FileMaker Pro database. Format ExecuteSQL(sqlQuery; fieldSeparator; rowSeparator {;arguments...}) Parameters sqlQuery - an SQL SELECT statement. The statement can include a Union clause that combines the results of two queries. The statement can contain programmatically generated SQL (dynamic parameters) that indicate where optional arguments are to be used in the query.
Logical functions • ExecuteSQL accepts only the SQL-92 syntax ISO date and time formats with no braces. ExecuteSQL does not accept the ODBC/JDBC format date, time, and timestamp constants in braces. • For more details about SELECT statement syntax, supported SQL statements, expressions, and Catalog functions, see the FILEMAKER ODBC AND JDBC GUIDE and the FILEMAKER SQL REFERENCE. Examples Suppose a database contains two tables, Employees and Salaries, which are related through the EmpID field.
Logical functions GetAsBoolean Purpose Returns 1 if data converts to a non-zero numeric value or if a container field contains data; returns 0 if data has a numeric value of 0 or is empty. Format GetAsBoolean(data) Parameters data - any text, number, date, time, timestamp or container expression, or a field containing text, a number, date, time, timestamp or container Data type returned number Originated in FileMaker Pro 8.0 Description Returns a Boolean value. Examples GetAsBoolean(“”) returns 0.
Logical functions GetField Purpose Returns the contents of fieldName. Format GetField(fieldName) Parameters fieldName - any text expression or text field that refers to a field’s name Important See Design functions for information about literal text parameters. Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 6.
Logical functions GetFieldName Purpose Returns the fully qualified name of a field reference. Format GetFieldName(fieldName) Parameters fieldName - any field object or evaluation of a text expression that refers to a field’s name Data type returned text Originated in FileMaker Pro 10.0 Description Use this function to get the fully qualified name of fieldName (tableName::fieldName). Note If you specify the context for the current calculation, this function will be evaluated based on that context.
Logical functions GetLayoutObjectAttribute Purpose Returns the specified attributes of the layout object given by objectName that is currently active in the calculation. Format GetLayoutObjectAttribute(objectName;attributeName{;repetitionNumber; portalRowNumber}) Parameters objectName - the name of a named layout object on the current layout. attributeName - the name of a supported attribute (see below). repetitionNumber - the repetition number (for repeating fields).
Logical functions height - returns a number representing the height (in points) of the specified object. rotation - returns a number representing the rotation (in degrees) of the specified object. startPoint,endPoint - returns a pair of numeric values (horizontal vertical), separated by spaces, that represent the start point or end point of a line object. Other objects return the top-left point for startPoint and the bottom-right point for endPoint.
Logical functions Examples GetLayoutObjectAttribute("CancelButton";"objectType") returns button (if the button was created in a new file or a file after it was converted), returns button group (if the button is associated with a button action or script and was converted in a file from a previous version of FileMaker Pro), or returns text (if the button isn’t associated with a button action or script and was converted in a file from a previous version of FileMaker Pro).
Logical functions GetNthRecord Purpose Returns the contents of fieldName from the provided recordNumber. Format GetNthRecord(fieldName;recordNumber) Parameters fieldName - any related field or repeating field, or an expression that returns a field or a repeating field recordNumber - the record number from which you want data Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 8.
Logical functions If Purpose Returns one of two possible results (result1 or result2) depending on the value of test. Format If(test;result1;result2) Parameters test - any numeric value or logical expression result1 - expression or field name result2 - expression or field name Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 6.0 or earlier Description If test is True (any non-zero numeric result), FileMaker Pro returns result1.
Logical functions IsEmpty Purpose Returns True(1) if field is empty, if a related field, related table, relationship, or file is missing, or if some other error occurs; otherwise, returns False(0). Format IsEmpty(field) Parameters field - any field name, text expression, or numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples IsEmpty(OrderNum) returns 1 if the OrderNum field is empty.
Logical functions IsValid Purpose Returns 0 (False) if the data is invalid and 1 (True) if the data is valid. Format IsValid(field) Parameters field - any field name Data type returned number Originated in FileMaker Pro 6.
Logical functions IsValidExpression Purpose Returns 1 (True) if expression syntax is correct. Returns 0 (False) if expression has a syntax error. Format IsValidExpression(expression) Parameters expression - any calculation expression Data type returned number Originated in FileMaker Pro 7.0 Examples IsValidExpression(calculationField) returns 1 (true) if calculationField contains total + 1.
Logical functions Let Purpose Sets varX to the result of expressionX for the duration of calculation, until the script exits (local variables), or until the file is closed (global variables). Format Let({[}var1=expression1{;var2=expression2...]};calculation) Parameters var - any variable name, local variable name, or global variable name (see About naming fields for guidelines on naming variables). expression - any calculation expression, field, or constant.
Logical functions Let(City=“Paris”;Let(City=“San Francisco”;City&“-“)&City) returns San Francisco - Paris. The following example sets a local variable counter at repetition 50 with a value of 120: Let($counter[50]=120;$counter[50]*2) returns 240.
Logical functions Lookup Purpose Returns the value specified in sourceField using the relationships in the relationships graph. The result of the optional failExpression will be returned if the lookup fails. Format Lookup(sourceField{;failExpression}) Parameters sourceField - the field from which the lookup value is taken. failExpression - any expression. Parameters in curly braces { } are optional. Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 7.
Logical functions The People and Company tables are related using the number field CompanyID. The calculation CompanyName = Lookup(Company::CompanyName;“Not found”) defined in the People table will return Apple for the first record, FileMaker for the second record, and Not found for the third record.
Logical functions LookupNext Purpose Returns the next lower or higher value in sourcefield when there isn’t a matching related value.
Logical functions Rate Code Maximum Weight A 25 B 50 C 100 D 150 The two tables are related by Weight and Max Weight. The calculation field Rate Lookup is defined as Rate Lookup = LookupNext(Shipping Costs::Max Weight; Higher). The Rate Lookup calculation field will return 25, 25, 100, and 150 for records 1 to 4. Rate Lookup can then be used to get the correct rate code (A, A, C, and D respectively).
Logical functions Self Purpose Returns the content of the object in which the calculation is defined. Format Self Parameters None Data type returned text, number, date, time, timestamp Originated in FileMaker Pro 9.0 Description The Self function provides a way for a calculation to reference the object with which it is associated without having to explicitly reference the object. Use Self to create a single calculation formula that can be applied to different objects.
Mobile functions Mobile functions Mobile functions are used with FileMaker Go. Click a function name for details. This function Returns Location The current latitude and longitude of an iOS device running FileMaker Go and the horizontal accuracy of the values returned. LocationValues The current latitude, longitude, and altitude of an iOS device running FileMaker Go; the horizontal and vertical accuracy of the values returned; and the number of minutes since the values were returned.
Mobile functions Location Purpose Returns the current latitude and longitude on an iOS device running FileMaker Go. Also returns the horizontal accuracy of the values returned. The location is obtained via GPS, cellular network, or WiFi. Format Location (accuracy {; timeout}) Parameters accuracy - any numeric expression or field containing a number that represents a distance in meters.
Mobile functions LocationValues Purpose Returns the current latitude, longitude, and altitude on an iOS device running FileMaker Go. Returns the horizontal and vertical accuracy of the values returned and the number of minutes since the values were returned. The location is obtained via GPS, cellular network, or Wi-Fi. Format LocationValues (accuracy {; timeout}) Parameters accuracy - any numeric expression or field containing a number that represents a distance in meters.
Number functions Number functions Number functions are used to manipulate numeric data. Click a function name for details. This function Returns Abs The absolute value (a positive number) of a number. Ceiling A number rounded up to the next integer. Combination The number of ways to uniquely choose a specified number of items from a set of specified size. Div An integer of the specified number divided by the divisor. Exp The value of the constant e (the base of the natural logarithm, equal to 2.
Number functions Abs Purpose Returns the absolute value of number. Format Abs(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number, time Originated in FileMaker Pro 6.0 or earlier Description The absolute value of a number is positive. For example, if a negative number appears in a field, the Abs function removes the minus sign and changes it to a positive value. Examples Abs(-123) returns 123.
Number functions Ceiling Purpose Returns number rounded up to the next integer. Format Ceiling(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 7.0 Examples Ceiling(1.25) returns 2. Ceiling(-1.25) returns -1.
Number functions Combination Purpose Returns the number of ways to uniquely choose numberOfChoices items from a set of size setSize. Format Combination(setSize;numberOfChoices) Parameters setSize - any numeric expression or field containing a non-negative numeric expression numberOfChoices - any numeric expression or field containing a non-negative numeric expression Data type returned number Originated in FileMaker Pro 7.
Number functions Div Purpose Returns the next lowest integer value after dividing number by divisor. Equivalent to Floor(number/divisor). Format Div(number;divisor) Parameters number - any numeric expression or field containing a numeric expression divisor - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 7.0 Examples Div(2.5;2) returns 1. Div(-2.5;2) returns -2.
Number functions Exp Purpose Returns the value of the constant e (the base of the natural logarithm, equal to 2.7182818) raised to the power of number. Format Exp(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The Exp function is the inverse of the Ln function. Examples Exp(1) returns 2.71828182.... Exp(Ln(2)) returns 2. Exp(0) returns 1.
Number functions Factorial Purpose Returns the factorial of number stopping at 1 or stopping at the optional numberOfFactors. Format Factorial(number{;numberOfFactors}) Parameters number - numeric expression or field containing a positive integer. numberOfFactors - any numeric expression or field containing a number that represents how many factors to include in the multiplication. Parameters in curly braces { } are optional. Data type returned number Originated in FileMaker Pro 7.
Number functions Floor Purpose Returns number rounded down to the next lower integer. Format Floor(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 7.0 Examples Floor(1.25) returns 1. Floor(-1.25) returns -2.
Number functions Int Purpose Drops digits to the right of the decimal point and returns the integer part of number without rounding. Format Int(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Int(1.45) returns 1. Int(-3.9) returns -3. Int(123.9) returns 123. Int(Players/3) returns 4, if Players contains 13.
Number functions Lg Purpose Returns the base-2 logarithm of number. Format Lg(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 7.0 Description Number can be any positive value. Negative values return an error. For 0, the Lg function returns nothing because this value is out of the acceptable range.
Number functions Ln Purpose Returns the base-e (natural) logarithm of number. Format Ln(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Number can be any positive value. Negative values and 0 return an error. The Exp function is the inverse of the Ln function. Examples Ln(2.7182818) returns .99999998.... Ln(Exp(5)) returns 5.
Number functions Log Purpose Returns the base-10 (common) logarithm of number. Format Log(number) Parameters number - any positive numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Number can be any positive value. Negative values return an error. For 0, the Log function returns nothing because this value is out of the acceptable range.
Number functions Mod Purpose Returns the remainder after number is divided by divisor. Format Mod(number;divisor) Parameters number - any numeric expression or field containing a numeric expression divisor - numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use the Mod function to test whether a number is even or odd by specifying a divisor of 2.
Number functions Random Purpose Returns a number between zero and one, including zero, but not including one. Format Random Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Returns a pseudo-random number in the range (0,1).
Number functions Round Purpose Returns number rounded off to the specified precision (number of decimal places). Format Round(number;precision) Parameters number - any numeric expression or field containing a numeric expression precision - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.
Number functions SetPrecision Purpose Computes any math function with a precision of 16 to 400 digits to the right of the decimal point. Format SetPrecision(expression;precision) Parameters expression - any numeric expression precision - any number or numeric expression Data type returned number Originated in FileMaker Pro 7.0 Description All functions except trigonometric functions support extended precision. This function doesn’t perform a truncation. Examples SetPrecision(5/9;30) returns 0.
Number functions Sign Purpose Returns one of three possible values: -1 when number is negative, 0 when it’s zero, and 1 when it’s positive. Format Sign(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Sign(15.12) returns 1. Sign(-175) returns -1. Sign(BalanceDue) returns 0, if BalanceDue is a number field containing 0.
Number functions Sqrt Purpose Calculates the square root of number. Format Sqrt(number) Parameters number - any positive number, numeric expression, or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use this function to calculate Sqrt. Sqrt = number Examples Sqrt(4) returns 2. Sqrt(SquareFeet) returns 6 if the SquareFeet number field contains 36.
Number functions Truncate Purpose Returns number truncated to the specified precision (number of decimal places). Format Truncate(number;precision) Parameters number - any numeric expression or field containing a numeric expression precision - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description This function doesn’t evaluate digits beyond the specified precision.
Repeating functions Repeating functions Repeating functions perform calculations on repeating fields. Click a function name for details. This function Returns Extend In a calculation involving both repeating and non-repeating fields, allows a value in a non-repeating field to be used with every repetition in a repeating field. GetRepetition The contents of the specified repetition of a repeating field. Last The last valid, non-blank value in the specified field.
Repeating functions Extend Purpose Allows a value in non-repeatingField to be used with every repetition in a repeating field. Format Extend(non-repeatingField) Parameters non-repeatingField - any non-repeating field (a field defined to contain only one value), or an expression that returns a reference to one Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 6.
Repeating functions GetRepetition Purpose Returns the contents of the repeating field specified by number. Format GetRepetition(repeatingField;number) Parameters repeatingField - any repeating field, or an expression that returns a reference to a repeating field number - the field repetition number Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 6.
Repeating functions Last Purpose Returns the last valid, non-blank value in field. Format Last(field) Parameters field - any repeating field or related field, or an expression that returns a reference to a repeating field or related field Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 6.0 or earlier Description If field specifies a repeating field then it returns the last non-blank repetition.
Summary functions Summary functions Summary functions produce a summary of all records in the found set, or subsummary values for records in different groups. Formulas can contain more than one summary function. Summary functions calculate more slowly than other functions because they generate values for a range of records. An alternative way to generate similar calculated results is to use Aggregate functions to summarize data in related records (whether or not they appear in a portal).
Summary functions GetSummary Purpose Returns the value of summaryField for the current range of records when the database file is sorted by breakField. Format GetSummary(summaryField;breakField) Parameters summaryField - field of type summary, or an expression that returns a reference to one. breakField - field, or an expression that returns a reference to one. To calculate a grand summary value, use the same summary field for both the summary field and the break field parameters.
Summary functions If(ThisCharge > 3 * GetSummary(AvgCharge;Customer), “Verify this charge”, “ “) displays Verify this charge if the current charge is greater than three times the average charge.
Text functions Text functions Text functions can be used to analyze, rearrange, extract, and build text strings. For example, you could use the MiddleWords function to extract specific words from supplied text. Text functions operate on these parameters: • fields of type text • text constants (in quotation marks) • expressions having a text result Click a function name for details. This function Returns Char Returns the characters for the Unicode code points in the number.
Text functions This function Returns Length The number of characters in the specified text, including all spaces, numbers, and special characters. Lower All letters in the specified text as lowercase. Middle The specified number of characters in the text, starting at a specified character position. MiddleValues The specified number of values in the text, starting with a specified value. MiddleWords The specified number of words in the text, starting with a specified word.
Text functions Char Purpose Returns the characters for the Unicode code points in the number. Format Char(number) Parameters number - a decimal number representing one or more Unicode code points Data type returned text Originated in FileMaker Pro 10.0 Description Each group of five digits in the number is treated as a Unicode code point, and the character for each five-digit group is returned in the text. If the number is 0, the function returns an empty string.
Text functions Code Purpose Returns the Unicode code points for the characters in the text. Format Code(text) Parameters text - one or more characters Data type returned number Originated in FileMaker Pro 10.0 Description Returns the Unicode code points for the characters in text. If zero characters are in text, returns an empty string. If one character is in the text, the function returns the code point for that character.
Text functions Key Pressed Is reported as Notes forward delete 127 Corresponds to Unicode/ASCII code for Delete Note If there are too many characters to be represented in the FileMaker number field type, the function returns a NaN (Not a Number) value. Examples Code(“”) returns an empty string. Code(“a”) returns 97. Code(“b”) returns 98. Code(“ab”) returns 9800097. Code(“ä”) returns 228. Code(“ä”)(an a followed by a dieresis character entered in a separate keystroke) returns 77600097.
Text functions Exact Purpose Compares the contents of any two fields. If the fields match, the result is 1 (True); otherwise, the result is 0 (False). Format Exact(originalText;comparisonText) Parameters originalText - any text expression, text field, or container field comparisonText - any text expression, text field, or container field Data type returned number Originated in FileMaker Pro 6.0 or earlier Description For text to match exactly, the uppercase and lowercase usage must be the same.
Text functions Filter Purpose Returns from textToFilter only those characters specified in filterText, in the order they were originally entered in textToFilter. Format Filter(textToFilter;filterText) Parameters textToFilter - any text expression or text field filterText - the characters to preserve in the specified text Data type returned text Originated in FileMaker Pro 7.0 Description If filterText doesn’t have any characters, an empty string is returned. The Filter function is case-sensitive.
Text functions FilterValues Purpose Returns a text result containing only the values that were provided in filterValues, in the order they were originally entered in textToFilter. Format FilterValues(textToFilter; filterValues) Parameters textToFilter - any text expression or text field filterValues - values that you want to preserve in the specified text Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 7.
Text functions GetAsCSS Purpose Returns text converted to the CSS (Cascading Style Sheets) format. Format GetAsCSS(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 7.0 Description CSS format is an internet text format similar to HTML. CSS supports more text formats than HTML, so CSS will represent what you have typed more accurately. Note The GetAsCSS function does not return formats that are set in the Conditional Formatting dialog box.
Text functions GetAsDate Purpose Returns dates in text as field type date, for use in formulas involving dates or date functions. Format GetAsDate(text) Parameters text - any text expression or text field containing text in the same format as the date on the system where the file was created Data type returned date Originated in FileMaker Pro 6.0 or earlier Description Use the GetAsDate or Date function to enter a date constant into a formula.
Text functions GetAsNumber Purpose Returns only the numbers in text, as field type number, for use with formulas involving numbers or numeric functions. Format GetAsNumber(text) Parameters text - any text expression or text field containing numbers Data type returned number Originated in FileMaker Pro 6.0 or earlier Description This function drops all non-numeric characters from text. If zero numeric characters are in text, returns an empty string.
Text functions GetAsSVG Purpose Returns text converted to the SVG (Scalable Vector Graphics) format. Format GetAsSVG(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 7.0 Description SVG is an internet text format similar to HTML or CSS. SVG supports more text formats than HTML, so SVG will represent what you have typed more accurately. Note The GetAsSVG function does not return formats that are set in the Conditional Formatting dialog box.
Text functions GetAsText Purpose Returns data as field type text, for use with formulas involving text or text functions. Format GetAsText(data) Parameters data - any number, date, time or timestamp expression, or a field containing a number, date, time, timestamp, or container Data type returned text Originated in FileMaker Pro 6.0 or earlier Description The data returned can be a field type number, date, time, timestamp, or container.
Text functions GetAsTime Purpose Returns times or timestamps in text as field type time, for use with formulas involving the Time or Timestamp functions. Format GetAsTime(text) Parameters text - any text expression or text field containing a time Data type returned time Originated in FileMaker Pro 6.0 or earlier Description Use the GetAsTime or the Time function to enter a time constant into a formula.
Text functions GetAsTimestamp Purpose Returns text as field type timestamp, for use with formulas involving timestamps. Format GetAsTimestamp(text) Parameters text - any text expression, or text, number, date, or time field Data type returned timestamp Originated in FileMaker Pro 7.0 Description Text strings must be in the form of a date followed by a time. A number is considered to be the number of seconds since 1/1/0001. There are 86400 seconds in each day.
Text functions GetAsURLEncoded Purpose Returns text as URL (Uniform Resource Locator) encoding, for use as a URL. Format GetAsURLEncoded(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 8.5 Description This function removes all styles from text. All characters are first converted to UTF-8 format.
Text functions GetValue Purpose Returns the requested value given by valueNumber from listOfValues. Format GetValue(listOfValues;valueNumber) Parameters listOfValues - a list of carriage return-delimited values valueNumber - the value to return from the list Data type returned text Originated in FileMaker Pro 8.0 Description This function is useful in looping scripts or recursive custom calculations. Values are text items separated by carriage returns.
Text functions Hiragana Purpose Converts Katakana (Hankaku and Zenkaku) in text to Hiragana. Format Hiragana(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.
Text functions KanaHankaku Purpose Converts Zenkaku Katakana to Hankaku Katakana. Format KanaHankaku(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.
Text functions KanaZenkaku Purpose Converts Hankaku Katakana to Zenkaku Katakana. Format KanaZenkaku(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.
Text functions KanjiNumeral Purpose Converts Arabic numerals to Kanji numeral. Format KanjiNumeral(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.
Text functions Katakana Purpose Converts from Hiragana to Zenkaku Katakana. Format Katakana(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.
Text functions Left Purpose Returns numberOfCharacters in text, counting from the left. Format Left(text;numberOfCharacters) Parameters text - any text expression or text field numberOfCharacters - any numeric expression or field containing a number Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples Left(“Manufacturing”;4) returns Manu. Left(Name;Position(Name;“ “;1;1)) returns Sophie, when the Name field contains Sophie Tang.
Text functions LeftValues Purpose Returns a text result containing numberOfValues from the list of values in text, counting from the left. Format LeftValues(text;numberOfValues) Parameters text - any text expression or text field numberOfValues - any numeric expression or field containing a number Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 7.0 Description Values are text items separated by carriage returns.
Text functions LeftWords Purpose Returns a text result containing numberOfWords in text, counting from the left. Format LeftWords(text;numberOfWords) Parameters text - any text expression or text field numberOfWords - any numeric expression or field containing a number Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples LeftWords(“Plaid Canvas Suitcase”;2) returns Plaid Canvas. LeftWords(Name;1) returns Sophie, when the Name field contains Sophie Tang.
Text functions Length Purpose Returns the number of characters in field, including all spaces, numbers, and special characters. Format Length(field) Parameters field - any text, number, date, time, timestamp, or container field, or any text expression or numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description This function returns the number of characters in a specified field. For a container field, Length returns the size of the original file in bytes.
Text functions Lower Purpose Returns all letters in text as lowercase. Format Lower(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.0 or earlier Note To change how a field displays without modifying its contents, see Text formatting functions. Examples Lower(“ABCD”) returns abcd. Lower(Course) returns history, when the Course field contains History. Lower(“YOUR BILL IS OVERDUE”) returns your bill is overdue.
Text functions Middle Purpose Extracts the numberOfCharacters from text, starting at the character position specified by start. Format Middle(text;start;numberOfCharacters) Parameters text - any text expression or text field start - any numeric expression or field containing a number numberOfCharacters - any numeric expression or field containing a number Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples Middle(“(408)555-9054”;2;3) returns 408.
Text functions MiddleValues Purpose Returns a text result containing the specified numberOfValues in text, starting with startingValue. Format MiddleValues(text;startingValue;numberOfValues) Parameters text - any text expression or text field startingValue - any numeric expression or field containing a number numberOfValues - any numeric expression or field containing a number Important See Design functions for information about literal text parameters.
Text functions MiddleWords Purpose Returns a text result containing the numberOfWords from text, beginning at startingWord. Format MiddleWords(text;startingWord;numberOfWords) Parameters text - any text expression or text field startingWord - any numeric expression or field containing a number numberOfWords - any numeric expression or field containing a number Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples MiddleWords(“Plaid Canvas Suitcase”;2;2) returns Canvas Suitcase.
Text functions NumToJText Purpose Converts Roman numbers in number to Japanese text. Format NumToJText(number;separator;characterType) Parameters number - any numeric expression or field containing a number separator - a number from 0 - 3 representing a separator characterType - a number from 0 - 3 representing a type Data type returned text Originated in FileMaker Pro 6.0 or earlier Description If the value for separator and characterType are blank or other than 0 to 3, then 0 is used.
Text functions PatternCount Purpose Returns the number of occurrences of searchString in text. Format PatternCount(text;searchString) Parameters text - any text expression or text field searchString - any text expression or text field representing the set of characters you want to find Data type returned number Originated in FileMaker Pro 6.0 or earlier Description This function is not case-sensitive. Examples PatternCount(“Mississippi”;“is”) returns 2.
Text functions Position Purpose Returns the starting position of the specified occurrence of searchString in text. Format Position(text;searchString;start;occurrence) Parameters text - any text expression or text field searchString - any text expression or text field representing the set of characters you want to find. start - any numeric expression, or field containing a number, representing the number of characters from the start of the text string at which to begin the search.
Text functions Proper Purpose Returns the first letter of each word in text as uppercase and all other letters as lowercase. Format Proper(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples Proper(“ABCD”) returns Abcd. Proper(Name) returns Yumiko Kitagawa, when the Name field contains YUMIKO KITAGAWA.
Text functions Quote Purpose Returns the text form of text enclosed in quotation marks. Format Quote(text) Parameters text - any text expression or field Data type returned text Originated in FileMaker Pro 7.0 Description This function protects text from being evaluated by the Evaluate function. Special characters within text are escaped appropriately. Examples Quote(“hello”) returns “hello”. Quote(“abc\¶”) returns “abc\¶”. Quote(“say \”hello\” fred”) returns “say \”hello\” fred”.
Text functions Replace Purpose Replaces a string of characters in text with replacementText.
Text functions Right Purpose Returns the specified numberOfCharacters in text, counting from the right. Format Right(text;numberOfCharacters) Parameters text - any text expression or text field numberOfCharacters - any numeric expression or field containing a number Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples Right(“Manufacturing”;4) returns ring. Right(Name;Length(Name) - Position(Name;“ “;1;1)) returns Cannon, when the Name field contains Michelle Cannon.
Text functions RightValues Purpose Returns a text result containing the specified numberOfValues in text, counting from the right. Format RightValues(text;numberOfValues) Parameters text - any text expression or text field numberOfValues - any numeric expression or field containing a number Important See Design functions for information about literal text parameters. Data type returned text Originated in FileMaker Pro 7.0 Description Values are text items separated by carriage returns.
Text functions RightWords Purpose Returns a text result containing the numberOfWords in text, counting from the right. Format RightWords(text;numberOfWords) Parameters text - any text expression or text field numberOfWords - any numeric expression or field containing a number Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples RightWords(“Plaid Canvas Suitcase”;2) returns Canvas Suitcase. RightWords(Name;1) returns Virtanen, when the Name field contains Matti Virtanen.
Text functions RomanHankaku Purpose Converts from Zenkaku alphanumeric and symbols to Hankaku alphanumeric and symbols. Format RomanHankaku(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples RomanHankaku(“M a c i n t o s h”) returns Macintosh.
Text functions RomanZenkaku Purpose Converts from Hankaku alphanumeric and symbols to Zenkaku alphanumeric and symbols. Format RomanZenkaku(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples RomanZenkaku(“Macintosh”) returns M a c i n t o s h.
Text functions SerialIncrement Purpose Returns the combined text and numbers specified by text, with the numbers in text incremented by the specified amount. Format SerialIncrement(text;incrementBy) Parameters text - any text that also contains a number incrementBy - any numeric expression to increment the text by Data type returned text Originated in FileMaker Pro 7.
Text functions Substitute Purpose Returns a text string with every occurrence of searchString in text replaced by replaceString in text. Format Substitute(text;searchString;replaceString) Parameters text - any text expression or text field searchString - any text expression or text field replaceString - any text expression or text field Data type returned text Originated in FileMaker Pro 6.0 or earlier Description This function is case-sensitive. Compare to the Replace function.
Text functions Trim Purpose Returns text stripped of all leading and trailing spaces. Format Trim(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Use this function to remove unneeded spaces when you convert files from other programs or systems that require a fixed number of characters per field, or to remove spaces accidentally typed during data entry. Examples Trim(“ Tom ”) returns Tom.
Text functions TrimAll Purpose Returns a copy of text with specified spaces removed or inserted. Use to work with spaces between text or non-Roman spaces such as full- and half-width spaces; otherwise, use Trim. Format TrimAll(text;trimSpaces;trimType) Parameters text - any text expression or text field trimSpaces - 0 or False, 1 or True trimType - 0 through 3 depending on the trim style that you wish to use Data type returned text Originated in FileMaker Pro 6.
Text functions This trimType value Does this 1 Always includes a half-width space between non-Roman and Roman characters (always leave one space between Roman words). 2 Removes spaces between non-Roman characters (reduce multiple space between non-Roman and Roman words to 1 space; do not add spaces if there are none; always leave one space between Roman words). 3 Removes all spaces everywhere. In all cases, spaces between non-Roman characters are removed.
Text functions Upper Purpose Returns all letters in text as uppercase. Format Upper(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Use the Upper function to ensure consistent data entry of such things as state abbreviations or postal codes. Note To change how a field displays without modifying its contents, see Text formatting functions. Examples Upper(“Ca”) returns CA. Upper(“12n34p”) returns 12N34P.
Text functions ValueCount Purpose Returns a count of the total number of values in text. Format ValueCount(text) Parameters text - any text expression or text field Important See Design functions for information about literal text parameters. Data type returned number Originated in FileMaker Pro 7.0 Description Values are text items separated by carriage returns. You can place several items together to create a carriage-return-delimited list of values.
Text functions WordCount Purpose Returns a count of the total number of words in text. Format WordCount(text) Parameters text - any text expression or text field Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples WordCount(“The sun is rising.”) returns 4. WordCount(Letter) returns the total number of words in the Letter field. Note Characters such as the ampersand (&) and hyphen (-) can be used to identify the beginning of a new word.
Text formatting functions Text formatting functions Text formatting functions can be used to change the color, font, size, and style of the specified text. For example, you could use the TextFont function to change the font of the specified text from Arial to Courier. You can use these functions together to change the appearance of text on your layouts.
Text formatting functions RGB Purpose Returns an integer number from 0 to 16777215 obtained by combining the red, green, and blue values (each ranging from 0 to 255) to represent a color.
Text formatting functions TextColor Purpose Changes the color of text to the color specified by the RGB function. Format TextColor(text;RGB(red;green;blue)) Parameters text - any text expression or text field RGB(red;green;blue) - any integer from 0 to 16777215 obtained by combining the red, green, and blue values (each ranging from 0 to 255) to represent a color Data type returned text Originated in FileMaker Pro 7.0 Description Use this function to change the color of text.
Text formatting functions TextColorRemove Purpose Removes all font colors in text, or removes the font color specified by the RGB function. Format TextColorRemove(text{;RGB(red;green;blue)}) Parameters text - any text expression or text field. RGB(red;green;blue) - any integer number from 0 to 16777215 obtained by combining the red, green, and blue values (each ranging from 0 to 255) to represent a color. Parameters in curly braces { } are optional.
Text formatting functions TextFont Purpose Changes the font of text to the specified fontName or optional {fontScript}. Format TextFont(text;fontName{;fontScript}) Parameters text - any text expression or text field. fontName - any font name expressed in text. {fontScript} - the name of a character set that contains characters required for writing in the specified language. Parameters in curly braces { } are optional.
Text formatting functions Examples TextFont(“Plaid”;“Courier”) returns the word Plaid in the Courier font. TextFont(“Plaid”;“Arial”) returns the word Plaid in the Arial font. TextFont(“Plaid”;“Arial”;Cyrillic) returns the word Plaid in the Arial font in the font script of Cyrillic. TextSize( TextFont( TextColor( MyTable::MyText; RGB( 0 ; 125 ; 125 ) ); "Courier" ) ; 12) returns the text contained in MyTable::MyText formatted as 12pt. green text with the Courier font.
Text formatting functions TextFontRemove Purpose Removes all fonts in text, or removes the font specified by fontToRemove or the combination of fontToRemove and fontScript. Format TextFontRemove(text{;fontToRemove;fontScript}) Parameters text - any text expression or text field. fontToRemove - any font name expressed in text. fontScript - the name of a character set that contains characters required for writing in the specified language. Parameters in curly braces { } are optional.
Text formatting functions • TraditionalChinese • SimplifiedChinese • OEM • Symbol • Other Examples TextFontRemove(“Arial Text and Courier Text”) returns Arial Text and Courier Text displayed in the field’s default font. TextFontRemove(“Arial Text and Courier Text”;“Arial”) returns Arial Text and Courier Text with the Arial font removed from the words Arial Text for all fontScripts that use the Arial font.
Text formatting functions TextFormatRemove Purpose Removes all text formatting from text in a single action. Format TextFormatRemove(text) Parameters text - any text expression or text field Data type returned text Originated in FileMaker Pro 8.0 Description Use this function to remove all fonts, styles, font sizes, and font colors from the specified text. Examples TextFormatRemove(“Plaid”) returns the word Plaid without any text formatting applied.
Text formatting functions TextSize Purpose Changes the font size of text to fontSize. Format TextSize(text;fontSize) Parameters text - any text expression or text or number field fontSize - any font size expressed as an integer Data type returned text, number Originated in FileMaker Pro 7.0 Description The font size is described in points (72 points to the inch). Text formatting options will be lost if the data type that is returned is something other than text or number.
Text formatting functions TextSizeRemove Purpose Removes all font sizes in text, or removes the font size specified by sizeToRemove. Format TextSizeRemove(text{;sizeToRemove}) Parameters text - any text expression or text field. sizeToRemove - any font size expressed as an integer. Parameters in curly braces { } are optional. Data type returned text Originated in FileMaker Pro 8.0 Description Use this function to revert text to the default font size for the field.
Text formatting functions TextStyleAdd Purpose Adds the specified styles to text in a single action. Format TextStyleAdd(text;styles) Parameters text - any text expression or text field styles - any named style listed below in Description Data type returned text Originated in FileMaker Pro 7.0 Description You can add multiple styles by using the + operator between style names. Negative values are not valid. All styles will be removed, if the only style specified is Plain.
Text formatting functions • AllStyles (all available styles) Note To format or change the case of text, use the Lower, Upper, or Proper function (see Text functions). Examples TextStyleAdd(“Plaid”;Italic) returns the word Plaid in italics. TextStyleAdd(FirstName;Bold+Underline) returns Sophie in bold, underlined text when the FirstName field contains Sophie. The following calculation removes all styles from the text, then italicizes the entire phrase.
Text formatting functions TextStyleRemove Purpose Removes the specified styles from text in a single action. Format TextStyleRemove(text;styles) Parameters text - any text expression or text field styles - any named style from the list of available styles Data type returned text Originated in FileMaker Pro 7.0 Description You can remove multiple styles by using the + operator between style names. Negative values are not valid. The Plain styles cannot be used for this function.
Text formatting functions Examples TextStyleRemove(“Plaid”;Italic) returns the word Plaid with the italics style removed. TextStyleRemove(FirstName;Bold + Underline) returns Sophie with the bold and underlined styles removed when the FirstName field contains Sophie. TextStyleRemove(FirstName;AllStyles) returns Sophie without any styles. TextStyleRemove(MyTable::MyText;HighlightYellow)returns the text contained in MyTable::MyText with the HighlightYellow style removed.
Time functions Time functions Time functions calculate times and manipulate time information. Click a function name for details. This function Returns Hour A number representing the hour portion (0-23) of a specified time value. Minute A number representing the minute portion (0-59) of a specified time value. Seconds A number representing the seconds portion (0-59) of a specified time value. Time A time result with the specified number of hours, minutes, and seconds.
Time functions Hour Purpose Returns a number representing the hour portion (0-23) of a specified time. Format Hour(time) Parameters time - any time value or field of type time Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Hour(“12:15:23”) returns 12. Hour(Duration) + (Minute(Duration)/60) returns 2.5, when the Duration time field contains 2:30:15. If(Hour(HoursWorked) > 8;“Overtime Pay”;“ “) returns Overtime Pay when the number of hours in HoursWorked is greater than 8.
Time functions Minute Purpose Returns a number representing the minute portion (0-59) of a specified time. Format Minute(time) Parameters time - any time value or field of type time Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Minute(“12:15:23”) returns 15. Hour(Duration) + (Minute(Duration)/60) returns 2.5, if the Duration time field contains 2:30:15. Note If no minute value is specified, 0 is returned.
Time functions Seconds Purpose Returns a number representing the seconds portion (0-59) of a specified time. Format Seconds(time) Parameters time - any time value or field of type time Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Seconds(“12:15:23”) returns 23. Note If no seconds value is specified, 0 is returned.
Time functions Time Purpose Returns a time result with the specified number of hours, minutes, and seconds. Format Time(hours;minutes;seconds) Parameters hours - the hour value of a time minutes - the minutes value of a time seconds - the seconds value of a time Data type returned time Originated in FileMaker Pro 6.0 or earlier Description FileMaker Pro compensates when you supply fractional hours or minutes.
Timestamp functions Timestamp functions Timestamps are used for a wide variety of synchronization purposes, such as marking the exact date and time at which a particular event occurred. This function Returns Timestamp A timestamp containing a calendar date and time of day.
Timestamp functions Timestamp Purpose Returns a timestamp containing date as a calendar date and time as a time of day. Format Timestamp(date;time) Parameters date - any calendar date or date field time - any time value or time field Data type returned timestamp Originated in FileMaker Pro 7.0 Description The format of the result depends on the date and time formats that were in use when the database file was created. You can change the date and time formats in your operating system.
Trigonometric functions Trigonometric functions Trigonometric functions are used to calculate degrees, angles, and other geometric data. Note All trigonometric functions use radians as the unit of measure. Once you have a result, you can convert the radians into degrees using the Degrees function. Click a function name for details. This function Returns Acos The arccosine, or inverse cosine, of a number. Asin The arcsine, or inverse sine, of a number.
Trigonometric functions Acos Purpose Returns the arccosine (Acos), or inverse cosine, of number. Format Acos (number) Parameters number - any numeric expression or field containing a numeric expression in the range -1 to 1 Data type returned number Originated in FileMaker Pro 9.0 Description The arccosine is the angle whose cosine is number. The returned angle is given in radians in the range 0 (zero) to Pi. The input number parameter must be between -1 and 1.
Trigonometric functions Asin Purpose Returns the arcsine (Asin), or inverse sine, of number. Format Asin (number) Parameters number - any numeric expression or field containing a numeric expression in the range -1 to 1 Data type returned number Originated in FileMaker Pro 9.0 Description The arcsine is the angle whose sine is number. The returned angle is given in radians in the range Pi/2 to Pi/2. The input number parameter must be between -1 and 1.
Trigonometric functions Atan Purpose Returns the trigonometric arc tangent (Atan), or inverse tangent, of number. Format Atan(number) Parameters number - any numeric expression or field containing a numeric expression Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The arc tangent is the angle, in radians, whose tangent is equal to the specified number. Examples Atan(1) returns .78539816.... Degrees(Atan(1)) returns 45.
Trigonometric functions Cos Purpose Returns the cosine (Cos) of angleInRadians. Format Cos(angleInRadians) Parameters angleInRadians - any numeric expression or field containing a numeric expression, in radians Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Cos(1.047) returns .50017107.... Cos(Radians(60)) returns .5.
Trigonometric functions Degrees Purpose Converts angleInRadians to degrees. Format Degrees(angleInRadians) Parameters angleInRadians - any numeric expression or field containing a numeric expression, in radians Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use this function to translate results of trigonometric functions from radians to degrees.
Trigonometric functions Pi Purpose Calculates the value of the constant Pi (), which is approximately 3.14159. Format Pi Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Pi * 15 returns 47.124.
Trigonometric functions Radians Purpose Converts angleInDegrees to radians. Format Radians(angleInDegrees) Parameters angleInDegrees - any numeric expression or field containing a numeric expression, in degrees Data type returned number Originated in FileMaker Pro 6.0 or earlier Description The parameters for FileMaker Pro trigonometric functions must be expressed in radians.
Trigonometric functions Sin Purpose Returns the sine (Sin) of angleInRadians expressed in radians. Format Sin(angleInRadians) Parameters angleInRadians - any numeric expression or field containing a numeric expression, in radians Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Sin(Radians(60)) returns .86602. Sin(.610865) returns .57357624....
Trigonometric functions Tan Purpose Returns the tangent (Tan) of angleInRadians. Format Tan(angleInRadians) Parameters angleInRadians - any numeric expression or field containing a numeric expression, in radians Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Use this function to calculate the Tan of angleInRadians. Note With the Tan function, you cannot use values exactly equal to 90 degrees (Pi/2 radians), or multiples of 90 degrees.
Glossary Glossary A Access key (Windows) A key that activates a menu, menu item, or control when used with the ALT key. In Windows, this key corresponds to the underlined letter on a menu, command, or dialog box option. Access privileges Permission to view and work with certain records, fields, layouts, value lists, and scripts and to perform selected activities in a file. Account A username and (usually) password that accesses a file with a defined level of privileges.
B (FileMaker Server can also authenticate an account via External Server — an external authentication system such as Apple Open Directory, or a Windows Domain.) Authorization Allowing a file to access a protected file’s schema (including its tables, layouts, scripts, and value lists). Such a file is an authorized file. Auxiliary files In a FileMaker Pro Advanced runtime solution, files that are bundled with a primary file.
C bar), view your records in a list (click List View), or view records arranged in a spreadsheet-like table (click Table View). (Use Browse mode to enter and edit your information; use Layout mode to design how your information is displayed. Use Find mode to find records that match search criteria; use Preview mode to display how your records will print.) Button A layout object that performs a specified script in Browse or Find modes. C Cache The amount of memory assigned to FileMaker Pro.
C Client/server architecture The relationship between two networked computers that share resources. The client requests services from the server, and the server provides services to the client. Clipboard A temporary storage area in computer memory where FileMaker Pro places the most recent selection you've cut or copied. Clone A copy of a FileMaker Pro file that contains all the field definitions, tables, layouts, scripts, and page setup options, but none of the data.
D Custom menu A menu that is not one of the default FileMaker Pro menus. In FileMaker Pro Advanced, you can create custom menus, menu items, and menu sets. D Data Entry Only privilege set One of the three predefined privilege sets that appear in every file. The Data Entry Only privilege set allows read/write access to the records in a file, but not design access (for example, the ability to create layouts and value lists).
D Developer Utilities A FileMaker Pro Advanced feature that lets you bind files into a runtime solution, display files in Kiosk mode, prevent users from modifying the design or structure of databases, and automatically rename sets of files and update links to related files. Dialog window A document window in a modal state. Its behavior is similar to the behavior of a window when a running script is paused. You can create and customize a dialog window using the New Window script step.
E E Email Electronic mail. A system for transmitting messages from one computer or terminal to another. A message sent from one computer user to another is stored in the recipient’s account mailbox until that person logs onto the system and reads the message. Embedded For container fields, a file that is stored in the container field. Container data can also be stored by reference or stored externally. Encryption password The password required to open an encrypted file.
F refer to the object on a layout that displays the data, such as an edit box, checkbox set, or popup menu. Field boundary In Layout mode, an outline that shows the size of a field. To see field boundaries, choose View menu > Show > Field Boundaries. These boundaries only appear in Layout mode. However, you can use the Appearance tab of the Inspector to format objects to have borders that do appear in Browse mode and when you print the layout. Field label Text on a layout that identifies a field.
F Floating document window A standard modeless FileMaker window that stays on top of other windows while users work in FileMaker Pro. You can create and customize a floating window using the New Window script step. Footer part Use the footer part for page numbers or dates. This part appears at the bottom of every screen or page (unless you add a Title Footer). You can have only one footer in a layout. A field in the footer displays data from the last record on that page.
G Function list separator The punctuation character ; (a semicolon) that separates parameters in a function definition. If you type a comma (,), FileMaker Pro automatically changes it to a semicolon after you close the Specify Calculation dialog box. G GIF (Graphics Interchange Format) A platform-independent file format often used to distribute graphics on the internet. Global field A field defined with the global storage option can contain one value that's used for all records in a file.
H H Handle One of the small squares surrounding a selected object, and used to resize and reshape the object. Header part Use a header part for column headings, titles, and other information that appears only at the top of every page on a layout. FileMaker Pro displays the header in Browse mode and prints it on every page, except the first page if you add a title header. Fields added to a header are printed on every page, using data from the first record on that page.
J, K Internet Service Provider (ISP) The company from which you purchase your connection to the internet. Intranet A private TCP/IP network of linked computers within a company or organization. IP (Internet Protocol) address For IPv4, a four-part number, usually formatted as 12.34.56.78, that uniquely identifies a computer on the internet; for IPv6, an eight-part number, usually formatted as [2001:0DB8:85A3:08D3:1319:8A2E:0370:7334], that uniquely identifies a computer on the internet.
L Layout bar in Layout mode If you don't see the status toolbar, click the status toolbar control button document window. at the bottom of the Layout mode The FileMaker mode in which you determine how information in fields is presented on the screen and in printed reports. (Use Browse mode to enter and edit your information; use Layout mode to design how your information is displayed. Use Find mode to find records that match search criteria; use Preview mode to display how your records will print.
M Link On a web page, text or a graphic which — when you click it — displays an associated web page or a specific element within a page. Also, the HTML code that creates a link to another web page or to a specific element within a page. List View Displays records one record at a time in a list format. To select this view, click List View in the layout bar. If you don't see the status toolbar, click the status toolbar control button document window.
N Menu bar The area at the top of the window (Windows) or screen (OS X) that displays the installed menu set. Menu item One item listed in a menu on the menu bar. A menu item corresponds with one command, submenu, or separator. Menu item properties All the settings for a menu item, including platform, display title, shortcut, and action. Menu set The collection of menus that installs on the menu bar. Merge field A placeholder on a layout for the contents of a database field.
O O Object On a FileMaker Pro layout, an object is a discrete entity or shape that you can select, move, modify, delete, or name. Lines, fields, buttons, popovers, panel controls, portals, imported graphics, blocks of text, tab controls, and web viewers are objects. ODBC An API that uses SQL statements to access data from, and exchange data with, many database management systems.
Q Plug-in Software that extends the capabilities of an application in a specific way. Popover A layout object that can contain other layout objects. Popovers include a content area (where objects are placed) and can include a title. You open a popover by clicking a popover button. Popovers reposition on the screen as needed to stay in view. Popover button A layout object that opens a popover.
R R Read-Only Access privilege set One of the three predefined privilege sets that appear in every file. The Read-Only Access privilege set allows read access to the records in a file, but not write or design access. Record One set of fields in a database table. Each record contains data about a single activity, individual, subject, or transaction. Recover If a file is damaged (for example, from an unexpected quit during a hard-drive update), you can attempt to recover the file.
S Repeating field A field containing multiple, separate values. Report layout A predefined layout type for setting up reports. You can create a layout with simple rows and columns of data (as in a list), or a complex report with grouped data (subsummary reports). The fields that you specify appear in columns across the screen or page in one line. Field names are in the header part and the footer part is blank. Report with grouped data A subsummary report that you create using the Report layout type.
S scripts, and value lists). Security also includes extended privileges, which determine the data sharing options that are permitted by a privilege set. Self-join A relationship between fields in the same table. This creates another occurrence of the table in the relationships graph. Separator A line within a menu that separates or groups menu items. Serial number A unique number entered by FileMaker Pro for each record.
S Slider In the status toolbar, the navigation control for quickly moving to a record in your database file based on its location in the file. For example, in Browse mode, move the slider to the left to go to the first record and to the right to go to the last record. In Browse mode, moving the slider changes the current record. In Find mode, moving the slider changes the current find request. In Layout mode, moving the slider changes the current layout.
S You specify a startup script in the File Options dialog box. Status toolbar The area across the top of the document window that displays navigation controls, customizable buttons, and a layout bar for working with layouts. In Layout mode, it includes layout tools. Status toolbar in Browse mode (Windows) Status toolbar in Layout mode (OS X) If you don't see the status toolbar, click the status toolbar control button document window.
T to use the system’s settings or the file’s settings. Using the Inspector, you can also format number fields to display decimals and thousands separators according to the current system formats. T Tab control A layout object made up of one or more tab panels that allows you to organize fields and other objects within each tab panel's borders. Tab control and tab panels in Browse mode Tab order The order in which you move from field to field in a record.
U Text baseline In Layout mode, the guideline that appears at the base of the text in a field or text block. Text baselines can be solid, dotted, or dashed. If you want text baselines to also appear in Browse and Find modes, select Text baselines in the Appearance tab of the Inspector. If you don’t see the Inspector, choose View menu > Inspector. Text expression Any expression that returns a text result.
W, X, Y, Z throughout the current file (global). Local and global variables can have the same name but they are treated as different variables. View An arrangement of your data primarily useful for onscreen manipulation. In Browse mode, Find mode, or Preview mode, Form View displays individual records, List View displays records in a list, and Table View displays records in a spreadsheet-like table format. W, X, Y, Z Web address The calculated expression that you enter in the Web Viewer Setup dialog box.
W, X, Y, Z FileMaker Pro can export XML data that can then be used, for example, by spreadsheet applications, data charting applications, and enterprise SQL databases. FileMaker Pro can also import XML data. Y-axis data In a column, stacked column, line, and area chart, the data series you are measuring (for example, annual sales). In a bar or stacked bar chart, the data series you are comparing (for example, company name).
