FileMaker Pro 15 ® Functions Reference
© 2007–2016 FileMaker, Inc. All Rights Reserved. FileMaker, Inc. 5201 Patrick Henry Drive Santa Clara, California 95054 FileMaker and FileMaker Go are trademarks of FileMaker, Inc. registered in the U.S. and other countries. The file folder logo and FileMaker WebDirect are trademarks of FileMaker, Inc. All other trademarks are the property of their respective owners. FileMaker documentation is copyrighted.
Contents Contents Script steps reference (alphabetical list) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 About functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Working with formulas and functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Using this functions reference . . . . . . . . . . . . . . . .
Contents FieldStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 FieldType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 GetNextSerialValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 LayoutIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Get(CustomMenuSetName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Get(DesktopPath) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Get(Device) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Get(DocumentsPath) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Get(StatusAreaState) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Get(SystemDrive) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Get(SystemIPAddress) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Get(SystemLanguage) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 LookupNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Self . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 Mobile functions . . . . . . . . . . . . . . . . . . . . . .
Contents GetValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294 Hiragana . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295 KanaHankaku . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 KanaZenkaku . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Trigonometric functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347 Acos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 Asin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 Atan . . . . . . . . . . . . . . . . . . . . . . . . . .
Script steps reference (alphabetical list) Script steps reference (alphabetical list) Abs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 Acos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 Asin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Script steps reference (alphabetical list) Get(ActiveModifierKeys) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Get(ActivePortalRowNumber) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Get(ActiveRepetitionNumber) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Get(ActiveSelectionSize) . . . . . . . . . . . . . . . . . . . . . .
Script steps reference (alphabetical list) Get(PreferencesPath) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Get(PrinterName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Get(QuickFindText) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Get(RecordAccess) . . . . . . . . . . . . . . . . .
Script steps reference (alphabetical list) Get(WindowZoomLevel) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 GetAsBoolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 GetAsCSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 GetAsDate . . . . . . . . . . . . . . . . . . . . .
Script steps reference (alphabetical list) MiddleValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306 MiddleWords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Minute . . . . . . . . . . . . .
Script steps reference (alphabetical list) Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344 Timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346 Trim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321 TrimAll . . . . . . . . .
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 Aggregate functions Note Aggregate functions perform statistical analysis on numbers (and dates or times for some functions) in: • several fields in a record. • related fields whether displayed in a portal or not. • repeating fields. For example, you can use the Sum function to add the values listed in a portal, as an alternative to creating a report with grouped data and subtotals. The parameter values can include a numeric constant (for example, 10) or any valid expression.
Aggregate functions Average Purpose Returns a value that is the average of all valid, non-blank values in a 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 braces { } are optional. Data type returned number Originated in FileMaker Pro 6.
Aggregate functions Count Purpose Returns the number of valid, non-blank values in a 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 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 List Purpose Returns a concatenated list of non-blank values 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 braces { } are optional. Data type returned text Originated in FileMaker Pro 8.5 Description Listed items are separated by carriage returns.
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 PRO FUNCTIONS REFERENCE 21
Aggregate functions Max Purpose Returns the highest valid value in a 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 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 a 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 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 a 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 braces { } are optional. Data type returned number Originated in FileMaker Pro 6.
Aggregate functions Examples A portal displays the related values 5, 6, 7, and 8 in a field called Scores. StDev(table::Scores) returns 1.29099444.... In the following examples: • Field1 contains two repetitions with values of 1 and 2. • Field2 contains four repetitions with values of 5, 6, 7, and 8. • Field3 contains four repetitions with values of 6, 0, 4, and 4. • Field4 contains one repetition with a value of 3.
Aggregate functions StDevP Purpose Returns the standard deviation of a population represented by a series of non-blank values in a 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 braces { } are optional. Data type returned number Originated in FileMaker Pro 6.
Aggregate functions Examples A portal displays the related values 5, 6, 7, and 8 in the field Scores. StDevP(table::Scores) returns 1.11803398.... In the following examples: • Field1 contains two repetitions with values of 1 and 2. • Field2 contains four repetitions with values of 5, 6, 7, and 8. • Field3 contains four repetitions with values of 6, 0, 4, and 4. • Field4 contains one repetition with a value of 3.
Aggregate functions Sum Purpose Returns the total of all valid, non-blank values in a 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 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 Examples An Invoice table has a portal showing line items. Sum(LineItems::ExtendedPrice) totals the amounts for all items on the invoice. A TimeBilling table has a portal showing time worked on a project. Hours is a time field. Sum(Hours::BillableHours) returns the total number of billable hours on a project. Thus, if the portal shows 40 hours and 15:30 hours, the total billable hours are 55:30, or 55 1/2 hours.
Aggregate functions Variance Purpose Returns the variance of a sample represented by a series of non-blank values in a 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 braces { } are optional. Data type returned number Originated in FileMaker Pro 7.
Aggregate functions Examples A portal displays the related values 5, 6, 7, and 8 in Scores. Variance(table::Scores) returns 1.66666666.... In the following examples: • Field1 contains two repetitions with values of 1 and 2. • Field2 contains four repetitions with values of 5, 6, 7, and 8. • Field3 contains four repetitions with values of 6, 0, 4,and 4. • 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.
Aggregate functions VarianceP Purpose Returns the variance of a population represented by a series of non-blank values in a 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 braces { } are optional. Data type returned number Originated in FileMaker Pro 7.
Aggregate functions Examples A portal displays the related values 5, 6, 7, and 8 in Scores. VarianceP(table::Scores) returns 1.25. In the following examples: • Field1 contains two repetitions with values of 1 and 2. • Field2 contains four repetitions with values of 5, 6, 7, and 8. • Field3 contains four repetitions with values of 6, 0, 4, and 4. • 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.
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 field as text in Base64 format. GetContainerAttribute The file metadata of the specified container field. GetHeight The height, in pixels, of the content 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 field as text in Base64 format. Format Base64Encode(sourceField) Parameters sourceField - the name of a field. Data type returned text Originated in FileMaker Pro 13.0 Description Base64Encode adds a line break after every 76 characters. Base64 encoding does not retain the filename or extension of encoded container field content.
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 externalSize The amount (in bytes) of the space that is stored externally by the container field. This is either the size of the referenced file or the total size of all files in the container field (set up for open or secure storage). number externalFiles A list of the external files associated with the container field text (either files using open or secure storage or a file reference).
Container functions Attribute Returns Data type returned year The year the audio was released. text track The track number and count of the audio. For example, 3/12, or 3 if the track count is not available. text genre The genre of the audio. text composer The composer of the audio. text coverArt An image of the album cover. container duration The duration of the audio. For example, 0:03:16. time bitRate The number of kilobits per second (kbps) used in the audio.
Container functions Notes • The internalSize can be much smaller than the fileSize (for example, container fields set up for open or secure storage, file references, or compressed files) or much larger than the fileSize (for example, container fields created by plug-ins). • Using the attribute MD5 allows you to prevent the insertion of duplicated files into a container field regardless of the filename. • Bar codes and signatures are not considered images.
Container functions [Photo] Orientation: 6 (Rotated 90 degrees counterclockwise) Created: 1/14/2015 2:40:31 PM Modified: Latitude: 37.406167 Longitude: -121.
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 a specified height and width. 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 0 (false) if container data was changed or deleted outside FileMaker; otherwise, returns 1 (true). 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 a 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 Day Purpose Returns a number from 1 to 31, for the day of the month on which a 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 text that is the full name of the weekday for a 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 text in Japanese that is the full name of the weekday for a 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 on which a date occurs. 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 the number of days from the beginning of the year of a 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 from 1 to 12, representing the month of the year in which a 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 a 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 a 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 a 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 to 54. Important To avoid errors when using dates, always use four-digit years.
Date functions WeekOfYearFiscal Purpose Returns a number from 1 to 53, representing the week containing a date, from a starting day. 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 a 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 a date, 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. 8 (Meiji 8), 0[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.
Design functions This function Returns ValueListIDs A list of all value list IDs in fileName. ValueListItems A list of the values in a value list. ValueListNames A list of the names of all value lists in fileName. WindowNames A list of the names of windows that are currently open.
Design functions DatabaseNames Purpose Returns a list of the names of all files open on the computer. Format DatabaseNames Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description Listed items are separated by carriage returns. 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. 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.0 or earlier Description Listed items are separated by carriage returns.
Design functions FieldNames Purpose Returns a list of the names of all fields on layoutName in fileName. 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.0 or earlier Description Listed items are separated by carriage returns.
Design functions FieldRepetitions Purpose Returns the number and orientation of repetitions of a repeating field as formatted on a layout. Format FieldRepetitions(fileName;layoutName;fieldName) Parameters fileName - the name of an open database file (local or remote). layoutName - the name of a layout in the specified file. fieldName - the name of a field on the specified layout. Important See Design functions for information about literal text parameters.
Design functions FieldStyle Purpose Returns the field formatting applied to fieldName on layoutName in fileName. 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. 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 Listed items are separated by carriage returns. 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. 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 Description Listed items are separated by carriage returns. 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. 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.5 Description Listed items are separated by carriage returns.
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 Examples A database file called Human Resources has three tables: Company, Employees, and Addresses. Company::Company ID is connected to Employees::Company ID, Employees::Employee ID is connected to Addresses::Employee ID and Employees::DateOfHire is connected to Addresses::DateMovedIn. The relationships have the following criteria: • You can create records in all tables. • You cannot delete records in all tables.
Design functions ScriptIDs Purpose Returns a list of all script IDs in fileName. 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 Description Listed items are separated by carriage returns. 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. 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 Listed items are separated by carriage returns. 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. 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 Listed items are separated by carriage returns. Each table ID is unique.
Design functions TableNames Purpose Returns a list of all table occurrences in the relationships graph for fileName. 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 Listed items are separated by carriage returns.
Design functions ValueListIDs Purpose Returns a list of all value list IDs in fileName. 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 Listed items are separated by carriage returns. 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 a value list. 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.0 or earlier Description Listed items are separated by carriage returns.
Design functions ValueListNames Purpose Returns a list of the names of all value lists in fileName. 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 Listed items are separated by carriage returns. 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 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). 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. Data type returned Depends on the external function Originated in FileMaker Pro 6.
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 (FV) 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 interest rate 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 interest rate 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, interest rate, 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, assuming a fixed interest rate 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). Data type returned number Originated in FileMaker Pro 6.
Get functions Get functions Get functions monitor errors in scripts, or capture information about file status or actions 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 update only when a new record is created.
Get functions This function Returns Get(CurrentDate) The current date according to the system calendar. Get(CurrentExtendedPrivileges) A list of keywords, based on the account used to evaluate this calculation, for the enabled extended privileges. Get(CurrentHostTimestamp) The host's current date and time (to the nearest second) according to the system clock. Get(CurrentPrivilegeSetName) The name of the privilege set being used to evaluate this calculation in the file.
Get functions This function Returns Get(LastMessageChoice) A number corresponding to the button clicked in an alert message displayed by the Show Custom Dialog script step. Get(LayoutAccess) A number based on record access privileges available through the current layout. Get(LayoutCount) The total number of layouts in the file. Get(LayoutName) The name of the layout currently being displayed.
Get functions This function Returns Get(ScreenScaleFactor) The scale factor of the screen in which the current file is open. Get(ScreenWidth) The width, in points, of the screen in which the window of the current file is open. Get(ScriptAnimationState) 1 (true) if animations are enabled for the current script; otherwise, returns 0 (false). Get(ScriptName) The name of the script that is currently running or is paused. Get(ScriptParameter) The script parameter passed into the current script.
Get functions This function Returns Get(UUID) Text representing a Universally Unique Identifier (UUID). Get(WindowContentHeight) The height, in points, of the window content area. Get(WindowContentWidth) The width, in points, of the window content area. Get(WindowDesktopHeight) The height, in points, of the desktop space. Get(WindowDesktopWidth) The width, in points, of the desktop space. Get(WindowHeight) The height, in points, of the window on which the script is acting.
Get functions Get(AccountExtendedPrivileges) Purpose Returns a list of keywords, based on the account used to open the file, for the enabled extended privileges. Format Get(AccountExtendedPrivileges) Parameters None Data type returned text Originated in FileMaker Pro 11.0 Description The keywords are separated by carriage returns. Extended privileges are additional access rights assigned to an account’s privilege set. See About accounts, privilege sets, and extended privileges.
Get functions Get(AccountName) Purpose Returns the authenticated account name being used by the file's current user. 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 privilege set name being used by the account used to open the file. 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 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 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 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. Examples There are two fields, Teachers::Name and Coaches::Name, on the current layout.
Get functions Get(ActiveLayoutObjectName) Purpose Returns the name of the layout object that has the focus in the calculation's current window. Format Get(ActiveLayoutObjectName) Parameters None Data type returned text Originated in FileMaker Pro 8.5 Description When no layout object has the focus, this function returns an empty string. Examples There is a named field on the current layout called customerName. When the focus is on the field, Get(ActiveLayoutObjectName) returns customerName.
Get functions Get(ActiveModifierKeys) Purpose Returns a number for the keyboard modifier keys 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 (for example, Control+Shift) being pressed.
Get functions Get(ActivePortalRowNumber) Purpose Returns the number of the portal row that has 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 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 repetition that has the focus in a repeating field. 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. Examples Returns 5 when the focus is in the fifth repetition of a repeating field.
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. • In FileMaker Go, this function may return an inaccurate value if the selected text is in a concealed edit box.
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 (true) if the Allow User Abort script step is on; otherwise, returns 0 (false). Format Get(AllowAbortState) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Examples Returns 1 if the Allow User Abort script step is on.
Get functions Get(AllowFormattingBarState) Purpose Returns 1 (true) if the formatting bar is allowed to be visible; otherwise, returns 0 (false). Format Get(AllowFormattingBarState) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Description The Allow Formatting Bar script step sets the formatting bar state. Notes • In FileMaker WebDirect, this function is not supported and returns 0. Examples Returns 1 if the formatting bar is allowed to be visible.
Get functions Get(ApplicationArchitecture) Purpose Returns the current application architecture. Format Get(ApplicationArchitecture) Parameters None Data type returned Text Originated in FileMaker Pro 14.
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 product 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 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. Example 1 Returns 5 when FileMaker Pro is calculating the fifth repetition of a repeating field.
Get functions Get(ConnectionAttributes) Purpose Returns the name of the current file's host, and 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 Secure connections are encrypted using SSL. If security is important in your environment, your server administrator needs to install a custom SSL certificate. Returns: • 0 for no network connection for the current file.
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, based on the account used to evaluate this calculation, for the enabled extended privileges. Format Get(CurrentExtendedPrivileges) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description The keywords in the list are separated by carriage returns. Extended privileges are additional access rights assigned to an account’s privilege set.
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 being used to evaluate this calculation in the file. 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 file, this function returns [Full Access].
Get functions Get(CurrentTime) Purpose Returns the current time (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 return 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. Examples Returns Custom Menu Set #1 when this custom menu set is active.
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 Server scripts, the Desktop folder is not supported, so this function returns unreliable results.
Get functions Get(Device) Purpose Returns a number representing the type of computer or mobile device running the FileMaker product. Format Get(Device) Parameters None Data type returned number Originated in FileMaker Pro 13.0 Description This function returns a number indicating the type of computer or mobile device currently running FileMaker Pro or FileMaker WebDirect, or the type of iOS device currently running FileMaker Go.
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 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 (true) if the Set Error Capture script step is on; otherwise, returns 0 (false). Format Get(ErrorCaptureState) Parameters None Data type returned number Originated in FileMaker Pro 7.0 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 Notes • In FileMaker WebDirect, this function is not supported and returns an empty string. Examples Returns /C:/Program Files/FileMaker/FileMaker Pro 15/ in Windows. Returns /Macintosh HD/Applications/FileMaker Pro 15/ in OS X.
Get functions Get(FileName) Purpose Returns the name of the currently active 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 of the location of the currently active 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 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. Examples Returns 15000 when the current file size is 15000 bytes.
Get functions Get(FoundCount) Purpose Returns 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 current high contrast default color scheme name. Format Get(HighContrastColor) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Description This function returns the current high contrast default color scheme name if the high contrast option is enabled in the Windows Ease of Access Center and if high contrast color scheme is active.
Get functions Get(HighContrastState) Purpose Returns 1 (true) if high contrast is available and active; otherwise, returns 0 (false). Format Get(HighContrastState) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Returns: • 0 if the high contrast option (in the Windows Ease of Access Center) is unavailable or inactive, or if the function is used in OS X. • 1 if the high contrast option is available and active.
Get functions Get(HostApplicationVersion) Purpose Returns the version of FileMaker Pro or FileMaker Server running on the computer hosting the current file. 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 file is not shared or hosted, this function returns an empty string.
Get functions Get(HostIPAddress) Purpose Returns the IP address of the host computer for the current file. Format Get(HostIPAddress) Parameters None Data type returned text Originated in FileMaker Pro 8.0 Description If the current file isn’t being hosted, an empty string is returned. Note In FileMaker WebDirect, returns the physical IP address of the host machine. If IPv4 and IPv6 addresses are available for remotely hosted files, the address is returned in the most common or default format.
Get functions Get(HostName) Purpose Returns the registered name of the computer that is hosting the 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 file, the current registered computer name is displayed in Control Panel (Windows) or System Preferences (OS X).
Get functions Get(InstalledFMPlugins) Purpose Returns the name, version number, and enabled state of installed plug-ins. Format Get(InstalledFMPlugins) Parameters None Data type returned text Originated in FileMaker Pro 12.0 Description This function is useful for determining whether an installed plug-in is newer or older than a plug-in required by a file. The version number is returned if it is available.
Get functions Get(LastError) Purpose Returns a number for the error that occurred 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(LastExternalErrorDetail) Purpose Returns text about errors external to FileMaker that are returned by Get(LastError). Format Get(LastExternalErrorDetail) 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 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(LastMessageChoice) Purpose Returns a number corresponding to the button clicked in an alert message displayed by the Show Custom Dialog script step. Format Get(LastMessageChoice) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Returns: • 1 for the first button (by default, labeled OK) • 2 for the second button (by default, labeled Cancel) • 3 for the third button Example 1 For an example script, see Show Custom Dialog script step.
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 access privileges in the Custom Layout Privileges dialog box.
Get functions Get(LayoutCount) Purpose Returns the total number of layouts in the file. Format Get(LayoutCount) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Examples Returns 3 when the file has three layouts.
Get functions Get(LayoutName) Purpose Returns the name of the layout currently being 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 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 (specified in the Manage Layouts dialog box) currently displayed. 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 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 displaying records in the current layout. 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. Examples There are two layouts, Teachers Layout and Coaches Layout, with corresponding tables named Teachers and Coaches in the table Instructors.
Get functions Get(LayoutViewState) Purpose Returns a number representing the currently active file view. Format Get(LayoutViewState) Parameters None Data type returned number Originated in FileMaker Pro 6.
Get functions Get(MenubarState) Purpose Returns a number for the current menu bar state. Format Get(MenubarState) Parameters None Data type returned number Originated in FileMaker Pro 14.
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 Returns a list of fields modified since the last time the record was committed. The list includes stored calculation fields that are dependent on one or more fields that have been modified. Field names are separated by carriage returns.
Get functions Get(MultiUserState) Purpose Returns a number representing the level of sharing for the 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 is using on this machine. Format Get(NetworkProtocol) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples Returns TCP/IP.
Get functions Get(NetworkType) Purpose In FileMaker Go, returns a number representing 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. Examples Returns 4 when page 4 is being printed or previewed.
Get functions Get(PersistentID) Purpose Returns text representing a unique identifier of the computer or device running FileMaker. 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 text 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 is stored in the quick find box. Format Get(QuickFindText) Parameters None Data type returned text Originated in FileMaker Pro 11.0 Description Use this function to pass the text that's in the quick find box to a script when you override the Perform Quick Find command in a custom menu set. Example 1 Performs a quick find using the text entered in the quick find box. If no records are found, returns a custom error message.
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 This function returns the number of open (uncommitted) records in the current found set, including uncommitted related records, that the current user hasn’t saved.
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.0 Description Returns: • 0 for a closed (committed) record • 1 for a new record that hasn’t been committed • 2 for a modified record that hasn’t been committed Notes • This function returns the state of the current record pertaining to the current user.
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 multiple windows are open in the current file, the results are returned for only the foreground window of the file in which the calculation is defined. Examples Returns 5 when there are five find requests defined for the current table.
Get functions Get(RequestOmitState) Purpose Returns 1 (true) if Omit is selected in the current find request; otherwise, returns 0 (false). Format Get(RequestOmitState) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Examples Returns 1 when Omit is selected in the current find request.
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. Examples Returns 32 on a display showing millions (232) of colors.
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(ScreenScaleFactor) Purpose Returns the scale factor of the screen in which the current file is open. Format Get(ScreenScaleFactor) Parameters None Data type returned number Originated in FileMaker Pro 13.0.
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 Returns 1 (true) if animations are enabled for the current script; otherwise, returns 0 (false). Format Get(ScriptAnimationState) Parameters None Data type returned number Originated in FileMaker Pro 13.0 Description Animations are off by default while a script is running. Examples Returns 1 when the current script has been set to enable animations using the Set Layout Object Animation script step.
Get functions Get(ScriptName) Purpose Returns the name of the script that is currently running or is paused. Format Get(ScriptName) Parameters None Data type returned text Originated in FileMaker Pro 6.0 or earlier Examples Returns Print Report when the Print Report script is running. Returns Update Customer when the Update Customer 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. Script parameters can be passed into a script via a button, a script trigger, or another script. See the Perform Script script step.
Get functions Get(ScriptResult) Purpose Returns the script result from a performed sub-script. 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 sub-script doesn’t return a result, then the contents of the script result will either be empty or the value of any previous subscript result.
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 representing 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 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. Examples Returns /C:/ in Windows when the operating system is on the C: drive. Returns /DriveName/ in OS X when the operating system is on a volume named DriveName.
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 Formats setting in Control Panel (Windows) or in System Preferences (OS X). 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 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 representing the current platform. Format Get(SystemPlatform) Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description Returns: • 1 if the current platform is Intel-based Macs • -2 if the platform is Windows • 3 if the platform is iOS • 4 if the platform is FileMaker WebDirect Examples Get(SystemPlatform) returns -2 when the current platform is a Windows platform.
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.3 for Windows 8.1 • 10.0 for Windows 10 • 10.11 for OS X version 10.
Get functions Get(TemporaryPath) Purpose Returns the path to the temporary folder FileMaker Pro uses for the current user, or the path 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 Get(TextRulerVisible) Purpose Returns 1 (true) if the text ruler is displayed; otherwise, returns 0 (false). Format Get(TextRulerVisible) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Notes • In FileMaker WebDirect, this function is not supported and returns 0. Examples Returns 1 when the text ruler is visible.
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. Examples Returns 876 when there are 876 records in the current table.
Get functions Get(TouchKeyboardState) Purpose Returns 1 (true) if the touch keyboard is set to display automatically when needed; otherwise, returns 0 (false). Format Get(TouchKeyboardState) Parameters None Data type returned number Originated in FileMaker Pro 14.
Get functions Get(TriggerCurrentPanel) Purpose Returns the index and object name of the panel to switch 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. Returns an index value, starting from 1, when running a script triggered by the OnPanelSwitch script trigger, and the object name assigned to the tab panel or slide panel.
Get functions Get(TriggerExternalEvent) Purpose In FileMaker Go, returns a number representing the event that activated an OnExternalCommandReceived script trigger. Format Get(TriggerExternalEvent) Parameters None Data type returned number Originated in FileMaker Pro 14.
Get functions Get(TriggerGestureInfo) Purpose Returns details about the gesture that activated an OnGestureTap script trigger. Format Get(TriggerGestureInfo) Parameters None Data type returned text Originated in FileMaker Pro 13.
Get functions Examples When a script is triggered by a three-finger tap, and the gesture occurred at the coordinates (400,600), this function returns: Tap 1 3 400 600 FILEMAKER PRO FUNCTIONS REFERENCE 193
Get functions Get(TriggerKeystroke) Purposeh Returns the characters that activated an OnObjectKeystroke or OnLayoutKeystroke script trigger. Format Get(TriggerKeystroke) Parameters None Data type returned text Originated in FileMaker Pro 10.0 Description Returns a value when running a script triggered by an OnObjectKeystroke or OnLayoutKeystroke script trigger or running a script called from the triggered script; otherwise, returns an empty string.
Get functions Get(TriggerModifierKeys) Purpose Returns the state of the keyboard modifier keys when an OnObjectKeystroke or OnLayoutKeystroke 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 Examples • The following example will only display a custom dialog box when lowercase “a” is entered: If [Get(TriggerKeystroke)=“a” and Get(TriggerModifierKeys)=0] Show Custom Dialog [“You entered \”a\”.”] End If • The value 9 is returned when Shift-Option is pressed on a computer running OS X.
Get functions Get(TriggerTargetPanel) Purpose Returns the index and the object name of the panel to switch 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. Returns an index value, starting from 1, when running a script triggered by the OnPanelSwitch script trigger, and the object name assigned to the tab panel or slide panel.
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 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 the Get(AccountName) function 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 1 (true) if Use System Formats in the Format menu is on; otherwise, returns 0 (false). Format Get(UseSystemFormatsState) Parameters None Data type returned number Originated in FileMaker Pro 8.0 Notes • In FileMaker WebDirect, this function is not supported and returns 0. Examples Returns 1 when Use System Formats is on.
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. Examples Stored calculation: In a calculation field, specify the calculation Get(UUID).
Get functions Get(WindowContentHeight) Purpose Returns the height, in points, of the window 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 Example 4 For iPhone 4-inch devices in landscape orientation, the height is 34 points for the menu bar and 34 points for the toolbar. iPhone devices don’t display the status bar in landscape orientation.
Get functions Get(WindowContentWidth) Purpose Returns the width, in points, of the window 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. 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. In FileMaker WebDirect, the window height does not include menus or toolbars that are part of the web browser.
Get functions Get(WindowLeft) Purpose Returns the horizontal distance, in points, of the outer edge of the window on which the script is acting, 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 leftmost corner below the menu bar. A negative value indicates the portion of the left side of the window that is hidden.
Get functions Get(WindowMode) Purpose Returns a number representing the mode the FileMaker product is in when 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. 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 • The window on which the script is acting may not necessarily be the foreground window. • You can set the window name with the Set Window Title script step.
Get functions Get(WindowOrientation) Purpose Returns a value representing the orientation of the window on which the script is acting. 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 Note The window on which the script is acting may not necessarily be the foreground window.
Get functions Get(WindowTop) Purpose Returns the vertical distance, in points, of the outer edge of the window on which the script is acting, 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 leftmost corner below the menu bar. A negative value indicates the portion of the top part of the window that is hidden behind the menu bar.
Get functions Get(WindowVisible) Purpose Returns 1 (true) if the window is visible; returns 0 (false) if the window is hidden using Hide Window. Format Get(WindowVisible) Parameters None Data type returned number Originated in FileMaker Pro 7.0 Description The window can be located outside of the visible screen space and still return 1. The current window may not necessarily be the foreground window. Examples Returns 1 when the current window is physically visible.
Get functions Get(WindowWidth) Purpose Returns the width, in points, of the window on which the script is acting. 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 leftmost to rightmost outer edge of the window. This position doesn’t include shadows or other effects applied to windows. Notes • The window on which the script is acting may not necessarily be the foreground window.
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 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 a 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 braces { } are optional.
Logical functions Evaluate Purpose Evaluates an 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 braces { } are optional. Notice that the optional field list is enclosed in brackets [ ].
Logical functions The following example shows how to pass named parameters, allowing access to both variable “a” and “b”. The simplified first parameter makes the second parameter more complex (the example returns 6, 12): ScriptParameter = "a = 5; b = 10" Evaluate("Let ( [" & Get(ScriptParameter) & "]; a + 1 & \", \" & b + 2 )") 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): Scr
Logical functions EvaluationError Purpose Returns an error code, if any, from an 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 in a FileMaker Pro file. 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. • FileMaker SQL uses the Unicode binary sort order, which is different from the FileMaker Pro sort order used with language sorting or with the default language-neutral sort order.
Logical functions GetAsBoolean Purpose Returns 1 (true) if data converts to a non-zero numeric value or a container field holds data; otherwise, returns 0 (false). 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 GetAVPlayerAttribute Purpose Returns the setting of the specified attribute for the audio, video, or image file in a container field. Format GetAVPlayerAttribute(attributeName) Parameters attributeName - the name of a supported attribute (see below). Data type returned text, number Originated in FileMaker Pro 14.0 Description This function is used in FileMaker Go.
Logical functions Data type returned Attribute Returns presentation The method used to display the media: 0 (Embedded) 1 (Full Screen) 2 (Full Screen Only) 3 (Audio Only) number position The position (in seconds) currently playing in the media. number startOffset The starting position of the playback (in seconds). number endOffset The end position of the playback (in seconds); returns 0 if playing to the end of the media.
Logical functions Data type returned Attribute Returns disableInteraction 1 (Yes) if users cannot interact with the playback; otherwise returns 0 (No). number disableExternalControls 1 (Yes) if the iOS playback controls on the lock screen or on the control panel are disabled when the media is playing or is paused; otherwise, returns 0 (No). number pauseInBackground 1 (Yes) if the audio is paused when FileMaker Go is moved to the background; otherwise returns 0 (No).
Logical functions GetField Purpose Evaluates fieldName and returns the contents of the specified field. 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 Example 1 If you sort records on a calculation field that's defined by the GetField function, you can dynamically sort records and display subsummary data by changing the value of the field specified by GetField.
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 the objectName 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 Data type returned Attribute Returns isObjectHidden 1 if objectName is hidden for the current record; otherwise, returns 0. Returns 1 for objects other than popovers that are to the right of the layout boundary. number bounds A list of numeric values, separated by spaces, that describes the placement of the specified object (top-left to bottom-right). text left The left edge coordinate of the specified object. number right The right edge coordinate of the specified object.
Logical functions Attribute Returns Data type returned content The content of the specified object as follows. text web viewers - returns the current content (such as HTML code). fields - returns the field data formatted using the specified object's properties. text objects - returns the text (including text from merge fields).
Logical functions GetNthRecord Purpose Returns the contents of fieldName from the specified record number. 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 either result1 or result2, depending on the value of a test. Format If(test;result1{;result2}) Parameters test - any numeric value or logical expression result1 - expression or field name result2 - expression or field name Parameters in braces { } are optional. 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 1 (true) if a field is empty or if other errors occur; otherwise, returns 0 (false). 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 Description This function returns 1 (true) if a field is empty, if a related field, a related table, relationship, or a file is missing, or if another error occurs; otherwise, 0 (false).
Logical functions IsValid Purpose Returns 0 (false) if the data is invalid; otherwise, returns 1 (true). 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 an expression syntax is correct; otherwise, returns 0 (false). 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. IsValidExpression(calculationField) returns 0 (false) if calculationField contains abs(-1 with no closing parenthesis.
Logical functions Let Purpose Sets a variable or variables to the result of the specified expression(s) for the duration of the calculation, or until the script exits or the file is closed. 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 Once defined, local and global variables can be referenced in any calculation within their scope. Local variables defined in a calculation are scoped to the file but are only available when scripts are not running. A local and a global variable (or even two local variables in different scripts) can have the same name but they are treated as different variables and store different values.
Logical functions The following example shows how to pass named parameters, allowing access to both variable “a” and variable “b”. The simplified first parameter makes the second parameter more complex (the example returns 6, 12): ScriptParameter = "a = 5; b = 10" Evaluate ( "Let ( [" & Get(ScriptParameter) & " ]; a+1 & \", \" & b+2 )" ) 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,
Logical functions Lookup Purpose Returns the value specified in sourceField, using the relationships in the relationships graph. Format Lookup(sourceField{;failExpression}) Parameters sourceField - the field from which the lookup value is taken. failExpression - any expression. Parameters in braces { } are optional. Data type returned text, number, date, time, timestamp, container Originated in FileMaker Pro 7.0 Description The result of the optional failExpression is returned if the lookup fails.
Logical functions LookupNext Purpose Returns the next lower or higher value in sourceField when there isn't a matching related value.
Logical functions Shipping Costs table 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 on an iOS device running FileMaker Go and their accuracy. LocationValues The current latitude, longitude, and altitude on an iOS device running FileMaker Go; their accuracy; and minutes since the values were returned. RangeBeacons Returns a list of iBeacons and their proximity to an iOS device.
Mobile functions Location Purpose Returns the current latitude and longitude on an iOS device running FileMaker Go, and their accuracy. Format Location (accuracy {; timeout}) Parameters accuracy - any numeric expression or field containing a number that represents a distance in meters. timeout - any numeric expression or field containing a number that represents the most time it will take to fetch the location. Measured in seconds, the default value is 60. Parameters in braces { } are optional.
Mobile functions LocationValues Purpose Returns the current latitude, longitude, and altitude on an iOS device running FileMaker Go; their accuracy; and minutes since the values were returned. Format LocationValues (accuracy {; timeout}) Parameters accuracy - any numeric expression or field containing a number that represents a distance in meters. timeout - any numeric expression or field containing a number that represents the most time it will take to fetch the location.
Mobile functions RangeBeacons Purpose Returns a list of iBeacons and their proximity to an iOS device. Format RangeBeacons (UUID {; timeout; major; minor}) Parameters UUID - the universally unique identifier for iBeacons to search for. The UUID identifies one or more iBeacons as a specific type or from a specific organization. For example, iBeacons for all branches of a department store could share the same UUID. timeout - the number of seconds to wait before returning a value.
Mobile functions Notes • If no iBeacons match the criteria, this function returns an empty string. • If the iOS Location Services setting is turned off, this function returns an empty string. • If the query is not valid, this function returns a question mark (?). Examples RangeBeacons("D9B9EC1F-XXXX-YYYY-80A9-1E39D4CEA95C") returns information about all nearby iBeacons with the specified UUID: D9B9EC1F-XXXX-YYYY-80A9-1E39D4CEA95C, 10, 1, 0, -1.00, 0 D9B9EC1F-XXXX-YYYY-80A9-1E39D4CEA95C, 5, 1, 3, 14.
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 of a number. Ceiling A number rounded up to the next integer. Combination The number of ways to uniquely choose numberOfChoices items from a set of size setSize. Div The next lowest integer value after dividing a number by a divisor. Exp The value of the constant e raised to the power of a number.
Number functions Abs Purpose Returns the absolute value of a 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 a 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 a number by a 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 Description Equivalent to Floor(number/divisor). Examples Div(2.5;2) returns 1. Div(-2.5;2) returns -2.
Number functions Exp Purpose Returns the value of the constant e raised to the power of a 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 This function returns the value of the constant e (the base of the natural logarithm, equal to 2.7182818) raised to the power of a number. The Exp function is the inverse of the Ln function. Examples Exp(1) returns 2.
Number functions Factorial Purpose Returns the factorial of a number, stopping at 1 or 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 braces { } are optional. Data type returned number Originated in FileMaker Pro 7.
Number functions Floor Purpose Returns a 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 a 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 a 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 a 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 a 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 a number is divided by a 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 when converting units of measure, such as from minutes to hours, to return the number of remaining units.
Number functions Random Purpose Returns a number between 0 and 1, including 0 but not including 1. 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 a number rounded 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 -1 when a number is negative, 0 when zero, 1 when 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 a 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 a number truncated to the specified 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 for the number of decimal places. 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 Allows a value in a non-repeating field to be used with every repetition in a repeating field. GetRepetition The contents of the repeating field specified by a number. Last The last valid, non-blank value in a field.
Repeating functions Extend Purpose Allows a value in a non-repeating field 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 a 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 a 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 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.
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 Does this Char Returns the characters for the Unicode code points in the number.
Text functions This function Does this Middle Extracts the specified numberOfCharacters from text, starting at the specified character position. MiddleValues Returns text containing the specified numberOfValues in text, starting at startingValue. MiddleWords Returns text containing the specified numberOfWords from specified text, starting at startingWord. NumToJText Converts Arabic numerals to Japanese text. PatternCount Returns the number of occurrences of searchString in text.
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 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 Returns 1 (true) if the contents of any two fields match; otherwise, returns 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 Furigana Purpose Converts Japanese text to Hiragana, Katakana, or Roman text. Format Furigana(text{;option}) Parameters text - any text expression or text field option - 1 through 5, depending on how you want to convert text Data type returned text Originated in FileMaker Pro 14.0 Description Japanese text is composed of Kana (Hiragana and Katakana) and Kanji (characters). Kanji characters have multiple readings, and the Unicode ordering of these characters is arbitrary.
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 GetAsCSS returns the specified text in a span element with CSS properties. 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. 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 with formulas involving dates or date functions; 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. 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 Use with formulas involving numbers or numeric functions. 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. 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 Use with formulas involving text or text functions. 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. 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 with formulas involving the Time or Timestamp function; 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. 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 Use with formulas involving timestamps. 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 numerals. 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 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 the specified 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 values contained in text, according to the specified numberOfValues, 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 text containing the specified 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 a 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 For a container field, Length returns the size of the original file in bytes. Examples Length(“John”) returns 4.
Text functions Lower Purpose Returns all letters in specified 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 specified numberOfCharacters from text, starting at the specified character position. 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 text containing the specified numberOfValues in text, starting at 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. Data type returned text Originated in FileMaker Pro 7.
Text functions MiddleWords Purpose Returns text containing the specified numberOfWords from specified text, starting 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.
Text functions NumToJText Purpose Converts Arabic numerals to Japanese text. Format NumToJText(number;separator;characterType) Parameters number - any numeric expression or field containing a number separator - a number from 0 to 3 representing a separator characterType - a number from 0 to 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 specified 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 values contained in text, according to the specified numberOfValues, 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 text containing the specified 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 specified text and numbers, with the numbers 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.0 Description This function doesn’t remove the text in text, which normally happens when performing standard math against a value that contains text.
Text functions Substitute Purpose Returns a text string with every occurrence of searchString in specified text replaced by replaceString. 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 (such as spaces between text, or non-Roman spaces such as full- and half-width) removed or inserted. 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 Spaces are removed or inserted depending on the value of trimType, as given in the following tables: This trimType value Does this 0 Removes all spaces between non-Roman and Roman characters (always leave one space between Roman words). 1 Always includes a half-width space between non-Roman and Roman characters (always leave one space between Roman words).
Text functions Upper Purpose Returns all letters in specified 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 specified 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 specified 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. If the Letter field contains the text x=y=1.
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 color values for red, green, and blue. Format RGB(red;green;blue) Parameters red - any numeric expression or numeric field containing a value from 0 to 255 green - any numeric expression or numeric field containing a value from 0 to 255 blue - any numeric expression or numeric field containing a value from 0 to 255 Data type returned number Originated in FileMaker Pro 7.
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 specified 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 braces { } are optional.
Text formatting functions TextFont Purpose Changes the font of text to the specified fontName. Format TextFont(text;fontName) Parameters text - any text expression or text field. fontName - any font name expressed in text. Note TextFont no longer uses the fontScript parameter. Data type returned text Originated in FileMaker Pro 7.0 Description Spellings for font names must be correct. Text formatting options will be lost if the field type that is returned is something other than text.
Text formatting functions TextFontRemove Purpose Removes all fonts or the fontToRemove from specified text. Format TextFontRemove(text{;fontToRemove}) Parameters text - any text expression or text field. fontToRemove - any font name expressed in text. Parameters in braces { } are optional. Note TextFontRemove no longer uses the fontScript parameter. Data type returned text Originated in FileMaker Pro 8.0 Description Use this function to revert text to the default for the field.
Text formatting functions TextFormatRemove Purpose Removes all text formatting from specified 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 specified 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 the font sizeToRemove. Format TextSizeRemove(text{;sizeToRemove}) Parameters text - any text expression or text field. sizeToRemove - any font size expressed as an integer. Parameters in 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 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. Minute A number representing the minute portion (0-59) of a specified time. Seconds A number representing the seconds portion (0-59) of a specified time. 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 date as a calendar date and a time as a time of day.
Timestamp functions Timestamp Purpose Returns a timestamp containing a date as a calendar date and a 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 Does this Acos Returns the arccosine (Acos), or inverse cosine, of a number. Asin Returns the arcsine (Asin), or inverse sine, of a number.
Trigonometric functions Acos Purpose Returns the arccosine (Acos), or inverse cosine, of a 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 a 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 a 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. Format Pi Parameters None Data type returned number Originated in FileMaker Pro 6.0 or earlier Description This function calculates the value of the constant Pi (π), which is approximately 3.14159. 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 user name and (usually) password that accesses a file with a defined level of privileges.
B ASCII character set American Standard Code for Information Interchange. A standard character set used by computer systems worldwide (often extended for different alphabets). Authentication The process of checking the validity of an account and password (if one is defined) before assigning privileges and allowing access to a system or a file. An account authenticated via FileMaker Pro or FileMaker Server is referred to as a FileMaker account.
C Browse mode The FileMaker mode in which you enter and edit information in fields. Groups of fields make up the records of your file. You can view one record at a time (click Form View in the layout 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.
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 function A function that is not one of the default FileMaker Pro functions. In FileMaker Pro Advanced, you can create custom functions that can be reused anywhere in the file. 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.
D Descending sort order Reverse alphabetical sequence (Z to A) for words, highest to lowest order for numbers, and latest to earliest dates and times. 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.
E E 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. For FileMaker Pro, the encryption password is required for the FileMaker Pro user who opens the file, but not for the client who opens a file hosted by FileMaker Pro. FileMaker Pro Advanced is required to enable, disable, or change an encryption password.
F Field label Text on a layout or within a field that identifies a field. A field label can be the field name, other text (such as instructions), or the result of a calculation. Field labels can appear in various positions outside the field or as placeholder text within the field. You can change or delete a field label if you want. Field name The name you assign to a field when you define the field.
F Focus Indicates that a record, portal row, tab, option, field, repeating field repetition, layout part, or layout object that has been activated by a click, the Tab key, a navigation button, or a script can then be acted upon in some way. For example, you can change the value in a field that has the focus; you can work with the data that’s in a record that has the focus; a calculation function can return the number of the portal row that has the focus.
G 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. Use the value of a global field as a fixed value in calculations, to declare variables in If or Loop script steps, or for fields that rarely need to be updated (for example, a company logo in a container field). A global field can be any field type except summary.
I 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. Homepage The starting page for a website. It often has some form of a table of contents that allows viewers to link to other parts of the website.
J, K 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 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.) Layout part A section of a layout that organizes or summarizes information.
M List View Displays records one record at a time in a list format. To select this view, click List View in the layout bar. List view layout A type of Report layout in which 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. (In previous versions of FileMaker Pro, a List view layout was a predefined layout type.) Locked object An object on a layout that cannot be edited or deleted.
N Menu set The collection of menus that installs on the menu bar. Merge field A placeholder on a layout for the contents of a field. A merge field expands or contracts in Browse and Preview modes, or when printed, to fit the amount of data in the field for each record. Merge fields are useful for mail merge form letters; FileMaker Pro uses merge fields in predefined Labels and Envelope layouts.
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. Some objects, such as portals, have multiple components; for example, a portal row is a component of a portal. Object component An element of an object, such as a portal row of a portal or a slide panel of a slide control.
P Permitted host Servers, hosts, websites, services, and so on that are allowed to be connected to. PHP (PHP: Hypertext Preprocessor) An open-source programming language primarily used in server-side application software to create dynamic webpages. FileMaker Server lets you publish data from FileMaker Pro files on customized webpages created with PHP. Placeholder text A type of field label that displays within a field.
Q Q Query Retrieving, manipulating, or modifying data from a data source by sending SQL statements. Also, requesting, and then receiving, data from a DBMS. You can also add, edit, format, sort, and perform calculations on your data using queries. Quick find In Browse mode, searches records across multiple fields on a layout. R Read-Only Access privilege set One of the three predefined privilege sets that appear in every file.
S Relationship Relationships provide access to data from one table to another. Relationships can join one record in one table to one record in another table, one record to many other records, or all records in one table to all records in another table, depending on the criteria you specify when you create the relationship in the relationships graph.
S Script trigger A mechanism that causes a specified script to run when a particular event occurs. Search criteria In Find mode, the values and operators you specify to locate records. For example, if you type ABC Travel in the Vendor field, FileMaker Pro looks for and returns all records that have this name in the Vendor field. Security The protection that’s placed on a file.
S Slide control A layout object made up of one or more slide panels, allowing you to organize fields and other objects within each slide panel’s borders. Slide control in Browse mode Slide panel A component of a slide control. The slide panel is the area displayed when a dot in a slide control is selected. You can place objects such as lines, fields, buttons, portals, imported graphics, blocks of text, tab controls, slide controls, and web viewers on slide panels.
S Stacking order The order in which objects overlap on a layout. In Layout mode, you can change this order by cutting and pasting objects or by clicking Arrange buttons in the Arrange & Align area of the Position tab in the Inspector. Standard form layout The default layout, with all fields arranged on separate lines in the order they were defined. The body part is only as tall as it needs to be to include all the fields in the file. This layout includes header and footer parts.
T Subsummary parts Use summary parts to view and display information from one or more records. You place a summary field in a summary part to display a summary of information for each group of records sorted on the break field. You can add one or more subsummaries above (leading) or below (trailing) the body. Subsummary value Aggregate values for different categories of data within a field. For example, a subsummary value can be the total of employees for each department.
U Table A collection of data pertaining to a subject, such as customers or stock prices. A database contains one or more tables, which consist of fields and records. When you create a new table, a visual representation, or occurrence, of the table appears in the relationships graph. You can specify multiple table occurrences (with unique names) of the same table in order to work with complex relationships in the graph. Table View Displays multiple records in a tabular format like a spreadsheet.
V URL (Uniform Resource Locator) A web address, which consists of a protocol, a host name, and optionally a port, a directory, and a filename. For example, http://www.filemaker.com/ , ftp://12.34.56.78:80/myfiles/, or fmp:// mywebsite.com/sample.fmp12. V Value list To save time and ensure accuracy during data entry, define frequently used text, number, date, or time values as a value list. When you enter data, you can choose from the list of defined values.
W, X, Y, Z Web viewer A layout object that allows you to display information from websites based on data in your file. World Wide Web An interlinked collection of webpages residing on web servers, and other documents, menus, and files, which are available via URLs. X-axis data In a column, stacked column, line, and area chart, the data series you are comparing (for example, company name). In a bar or stacked bar chart, the data series you are measuring (for example, annual sales).
